SodiumCipher
Implements CipherInterfaceJCrypt cipher for sodium algorithm encryption, decryption and key generation.
| since |
3.8.0 |
|---|---|
| package |
Joomla CMS |
Methods
decrypt
Method to decrypt a data string.
decrypt( data, \Joomla\Crypt\Key key) :
| since |
3.8.0 |
|---|---|
| throws |
|
Arguments
- data
stringThe encrypted string to decrypt.- key
KeyThe key object to use for decryption.
Response
stringThe decrypted data string.
encrypt
Method to encrypt a data string.
encrypt( data, \Joomla\Crypt\Key key) :
| since |
3.8.0 |
|---|---|
| throws |
|
Arguments
- data
stringThe data string to encrypt.- key
KeyThe key object to use for encryption.
Response
stringThe encrypted data string.
generateKey
Method to generate a new encryption key object.
generateKey(mixed||string|int options = []) : \Joomla\Crypt\Key
| since |
3.8.0 |
|---|---|
| throws |
|
Arguments
- options
array<string|int, mixed>Key generation options.
Response
Key
isSupported
Check if the cipher is supported in this environment.
isSupported() :
static
| since |
4.0.0 |
|---|
Response
bool
setNonce
Set the nonce to use for encrypting/decrypting messages
setNonce( nonce) :
| since |
3.8.0 |
|---|
Arguments
- nonce
stringThe message nonce
Response
void
Properties
nonce
The message nonce to be used with encryption/decryption
| since |
3.8.0 |
|---|
Type(s)
string