CryptoManana

AsymmetricEncryption

Compatibility

Core

Abstractions

Containers

DataStructures

AbstractBasicStructure

DesignPatterns

ErrorHandling

MessageDigestion

MessageEncryption

Randomness

Interfaces

Containers

DataStructures

PropertyOverloadingInterface

DesignPatterns

ErrorHandling

EditableExceptionInterface

MessageDigestion

MessageEncryption

Randomness

Traits

CommonValidations

Containers

DataStructures

DisablePropertyOverloadingTrait

DesignPatterns

SingleInstancingTrait

MessageDigestion

MessageEncryption

Randomness

StringBuilder

CryptographicProtocol

DataStructures

Exceptions

Factories

Hashing

Randomness

SymmetricEncryption

Utilities

\CryptoManana\Core\Abstractions\MessageEncryptionAbstractSymmetricEncryptionAlgorithm

Class AbstractSymmetricEncryptionAlgorithm - The symmetric encryption algorithm abstraction representation.

Summary

Methods

Properties

Constants

setSecretKey()
getSecretKey()
setCipherFormat()
getCipherFormat()
__construct()

No public properties found

ALGORITHM_NAME
KEY_SIZE

encryptionFormat()
decryptionFormatHex()
decryptionFormatBase64()
decryptionFormat()
changeOutputFormat()
fetchAlgorithmMethodName()
validatePlainDataForEncryption()
validateCipherDataForDecryption()

$key
$cipherFormat

N/A

No private methods found

No private properties found

N/A

abstract

File: Core\Abstractions\MessageEncryption\AbstractSymmetricEncryptionAlgorithm.php
Package: Abstractions\MessageEncryption
Class hierarchy: \CryptoManana\Core\Abstractions\MessageEncryption\AbstractSymmetricEncryptionAlgorithm
Implements: \CryptoManana\Core\Interfaces\MessageEncryption\DataEncryptionInterface; \CryptoManana\Core\Interfaces\MessageEncryption\SecretKeyInterface; \CryptoManana\Core\Interfaces\MessageEncryption\CipherDataFormatsInterface
Uses traits: \CryptoManana\Core\Traits\MessageEncryption\SecretKeyTrait; \CryptoManana\Core\Traits\MessageEncryption\CipherDataFormatsTrait

Tags

mixin

TwoWaySecretKey

CipherDataFormats

Constants

ALGORITHM_NAME

ALGORITHM_NAME

The internal name of the algorithm.

KEY_SIZE

KEY_SIZE

The internal secret key size measured in raw bytes length for the algorithm

Properties

$key

$key : string

The encryption/decryption secret key property storage.

Type

string — The encryption/decryption secret key string value.

$cipherFormat

$cipherFormat : integer

The output cipher format property storage.

Type

integer — The output cipher format integer code value.

Methods

setSecretKey()

setSecretKey(string  $key) : $this

Setter for the secret key string property.

Parameters

string

$key

The encryption key string.

Throws

\Exception: Validation errors.

Returns

$this —

The symmetric encryption algorithm object.

getSecretKey()

getSecretKey() : string

Getter for the secret key string property.

Returns

string —

The encryption key string.

setCipherFormat()

setCipherFormat(integer  $cipherFormat) : $this

Setter for the output cipher format code property.

Parameters

integer

$cipherFormat

The output cipher format code.

Throws

\Exception: Validation errors.

Returns

$this —

The encryption algorithm object.

getCipherFormat()

getCipherFormat() : integer

Getter for the output cipher format code property.

Returns

integer —

The output cipher format code.

__construct()

__construct()

Symmetrical encryption algorithm constructor.

encryptionFormat()

encryptionFormat(string  $bytes)

Internal method for converting format after encryption operations.

Parameters

string

$bytes

The bytes for conversion.

Inherited from: \CryptoManana\Core\Traits\MessageEncryption\CipherDataFormatsTrait

Tags

note	The parameter is passed via reference from the main logical method for performance reasons.

decryptionFormatHex()

decryptionFormatHex(string  $bytes)

Internal method for converting from HEX formatted string after decryption operations.

Parameters

string

$bytes

The bytes for conversion.

Inherited from: \CryptoManana\Core\Traits\MessageEncryption\CipherDataFormatsTrait

Tags

note	The parameter is passed via reference from the main logical method for performance reasons.

decryptionFormatBase64()

decryptionFormatBase64(string  $bytes)

Internal method for converting from Base64 formatted string after decryption operations.

Parameters

string

$bytes

The bytes for conversion.

Inherited from: \CryptoManana\Core\Traits\MessageEncryption\CipherDataFormatsTrait

Tags

note	The parameter is passed via reference from the main logical method for performance reasons.

decryptionFormat()

decryptionFormat(string  $bytes)

Internal method for converting format after decryption operations.

Parameters

string

$bytes

The bytes for conversion.

Inherited from: \CryptoManana\Core\Traits\MessageEncryption\CipherDataFormatsTrait

Tags

note	The parameter is passed via reference from the main logical method for performance reasons.

changeOutputFormat()

changeOutputFormat(string  $bytes, boolean|integer|null  $direction = true) : string

Internal method for converting the output format representation via the chosen format.

Parameters

string	$bytes	The bytes for conversion.
boolean\|integer\|null	$direction	Flag for encryption direction (encrypt => `true` or decrypt => `false`).

Returns

string —

The formatted bytes.

fetchAlgorithmMethodName()

fetchAlgorithmMethodName() : string

Fetch the correctly formatted internal encryption algorithm method name.

Returns

string —

The symmetric encryption algorithm standard.

validatePlainDataForEncryption()

validatePlainDataForEncryption(string  $plainData)

Internal method for the validation of plain data used at encryption operations.

Parameters

string

$plainData

The plain input string.

Throws

\Exception: Validation errors.

validateCipherDataForDecryption()

validateCipherDataForDecryption(string  $cipherData)

Internal method for the validation of cipher data used at decryption operations.

Parameters

string

$cipherData

The encrypted input string.

Throws

\Exception: Validation errors.