Security

class Security

La librairie security gère les mesures basiques de sécurité comme fournir des méthodes pour créer des hashs et chiffrer les données.

Avertissement

Les fonctionnalités d’encryption fournies par la classe Security reposent sur l’extension dépréciée mcrypt. Si vous utilisez PHP>=7.1, vous devez installer mcrypt via PECL.

L’API de Security

static Security::cipher($text, $key)
Type retourné:string

Chiffre/Déchiffre un texte selon la clé donnée:

// Chiffre votre mot de passe secret avec my_key
$secret = Security::cipher('hello world', 'my_key');

// Plus tard, déchiffrez votre mot de passe secret
$nosecret = Security::cipher($secret, 'my_key');

Avertissement

cipher() utilise un cipher XOR faible et ne doit pas être utilisé pour des données importantes ou sensibles.

static Security::rijndael($text, $key, $mode)
Paramètres:
  • $text (string) – Le texte à chiffrer.
  • $key (string) – La clé à utiliser pour le chiffrement. Elle doit être plus longue que 32 bytes.
  • $mode (string) – Le mode à utiliser, soit “encrypt” soit “decrypt”.

Chiffre/Déchiffre le texte en utilisant le cipher rijndael-256. Ceci nécessite que l’extension mcrypt soit installée:

// Chiffre quelques données.
$encrypted = Security::rijndael('a secret', Configure::read('Security.key'), 'encrypt');

// Plus tard, le déchiffre.
$decrypted = Security::rijndael($encrypted, Configure::read('Security.key'), 'decrypt');

rijndael() peut être utilisée pour stocker des données que vous voulez déchiffrer plus tard, comme les contenus des cookies. Il ne devra jamais être utilisé pour stocker des mots de passe. Pour cela, vous devrez utiliser la seule méthode de hashage fourni par hash()

Nouveau dans la version 2.2: Security::rijndael() a été ajoutée pour la version 2.2.

static Security::encrypt($text, $key, $hmacSalt = null)
Paramètres:
  • $text (string) – La valeur à chiffrer.
  • $key (string) – La clé 256 bit/32 byte à utiliser en clé cipher.
  • $hmacSalt (string) – Le sel à utiliser pour le processus HMAC. Laissez à null pour utiliser Security.salt.

Chiffre $text en utilisant AES-256. La $key devrait être une valeur avec beaucoup de différence dans les données un peu comme un bon mot de passe. Le résultat retourné sera la valeur chiffrée avec un checksum HMAC.

Cette méthode ne devrait jamais être utilisée pour stocker des mots de passe. A la place, vous devriez utiliser la manière de hasher les mots de passe fournie par hash(). Un exemple d’utilisation serait:

// En supposant que la clé est stockée quelque part, elle peut être
// réutilisée pour le déchiffrement plus tard.
$key = 'wt1U5MACWJFTXGenFoZoiLwQGrLgdbHA';
$result = Security::encrypt($value, $key);

Les valeurs chiffrés peuvent être déchiffrées en utilisant Security::decrypt().

Nouveau dans la version 2.5.

static Security::decrypt($cipher, $key, $hmacSalt = null)
Paramètres:
  • $cipher (string) – Le ciphertext à déchiffrer.
  • $key (string) – La clé 256 bit/32 byte à utiliser pour une clé cipher.
  • $hmacSalt (string) – Le sel à utiliser pour un processus HMAC. Laissez null pour utiliser Security.salt.

Déchiffre une valeur chiffrée au préalable. Les paramètres $key et $hmacSalt doivent correspondre aux valeurs utilisées pour chiffrer ou alors le déchiffrement sera un échec. Un exemple d’utilisation serait:

// En supposant que la clé est stockée quelque part, elle peut être
// réutilisée pour le déchiffrement plus tard.
$key = 'wt1U5MACWJFTXGenFoZoiLwQGrLgdbHA';

$cipher = $user['User']['secrets'];
$result = Security::decrypt($cipher, $key);

Si la valeurne peut pas être déchiffrée à cause de changements dans la clé ou le sel HMAC à false sera retournée.

Nouveau dans la version 2.5.

static Security::hash($string, $type = NULL, $salt = false)
Type retourné:string

Crée un hash à partir d’une chaîne en utilisant la méthode donnée. Le Fallback sur la prochaine méthode disponible. Si $salt est défini à true, la valeur de salt de l’application sera utilisé:

// Utilise la valeur du salt de l'application
$sha1 = Security::hash('CakePHP Framework', 'sha1', true);

// Utilise une valeur du salt personnalisée
$md5 = Security::hash('CakePHP Framework', 'md5', 'my-salt');

// Utilise l'algorithme de hashage par défaut
$hash = Security::hash('CakePHP Framework');

hash() supporte aussi d’autres algorithmes sécurisés de hashage comme bcrypt. Quand vous utilisez bcrypt, vous devez vous souvenir de son usage légèrement différent. Créer un hash initial fonctionne de la même façon que les autres algorithmes:

// Crée un hash en utilisant bcrypt
Security::setHash('blowfish');
$hash = Security::hash('CakePHP Framework');

Au contraire des autres types de hash, la comparaison des valeurs de texte brut devra être faîte comme ce qui suit:

// $storedPassword, est un hash bcrypt précédemment généré.
$newHash = Security::hash($newPassword, 'blowfish', $storedPassword);

Quand vous comparez les valeurs hashées avec bcrypt, le hash original devra être fourni dans le paramètre $salt. Cela permet à bcrypt de réutiliser les mêmes valeur de coût et de salt, en autorisant le hash généré de retourner les mêmes hashs résultants, avec la même valeur d’entrée.

Modifié dans la version 2.3: Le support pour bcrypt a été ajouté dans la version 2.3.

static Security::setHash($hash)
Type retourné:void

Définit la méthode de hash par défaut pour l’objet Security. Cela affecte tous les objets en utilisant Security::hash().