xref: /dokuwiki/vendor/phpseclib/phpseclib/README.md (revision 41ebb58aa496fcfcdcff79471884b19704a77471)
1# phpseclib - PHP Secure Communications Library
2
3[![Build Status](https://travis-ci.org/phpseclib/phpseclib.svg?branch=2.0)](https://travis-ci.org/phpseclib/phpseclib)
4
5MIT-licensed pure-PHP implementations of an arbitrary-precision integer
6arithmetic library, fully PKCS#1 (v2.1) compliant RSA, DES, 3DES, RC4, Rijndael,
7AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509
8
9* [Browse Git](https://github.com/phpseclib/phpseclib)
10* [Code Coverage Report](https://coverage.phpseclib.org/2.0/latest/)
11
12## Documentation
13
14* [Documentation / Manual](http://phpseclib.sourceforge.net/)
15* [API Documentation](https://api.phpseclib.org/2.0/) (generated by Sami)
16
17## Branches
18
19### master
20
21* Development Branch
22* Unstable API
23* Do not use in production
24
25### 2.0
26
27* Modernized version of 1.0
28* Minimum PHP version: 5.3.3
29* PSR-4 autoloading with namespace rooted at `\phpseclib`
30* Install via Composer: `composer require phpseclib/phpseclib ~2.0`
31
32### 1.0
33
34* Long term support (LTS) release
35* PHP4 compatible
36* Composer compatible (PSR-0 autoloading)
37* Install using Composer: `composer require phpseclib/phpseclib ~1.0`
38* Install using PEAR: See [phpseclib PEAR Channel Documentation](http://phpseclib.sourceforge.net/pear.htm)
39* [Download 1.0.7 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.7.zip/download)
40
41## Support
42
43Need Support?
44
45* [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
46* [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
47* [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)
48
49## Contributing
50
511. Fork the Project
52
532. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))
54
553. Install Development Dependencies
56
57    ``` sh
58    composer install
59    ```
60
614. Create a Feature Branch
62
635. (Recommended) Run the Test Suite
64
65    ``` sh
66    vendor/bin/phpunit
67    ```
686. (Recommended) Check whether your code conforms to our Coding Standards by running
69
70    ``` sh
71    vendor/bin/phing -f build/build.xml sniff
72    ```
73
747. Send us a Pull Request
75