MediaWiki  master
MWCryptHash Class Reference

Static Public Member Functions

static hash ( $data, $raw=true)
 Generate an acceptably unstable one-way-hash of some text 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 an acceptably unstable one-way-hmac of some text making use of the best hash algorithm that we have available. More...
 

Static Public Attributes

static false
 

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 an acceptably unstable one-way-hash of some text 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 93 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.

◆ 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 76 of file MWCryptHash.php.

◆ hmac()

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

Generate an acceptably unstable one-way-hmac of some text 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 106 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.

◆ $hashLength

MWCryptHash::$hashLength
staticprotected
Initial value:
= [
true => null

The number of bytes outputted by the hash algorithm.

Definition at line 35 of file MWCryptHash.php.

◆ false

MWCryptHash::false
static
Initial value:
=> null,
]

Definition at line 37 of file MWCryptHash.php.


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