pacoorozco / openssh
Creating and loading private/public OpenSSH keys
Installs: 17 027
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- php: ^8.1
- illuminate/support: ^8|^9|^10
- phpseclib/phpseclib: ^3.0.23
Requires (Dev)
- orchestra/testbench: ^8.12.2
- phpunit/phpunit: ^9.6.13
README
This package allows you to easily generate OpenSSH private/public key pairs, which can be used as authentication method in SSH connections.
use PacoOrozco\OpenSSH\PrivateKey; use PacoOrozco\OpenSSH\PublicKey; // generating an OpenSSH key $privateKey = PrivateKey::generate(); $publicKey = $privateKey->getPublicKey(); // (only RSA keys) keys can be used to encrypt/decrypt data $data = 'my secret data'; $encryptedData = $publicKey->encrypt($data); // returns something unreadable $decryptedData = $privateKey->decrypt($encryptedData); // returns 'my secret data'
Most functions in this package are wrappers around phpseclib functions.
Installation
You can install the package via composer:
composer require pacoorozco/openssh
Usage
You can generate a private key using the generate
function and saving it to a file:
use PacoOrozco\OpenSSH\PrivateKey; $privateKey = PrivateKey::generate(); $privateKey->toFile('/home/foo/bar');
Loading keys
To load a key from a file use the fromFile
static method:
use PacoOrozco\OpenSSH\PrivateKey; use PacoOrozco\OpenSSH\PublicKey; PrivateKey::fromFile($pathToPrivateKey); PublicKey::fromFile($pathToPublicKey);
Alternatively, you can also create a key object using a string.
use PacoOrozco\OpenSSH\PrivateKey; use PacoOrozco\OpenSSH\PublicKey; PrivateKey::fromString($privateKeyContent); PublicKey::fromString($publicKeyString);
At any time, you can obtain the public key from a private key
use PacoOrozco\OpenSSH\PrivateKey; $privateKey = PrivateKey::fromString($privateKeyContent); $publicKey = $privateKey->getPublicKey();
[RSA keys only] Encrypting a message with a public key, decrypting with the private key
Here's how you can encrypt data using the public key, and how to decrypt it using the private key.
use PacoOrozco\OpenSSH\PrivateKey; use PacoOrozco\OpenSSH\PublicKey; $data = 'my secret data'; $publicKey = PublicKey::fromFile($pathToPublicKey); $encryptedData = $publicKey->encrypt($data); // encrypted data contains something unreadable $privateKey = PrivateKey::fromFile($pathToPrivateKey); $decryptedData = $privateKey->decrypt($encryptedData); // decrypted data contains 'my secret data'
If decrypt
cannot decrypt the given data (maybe a non-matching public key was used to encrypt the data, or maybe tampered with the data), an exception of class \PacoOrozco\OpenSSH\Exceptions\BadDecryptionException
will be thrown.
Determining if the data can be decrypted
The PrivateKey
class has a canDecrypt
method to determine if given data can be decrypted.
use PacoOrozco\OpenSSH\PrivateKey; PrivateKey::fromFile($pathToPrivateKey)->canDecrypt($data); // returns a boolean;
Signing and verifying data
The PrivateKey
class has a method sign
to generate a signature for the given data. The verify
method on the PublicKey
class can be used to verify if a signature is valid for the given data.
If verify
returns true
, you know for certain that the holder of the private key signed the message, and that it was not tampered with.
use PacoOrozco\OpenSSH\PrivateKey; use PacoOrozco\OpenSSH\PublicKey; $signature = PrivateKey::fromFile($pathToPrivateKey)->sign('my message'); // returns a string $publicKey = PublicKey::fromFile($pathToPublicKey); $publicKey->verify('my message', $signature) // returns true; $publicKey->verify('my modified message', $signature) // returns false;
Validating inputs (Laravel)
You can use this library to validate form inputs.
To validate if an input is a valid public or private key you can use:
use PacoOrozco\OpenSSH\Rules\PublicKeyRule; [...] public function rules(): array { return [ 'public_key' => [ new PublicKeyRule(), ], 'private_key' => [ new PrivateKeyRule(), ], ]; } }
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.