xref: /dokuwiki/vendor/phpseclib/phpseclib/README.md (revision b9b72303a4f72a2b30a10f3a8834dd2b17097d25)
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
5## Supporting phpseclib
6
7- [Become a backer or sponsor on Patreon](https://www.patreon.com/phpseclib)
8- [One-time donation via PayPal or crypto-currencies](http://sourceforge.net/donate/index.php?group_id=198487)
9- [Subscribe to Tidelift](https://tidelift.com/subscription/pkg/packagist-phpseclib-phpseclib?utm_source=packagist-phpseclib-phpseclib&utm_medium=referral&utm_campaign=readme)
10
11## Introduction
12
13MIT-licensed pure-PHP implementations of an arbitrary-precision integer
14arithmetic library, fully PKCS#1 (v2.1) compliant RSA, DES, 3DES, RC4, Rijndael,
15AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509
16
17* [Browse Git](https://github.com/phpseclib/phpseclib)
18
19## Documentation
20
21* [Documentation / Manual](http://phpseclib.sourceforge.net/)
22* [API Documentation](https://api.phpseclib.org/2.0/) (generated by Sami)
23
24## Branches
25
26### master
27
28* Development Branch
29* Unstable API
30* Do not use in production
31
32### 2.0
33
34* Long term support (LTS) release
35* Modernized version of 1.0
36* Minimum PHP version: 5.3.3
37* PSR-4 autoloading with namespace rooted at `\phpseclib`
38* Install via Composer: `composer require phpseclib/phpseclib:~2.0`
39
40### 1.0
41
42* Long term support (LTS) release
43* PHP4 compatible
44* Composer compatible (PSR-0 autoloading)
45* Install using Composer: `composer require phpseclib/phpseclib:~1.0`
46* Install using PEAR: See [phpseclib PEAR Channel Documentation](http://phpseclib.sourceforge.net/pear.htm)
47* [Download 1.0.18 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.18.zip/download)
48
49## Security contact information
50
51To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
52
53## Support
54
55Need Support?
56
57* [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
58* [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
59* [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)
60
61## Contributing
62
631. Fork the Project
64
652. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))
66
673. Install Development Dependencies
68
69    ``` sh
70    composer install
71    ```
72
734. Create a Feature Branch
74
755. (Recommended) Run the Test Suite
76
77    ``` sh
78    vendor/bin/phpunit
79    ```
806. (Recommended) Check whether your code conforms to our Coding Standards by running
81
82    ``` sh
83    vendor/bin/phing -f build/build.xml sniff
84    ```
85
867. Send us a Pull Request
87