artisansdk/srp

A client and server-side implementation in PHP of the Secure Remote Password (SRP-6a) protocol.

dev-master 2023-01-20 03:17 UTC

Requires

• php: >=8.0
• phpseclib/phpseclib: ~3.0

Requires (Dev)

• artisansdk/bench: dev-master

Suggests

• ext-gmp: Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.

MIT

• Daniel LaBarge

• Authentication
• password
• salt
• zero-knowledge
• SRP
• SRP6a
• RFC 5054
• RFC 2945
• RFC5054
• RFC2945
• proof-of-password

README

A client and server-side implementation in PHP of the Secure Remote Password (SRP-6a) protocol.

Want to see a demo in Laravel? Check out dalabarge/srp-demo

Table of Contents

• Secure Remote Protocol
  • Table of Contents
• Installation
• Usage Guide
• Running the Tests
• Licensing

Installation

The package installs into a PHP application like any other PHP package:

composer require artisansdk/srp

Usage Guide

The common use cases for this package should be documented including any troubleshooting.

Running the Tests

The package is unit tested with 100% line coverage and path coverage. You can run the tests by simply cloning the source, installing the dependencies, and then running ./vendor/bin/phpunit. Additionally included in the developer dependencies are some Composer scripts which can assist with Code Styling and coverage reporting:

composer test
composer fix
composer report

See the composer.json for more details on their execution and reporting output.

Licensing

Copyright (c) 2019-2023 Artisan Made, Co.

This package is released under the MIT license. Please see the LICENSE file distributed with every copy of the code for commercial licensing terms.

Special thanks goes to simon_massey/thinbus-php-srp for initial inspiration for both the PHP and JavaScript libraries. This demo would not be possible without his explanation of the mechanics of Secure Remote Password protocol.