xref: /dokuwiki/vendor/phpseclib/phpseclib/README.md (revision 903d43fe60f76e180b5d8ef35db7007bee2a8e5e)
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* [Code Coverage Report](https://coverage.phpseclib.org/2.0/latest/)
19
20## Documentation
21
22* [Documentation / Manual](http://phpseclib.sourceforge.net/)
23* [API Documentation](https://api.phpseclib.org/2.0/) (generated by Sami)
24
25## Branches
26
27### master
28
29* Development Branch
30* Unstable API
31* Do not use in production
32
33### 2.0
34
35* Long term support (LTS) release
36* Modernized version of 1.0
37* Minimum PHP version: 5.3.3
38* PSR-4 autoloading with namespace rooted at `\phpseclib`
39* Install via Composer: `composer require phpseclib/phpseclib:~2.0`
40
41### 1.0
42
43* Long term support (LTS) release
44* PHP4 compatible
45* Composer compatible (PSR-0 autoloading)
46* Install using Composer: `composer require phpseclib/phpseclib:~1.0`
47* Install using PEAR: See [phpseclib PEAR Channel Documentation](http://phpseclib.sourceforge.net/pear.htm)
48* [Download 1.0.17 as ZIP](http://sourceforge.net/projects/phpseclib/files/phpseclib1.0.17.zip/download)
49
50## Security contact information
51
52To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
53
54## Support
55
56Need Support?
57
58* [Checkout Questions and Answers on Stack Overflow](http://stackoverflow.com/questions/tagged/phpseclib)
59* [Create a Support Ticket on GitHub](https://github.com/phpseclib/phpseclib/issues/new)
60* [Browse the Support Forum](http://www.frostjedi.com/phpbb/viewforum.php?f=46) (no longer in use)
61
62## Contributing
63
641. Fork the Project
65
662. Ensure you have Composer installed (see [Composer Download Instructions](https://getcomposer.org/download/))
67
683. Install Development Dependencies
69
70    ``` sh
71    composer install
72    ```
73
744. Create a Feature Branch
75
765. (Recommended) Run the Test Suite
77
78    ``` sh
79    vendor/bin/phpunit
80    ```
816. (Recommended) Check whether your code conforms to our Coding Standards by running
82
83    ``` sh
84    vendor/bin/phing -f build/build.xml sniff
85    ```
86
877. Send us a Pull Request
88