AWSKMSDeriveSharedSecretResponse

Objective-C

@interface AWSKMSDeriveSharedSecretResponse

Swift

class AWSKMSDeriveSharedSecretResponse

  • The plaintext shared secret encrypted with the public key in the attestation document.

    This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable ciphertextForRecipient;

    Swift

    var ciphertextForRecipient: Data? { get set }

  • Identifies the key agreement algorithm used to derive the shared secret.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSKeyAgreementAlgorithmSpec keyAgreementAlgorithm;

    Swift

    var keyAgreementAlgorithm: AWSKMSKeyAgreementAlgorithmSpec { get set }

  • Identifies the KMS key used to derive the shared secret.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable keyId;

    Swift

    var keyId: String? { get set }

  • The source of the key material for the specified KMS key.

    When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn’t have any key material.

    The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSOriginType keyOrigin;

    Swift

    var keyOrigin: AWSKMSOriginType { get set }

  • The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer’s public key.

    If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable sharedSecret;

    Swift

    var sharedSecret: Data? { get set }