Skip to content

farleyb-amazon/busy-engineers-document-bucket

 
 

Repository files navigation

Busy Engineer's Document Bucket

This is the GitHub repo for the Busy Engineer's Document Bucket. In this workshop, you will be guided through adding client-side encryption with AWS KMS and the AWS Encryption SDK.

The workshop instructions can be found at https://document-bucket.awssecworkshops.com/

Security issue notifications

Repository Structure

  • cdk - the AWS Cloud Development Kit code describing all AWS resources required for the workshop.
  • dev - utilities for writing and updating the workshop, including the CDK resources for Cloud9 which is the base for launching workshop activities.
  • exercises - the actual exercise source code for each supported language in the workshop. -start is the content for actually working the exercise, and -complete is the finished exercise content, for reference.
  • instructions - is the configuration and content for the documentation website, https://document-bucket.awssecworkshops.com

Testing

After creating a PR, test the changes by manually spinning up the workshop in a test account. To spin up the workshop, follow the instructions here until you reach the make bootstrap step. Before running make bootstrap, add your remote and check out your branch:

  1. git remote add [name] [httpUrl]
  2. git fetch --all
  3. git checkout [pr-branch-name]

After the bootstrap has completed, close the terminal and open a new one. Then

  1. cd ~/environment/workshop
  2. make basic_cli_smoke_tests

Updating JavaScript dependencies

Make targets to update and check the JavaScript dependencies exist. Checking out the code locally and running make npm_update will run npm update on all JavaScript code. Similarly make npm_audit can be used to run npm audit on all JavaScript code.

License

This project is licensed under the Apache-2.0 License.

About

A workshop to introduce client-side encryption with the AWS Encryption SDK and AWS KMS.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 46.9%
  • Python 32.6%
  • TypeScript 9.8%
  • JavaScript 8.4%
  • Makefile 1.7%
  • CSS 0.4%
  • Shell 0.2%