If you like this package, please note that it is no longer in active development and please check PHP-Cryphography package., (*1)
PHP Encrypt
This is readonly Mirror however you can still conttibute if you have email. For more infomation scroll down to Contributing., (*2)
Library for signing certificates with selfsigned CA, (*3)
, (*4)
Installation
Install with docker:, (*5)
composer require maymeow/php-encrypt
And intialize it withhin your script, (*6)
$cf = new \MayMeow\Factory\CertificateFactory(new \MayMeow\Model\EncryptConfiguration());
Alternative you can download from my private server
add to your composer.json files to repositories section, (*7)
{"type":"composer","url":"https://git.cloud.hsoww.net/api/v4/group/121/-/packages/composer/packages.json"}
Usage [WIP]
Path Configuring
To set diferent path for cert templates (cnf files) use:, (*8)
// dont forget to use trailing slash
$cf = new \MayMeow\Factory\CertificateFactory(new \MayMeow\Model\EncryptConfiguration(), '/path/to/templates/folder/');
To chanage folder to change path to your configuration file, (*9)
// use full path to your configuration file include name of this file
$cf = new \MayMeow\Factory\CertificateFactory(new \MayMeow\Model\EncryptConfiguration('/path/to/templates/folder/my_config_file.yml'));
Certificate Signing - [DEPRECATED]
- Create Selfsigned CA
use MayMeow\Writers\FileWriter;
$cf->domainName()
->setOrganizationName('Hogwarts School of Witchcraft and Wizardry')
->setCountryName('SK')
->setCommonName('Hogwarts School of Witchcraft and Wizardry Root CA');
$cf->setType('ca')
->setName('Hogwarts')
->sign()
->writeTo(FileWriter::class);
- Create Intermediate CAs. This type of CA you will use for signing users and servers certificates.
use MayMeow\Writers\FileWriter;
use MayMeow\Loaders\FileLoader;
$cf->domainName()
->setOrganizationName('Hogwarts School of Witchcraft and Wizardry')
->setCountryName('SK')
->setOrganizationalUnitName('Hogwarts houses')
->setCommonName('Slytherin HSoWaW House');
$cf->setType('intermediate')
->setName('Hogwarts/Slytherin')
->setCaFrom(new FileLoader('test-ca'))
->sign()->writeTo(FileWriter::class);
- Sign User or server certificate
use MayMeow\Writers\FileWriter;
use MayMeow\Loaders\FileLoader;
$cf->domainName()
->setCommonName('Hermione Granger')
->setEmailAddress('hermione.granger@g.hogwarts.local')
->setOrganizationName('Hogwarts School of Witchcraft and Wizardry')
->setOrganizationalUnitName('Hogwarts Students');
$cf->setType('user')
->setName('Hogwarts/Students/hermione-granger')
->setCaFrom(new FileLoader('test-ca'))
->sign()->writeTo(FileWriter::class);
use MayMeow\Writers\FileWriter;
use MayMeow\Loaders\FileLoader;
$cf->domainName()
->setCommonName("gryffindor.hogwarts.local")
->setOrganizationalUnitName("Hogwarts Webpages")
->setOrganizationName("Hogwarts School of Witchcraft and Wizardry");
$cf->getAltNames()
->setDns("gryffindor.hogwarts.local")
->setDns("*.gryffindor.hogwarts.local")
->setIp("10.0.20.2");
$cf->setType("server")
->setName("Hogwarts/Webpages/griffindor-hogwarts-local")
->setCaFrom(new FileLoader('test-ca'))
->sign()->writeTo(FileWriter::class);
- Each certificatess are located in
webroot/<certificate-name>. Certificate Names can be set
with ->setName(<certificate-name>) function.
- To load CA for signing certificate you will use
->setCa(<certificate-name>, <certificate-key-pass>).
Certificate Key pass is located in code.txt file in each certificate folder.
Windows users need certificate in PKCS12 format, .pfx file extension. To create this type of file use, (*10)
// public function write($decryptPK = false, $pcks12 = false);
...->write(false, true);
Creating key pairs
If you dont need certificate you can create key pair from v2018.4 updated in v2019.5, (*11)
use MayMeow\RSA\RSACryptoServiceProvider;
$this->csp = new RSACryptoServiceProvider();
$keypair = $this->csp->generateKeyPair('yourSuperStrongPas$$phrase'); // returns RSAParameters
// privateKey & public key
$keypair->getPrivateKey();
$keypair->getPublicKey();
Loaders [DEPRECATED]
Are now deprecated and will be removed in nex major release, (*12)
use MayMeow\Loaders\FileLoader;
$kp = new FileLoader('test-ca');
$kp->getPublicKey();
$kp->getPrivateKey();
Crypto Service Providers
RSA Crypto Service Provider
RSACSP is replace Security factory. It's used for asymetric encryption. Asymetric encryption is using two keys, public for encrypt and private key for decrypt data;, (*13)
// Generate keypPairs
use MayMeow\Cryptography\RSA\RSACryptoServiceProvider;
use MayMeow\Cryptography\Filesystem\RsaParametersFileLoader;
$this->csp = new RSACryptoServiceProvider();
// generate new keypairs
$keypair = $this->csp->generateKeyPair('yourSuperStrongPas$$phrase'); // returns RSAParameter
// OR Load keypairs from file
$fileLoader = new RsaParametersFileLoader();
$this->csp->setRsaParameters($fileLoader->load('name_of_certificate'));
// Ecrypt and decrypt
$plainText = 'Hello World!';
$encryptedText = $this->csp->encrypt($plainText);
$decrypted = $this->csp->decrypt($encryptedText);
// Signing
$signature = $this->csp->sign($plainText);
$this->csp->verify($plainText, $signature); // true or false
// md5 fingerprint
$this->csp->getFingerPrint();
AES Crypto Service Provider
AESCSP is using for aes encryption. Aes is symetric encryption, is using only one key for encrypt/decrypt data. For more security it can be used together with asymetric encryption., (*14)
use MayMeow\Cryptography\AES\AESCryptoServiceProvider;
//initialize CSP, generate key and IV
$csp = new AESCryptoServiceProvider();
$csp->generateIV();
$key = $csp->generateKey();
//encrypt data
$plainText = "This is going to be encrypted!";
$encryptedText = $this->csp->encrypt($plainText);
// inistialize another CSP
// sure you can use same instance to decrypt but in most cases you only ancrypting
// and then storing to database to decrypt it later
$csp2 = new AESCryptoServiceProvider();
$csp2->setKey($key); // et key you generated before
//decrypt text
$originalText = $csp2->decrypt($encryptedText);
Contributing
This repository is mirror from my own git server. If you want to contribute you will need email., (*15)
- Create new branch
``` bash
it checkout -b , (*16)
2. Create new commit from your changes and make patch.
``` bash
git add <file>
git commit
git format-patch -o /tmp/ HEAD^
- Send you patch to my email.
DO NOT make changes right inside master branch. I will not accept that., (*17)
History
SEE changelog, (*18)
Credits
Stargazers
, (*19)
License
MIT, (*20)
Wallogit.com
