Technical API Documentation for the CryptoManana Framework
\
CryptoManana
AsymmetricEncryption
Compatibility
Core
Abstractions
Containers
DataStructures
DesignPatterns
ErrorHandling
MessageDigestion
MessageEncryption
Randomness
Interfaces
Containers
DataStructures
DesignPatterns
ErrorHandling
MessageDigestion
MessageEncryption
Randomness
Traits
CommonValidations
Containers
DataStructures
DesignPatterns
MessageDigestion
MessageEncryption
Randomness
CryptographicProtocol
DataStructures
Exceptions
Factories
Hashing
Randomness
SymmetricEncryption
Utilities

\CryptoManana\DataStructuresEnvelopeData

Class EnvelopeData - The digital envelope data object.

Summary

Methods
Properties
Constants
__construct()
__destruct()
__toString()
__get()
__set()
__isset()
__unset()
$key
$iv
$cipherData
$authenticationTag
No constants found
No protected methods found
$key
$iv
$cipherData
$authenticationTag
N/A
No private methods found
No private properties found
N/A

Properties

$key

$key : string

The encrypted secret key.

Type

string

$iv

$iv : string

The encrypted initialization vector.

Type

string

$cipherData

$cipherData : string

The encrypted message information.

Type

string

$authenticationTag

$authenticationTag : string

The message authentication code (tag).

Type

string

$key

$key : string

The concealed symmetric encryption secret key property storage.

Type

string — The encrypted secret key.

$iv

$iv : string

The concealed symmetric encryption initialization vector property storage.

Type

string — The encrypted initialization vector.

$cipherData

$cipherData : string

The encrypted information property storage.

Type

string — The encrypted data information.

$authenticationTag

$authenticationTag : string

The message authentication code property storage.

Type

string — The message authentication code (tag).

Methods

__construct()

__construct(string  $encryptedKey = '', string  $encryptedIv = '', string  $encryptedData = '', string  $digestionTag = '')

Envelope constructor.

Parameters

string $encryptedKey

The encrypted secret key.
string $encryptedIv

The encrypted initialization vector.
string $encryptedData

The encrypted message data information.
string $digestionTag

The message authentication code (tag).

Throws

\Exception

Validation errors.

__destruct()

__destruct()

Envelope destructor

__toString()

__toString() : string

The envelope string representation.

Returns

string

__get()

__get(mixed  $name) : mixed

Magic method invoked when attempting to get the value of an inaccessible or a non-existent property.

Parameters

mixed $name

The property name.

Returns

mixed —

The property value.

__set()

__set(mixed  $name, mixed  $value)

Magic method invoked when attempting to create or modify of an inaccessible or a non-existent property.

Parameters

mixed $name

The property name.
mixed $value

The property value.

Throws

\Exception|\InvalidArgumentException

The property does not exist or is from another type.

__isset()

__isset(mixed  $name) : boolean

Magic method invoked when checking of an inaccessible or a non-existent property is set.

Parameters

mixed $name

The property name.

Returns

boolean —

The existence check result.

__unset()

__unset(mixed  $name)

Magic method invoked when attempting to unset an inaccessible or a non-existent property.

Parameters

mixed $name

The property name.

Throws

\Exception|\LogicException

The object does not allow dynamic property removal.