class Crypt
Same name in other branches
- 9 core/lib/Drupal/Component/Utility/Crypt.php \Drupal\Component\Utility\Crypt
- 8.9.x core/lib/Drupal/Component/Utility/Crypt.php \Drupal\Component\Utility\Crypt
- 11.x core/lib/Drupal/Component/Utility/Crypt.php \Drupal\Component\Utility\Crypt
Utility class for cryptographically-secure string handling routines.
Hierarchy
- class \Drupal\Component\Utility\Crypt
Expanded class hierarchy of Crypt
Related topics
87 files declare their use of Crypt
- AnnotatedClassDiscovery.php in core/
lib/ Drupal/ Component/ Annotation/ Plugin/ Discovery/ AnnotatedClassDiscovery.php - AssetDumper.php in core/
lib/ Drupal/ Core/ Asset/ AssetDumper.php - AssetGroupSetHashTrait.php in core/
lib/ Drupal/ Core/ Asset/ AssetGroupSetHashTrait.php - AssetResolver.php in core/
lib/ Drupal/ Core/ Asset/ AssetResolver.php - AttributeDiscoveryWithAnnotations.php in core/
lib/ Drupal/ Core/ Plugin/ Discovery/ AttributeDiscoveryWithAnnotations.php
File
-
core/
lib/ Drupal/ Component/ Utility/ Crypt.php, line 10
Namespace
Drupal\Component\UtilityView source
class Crypt {
/**
* Calculates a base-64 encoded, URL-safe sha-256 hmac.
*
* @param mixed $data
* Scalar value to be validated with the hmac.
* @param mixed $key
* A secret key, this can be any scalar value.
*
* @return string
* A base-64 encoded sha-256 hmac, with + replaced with -, / with _ and
* any = padding characters removed.
*/
public static function hmacBase64($data, $key) {
// $data and $key being strings here is necessary to avoid empty string
// results of the hash function if they are not scalar values. As this
// function is used in security-critical contexts like token validation it
// is important that it never returns an empty string.
if (!is_scalar($data) || !is_scalar($key)) {
throw new \InvalidArgumentException('Both parameters passed to \\Drupal\\Component\\Utility\\Crypt::hmacBase64 must be scalar values.');
}
$hmac = base64_encode(hash_hmac('sha256', $data, $key, TRUE));
// Modify the hmac so it's safe to use in URLs.
return str_replace([
'+',
'/',
'=',
], [
'-',
'_',
'',
], $hmac);
}
/**
* Calculates a base-64 encoded, URL-safe sha-256 hash.
*
* @param string $data
* String to be hashed.
*
* @return string
* A base-64 encoded sha-256 hash, with + replaced with -, / with _ and
* any = padding characters removed.
*/
public static function hashBase64($data) {
$hash = base64_encode(hash('sha256', $data, TRUE));
// Modify the hash so it's safe to use in URLs.
return str_replace([
'+',
'/',
'=',
], [
'-',
'_',
'',
], $hash);
}
/**
* Returns a URL-safe, base64 encoded string of highly randomized bytes.
*
* @param $count
* The number of random bytes to fetch and base64 encode.
*
* @return string
* A base-64 encoded string, with + replaced with -, / with _ and any =
* padding characters removed.
*/
public static function randomBytesBase64($count = 32) {
return str_replace([
'+',
'/',
'=',
], [
'-',
'_',
'',
], base64_encode(random_bytes($count)));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
Crypt::hashBase64 | public static | function | Calculates a base-64 encoded, URL-safe sha-256 hash. |
Crypt::hmacBase64 | public static | function | Calculates a base-64 encoded, URL-safe sha-256 hmac. |
Crypt::randomBytesBase64 | public static | function | Returns a URL-safe, base64 encoded string of highly randomized bytes. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.