Go Documentation

.golangci.yml

@@ -56,6 +56,9 @@ linters:
     - wrapcheck
     - gofmt
     - zerologlint
+# enable these on the next golangci-lint release:
+#    - copyloopvar
+#    - intrange
 
 linters-settings:
   errorlint:
@@ -126,8 +129,8 @@ linters-settings:
       - assign
     ignored-files:
       - 'algorithm\.go'
-      - 'pkg/utils/conv/conv\.go'
-      - 'pkg/helpers/arn/arn\.go'
+      - 'pkg/internal/utils/conv/conv\.go'
+      - 'pkg/utils/arn/arn\.go'
     ignored-functions:
       - '^math\.'
       - '^http\.StatusText$'
@@ -180,7 +183,7 @@ issues:
     - path: 'pkg/suite/algorithm.go'
       linters:
         - gochecknoglobals
-    - path: 'pkg/utils/conv/conv.go'
+    - path: 'pkg/internal/utils/conv/conv.go'
       linters:
         - gochecknoglobals
     - linters:

.mockery.yaml

@@ -39,6 +39,9 @@ packages:
         config:
           mockname: "MockEncrypter"
           filename: "Encrypter_mock.go"
+      GcmCrypter:
+      AEADEncrypter:
+      AEADDecrypter:
   github.com/chainifynet/aws-encryption-sdk-go/pkg/model/format:
     interfaces:
       MessageAAD:
@@ -50,15 +53,9 @@ packages:
       MessageFooter:
       Deserializer:
       Serializer:
-  github.com/chainifynet/aws-encryption-sdk-go/pkg/utils/encryption:
-    interfaces:
-      GcmBase:
-        config:
-          mockname: "MockEncrypter"
-          filename: "Encrypter_mock.go"
-      AEADDecrypter:
-      AEADEncrypter:
-  github.com/chainifynet/aws-encryption-sdk-go/pkg/utils/rand:
+  github.com/chainifynet/aws-encryption-sdk-go/pkg/internal/utils/rand:
+    config:
+      dir: mocks/{{ replaceAll .PackagePath "internal" "internal_" }}
     interfaces:
       RandomGenerator:
   github.com/chainifynet/aws-encryption-sdk-go/pkg/internal/crypto/signature:

README.md

@@ -188,13 +188,13 @@ if err != nil {
 ## TODO
 
 - [ ] Add support for Caching Materials Manager.
-- [x] Add support for Message Format Version 1 [#170](https://github.com/chainifynet/aws-encryption-sdk-go/pull/46).
+- [x] Add support for Message Format Version 1 [#170](https://github.com/chainifynet/aws-encryption-sdk-go/pull/170).
 - [x] Add support for AWS KMS Multi-Region Keys [#46](https://github.com/chainifynet/aws-encryption-sdk-go/pull/46).
 - [ ] Add support for KMS aliases.
 - [x] Cover `providers` package with tests.
 - [x] Cover `keys` package with tests.
 - [x] Cover `materials` package with tests.
-- [ ] GoDoc documentation.
+- [x] GoDoc documentation [#294](https://github.com/chainifynet/aws-encryption-sdk-go/pull/294).
 - [ ] Streamlined encryption and decryption.
 
 ## Support and Contributions

doc.go

@@ -1,4 +1,73 @@
 // Copyright Chainify Group LTD. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+// Package sdk is the Unofficial Go SDK implementation of the AWS Encryption SDK.
+//
+// # Getting started
+//
+// To install the AWS Encryption SDK for Go, use the following command:
+//
+//	go get github.com/chainifynet/aws-encryption-sdk-go@latest
+//
+// # Usage
+//
+// The following example demonstrates how to use SDK to encrypt and decrypt data using a static key.
+//
+//	package main
+//
+//	import (
+//		"context"
+//		"fmt"
+//
+//		"github.com/chainifynet/aws-encryption-sdk-go/pkg/client"
+//		"github.com/chainifynet/aws-encryption-sdk-go/pkg/materials"
+//		"github.com/chainifynet/aws-encryption-sdk-go/pkg/providers/rawprovider"
+//	)
+//
+//	func main() {
+//		// static key to use for encryption and decryption
+//		staticKey1 := []byte("superSecureKeySecureKey32bytes32")
+//
+//		// data to encrypt
+//		secretData := []byte("secret data to encrypt")
+//
+//		// setup Encryption SDK client with default configuration
+//		sdkClient := client.NewClient()
+//
+//		// setup Raw Key provider
+//		rawKeyProvider, err := rawprovider.NewWithOpts(
+//			"raw",
+//			rawprovider.WithStaticKey("static1", staticKey1),
+//		)
+//		if err != nil {
+//			panic(err) // handle error
+//		}
+//
+//		// setup crypto materials manager
+//		cmm, err := materials.NewDefault(rawKeyProvider)
+//		if err != nil {
+//			panic(err) // handle error
+//		}
+//
+//		// encrypt data without encryption context passing nil as the third argument
+//		encrypted, header, err := sdkClient.Encrypt(context.TODO(), secretData, nil, cmm)
+//		if err != nil {
+//			panic(err) // handle error
+//		}
+//
+//		fmt.Printf("encrypted encryption context: %v\n", header.AADData().EncryptionContext())
+//
+//		// decrypt "encrypted" data
+//		decrypted, _, err := sdkClient.Decrypt(context.TODO(), encrypted, cmm)
+//		if err != nil {
+//			panic(err) // handle error
+//		}
+//
+//		fmt.Printf("decrypted data: %s\n", decrypted)
+//
+//		// verify that "decrypted" plaintext is identical to the original secret data
+//		if string(decrypted) != string(secretData) {
+//			panic("decrypted data does not match with the original data")
+//		}
+//	}
 package sdk

example/discoveryFilterKmsProvider/main.go

@@ -9,10 +9,10 @@ import (
 
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/client"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/clientconfig"
-	"github.com/chainifynet/aws-encryption-sdk-go/pkg/helpers/arn"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/materials"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/providers/kmsprovider"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/suite"
+	"github.com/chainifynet/aws-encryption-sdk-go/pkg/utils/arn"
 )
 
 // encrypts and then decrypts a string using KMS key provider with discovery filter

example/mrkAwareKmsProvider/main.go

@@ -9,10 +9,10 @@ import (
 
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/client"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/clientconfig"
-	"github.com/chainifynet/aws-encryption-sdk-go/pkg/helpers/arn"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/materials"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/providers/kmsprovider"
 	"github.com/chainifynet/aws-encryption-sdk-go/pkg/suite"
+	"github.com/chainifynet/aws-encryption-sdk-go/pkg/utils/arn"
 )
 
 // encrypts and then decrypts a string using MRK-aware KMS key provider