1. class
  2. Riimu
  3. \
  4. Kit
  5. \
  6. SecureRandom
  7. \
  8. Generator
  9. \
  10. Mcrypt

Mcrypt

class Mcrypt extends AbstractGenerator (View source)

Generates bytes using mcrypt extension.

Mcrypt generator creates secure random byte using the mcrypt_create_iv function. The generator can either use /dev/urandom or /dev/random as the randomness source for the function. Note that on windows based systems, the function resorts to windows specific random generator.

Methods

string
getBytes(int $count)

Returns securely generated random bytes.

from AbstractGenerator
string|false
readBytes(int $count)

Reads bytes from the randomness source.

__construct(bool $urandom = true)

Creates new instance of Mcrypt generator.

bool
isSupported()

Tells if the generator is supported by the operating system.

Details

in AbstractGenerator at line 15
string getBytes(int $count)

Returns securely generated random bytes.

This method will always return the correct number of bytes that have been securely generated. If the bytes cannot be securely generated or if the correct number of bytes cannot be generated, the method MUST throw an exception.

Parameters

int $count Number of bytes to return

Return Value

string Bytes generated by the secure random byte generator

Exceptions

GeneratorException If any error occurs

at line 36
protected string|false readBytes(int $count)

Reads bytes from the randomness source.

Parameters

int $count number of bytes to read

Return Value

string|false The bytes read from the randomness source or false on error

Exceptions

GeneratorException If error occurs in byte generation

at line 26
__construct(bool $urandom = true)

Creates new instance of Mcrypt generator.

Parameters

bool $urandom True to use /dev/urandom and false for /dev/random

at line 31
bool isSupported()

Tells if the generator is supported by the operating system.

Return Value

bool True if the generator is supported, false if not