phpseclib/README.md

101 lines
3.4 KiB
Markdown
Raw Normal View History

# phpseclib - PHP Secure Communications Library
2021-12-04 21:10:52 +00:00
[![Build Status](https://travis-ci.com/phpseclib/phpseclib.svg?branch=3.0)](https://travis-ci.com/github/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
* [Browse Git](https://github.com/phpseclib/phpseclib)
## Documentation
2020-12-17 05:32:16 +00:00
* [Documentation / Manual](https://phpseclib.com/)
2020-12-17 05:59:48 +00:00
* [API Documentation](https://api.phpseclib.com/3.0/) (generated by Doctum)
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
* 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`
* 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)
* 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)
2021-12-28 06:26:23 +00:00
* [Download 1.0.20 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.20.zip/download)
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)
2021-11-17 15:22:30 +00:00
## Special Thanks
2022-02-01 13:00:55 +00:00
Special Thanks to our $50+ sponsors!:
2021-11-17 15:22:30 +00:00
- Allan Simon
2022-02-01 13:00:55 +00:00
- [ChargeOver](https://chargeover.com/)
2021-11-17 15:22:30 +00:00
## Contributing
1. Fork the Project
2. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))
3. Install Development Dependencies
```sh
2016-12-18 09:38:28 +00:00
composer install
```
2014-04-12 18:26:27 +00:00
4. Create a Feature Branch
2014-04-12 18:26:27 +00:00
5. Run continuous integration checks:
```sh
vendor/bin/phpunit
vendor/bin/phing -f build/build.xml sniff
# The following tools are from the build specific composer.json:
composer install --no-interaction --working-dir=build
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