Référence de la classe SodiumCipher

Graphe d'héritage de SodiumCipher:

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

Fonctions membres publiques statiques
static	isSupported ()

Attributs privés
	$nonce

Description détaillée

JCrypt cipher for sodium algorithm encryption, decryption and key generation.

Depuis

3.8.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

3.8.0

Exceptions

Implémente CipherInterface.

Références $data, $key, ParagonIE_Sodium_Compat\crypto_box_keypair_from_secretkey_and_publickey(), et ParagonIE_Sodium_Compat\crypto_box_open().

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

3.8.0

Exceptions

Implémente CipherInterface.

Références $data, $key, ParagonIE_Sodium_Compat\crypto_box(), et ParagonIE_Sodium_Compat\crypto_box_keypair_from_secretkey_and_publickey().

generateKey()

generateKey

(

array

$options = array()

)

Method to generate a new encryption key object.

Paramètres

array

$options

Key generation options.

Renvoie

Key

Depuis

3.8.0

Exceptions

Implémente CipherInterface.

Références ParagonIE_Sodium_Compat\crypto_box_keypair(), ParagonIE_Sodium_Compat\crypto_box_publickey(), et ParagonIE_Sodium_Compat\crypto_box_secretkey().

isSupported()

static isSupported ( )

static

Check if the cipher is supported in this environment.

Renvoie

boolean

Depuis

4.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

3.8.0

Documentation des champs

$nonce

$nonce

private

---

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

• SodiumCipher.php