class Encrypter implements Encrypter (View source)

Properties

protected string $key The encryption key.
protected string $cipher The algorithm used for encryption.

Methods

void
__construct(string $key, string $cipher = 'AES-128-CBC')

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
decrypt(string $payload)

Decrypt the given value.

string
hash(string $iv, mixed $value)

Create a MAC for the given value.

array
getJsonPayload(string $payload)

Get the JSON array from the given payload.

bool
validPayload(mixed $payload)

Verify that the encryption payload is valid.

bool
validMac(array $payload)

Determine if the MAC for the given payload is valid.

string
getKey()

Get the encryption key.

Details

void __construct(string $key, string $cipher = 'AES-128-CBC')

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

string decrypt(string $payload)

Decrypt the given value.

Parameters

string $payload

Return Value

string

Exceptions

DecryptException

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

Create a MAC for the given value.

Parameters

string $iv
mixed $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 validPayload(mixed $payload)

Verify that the encryption payload is valid.

Parameters

mixed $payload

Return Value

bool

protected bool validMac(array $payload)

Determine if the MAC for the given payload is valid.

Parameters

array $payload

Return Value

bool

string getKey()

Get the encryption key.

Return Value

string