mirror of https://github.com/phpseclib/phpseclib.git synced 2024-06-26 12:02:35 +00:00

PHP Secure Communications Library

aes aes-gcm asn1 diffie-hellman dsa ecdh ecdsa lts php rsa sftp ssh x509

Go to file

Petr Muzikant 40db7daea9 Update README.md		2023-07-13 16:10:05 +02:00
.github	backport enhancements from the 2.0 branch	2023-02-11 22:20:03 -06:00
build	Remove bootstrap.php	2022-10-20 17:57:21 -05:00
phpseclib	Introduce PQ support (Dilithium5 functional)	2023-06-26 11:11:50 +02:00
tests	CS adjustments	2023-06-04 11:26:34 -05:00
.gitattributes	Update .gitattributes	2022-04-10 09:32:45 -05:00
.gitignore	Upgrade to PHP 7.0	2022-07-02 16:26:15 -05:00
AUTHORS	Update authors - jack worman	2022-08-18 08:08:31 -05:00
BACKERS.md	BACKERS: add istiak-tridip. thanks!!	2023-05-10 04:36:30 -05:00
CHANGELOG.md	Merge branch '2.0' into 3.0	2023-06-13 03:42:25 -05:00
composer.json	fix bad merge	2023-02-11 22:08:27 -06:00
LICENSE	update copyright years on license	2019-07-02 06:42:17 -05:00
README.md	Update README.md	2023-07-13 16:10:05 +02:00

README.md

Post-Quantum support

adds the functionality to handle FALCON, SPHINCS+ and Dilithium5 operations
currently, only Dilithium5 was tested in https://github.com/Muzosh/Post-Quantum-Authentication-On-The-Web

Before usage, call the following function atleast once if you are using OIDs from here

ASN1::loadOIDs([
    "dilithium2" => "1.3.6.1.4.1.2.267.7.4.4",
    "p256_dilithium2" => "1.3.9999.2.7.1",
    "rsa3072_dilithium2" => "1.3.9999.2.7.2",
    "dilithium3" => "1.3.6.1.4.1.2.267.7.6.5",
    "p384_dilithium3" => "1.3.9999.2.7.3",
    "dilithium5" => "1.3.6.1.4.1.2.267.7.8.7",
    "p521_dilithium5" => "1.3.9999.2.7.4",
    "dilithium2_aes" => "1.3.6.1.4.1.2.267.11.4.4",
    "p256_dilithium2_aes" => "1.3.9999.2.11.1",
    "rsa3072_dilithium2_aes" => "1.3.9999.2.11.2",
    "dilithium3_aes" => "1.3.6.1.4.1.2.267.11.6.5",
    "p384_dilithium3_aes" => "1.3.9999.2.11.3",
    "dilithium5_aes" => "1.3.6.1.4.1.2.267.11.8.7",
    "p521_dilithium5_aes" => "1.3.9999.2.11.4",
    "falcon512" => "1.3.9999.3.1",
    "p256_falcon512" => "1.3.9999.3.2",
    "rsa3072_falcon512" => "1.3.9999.3.3",
    "falcon1024" => "1.3.9999.3.4",
    "p521_falcon1024" => "1.3.9999.3.5",
    "sphincsharaka128frobust" => "1.3.9999.6.1.1",
    "p256_sphincsharaka128frobust" => "1.3.9999.6.1.2",
    "rsa3072_sphincsharaka128frobust" => "1.3.9999.6.1.3",
    "sphincsharaka128fsimple" => "1.3.9999.6.1.4",
    "p256_sphincsharaka128fsimple" => "1.3.9999.6.1.5",
    "rsa3072_sphincsharaka128fsimple" => "1.3.9999.6.1.6",
    "sphincsharaka128srobust" => "1.3.9999.6.1.7",
    "p256_sphincsharaka128srobust" => "1.3.9999.6.1.8",
    "rsa3072_sphincsharaka128srobust" => "1.3.9999.6.1.9",
    "sphincsharaka128ssimple" => "1.3.9999.6.1.10",
    "p256_sphincsharaka128ssimple" => "1.3.9999.6.1.11",
    "rsa3072_sphincsharaka128ssimple" => "1.3.9999.6.1.12",
    "sphincsharaka192frobust" => "1.3.9999.6.2.1",
    "p384_sphincsharaka192frobust" => "1.3.9999.6.2.2",
    "sphincsharaka192fsimple" => "1.3.9999.6.2.3",
    "p384_sphincsharaka192fsimple" => "1.3.9999.6.2.4",
    "sphincsharaka192srobust" => "1.3.9999.6.2.5",
    "p384_sphincsharaka192srobust" => "1.3.9999.6.2.6",
    "sphincsharaka192ssimple" => "1.3.9999.6.2.7",
    "p384_sphincsharaka192ssimple" => "1.3.9999.6.2.8",
    "sphincsharaka256frobust" => "1.3.9999.6.3.1",
    "p521_sphincsharaka256frobust" => "1.3.9999.6.3.2",
    "sphincsharaka256fsimple" => "1.3.9999.6.3.3",
    "p521_sphincsharaka256fsimple" => "1.3.9999.6.3.4",
    "sphincsharaka256srobust" => "1.3.9999.6.3.5",
    "p521_sphincsharaka256srobust" => "1.3.9999.6.3.6",
    "sphincsharaka256ssimple" => "1.3.9999.6.3.7",
    "p521_sphincsharaka256ssimple" => "1.3.9999.6.3.8",
    "sphincssha256128frobust" => "1.3.9999.6.4.1",
    "p256_sphincssha256128frobust" => "1.3.9999.6.4.2",
    "rsa3072_sphincssha256128frobust" => "1.3.9999.6.4.3",
    "sphincssha256128fsimple" => "1.3.9999.6.4.4",
    "p256_sphincssha256128fsimple" => "1.3.9999.6.4.5",
    "rsa3072_sphincssha256128fsimple" => "1.3.9999.6.4.6",
    "sphincssha256128srobust" => "1.3.9999.6.4.7",
    "p256_sphincssha256128srobust" => "1.3.9999.6.4.8",
    "rsa3072_sphincssha256128srobust" => "1.3.9999.6.4.9",
    "sphincssha256128ssimple" => "1.3.9999.6.4.10",
    "p256_sphincssha256128ssimple" => "1.3.9999.6.4.11",
    "rsa3072_sphincssha256128ssimple" => "1.3.9999.6.4.12",
    "sphincssha256192frobust" => "1.3.9999.6.5.1",
    "p384_sphincssha256192frobust" => "1.3.9999.6.5.2",
    "sphincssha256192fsimple" => "1.3.9999.6.5.3",
    "p384_sphincssha256192fsimple" => "1.3.9999.6.5.4",
    "sphincssha256192srobust" => "1.3.9999.6.5.5",
    "p384_sphincssha256192srobust" => "1.3.9999.6.5.6",
    "sphincssha256192ssimple" => "1.3.9999.6.5.7",
    "p384_sphincssha256192ssimple" => "1.3.9999.6.5.8",
    "sphincssha256256frobust" => "1.3.9999.6.6.1",
    "p521_sphincssha256256frobust" => "1.3.9999.6.6.2",
    "sphincssha256256fsimple" => "1.3.9999.6.6.3",
    "p521_sphincssha256256fsimple" => "1.3.9999.6.6.4",
    "sphincssha256256srobust" => "1.3.9999.6.6.5",
    "p521_sphincssha256256srobust" => "1.3.9999.6.6.6",
    "sphincssha256256ssimple" => "1.3.9999.6.6.7",
    "p521_sphincssha256256ssimple" => "1.3.9999.6.6.8",
    "sphincsshake256128frobust" => "1.3.9999.6.7.1",
    "p256_sphincsshake256128frobust" => "1.3.9999.6.7.2",
    "rsa3072_sphincsshake256128frobust" => "1.3.9999.6.7.3",
    "sphincsshake256128fsimple" => "1.3.9999.6.7.4",
    "p256_sphincsshake256128fsimple" => "1.3.9999.6.7.5",
    "rsa3072_sphincsshake256128fsimple" => "1.3.9999.6.7.6",
    "sphincsshake256128srobust" => "1.3.9999.6.7.7",
    "p256_sphincsshake256128srobust" => "1.3.9999.6.7.8",
    "rsa3072_sphincsshake256128srobust" => "1.3.9999.6.7.9",
    "sphincsshake256128ssimple" => "1.3.9999.6.7.10",
    "p256_sphincsshake256128ssimple" => "1.3.9999.6.7.11",
    "rsa3072_sphincsshake256128ssimple" => "1.3.9999.6.7.12",
    "sphincsshake256192frobust" => "1.3.9999.6.8.1",
    "p384_sphincsshake256192frobust" => "1.3.9999.6.8.2",
    "sphincsshake256192fsimple" => "1.3.9999.6.8.3",
    "p384_sphincsshake256192fsimple" => "1.3.9999.6.8.4",
    "sphincsshake256192srobust" => "1.3.9999.6.8.5",
    "p384_sphincsshake256192srobust" => "1.3.9999.6.8.6",
    "sphincsshake256192ssimple" => "1.3.9999.6.8.7",
    "p384_sphincsshake256192ssimple" => "1.3.9999.6.8.8",
    "sphincsshake256256frobust" => "1.3.9999.6.9.1",
    "p521_sphincsshake256256frobust" => "1.3.9999.6.9.2",
    "sphincsshake256256fsimple" => "1.3.9999.6.9.3",
    "p521_sphincsshake256256fsimple" => "1.3.9999.6.9.4",
    "sphincsshake256256srobust" => "1.3.9999.6.9.5",
    "p521_sphincsshake256256srobust" => "1.3.9999.6.9.6",
    "sphincsshake256256ssimple" => "1.3.9999.6.9.7",
    "p521_sphincsshake256256ssimple" => "1.3.9999.6.9.8",
]);

phpseclib - PHP Secure Communications Library

Supporting phpseclib

Introduction

MIT-licensed pure-PHP implementations of the following:

SSH-2, SFTP, X.509, an arbitrary-precision integer arithmetic library, Ed25519 / Ed449 / Curve25519 / Curve449, ECDSA / ECDH (with support for 66 curves), RSA (PKCS#1 v2.2 compliant), DSA / DH, DES / 3DES / RC4 / Rijndael / AES / Blowfish / Twofish / Salsa20 / ChaCha20, GCM / Poly1305

Browse Git

Documentation

Documentation / Manual
API Documentation (generated by Doctum)

Branches

master

Development Branch
Unstable API
Do not use in production

3.0

Long term support (LTS) release
Major expansion of cryptographic primitives
Minimum PHP version: 5.6.1
PSR-4 autoloading with namespace rooted at \phpseclib3
Install via Composer: composer require phpseclib/phpseclib:~3.0

2.0

Long term support (LTS) release
Modernized version of 1.0
Minimum PHP version: 5.3.3
PSR-4 autoloading with namespace rooted at \phpseclib
Install via Composer: composer require phpseclib/phpseclib:~2.0

1.0

Long term support (LTS) release
PHP4 compatible
Composer compatible (PSR-0 autoloading)
Install using Composer: composer require phpseclib/phpseclib:~1.0
Install using PEAR: See phpseclib PEAR Channel Documentation
Download 1.0.20 as ZIP

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Support

Need Support?

Checkout Questions and Answers on Stack Overflow
Create a Support Ticket on GitHub
Browse the Support Forum (no longer in use)

Special Thanks

Special Thanks to our $50+ sponsors!:

Allan Simon
ChargeOver

Contributing

Fork the Project
Ensure you have Composer installed (see Composer Download Instructions)
Install Development Dependencies
```
composer install
```
Create a Feature Branch
Run continuous integration checks:
```
composer run-script all-quality-tools
```
Send us a Pull Request