SDK for PHP 3.x

CipherMethod
in

Table of Contents

Methods

getAesName()  : string
Returns an AES recognizable name, such as 'AES/GCM/NoPadding'.
getCurrentIv()  : string
Returns the IV that should be used to initialize the next block in encrypt or decrypt.
getOpenSslName()  : string
Returns an identifier recognizable by `openssl_*` functions, such as `aes-256-cbc` or `aes-128-ctr`.
requiresPadding()  : bool
Indicates whether the cipher method used with this IV requires padding the final block to make sure the plaintext is evenly divisible by the block size.
seek()  : mixed
Adjust the return of this::getCurrentIv to reflect a seek performed on the encryption stream using this IV object.
update()  : mixed
Take account of the last cipher text block to adjust the return of this::getCurrentIv

Methods

getAesName()

Returns an AES recognizable name, such as 'AES/GCM/NoPadding'.

public getAesName() : string
Return values
string

getCurrentIv()

Returns the IV that should be used to initialize the next block in encrypt or decrypt.

public getCurrentIv() : string
Return values
string

getOpenSslName()

Returns an identifier recognizable by `openssl_*` functions, such as `aes-256-cbc` or `aes-128-ctr`.

public getOpenSslName() : string
Return values
string

requiresPadding()

Indicates whether the cipher method used with this IV requires padding the final block to make sure the plaintext is evenly divisible by the block size.

public requiresPadding() : bool
Return values
bool

seek()

Adjust the return of this::getCurrentIv to reflect a seek performed on the encryption stream using this IV object.

public seek(int $offset[, int $whence = SEEK_SET ]) : mixed
Parameters
$offset : int
$whence : int = SEEK_SET
Tags
throws
LogicException

Thrown if the requested seek is not supported by this IV implementation. For example, a CBC IV only supports a full rewind ($offset === 0 && $whence === SEEK_SET)

update()

Take account of the last cipher text block to adjust the return of this::getCurrentIv

public update(string $cipherTextBlock) : mixed
Parameters
$cipherTextBlock : string
On this page