Arabic
Chinese
Dutch
English
French
German
Indonesian
Italian
Japanese
Korean
Malay
Portuguese
Russian
SpanishPHP Luminova: Encryption Interface Class
A Comprehensive Guide to the luminova's Encryption Interface Class for PHP Framework Integration with OpenSSL and Sodium Libraries.
The Luminova Crypter class serves as a valuable asset for developers utilizing the Luminova PHP framework, offering a convenient and secure solution for implementing encryption and decryption functionalities. By abstracting away the complexities of cryptographic libraries and providing a unified interface, the Crypter class facilitates the integration of encryption features into PHP applications, enhancing overall security and reliability.
- Class namespace:
\Luminova\Interface\EncryptionInterface
Methods
constructor
Constructor, optional pass a blank key string and setKey() later before encrypt/decrypt.
public __construct(string $key = ''): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$key | string | The encryption key. |
Throws:
- \Luminova\Exceptions\InvalidException - If the method or block size is invalid while using openssl.
setData
Set the data to encrypt/decrypt.
public setData(string $data): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$data | string | The data to encrypt/decrypt. |
setKey
Set the encryption key.
public setKey(string $key): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$key | string | The encryption key. |
setNonce
Set nonce for encryption and decryption, if null random nonce will be generated.
public setNonce(string|null $nonce = null): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$nonce | string|null | The nonce for encryption. |
setCypherAlgo
Set the encryption method and block size for openssl.
public setCypherAlgo(int|null $blockSize, string $mode): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$blockSize | int|null | The block size for encryption. |
$mode | string | The encryption mode. |
Throws:
- \Luminova\Exceptions\InvalidException - If the method or block size is invalid.
nonce
Generate a random nonce, or return from a string.
public nonce(string|null $string = null): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$string | string|null | The string to extract the nonce from. |
Return Value:
string - The nonce string.
encrypt
Encrypt data.
public encrypt(): string|boolReturn Value:
string|bool - The encrypted data, or false if encryption fails.
Throws:
- \Luminova\Exceptions\InvalidException - If encryption fails due to invalid parameters.
decrypt
Decrypt data.
public decrypt(): string|boolReturn Value:
string|bool - The decrypted data, or false if decryption fails.
Throws:
- \Luminova\Exceptions\InvalidException - If decryption fails due to invalid parameters.
free
Free up resources.
public free(): void