-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(examples): Add examples for Go with CI #733
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few README nits, otherwise LGTM
@@ -0,0 +1,90 @@ | |||
# AWS Encryption SDK for Go Examples |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename this file to README.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
|
||
The AWS Encryption SDK provides two high-level APIs: | ||
one-step APIs that process the entire operation in memory | ||
and streaming APIs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find the streaming API examples -- if it's just 1 or 2 examples could you link them specifically?
(I'm also surprised to hear this -- I was also under the impression that our Dafny libraries wouldn't support streaming until Dafny did some work. Did that get done?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. This came in when I copied the readme from other runtimes. I think we don't support streaming rn.
* How to restrict algorithm suites | ||
* [with a custom cryptographic materials manager](./cryptographicmaterialsmanager/restrictalgorithmsuite/signingsuiteonlycmm.go) | ||
|
||
### Keyrings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They determine how the AWS Encryption SDK protects your data. | ||
You can find these examples in [`examples/keyring`](./keyring). | ||
|
||
### Cryptographic Materials Managers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My README nits apply to all languages, will be addressed in alter PR
AwsEncryptionSDK/Makefile
Outdated
_polymorph_dependencies: | ||
@echo "No polymorphing of dependency" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be left in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohh no. I forgot to remove it. Thats my faster polymorph'ing trick
Issue #, if available:
Description of changes:
Moving all examples from here which is already PR reviewed to this repo but did following changes while moving:
commitmentpolicy.go
,limitencrypteddatakeysexample.go
andsetencryptionalgorithmsuite.go
files to the misc directory to improve code organization, as these auxiliary examples are better separated from the core project files (main.go
,go.mod
andgo.sum
).AwsEncryptionSDK/runtimes/go/examples/readme.md
)Squash/merge commit message, if applicable:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.