MediaWiki  master
MWCryptHash Class Reference

Static Public Member Functions

static hash ( $data, $raw=true)
 Generate a cryptographic hash value (message digest) for a string, making use of the best hash algorithm that we have available. More...
 
static hashAlgo ()
 Decide on the best acceptable hash algorithm we have available for hash() More...
 
static hashLength ( $raw=true)
 Return the byte-length output of the hash algorithm we are using in self::hash and self::hmac. More...
 
static hmac ( $data, $key, $raw=true)
 Generate a keyed cryptographic hash value (HMAC) for a string, making use of the best hash algorithm that we have available. More...
 

Static Protected Attributes

static $algo = null
 The hash algorithm being used. More...
 
static $hashLength
 The number of bytes outputted by the hash algorithm. More...
 

Detailed Description

Definition at line 26 of file MWCryptHash.php.

Member Function Documentation

◆ hash()

static MWCryptHash::hash (   $data,
  $raw = true 
)
static

Generate a cryptographic hash value (message digest) for a string, making use of the best hash algorithm that we have available.

Parameters
string$data
bool$rawTrue to return binary data, false to return it hex-encoded
Returns
string A hash of the data

Definition at line 88 of file MWCryptHash.php.

◆ hashAlgo()

static MWCryptHash::hashAlgo ( )
static

Decide on the best acceptable hash algorithm we have available for hash()

Returns
string A hash algorithm

Definition at line 44 of file MWCryptHash.php.

References $algo.

◆ hashLength()

static MWCryptHash::hashLength (   $raw = true)
static

Return the byte-length output of the hash algorithm we are using in self::hash and self::hmac.

Parameters
bool$rawTrue to return the length for binary data, false to return for hex-encoded
Returns
int Number of bytes the hash outputs

Definition at line 70 of file MWCryptHash.php.

◆ hmac()

static MWCryptHash::hmac (   $data,
  $key,
  $raw = true 
)
static

Generate a keyed cryptographic hash value (HMAC) for a string, making use of the best hash algorithm that we have available.

Parameters
string$data
string$key
bool$rawTrue to return binary data, false to return it hex-encoded
Returns
string An HMAC hash of the data + key

Definition at line 101 of file MWCryptHash.php.

Referenced by MediaWiki\Block\BlockManager\getCookieValue(), MediaWiki\Block\BlockManager\getIdFromCookieValue(), User\getToken(), and MediaWiki\Session\SessionProvider\hashToSessionId().

Member Data Documentation

◆ $algo

MWCryptHash::$algo = null
staticprotected

The hash algorithm being used.

Definition at line 30 of file MWCryptHash.php.

Referenced by hashAlgo().

◆ $hashLength

MWCryptHash::$hashLength
staticprotected
Initial value:
= [
'binary' => null,
'hex' => null,
]

The number of bytes outputted by the hash algorithm.

Definition at line 35 of file MWCryptHash.php.


The documentation for this class was generated from the following file: