Motivation

Features

Current Limitations

Requirements

Installation

$ go get github.com/chainifynet/aws-encryption-sdk-go@latest

Usage

For advanced use cases, checkexamples.

Setting Up the Client

Default Client Configuration

import ("github.com/chainifynet/aws-encryption-sdk-go/client""github.com/chainifynet/aws-encryption-sdk-go/clientconfig""github.com/chainifynet/aws-encryption-sdk-go/materials""github.com/chainifynet/aws-encryption-sdk-go/providers/kmsprovider""github.com/chainifynet/aws-encryption-sdk-go/providers/rawprovider""github.com/chainifynet/aws-encryption-sdk-go/suite")// setup Encryption SDK client with default configsdkClient:=client.NewClient()

Custom Client Configuration (advanced)

// setup Encryption SDK client with custom client configcfg,err:=clientconfig.NewConfigWithOpts(clientconfig.WithCommitmentPolicy(suite.CommitmentPolicyRequireEncryptRequireDecrypt),clientconfig.WithMaxEncryptedDataKeys(3),)iferr!=nil {panic(err)// handle error}// setup Encryption SDK client with a custom configsdkClient:=client.NewClientWithConfig(cfg)

Prepare the Key Provider

Raw Key Provider using static keys

rawKeyProvider,err:=rawprovider.NewWithOpts("raw",providers.WithStaticKey("static1", []byte("superSecureKeySecureKey32bytes32")),)iferr!=nil {panic("raw key provider setup failed")// handle error}

KMS Key Provider using KMS CMKs

// KMS key ARN to be used for encryption and decryptionkmsKeyArn:="arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"// setup KMS key providerkmsKeyProvider,err:=kmsprovider.New(kmsKeyArn)iferr!=nil {panic("kms key provider setup failed")// handle error}

Create the Crypto Materials Manager

Crypto Materials Manager with the Raw Key Provider

cmm,err:=materials.NewDefault(rawKeyProvider)iferr!=nil {panic("materials manager setup failed")// handle error}

Crypto Materials Manager with KMS Key Provider

cmm,err:=materials.NewDefault(kmsKeyProvider)iferr!=nil {panic("materials manager setup failed")// handle error}

Crypto Materials Manager using both KMS and Raw Key Providers

cmm,err:=materials.NewDefault(kmsKeyProvider,rawKeyProvider)iferr!=nil {panic("materials manager setup failed")// handle error}

Encrypting Data

// define the encryption context, which is a set of key-value pairs that represent additional authenticated dataencryptionContext:=map[string]string{"purpose":"test",}// data to encryptsecretData:= []byte("secret data to encrypt")// encrypt dataciphertext,header,err:=sdkClient.Encrypt(context.TODO(),secretData,encryptionContext,cmm,)iferr!=nil {panic("encryption failed")// handle error}

Decrypting Data

// decrypt dataplaintext,header,err:=sdkClient.Decrypt(context.TODO(),ciphertext,cmm)iferr!=nil {panic("decryption failed")// handle error}

TODO

Support and Contributions

License