Class KmsMaterialsProviderV2
- Aws\Crypto\MaterialsProviderV2 implements Aws\Crypto\MaterialsProviderInterfaceV2
-
Aws\Crypto\KmsMaterialsProviderV2
implements
Aws\Crypto\MaterialsProviderInterfaceV2
- Namespace: Aws\Crypto
- Located at Crypto/KmsMaterialsProviderV2.php
Uses KMS to supply materials for encrypting and decrypting data. This V2 implementation should be used with the V2 encryption clients (i.e. S3EncryptionClientV2).
Methods Summary
- __construct ( Aws\Kms\KmsClient $kmsClient, string $kmsKeyId = null )
- getWrapAlgorithmName ( )
- decryptCek ( string $encryptedCek, string $materialDescription, string $options )
- generateCek ( string $keySize, array $context, array $options )
Methods inherited from Aws\Crypto\MaterialsProviderV2
Methods Details
__construct (
Aws\Kms\KmsClient
$kmsClient,
string
$kmsKeyId = null
)
Parameters
Aws\Kms\KmsClient |
$kmsClient | A KMS Client for use encrypting and decrypting keys. |
| string | $kmsKeyId = null | The private KMS key id to be used for encrypting and decrypting keys. |
string getWrapAlgorithmName ( )
Returns
| string |
Inheritdoc
Implementation of
string decryptCek ( string $encryptedCek, string $materialDescription, string $options )
Parameters
| string | $encryptedCek | Encrypted key to be decrypted by the Provider for use decrypting other data. |
| string | $materialDescription | Material Description for use in decrypting the CEK. |
| string | $options | Options for use in decrypting the CEK. |
Returns
| string |
Inheritdoc
Implementation of
array generateCek ( string $keySize, array $context, array $options )
Parameters
| string | $keySize | Length of a cipher key in bits for generating a random content encryption key (CEK). |
| array | $context | Context map needed for key encryption |
| array | $options | Additional options to be used in CEK generation |
Returns
| array |
Inheritdoc
Implementation of
Constants summary
string |
WRAP_ALGORITHM_NAME
|
#
'kms+context'
|