Référence de la classe Crypt

Fonctions membres publiques
	__construct (CipherInterface $cipher=null, Key $key=null)
	decrypt ($data)
	encrypt ($data)
	generateKey (array $options=array())
	setKey (Key $key)

Fonctions membres publiques statiques
static	genRandomBytes ($length=16)
static	timingSafeCompare ($known, $unknown)
static	hasStrongPasswordSupport ()
static	safeStrlen ($str)
static	safeSubstr ($str, $start, $length=null)

Attributs privés
	$_cipher
	$_key

Description détaillée

Crypt is a Joomla Platform class for handling basic encryption/decryption of data.

Depuis

3.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	CipherInterface	$cipher = null,
		Key	$key = null
	)

Object Constructor takes an optional key to be used for encryption/decryption. If no key is given then the secret word from the configuration object is used.

Paramètres

CipherInterface	$cipher	The encryption cipher object.
Key	$key	The encryption key[/pair)].

Depuis

3.0.0

Références $key.

Documentation des fonctions membres

decrypt()

decrypt

(

$data

)

Method to decrypt a data string.

Paramètres

string

$data

The encrypted string to decrypt.

Renvoie

string The decrypted data string.

Depuis

3.0.0

Exceptions

Références $data.

encrypt()

encrypt

(

$data

)

Method to encrypt a data string.

Paramètres

string

$data

The data string to encrypt.

Renvoie

string The encrypted data string.

Depuis

3.0.0

Références $data.

generateKey()

generateKey

(

array

$options = array()

)

Method to generate a new encryption key[/pair] object.

Paramètres

array

$options

Key generation options.

Renvoie

Key

Depuis

3.0.0

Références $options.

genRandomBytes()

static genRandomBytes (   $length = 16 )

static

Generate random bytes.

Paramètres

integer

$length

Length of the random data to generate

Renvoie

string Random binary data

Depuis

3.0.0

Référencé par SimpleCipher\generateKey(), McryptCipher\generateKey(), SimpleCryptPassword\getSalt(), et Path\isOwner().

hasStrongPasswordSupport()

static hasStrongPasswordSupport ( )

static

Tests for the availability of updated crypt(). Based on a method by Anthony Ferrera

Renvoie

boolean Always returns true since 3.3

Note

To be removed when PHP 5.3.7 or higher is the minimum supported version. 3.2 deprecated 741.

Références Log\add(), JPATH_ROOT, et Log\WARNING.

Référencé par SimpleCryptPassword\create(), et SimpleCryptPassword\verify().

safeStrlen()

static safeStrlen (   $str )

static

Safely detect a string's length

This method is derived from ::safeStrlen()

Paramètres

string

$str

String to check the length of

Renvoie

integer

Depuis

3.5 mbstring.func_overload

Exceptions

Références null.

safeSubstr()

static safeSubstr (   $str,   $start,   $length = null  )

static

Safely extract a substring

This method is derived from ::safeSubstr()

Paramètres

string	$str	The string to extract the substring from
integer	$start	The starting position to extract from
integer	$length	The length of the string to return

Renvoie

string

Depuis

3.5

Références $start, et null.

setKey()

setKey

(

Key

$key

)

Method to set the encryption key[/pair] object.

Paramètres

Key

$key

The key object to set.

Renvoie

Crypt

Depuis

3.0.0

Références $key.

timingSafeCompare()

static timingSafeCompare (   $known,   $unknown  )

static

A timing safe comparison method.

This defeats hacking attempts that use timing based attack vectors.

NOTE: Length will leak.

Paramètres

string	$known	A known string to check against.
string	$unknown	An unknown string to check.

Renvoie

boolean True if the two strings are exactly the same.

Depuis

3.2

Référencé par SimpleCryptPassword\verify().

Documentation des champs

$_cipher

$_cipher

private

$_key

$_key

private

---

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

• Crypt.php