2012-06-10 09:27:23 +00:00
|
|
|
# phpseclib - PHP Secure Communications Library
|
|
|
|
|
2016-04-30 21:23:35 +00:00
|
|
|
[![Build Status](https://travis-ci.org/phpseclib/phpseclib.svg?branch=master)](https://travis-ci.org/phpseclib/phpseclib)
|
2012-06-11 08:30:46 +00:00
|
|
|
|
2012-06-10 09:27:23 +00:00
|
|
|
MIT-licensed pure-PHP implementations of an arbitrary-precision integer
|
|
|
|
arithmetic library, fully PKCS#1 (v2.1) compliant RSA, DES, 3DES, RC4, Rijndael,
|
2013-06-10 14:55:41 +00:00
|
|
|
AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509
|
2012-06-10 09:27:23 +00:00
|
|
|
|
2016-08-18 18:43:04 +00:00
|
|
|
* [Download (1.0.3)](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.3.zip/download)
|
2012-06-10 09:27:23 +00:00
|
|
|
* [Browse Git](https://github.com/phpseclib/phpseclib)
|
2016-04-30 21:23:35 +00:00
|
|
|
* [Code Coverage Report](http://phpseclib.bantux.org/code_coverage/master/latest/)
|
2012-06-10 09:27:23 +00:00
|
|
|
|
|
|
|
<img src="http://phpseclib.sourceforge.net/pear-icon.png" alt="PEAR Channel" width="16" height="16">
|
2012-06-11 08:30:46 +00:00
|
|
|
PEAR Channel: [phpseclib.sourceforge.net](http://phpseclib.sourceforge.net/pear.htm)
|
2014-04-12 18:15:34 +00:00
|
|
|
|
2014-08-01 15:57:06 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
* [Documentation / Manual](http://phpseclib.sourceforge.net/)
|
2016-04-30 21:23:35 +00:00
|
|
|
* [API Documentation](http://phpseclib.bantux.org/api/master/) (generated by Sami)
|
2014-08-01 15:57:06 +00:00
|
|
|
|
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)
|
|
|
|
|
2014-04-15 14:51:50 +00:00
|
|
|
## Installing Development Dependencies
|
2014-04-12 18:15:34 +00:00
|
|
|
|
|
|
|
Dependencies are managed via Composer.
|
|
|
|
|
|
|
|
1. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable as per the
|
|
|
|
[Composer Download Instructions](https://getcomposer.org/download/), e.g. by running
|
|
|
|
|
|
|
|
``` sh
|
|
|
|
curl -sS https://getcomposer.org/installer | php
|
|
|
|
```
|
|
|
|
|
|
|
|
2. Install Dependencies
|
|
|
|
|
|
|
|
``` sh
|
2016-04-10 16:30:59 +00:00
|
|
|
php composer.phar install
|
2014-04-12 18:15:34 +00:00
|
|
|
```
|
2014-04-12 18:26:27 +00:00
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
2014-04-12 18:35:30 +00:00
|
|
|
1. Fork the Project
|
2014-04-12 18:26:27 +00:00
|
|
|
|
2014-04-15 14:51:50 +00:00
|
|
|
2. Install Development Dependencies
|
2014-04-12 18:26:27 +00:00
|
|
|
|
2014-04-12 18:35:30 +00:00
|
|
|
3. Create a Feature Branch
|
2014-04-12 18:26:27 +00:00
|
|
|
|
2014-04-12 18:35:30 +00:00
|
|
|
4. (Recommended) Run the Test Suite
|
2014-04-12 18:26:27 +00:00
|
|
|
|
|
|
|
``` sh
|
|
|
|
vendor/bin/phpunit
|
|
|
|
```
|
2014-04-12 18:35:30 +00:00
|
|
|
5. (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
|
|
|
|
```
|
|
|
|
|
2014-04-12 18:35:30 +00:00
|
|
|
6. Send us a Pull Request
|