SDK for PHP 3.x
MaterialsProviderInterfaceV2
in
Table of Contents
Methods
- decryptCek() : string
- Takes an encrypted content encryption key (CEK) and material description for use decrypting the key according to the Provider's specifications.
- generateCek() : array<string|int, mixed>
- generateIv() : string
- getWrapAlgorithmName() : string
- Returns the wrap algorithm name for this Provider.
- isSupportedKeySize() : bool
- Returns if the requested size is supported by AES.
Methods
decryptCek()
Takes an encrypted content encryption key (CEK) and material description for use decrypting the key according to the Provider's specifications.
public
decryptCek(string $encryptedCek, string $materialDescription, array<string|int, mixed> $options) : string
Parameters
- $encryptedCek : string
-
Encrypted key to be decrypted by the Provider for use decrypting other data.
- $materialDescription : string
-
Material Description for use in decrypting the CEK.
- $options : array<string|int, mixed>
-
Options for use in decrypting the CEK.
Return values
stringgenerateCek()
public
generateCek(string $keySize, array<string|int, mixed> $context, array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $keySize : string
-
Length of a cipher key in bits for generating a random content encryption key (CEK).
- $context : array<string|int, mixed>
-
Context map needed for key encryption
- $options : array<string|int, mixed>
-
Additional options to be used in CEK generation
Return values
array<string|int, mixed>generateIv()
public
generateIv(string $openSslName) : string
Parameters
- $openSslName : string
-
Cipher OpenSSL name to use for generating an initialization vector.
Return values
stringgetWrapAlgorithmName()
Returns the wrap algorithm name for this Provider.
public
getWrapAlgorithmName() : string
Return values
stringisSupportedKeySize()
Returns if the requested size is supported by AES.
public
static isSupportedKeySize(int $keySize) : bool
Parameters
- $keySize : int
-
Size of the requested key in bits.