You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Module: Aws::S3::Encryption::KeyProvider

Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/key_provider.rb

Overview

This module defines the interface required for a Client#key_provider. A key provider is any object that:

  • Responds to #encryption_materials with an Materials object.

  • Responds to #key_for, receiving a JSON document String, returning an encryption key. The returned encryption key must be one of:

    • OpenSSL::PKey::RSA - for asymmetric encryption
    • String - 32, 24, or 16 bytes long, for symmetric encryption

Instance Method Summary collapse

Instance Method Details

#encryption_materialsMaterials

Returns:



20
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/key_provider.rb', line 20

def encryption_materials; end

#key_for(materials_description) ⇒ OpenSSL::PKey::RSA, String

Returns encryption_key

Parameters:

  • materials_description (String<JSON>)

Returns:

  • (OpenSSL::PKey::RSA, String)

    encryption_key



24
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/key_provider.rb', line 24

def key_for(materials_description); end