https://github.com/ialopezg/encryption
Encryption Library for PHP
https://github.com/ialopezg/encryption
Last synced: 2 months ago
JSON representation
Encryption Library for PHP
- Host: GitHub
- URL: https://github.com/ialopezg/encryption
- Owner: ialopezg
- License: mit
- Created: 2020-09-23T11:48:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-24T01:11:12.000Z (over 4 years ago)
- Last Synced: 2025-01-20T01:31:55.705Z (4 months ago)
- Language: PHP
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Cryptography Library
Cryptography Library for PHP
**Table of Contents**
- [Installation](#installation)
- [Features](#features)
- [Requirements](#requirements)
- [Usage instructions](#usage-instructions)
- [License](#license)
## Installation
1. Package manager
- Composer
```shell script
composer require ialopezg/encryption
```
2. Manually
- **Github**
```shell script
git clone https://github.com/ialopezg/encryption
```
## Features
| Library | Description |
|---|---|
| `Password` | Library for password manipulation. |
## Requirements
* **PHP** *v5.6+*
* **ext-mbstring** PHP extension
* **ext-openssl** PHP extension
* **ialopezg/core** *v0.0.1+*
* **ialopezg/logger** *v0.0.4+*
## Usage instructions
### IteratorObject
### Methods
| Method | Description |
|---|---|
| `createKey()` | Creates a random key with the lengh provided. Optional the result could be returned with capital letters. |
| `getOption()` | Gets an option value. If value does not exists will return the default value. |
| `hash()` | Encrypts a simple text password into a ciphered password. |
| `setOption()` | Sets an option value. |
| `verify()` | Encrypts a plain text into cipher text. |
#### Method Details
```php
/**
* Creates a random key with the length specified. Optional the result could be returned with capital letters.
*
* @param int $length Output length.
* @param bool $capitalize Whether if the result key will be returned with capital letters.
*
* @throws Exception If it was not possible to gather sufficient entropy.
* @return string A random key.
*/
public static function createKey($length, $capitalize = false): string
```
**Examples**
```php
$key = \ialopezg\Libraries\Encryption\Password::createKey(8, true);
// Display the encryption key string
echo "Encryption key: {$key}
";
```
```php
/**
* Gets an option value. If value does not exists will return the default value.
*
* @param string $key Option key name.
* @param null $default Option default value.
*
* @return mixed
*/
public function getOption($key, $default = null): string
```
**Examples**
```php
$encrypter->setOption('key', Password::createKey(8, true);
// Display the encryption key string
echo "Encryption key: {$encrypter->getOption('key')}
";
```
```php
/**
* Encrypts a simple text password into a ciphered password.
*
* @param string $password Plain text password.
*
* @return string Ciphered password.
* @throws Exception If data provided is not a string.
*/
public function hash($password): string
```
**Examples**
```php
$encrypter = new \ialopezg\Libraries\Encryption\Password([
'cipher' => 'AES-128-CTR',
'digest' => 'SHA512',
'options' => OPENSSL_CIPHER_RC2_40,
'key' => 'YOUR_SECRET_KEY'
]);
$encrypted_password = $encrypter->encrypt($password);
// Display the encrypted string
echo "Encrypted password: {$encrypted_password}
";
```
```php
/**
* Sets an option value.
*
* @param string $key Option key name.
* @param mixed $value Option value.
*
* @return void
*/
public function setOption($key, $value): string
```
**Examples**
```php
$encrypter = new \ialopezg\Libraries\Encryption\Password();
$encrypter->setOption('key', $key);
```
```php
/**
* Verifies if a hashed password is equal to the plain tex provided.
*
* @param string $password Plain text password.
* @param string $hash Ciphered text
*
* @return bool true If password equals to hash, false otherwise.
* @throws Exception If data provided is not a string.
*/
public function verify($password, $hash): bool
```
**Examples**
```php
$encrypter = new \ialopezg\Libraries\Encryption\Password();
$password = 'YOUR_PASSWORD';
$encrypted_password = 'YOUR_ENCRYPTED_PASSWORD';
// Display the encrypted string
echo 'Password are equals: ' . ($encrypter->verify($password, $encrypted_password) ? 'true' : 'false') . '';
```
For more examples or options, see [examples](examples) directory. For live examples, run:
```shell script
### linux bash
./server.sh
```
or
```shell script
### windows prompt
server.bat
```
## License
This project is under the MIT license. For more information see [LICENSE](https://github.com/ialopezg/core/blob/master/LICENSE).
Copyright (c) [Isidro A. López G.](https://ialopezg.com/)