2012-06-10 09:27:23 +00:00
# phpseclib - PHP Secure Communications Library
2020-11-21 17:55:24 +00:00
[](https://travis-ci.com/phpseclib/phpseclib)
2012-06-11 08:30:46 +00:00
2019-07-02 12:03:46 +00:00
## Supporting phpseclib
- [Become a backer or sponsor on Patreon ](https://www.patreon.com/phpseclib )
- [One-time donation via PayPal or crypto-currencies ](http://sourceforge.net/donate/index.php?group_id=198487 )
- [Subscribe to Tidelift ](https://tidelift.com/subscription/pkg/packagist-phpseclib-phpseclib?utm_source=packagist-phpseclib-phpseclib&utm_medium=referral&utm_campaign=readme )
## Introduction
2020-12-17 05:32:16 +00:00
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
2012-06-10 09:27:23 +00:00
* [Browse Git ](https://github.com/phpseclib/phpseclib )
2014-08-01 15:57:06 +00:00
## Documentation
2020-12-17 05:32:16 +00:00
* [Documentation / Manual ](https://phpseclib.com/ )
* [API Documentation ](https://api.phpseclib.com/1.0/ ) (generated by Doctum)
2014-08-01 15:57:06 +00:00
2016-12-18 10:02:41 +00:00
## Branches
### master
* Development Branch
* Unstable API
* Do not use in production
2020-12-17 05:32:16 +00:00
### 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`
2016-12-18 10:02:41 +00:00
### 2.0
2018-11-14 20:41:55 +00:00
* Long term support (LTS) release
2016-12-18 10:02:41 +00:00
* Modernized version of 1.0
* Minimum PHP version: 5.3.3
* PSR-4 autoloading with namespace rooted at `\phpseclib`
2019-07-02 12:03:46 +00:00
* Install via Composer: `composer require phpseclib/phpseclib:~2.0`
2016-12-18 10:02:41 +00:00
### 1.0
* Long term support (LTS) release
* PHP4 compatible
* Composer compatible (PSR-0 autoloading)
2019-07-02 12:03:46 +00:00
* Install using Composer: `composer require phpseclib/phpseclib:~1.0`
2016-12-25 15:09:17 +00:00
* Install using PEAR: See [phpseclib PEAR Channel Documentation ](http://phpseclib.sourceforge.net/pear.htm )
2020-07-08 04:31:58 +00:00
* [Download 1.0.19 as ZIP ](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.19.zip/download )
2016-12-18 10:02:41 +00:00
2019-07-02 12:03:46 +00:00
## Security contact information
To report a security vulnerability, please use the [Tidelift security contact ](https://tidelift.com/security ). Tidelift will coordinate the fix and disclosure.
2014-07-14 18:20:18 +00:00
## Support
Need Support?
* [Checkout Questions and Answers on Stack Overflow ](http://stackoverflow.com/questions/tagged/phpseclib )
* [Create a Support Ticket on GitHub ](https://github.com/phpseclib/phpseclib/issues/new )
* [Browse the Support Forum ](http://www.frostjedi.com/phpbb/viewforum.php?f=46 ) (no longer in use)
2016-12-18 09:40:24 +00:00
## Contributing
2014-04-12 18:15:34 +00:00
2016-12-18 09:40:24 +00:00
1. Fork the Project
2014-04-12 18:15:34 +00:00
2016-12-18 09:40:24 +00:00
2. Ensure you have Composer installed (see [Composer Download Instructions ](https://getcomposer.org/download/ ))
2014-04-12 18:15:34 +00:00
2016-12-18 09:40:24 +00:00
3. Install Development Dependencies
2014-04-12 18:15:34 +00:00
``` sh
2016-12-18 09:38:28 +00:00
composer install
2014-04-12 18:15:34 +00:00
```
2014-04-12 18:26:27 +00:00
2016-12-18 09:40:24 +00:00
4. Create a Feature Branch
2014-04-12 18:26:27 +00:00
2016-12-18 09:40:24 +00:00
5. (Recommended) Run the Test Suite
2014-04-12 18:26:27 +00:00
``` sh
vendor/bin/phpunit
```
2016-12-18 09:40:24 +00:00
6. (Recommended) Check whether your code conforms to our Coding Standards by running
2014-04-12 18:26:27 +00:00
``` sh
vendor/bin/phing -f build/build.xml sniff
```
2016-12-18 09:40:24 +00:00
7. Send us a Pull Request
