Référence de la classe Key

Fonctions membres publiques
	saveToAsciiSafeString ()
	getRawBytes ()

Fonctions membres publiques statiques
static	createNewRandomKey ()
static	loadFromAsciiSafeString ($saved_key_string, $do_not_trim=false)

Champs de données
const	KEY_CURRENT_VERSION = "\xDE\xF0\x00\x00"
const	KEY_BYTE_SIZE = 32

Fonctions membres privées
	__construct ($bytes)

Attributs privés
	$key_bytes

Documentation des constructeurs et destructeur

__construct()

__construct (   $bytes )

private

Constructs a new Key object from a string of raw bytes.

Paramètres

string

$bytes

Exceptions

Ex

Références Core\ensureTrue(), et Core\ourStrlen().

Documentation des fonctions membres

createNewRandomKey()

static createNewRandomKey ( )

static

Creates new random key.

Exceptions

Ex

Références Core\secureRandom().

Référencé par KeyProtectedByPassword\createRandomPasswordProtectedKey(), RuntimeTests\runtimeTest(), et RuntimeTests\testEncryptDecrypt().

getRawBytes()

getRawBytes

(

)

Gets the raw bytes of the key.

Renvoie

string

Références Key\$key_bytes.

loadFromAsciiSafeString()

static loadFromAsciiSafeString (   $saved_key_string,   $do_not_trim = false  )

static

Loads a Key from its encoded form.

By default, this function will call Encoding::trimTrailingWhitespace() to remove trailing CR, LF, NUL, TAB, and SPACE characters, which are commonly appended to files when working with text editors.

Paramètres

string	$saved_key_string
bool	$do_not_trim	(default: false)

Exceptions

Ex

Références Key\$key_bytes, Encoding\loadBytesFromChecksummedAsciiSafeString(), et Encoding\trimTrailingWhitespace().

Référencé par KeyProtectedByPassword\unlockKey().

saveToAsciiSafeString()

saveToAsciiSafeString

(

)

Encodes the Key into a string of printable ASCII characters.

Exceptions

Ex

Références Encoding\saveBytesToChecksummedAsciiSafeString().

Documentation des champs

$key_bytes

$key_bytes

private

Référencé par Key\getRawBytes(), et Key\loadFromAsciiSafeString().

KEY_BYTE_SIZE

const KEY_BYTE_SIZE = 32

KEY_CURRENT_VERSION

const KEY_CURRENT_VERSION = "\xDE\xF0\x00\x00"

---

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

• defuse/php-encryption/src/Key.php