Référence de la classe Sodium

Graphe d'héritage de Sodium:

Fonctions membres publiques
	decrypt ($data, Key $key)
	encrypt ($data, Key $key)
	generateKey (array $options=[])
	setNonce ($nonce)

Fonctions membres publiques statiques
static	isSupported ()

Attributs privés
	$nonce

Description détaillée

Cipher for sodium algorithm encryption, decryption and key generation.

Depuis

1.4.0

Documentation des fonctions membres

decrypt()

decrypt	(		$data,
		Key	$key
	)

Method to decrypt a data string.

Paramètres

string	$data	The encrypted string to decrypt.
Key	$key	The key object to use for decryption.

Renvoie

string The decrypted data string.

Depuis

1.4.0

Exceptions

DecryptionException	if the data cannot be decrypted
InvalidKeyTypeException	if the key is not valid for the cipher

Implémente CipherInterface.

Références $data, $key, et class.

encrypt()

encrypt	(		$data,
		Key	$key
	)

Method to encrypt a data string.

Paramètres

string	$data	The data string to encrypt.
Key	$key	The key object to use for encryption.

Renvoie

string The encrypted data string.

Depuis

1.4.0

Exceptions

EncryptionException	if the data cannot be encrypted
InvalidKeyTypeException	if the key is not valid for the cipher

Implémente CipherInterface.

Références $data, $key, et class.

generateKey()

generateKey

(

array

$options = []

)

Method to generate a new encryption key object.

Paramètres

array

$options

Key generation options.

Renvoie

Key

Depuis

1.4.0

Exceptions

InvalidKeyException	if the key cannot be generated
UnsupportedCipherException	if the cipher is not supported on the current environment

Implémente CipherInterface.

Références class.

isSupported()

static isSupported ( )

static

Check if the cipher is supported in this environment.

Renvoie

boolean

Depuis

2.0.0

Implémente CipherInterface.

Références class.

setNonce()

setNonce

(

$nonce

)

Set the nonce to use for encrypting/decrypting messages

Paramètres

string

$nonce

The message nonce

Renvoie

void

Depuis

1.4.0

Références Sodium\$nonce.

Documentation des champs

$nonce

$nonce

private

Référencé par Sodium\setNonce().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Sodium.php