https://github.com/maymeow/php-encrypt
🔏PHP library for creating and signing Certificates, text encryption and decryption.
https://github.com/maymeow/php-encrypt
certificates encryption hacktoberfest hacktoberfest2020 library openssl php security
Last synced: about 1 year ago
JSON representation
🔏PHP library for creating and signing Certificates, text encryption and decryption.
- Host: GitHub
- URL: https://github.com/maymeow/php-encrypt
- Owner: MayMeow
- License: mit
- Created: 2018-05-07T18:09:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T18:27:18.000Z (over 3 years ago)
- Last Synced: 2024-10-06T10:17:27.584Z (over 1 year ago)
- Topics: certificates, encryption, hacktoberfest, hacktoberfest2020, library, openssl, php, security
- Language: PHP
- Homepage: https://wiki.0x0.sk/en/php-encrypt
- Size: 1.84 MB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
If you like this package, please note that it is no longer in active development and please check [PHP-Cryphography](https://github.com/MayMeow/php-cryptography) package.
# PHP Encrypt
This is readonly Mirror however you can still conttibute if you have email. For more infomation scroll down to **Contributing**.
Library for signing certificates with selfsigned CA
[](https://codeclimate.com/github/MayMeow/php-encrypt/maintainability)
## Installation
Install with docker:
```bash
composer require maymeow/php-encrypt
```
And intialize it withhin your script
```php
$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
```json
{"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:
```php
// 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
```php
// 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]
1. Create Selfsigned CA
```php
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);
```
2. Create Intermediate CAs. This type of CA you will use for signing users and servers certificates.
```php
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);
```
3. Sign User or server certificate
* User Certificate
```php
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);
```
* Server Certificate
```php
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);
```
4. Each certificatess are located in `webroot/`. Certificate Names can be set
with `->setName()` function.
5. To load CA for signing certificate you will use `->setCa(, )`.
__Certificate Key pass__ is located in `code.txt` file in each certificate folder.
### PKCS12 file format
Windows users need certificate in PKCS12 format, `.pfx` file extension. To create this type of file use
```php
// 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`
```php
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
```php
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;
```php
// 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.
```php
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.
1. Create new branch
``` bash
it checkout -b
```
2. Create new commit from your changes and make patch.
``` bash
git add
git commit
git format-patch -o /tmp/ HEAD^
```
3. Send you patch to my email.
**DO NOT** make changes right inside master branch. I will not accept that.
## History
SEE changelog
## Credits
* [MayMeow (Emma)](https://github.com/MayMeow)
## Stargazers
[](https://github.com/MayMeow/php-encrypt/stargazers)
## License
MIT