McryptEncrypter deprecated

class McryptEncrypter extends BaseEncrypter implements Encrypter (View source)

deprecated

since version 5.1. Use Illuminate\Encryption\Encrypter.

Properties

protected string $key The encryption key. from BaseEncrypter
protected string $cipher The algorithm used for encryption.
protected int $block The block size of the cipher.

Methods

string hash(string $iv, string $value)

Create a MAC for the given value.

 from BaseEncrypter
array getJsonPayload(string $payload)

Get the JSON array from the given payload.

 from BaseEncrypter
bool invalidPayload(array|mixed $data)

Verify that the encryption payload is valid.

 from BaseEncrypter
bool validMac(array $payload)

Determine if the MAC for the given payload is valid.

 from BaseEncrypter
void __construct(string $key, string $cipher = MCRYPT_RIJNDAEL_128)

Create a new encrypter instance.
static bool supported(string $key, string $cipher)

Determine if the given key and cipher combination is valid.
string encrypt(string $value)

Encrypt the given value.
string padAndMcrypt(string $value, string $iv)

Pad and use mcrypt on the given value and input vector.
string decrypt(string $payload)

Decrypt the given value.
string mcryptDecrypt(string $value, string $iv)

Run the mcrypt decryption routine for the value.
string addPadding(string $value)

Add PKCS7 padding to a given value.
string stripPadding(string $value)

Remove the padding from the given value.
bool paddingIsValid(string $pad, string $value)

Determine if the given padding for a value is valid.
int getIvSize()

Get the IV size for the cipher.
int getRandomizer()

Get the random data source available for the OS.

Details

protected string hash(string $iv, string $value)

Create a MAC for the given value.

Parameters

string $iv
string $value

Return Value

string

protected array getJsonPayload(string $payload)

Get the JSON array from the given payload.

Parameters

string $payload

Return Value

array

Exceptions

DecryptException

protected bool invalidPayload(array|mixed $data)

Verify that the encryption payload is valid.

Parameters

array|mixed $data

Return Value

bool

protected bool validMac(array $payload)

Determine if the MAC for the given payload is valid.

Parameters

array $payload

Return Value

bool

Exceptions

RuntimeException

void __construct(string $key, string $cipher = MCRYPT_RIJNDAEL_128)

Create a new encrypter instance.

Parameters

string $key
string $cipher

Return Value

void

Exceptions

RuntimeException

static bool supported(string $key, string $cipher)

Determine if the given key and cipher combination is valid.

Parameters

string $key
string $cipher

Return Value

bool

string encrypt(string $value)

Encrypt the given value.

Parameters

string $value

Return Value

string

Exceptions

EncryptException

protected string padAndMcrypt(string $value, string $iv)

Pad and use mcrypt on the given value and input vector.

Parameters

string $value
string $iv

Return Value

string

string decrypt(string $payload)

Decrypt the given value.

Parameters

string $payload

Return Value

string

protected string mcryptDecrypt(string $value, string $iv)

Run the mcrypt decryption routine for the value.

Parameters

string $value
string $iv

Return Value

string

Exceptions

DecryptException

protected string addPadding(string $value)

Add PKCS7 padding to a given value.

Parameters

string $value

Return Value

string

protected string stripPadding(string $value)

Remove the padding from the given value.

Parameters

string $value

Return Value

string

protected bool paddingIsValid(string $pad, string $value)

Determine if the given padding for a value is valid.

Parameters

string $pad
string $value

Return Value

bool

protected int getIvSize()

Get the IV size for the cipher.

Return Value

int

protected int getRandomizer()

Get the random data source available for the OS.

Return Value

int

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Encryption/McryptEncrypter.html