|
| 1 | +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package keyring |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "fmt" |
| 9 | + "reflect" |
| 10 | + |
| 11 | + mpl "github.com/aws/aws-cryptographic-material-providers-library/releases/go/mpl/awscryptographymaterialproviderssmithygenerated" |
| 12 | + mpltypes "github.com/aws/aws-cryptographic-material-providers-library/releases/go/mpl/awscryptographymaterialproviderssmithygeneratedtypes" |
| 13 | + dbesdkdynamodbencryptiontypes "github.com/aws/aws-database-encryption-sdk-dynamodb/awscryptographydbencryptionsdkdynamodbsmithygeneratedtypes" |
| 14 | + dbesdkstructuredencryptiontypes "github.com/aws/aws-database-encryption-sdk-dynamodb/awscryptographydbencryptionsdkstructuredencryptionsmithygeneratedtypes" |
| 15 | + "github.com/aws/aws-database-encryption-sdk-dynamodb/dbesdkmiddleware" |
| 16 | + |
| 17 | + "github.com/aws/aws-sdk-go-v2/aws" |
| 18 | + "github.com/aws/aws-sdk-go-v2/config" |
| 19 | + "github.com/aws/aws-sdk-go-v2/service/dynamodb" |
| 20 | + "github.com/aws/aws-sdk-go-v2/service/dynamodb/types" |
| 21 | + "github.com/aws/aws-sdk-go-v2/service/kms" |
| 22 | +) |
| 23 | + |
| 24 | +/* |
| 25 | +This example sets up DynamoDb Encryption for the AWS SDK client |
| 26 | +and uses the low level PutItem and GetItem DDB APIs to demonstrate |
| 27 | +putting a client-side encrypted item into DynamoDb |
| 28 | +and then retrieving and decrypting that item from DynamoDb. |
| 29 | +
|
| 30 | +Running this example requires access to the DDB Table whose name |
| 31 | +is provided in CLI arguments. |
| 32 | +This table must be configured with the following |
| 33 | +primary key configuration: |
| 34 | + - Partition key is named "partition_key" with type (S) |
| 35 | + - Sort key is named "sort_key" with type (N) |
| 36 | +*/ |
| 37 | +func AwsKmsKeyringExample(kmsKeyID, ddbTableName string) { |
| 38 | + // 1. Create a Keyring. This Keyring will be responsible for protecting the data keys that protect your data. |
| 39 | + // For this example, we will create a AWS KMS Keyring with the AWS KMS Key we want to use. |
| 40 | + // We will use the `CreateMrkMultiKeyring` method to create this keyring, |
| 41 | + // as it will correctly handle both single region and Multi-Region KMS Keys. |
| 42 | + cfg, err := config.LoadDefaultConfig(context.TODO()) |
| 43 | + if err != nil { |
| 44 | + panic(err) |
| 45 | + } |
| 46 | + // Create KMS client |
| 47 | + kmsClient := kms.NewFromConfig(cfg, func(o *kms.Options) { |
| 48 | + o.Region = "us-west-2" |
| 49 | + }) |
| 50 | + // Initialize the mpl client |
| 51 | + matProv, err := mpl.NewClient(mpltypes.MaterialProvidersConfig{}) |
| 52 | + if err != nil { |
| 53 | + panic(err) |
| 54 | + } |
| 55 | + // Create the Aws Kms Keyring |
| 56 | + awsKmsKeyringInput := mpltypes.CreateAwsKmsKeyringInput{ |
| 57 | + KmsClient: kmsClient, |
| 58 | + KmsKeyId: kmsKeyID, |
| 59 | + } |
| 60 | + keyring, err := matProv.CreateAwsKmsKeyring(context.Background(), awsKmsKeyringInput) |
| 61 | + if err != nil { |
| 62 | + panic(err) |
| 63 | + } |
| 64 | + |
| 65 | + // 2. Configure which attributes are encrypted and/or signed when writing new items. |
| 66 | + // For each attribute that may exist on the items we plan to write to our DynamoDbTable, |
| 67 | + // we must explicitly configure how they should be treated during item encryption: |
| 68 | + // - ENCRYPT_AND_SIGN: The attribute is encrypted and included in the signature |
| 69 | + // - SIGN_ONLY: The attribute not encrypted, but is still included in the signature |
| 70 | + // - DO_NOTHING: The attribute is not encrypted and not included in the signature |
| 71 | + attributeActions := map[string]dbesdkstructuredencryptiontypes.CryptoAction{ |
| 72 | + "partition_key": dbesdkstructuredencryptiontypes.CryptoActionSignOnly, // Partition key must be SIGN_ONLY |
| 73 | + "sort_key": dbesdkstructuredencryptiontypes.CryptoActionSignOnly, // Sort key must be SIGN_ONLY |
| 74 | + "attribute1": dbesdkstructuredencryptiontypes.CryptoActionEncryptAndSign, |
| 75 | + "attribute2": dbesdkstructuredencryptiontypes.CryptoActionSignOnly, |
| 76 | + ":attribute3": dbesdkstructuredencryptiontypes.CryptoActionDoNothing, |
| 77 | + } |
| 78 | + |
| 79 | + // 3. Configure which attributes we expect to be included in the signature |
| 80 | + // when reading items. There are two options for configuring this: |
| 81 | + // |
| 82 | + // - (Recommended) Configure `allowedUnsignedAttributesPrefix`: |
| 83 | + // When defining your DynamoDb schema and deciding on attribute names, |
| 84 | + // choose a distinguishing prefix (such as ":") for all attributes that |
| 85 | + // you do not want to include in the signature. |
| 86 | + // This has two main benefits: |
| 87 | + // - It is easier to reason about the security and authenticity of data within your item |
| 88 | + // when all unauthenticated data is easily distinguishable by their attribute name. |
| 89 | + // - If you need to add new unauthenticated attributes in the future, |
| 90 | + // you can easily make the corresponding update to your `attributeActionsOnEncrypt` |
| 91 | + // and immediately start writing to that new attribute, without |
| 92 | + // any other configuration update needed. |
| 93 | + // Once you configure this field, it is not safe to update it. |
| 94 | + // |
| 95 | + // - Configure `allowedUnsignedAttributes`: You may also explicitly list |
| 96 | + // a set of attributes that should be considered unauthenticated when encountered |
| 97 | + // on read. Be careful if you use this configuration. Do not remove an attribute |
| 98 | + // name from this configuration, even if you are no longer writing with that attribute, |
| 99 | + // as old items may still include this attribute, and our configuration needs to know |
| 100 | + // to continue to exclude this attribute from the signature scope. |
| 101 | + // If you add new attribute names to this field, you must first deploy the update to this |
| 102 | + // field to all readers in your host fleet before deploying the update to start writing |
| 103 | + // with that new attribute. |
| 104 | + // |
| 105 | + // For this example, we have designed our DynamoDb table such that any attribute name with |
| 106 | + // the ":" prefix should be considered unauthenticated. |
| 107 | + allowedUnsignedAttributePrefix := ":" |
| 108 | + |
| 109 | + // 4. Create the DynamoDb Encryption configuration for the table we will be writing to. |
| 110 | + partitionKey := "partition_key" |
| 111 | + sortKeyName := "sort_key" |
| 112 | + algorithmSuiteId := mpltypes.DBEAlgorithmSuiteIdAlgAes256GcmHkdfSha512CommitKeyEcdsaP384SymsigHmacSha384 |
| 113 | + tableConfig := dbesdkdynamodbencryptiontypes.DynamoDbTableEncryptionConfig{ |
| 114 | + LogicalTableName: ddbTableName, |
| 115 | + PartitionKeyName: partitionKey, |
| 116 | + SortKeyName: &sortKeyName, |
| 117 | + AttributeActionsOnEncrypt: attributeActions, |
| 118 | + Keyring: keyring, |
| 119 | + AllowedUnsignedAttributePrefix: &allowedUnsignedAttributePrefix, |
| 120 | + AlgorithmSuiteId: &algorithmSuiteId, |
| 121 | + } |
| 122 | + tableConfigsMap := make(map[string]dbesdkdynamodbencryptiontypes.DynamoDbTableEncryptionConfig) |
| 123 | + tableConfigsMap[ddbTableName] = tableConfig |
| 124 | + listOfTableConfigs := dbesdkdynamodbencryptiontypes.DynamoDbTablesEncryptionConfig{ |
| 125 | + TableEncryptionConfigs: tableConfigsMap, |
| 126 | + } |
| 127 | + // 5. Create a new AWS SDK DynamoDb client using the TableEncryptionConfigs |
| 128 | + dbEsdkMiddleware, err := dbesdkmiddleware.NewDBEsdkMiddleware(listOfTableConfigs) |
| 129 | + if err != nil { |
| 130 | + panic(err) |
| 131 | + } |
| 132 | + ddb := dynamodb.NewFromConfig(cfg, dbEsdkMiddleware.CreateMiddleware()) |
| 133 | + |
| 134 | + // 6. Put an item into our table using the above client. |
| 135 | + // Before the item gets sent to DynamoDb, it will be encrypted |
| 136 | + // client-side, according to our configuration. |
| 137 | + item := map[string]types.AttributeValue{ |
| 138 | + "partition_key": &types.AttributeValueMemberS{Value: "BasicPutGetExample"}, |
| 139 | + "sort_key": &types.AttributeValueMemberN{Value: "0"}, |
| 140 | + "attribute1": &types.AttributeValueMemberS{Value: "encrypt and sign me!"}, |
| 141 | + "attribute2": &types.AttributeValueMemberS{Value: "sign me!"}, |
| 142 | + ":attribute3": &types.AttributeValueMemberS{Value: "ignore me!"}, |
| 143 | + } |
| 144 | + putInput := &dynamodb.PutItemInput{ |
| 145 | + TableName: aws.String(ddbTableName), |
| 146 | + Item: item, |
| 147 | + } |
| 148 | + _, err = ddb.PutItem(context.TODO(), putInput) |
| 149 | + if err != nil { |
| 150 | + panic(err) |
| 151 | + } |
| 152 | + |
| 153 | + // 7. Get the item back from our table using the same client. |
| 154 | + // The client will decrypt the item client-side, and return |
| 155 | + // back the original item. |
| 156 | + key := map[string]types.AttributeValue{ |
| 157 | + "partition_key": &types.AttributeValueMemberS{Value: "BasicPutGetExample"}, |
| 158 | + "sort_key": &types.AttributeValueMemberN{Value: "0"}, |
| 159 | + } |
| 160 | + getInput := &dynamodb.GetItemInput{ |
| 161 | + TableName: aws.String(ddbTableName), |
| 162 | + Key: key, |
| 163 | + // In this example we configure a strongly consistent read |
| 164 | + // because we perform a read immediately after a write (for demonstrative purposes). |
| 165 | + // By default, reads are only eventually consistent. |
| 166 | + // Read our docs to determine which read consistency to use for your application: |
| 167 | + // https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html |
| 168 | + ConsistentRead: aws.Bool(true), |
| 169 | + } |
| 170 | + result, err := ddb.GetItem(context.TODO(), getInput) |
| 171 | + if err != nil { |
| 172 | + panic(err) |
| 173 | + } |
| 174 | + // Verify the decrypted item |
| 175 | + if !reflect.DeepEqual(item, result.Item) { |
| 176 | + panic("Decrypted item does not match original item") |
| 177 | + } |
| 178 | + fmt.Println("Aws Kms Keyring Example successful.") |
| 179 | +} |
0 commit comments