phpseclib/README.md

phpseclib - PHP Secure Communications Library

Supporting phpseclib

• Become a backer or sponsor on Patreon
• One-time donation via PayPal or crypto-currencies
• Subscribe to Tidelift

Introduction

MIT-licensed pure-PHP implementations of the following:

SSH-2, SFTP, X.509, an arbitrary-precision integer arithmetic library, Ed25519 / Ed449 / Curve25519 / Curve449, ECDSA / ECDH (with support for 66 curves), RSA (PKCS#1 v2.2 compliant), DSA / DH, DES / 3DES / RC4 / Rijndael / AES / Blowfish / Twofish / Salsa20 / ChaCha20, GCM / Poly1305

• Browse Git

Documentation

• Documentation / Manual
• API Documentation (generated by Doctum)

Branches

master

• Development Branch
• Unstable API
• Do not use in production

3.0

• Long term support (LTS) release
• Major expansion of cryptographic primitives
• Minimum PHP version: 5.6.1
• PSR-4 autoloading with namespace rooted at \phpseclib3
• Install via Composer: composer require phpseclib/phpseclib:~3.0

2.0

• Long term support (LTS) release
• Modernized version of 1.0
• Minimum PHP version: 5.3.3
• PSR-4 autoloading with namespace rooted at \phpseclib
• Install via Composer: composer require phpseclib/phpseclib:~2.0

1.0

• Long term support (LTS) release
• PHP4 compatible
• Composer compatible (PSR-0 autoloading)
• Install using Composer: composer require phpseclib/phpseclib:~1.0
• Install using PEAR: See phpseclib PEAR Channel Documentation
• Download 1.0.20 as ZIP

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Support

Need Support?

• Checkout Questions and Answers on Stack Overflow
• Create a Support Ticket on GitHub
• Browse the Support Forum (no longer in use)

Special Thanks

Special Thanks to our $50+ sponsors!:

• Allan Simon
• ChargeOver

Contributing

1. Fork the Project

2. Ensure you have Composer installed (see Composer Download Instructions)

3. Install Development Dependencies

   composer install
   composer install --no-interaction --working-dir=build
   

4. Create a Feature Branch

5. Run continuous integration checks:

   vendor/bin/phpunit
   
   # The following tools are from the build specific composer.json using the most recent PHP version:
   build/vendor/bin/phpcs --standard=build/phpcs_ruleset.xml
   build/vendor/bin/php-cs-fixer fix --config=build/php-cs-fixer.php --diff --dry-run
   build/vendor/bin/psalm --config=build/psalm.xml --no-cache --long-progress --report-show-info=false --output-format=text
   

6. Send us a Pull Request