1. class
  2. phpseclib3
  3. \
  4. Crypt
  5. \
  6. Hash

Hash

class Hash (View source)

Constants

PADDING_SHA3

Padding Types
PADDING_SHAKE

Padding Types

Methods

__construct(string $hash = 'sha256')

Default Constructor.

setKey(string $key = false)

Sets the key for HMACs

setNonce(string $nonce = false)

Sets the nonce for UMACs

string
getHash()

Gets the hash function.

setHash(string $hash)

Sets the hash function.

string
hash(string $text)

Compute the Hash / HMAC / UMAC.

int
getLength()

Returns the hash length (in bits)

int
getLengthInBytes()

Returns the hash length (in bytes)

int
getBlockLength()

Returns the block length (in bits)

int
getBlockLengthInBytes()

Returns the block length (in bytes)

__toString()

__toString() magic method

Details

at line 217
__construct(string $hash = 'sha256')

Default Constructor.

Parameters

string $hash

at line 230
setKey(string $key = false)

Sets the key for HMACs

Keys can be of any length.

Parameters

string $key

at line 245
setNonce(string $nonce = false)

Sets the nonce for UMACs

Keys can be of any length.

Parameters

string $nonce

at line 295
string getHash()

Gets the hash function.

As set by the constructor or by the setHash() method.

Return Value

string

at line 306
setHash(string $hash)

Sets the hash function.

Parameters

string $hash

at line 797
string hash(string $text)

Compute the Hash / HMAC / UMAC.

Parameters

string $text

Return Value

string

at line 885
int getLength()

Returns the hash length (in bits)

Return Value

int

at line 896
int getLengthInBytes()

Returns the hash length (in bytes)

Return Value

int

at line 907
int getBlockLength()

Returns the block length (in bits)

Return Value

int

at line 918
int getBlockLengthInBytes()

Returns the block length (in bytes)

Return Value

int

at line 1480
__toString()

__toString() magic method