\CryptoManana\CryptographicProtocolPasswordBasedAuthentication

Class PasswordBasedAuthentication - The password-based authentication protocol object.

Summary

Methods

Properties

Constants

setVerificationAlgorithm()
getVerificationAlgorithm()
identifyEntity()
__construct()
__destruct()
__clone()
authenticateEntity()

No public properties found

No constants found

No protected methods found

$verificationSource

N/A

No private methods found

No private properties found

N/A

File: CryptographicProtocol\PasswordBasedAuthentication.php
Package: CryptoManana\CryptographicProtocol
Class hierarchy: \CryptoManana\Core\Abstractions\Containers\AbstractCryptographicProtocol

\CryptoManana\CryptographicProtocol\PasswordBasedAuthentication
Implements: \CryptoManana\Core\Interfaces\Containers\VerificationAlgorithmInjectableInterface; \CryptoManana\Core\Interfaces\Containers\EntityIdentificationInterface; \CryptoManana\Core\Interfaces\Containers\EntityAuthenticationInterface
Uses traits: \CryptoManana\Core\Traits\Containers\VerificationAlgorithmInjectableTrait; \CryptoManana\Core\Traits\Containers\EntityIdentificationTrait

Properties

$verificationSource

$verificationSource : \CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface|null

The message digestion and verification service property storage.

Type

\CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface|null — The message digestion service.

Methods

setVerificationAlgorithm()

setVerificationAlgorithm(\CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface  $hasher) : $this

Setter for the message digestion and verification service.

Parameters

\CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface

$hasher

The message digestion verification service or null.

Returns

$this —

The container object.

getVerificationAlgorithm()

getVerificationAlgorithm() : \CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface|null

Getter for the message digestion and verification service.

Returns

\CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface|null —

The currently injected message digestion service or null.

identifyEntity()

identifyEntity(string  $correctIdentification, string  $suppliedIdentification) : boolean

Verify the identity of a user or a client entity.

Parameters

string	$correctIdentification	The correct identification information.
string	$suppliedIdentification	The supplied identification information.

Throws

\Exception: Validation errors.

Returns

boolean —

The identity verification result.

__construct()

__construct(\CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface|null  $hasher = null)

Container constructor.

Parameters

\CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm|\CryptoManana\Core\Interfaces\MessageDigestion\SecureVerificationInterface|null

$hasher

The message digestion and verification service.

Throws

\Exception: Initialization validation.

string	$correctPassphrase	The correct passphrase information.
string	$suppliedPassphrase	The supplied passphrase information.