sivin/crypt

Small library for encryption via phpseclib

v2.1 2021-04-20 08:31 UTC

Requires

• php: >= 7.1
• ext-openssl: *
• nette/di: ~3.0
• phpseclib/phpseclib: ^3.0
• tracy/tracy: ^2.6

Requires (Dev)

• ninjify/nunjuck: ^0.3.0@dev

MIT

• Milan Sivak

• security
• ssh
• nette
• crypt
• blowfish
• rsa
• aes
• sftp
• x509
• x.509
• asn1
• asn.1
• BigInteger
• twofish

README

Small library for encryption via phpseclib

1. Install via composer

   composer require sivin/crypt

2. Register extension in config.neon:

   extensions:
   	crypt: SiViN\Crypt\DI\CryptExtension

3. Create or use your key/s:

   /** @var Crypt */
   private $crypt;
   
   public function __construct(Crypt $crypt)
   {
   	$this->crypt = $crypt;
   }
   ...
   $keys = $this->crypt->createKeyPair()
   $privateKeyRaw = $keys['privateKeyRaw'];
   $publicKeyRaw = $keys['publicKeyRaw'];

4. Use your own key or define it in a config.local.neon:

   $crypt->setPublicKey($myPublicKeyForEncrypt);
   $crypt->setPrivateKey($myPrivateKeyForDecrypt);
   //if there is a private key with a password
   $crypt->setPrivateKeyPassword($myPivateKeyPasswordForDecrypt);

   or in a config.local.neon:

   crypt:
   	publicKeyPath: publicKeyFile.pub #for encrypting
   	privateKeyPath: privateKeyFile.key #for decrypting
   	privateKeyPassword: 'PrivateKeyPassword' #optional

   If you only want to encrypt/decrypt, just define the encrypting/decrypting key

5. And finally?:

   $encryptedStr = $crypt->encryptRijndaelMessage($stringToEncode); //for transport
   $decryptedStr = $crypt->decryptRijndaelMessage($encryptedStr);
   
   $encryptedStr = $crypt->encryptRsa($stringToEncode);
   $decryptedStr = $crypt->decryptRsa($encryptedStr);
   
   $encryptedStr = $crypt->encryptRijndael($stringToEncode);
   $decryptedStr = $crypt->decryptRijndael($encryptedStr);