xref: /dokuwiki/vendor/phpseclib/phpseclib/README.md (revision 343a31d8fe7efc33670809a79d82b500fdc99b76)
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* [Download (1.0.4)](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.4.zip/download)
10* [Browse Git](https://github.com/phpseclib/phpseclib)
11* [Code Coverage Report](http://phpseclib.bantux.org/code_coverage/2.0/latest/)
12
13<img src="http://phpseclib.sourceforge.net/pear-icon.png" alt="PEAR Channel" width="16" height="16">
14PEAR Channel: [phpseclib.sourceforge.net](http://phpseclib.sourceforge.net/pear.htm)
15
16## Documentation
17
18* [Documentation / Manual](http://phpseclib.sourceforge.net/)
19* [API Documentation](http://phpseclib.bantux.org/api/2.0/) (generated by Sami)
20
21## Support
22
23Need Support?
24
25* [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
26* [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
27* [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)
28
29## Installing Development Dependencies
30
31Dependencies are managed via Composer.
32
331. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable as per the
34   [Composer Download Instructions](https://getcomposer.org/download/), e.g. by running
35
36    ``` sh
37    curl -sS https://getcomposer.org/installer | php
38    ```
39
402. Install Dependencies
41
42    ``` sh
43    php composer.phar install
44    ```
45
46## Contributing
47
481. Fork the Project
49
502. Install Development Dependencies
51
523. Create a Feature Branch
53
544. (Recommended) Run the Test Suite
55
56    ``` sh
57    vendor/bin/phpunit
58    ```
595. (Recommended) Check whether your code conforms to our Coding Standards by running
60
61    ``` sh
62    vendor/bin/phing -f build/build.xml sniff
63    ```
64
656. Send us a Pull Request
66