As a senior Sales Engineer for Trend Micro, I regularly run security PoCs, demos, webinars, etc. One day while running one of these sessions, I had an idea:
“People can learn a lot about traditional security and DevSecOps by becoming hackers themselves. Wouldn’t it be great to give them an environment to hack, and then secure?”
And with that, I started on the design immediately.
High level design
After some time, the design was done:
- The entire solution must be automated. Therefore, everything must be done using:
- Python
- Trend’s APIs
- Boto3
- CloudFormation
- Don’t re-invent the wheel:
- Minimise the amount of code that needs to be written
- If AWS has a solution for it, use it
- If an open source tool or library suits, use it
- It must have a plugin in system
- It must be easy for new hacks and tools to be added to the solution without needing to re-architect the solution
- Plugins with dependencies must ensure their parent plugin(s) are invoked beforehand
- Deployment cleanups must also adhere to the dependency tree
- It must be modular
- Different users have different interests. The solution must enable lab scenarios to be added and removed easily
- Lab guides must be unique per user and generated automatically
- Each user’s unique username, password, URLs, etc must be populated in the guide
- The guides themselves must be completely customisable
- Distributing the guides must be simple
- It must be extremely scalable
- Deployments must be seamless, whether they’re for 1 user or 1,000+ users
- User experience must be flawless, whether there’s 1 user or 1,000+ users
- It must be portable & efficient
- AWS quotas increases must be kept to a minimum to enable quick deployments in new accounts/regions
- It must be region agnostic so that it can be deployed in the region(s) which are closest to the users
- Re-use infrastructure where possible. For example, if two plugins use Cloud9, use a single instance instead of one per plugin
- Users must not need to download or install anything on their machines
- It must be secure
- Users should not be able to access or affect each other’s labs
- Secrets must not be passed or stored in clear text
- It must adhere to AWS limits, such as:
- CloudFormation template file size (51,200 bytes for template body or 460,800 bytes for S3 objects)
- Number of resources per CloudFormation template (200)
- Parameters (60)
- Outputs (60)
- API rate limit
- It must be easy to deploy and clean up
Tooling
Once the design was done, choosing the tools which would make up the solution was the next task. This is how it went:
- Infrastructure as Code (IAC)
- CloudFormation (AWS) was chosen over Terraform (Hashicorp) as it affords vendor consolidation
- AWS is able to provide the infrastructure, the Infrastructure as Code (CloudFormation) as well as the SDK (Boto3)
- Jinja2 was chosen over CDK to minimise complexity
- Jinja2 was chosen over CloudFormation parameters and outputs to circumvent the 60 item limit on each
- JSON templates were chosen over YAML templates because they can minified, thereby enabling more data per CloudFormation stack
- Template uploads to S3 were chosen over body templates due to the increased file size limit (460,800 bytes vs 51,200 bytes)
- Python will be used to split CloudFormation templates that exceed the maximum template size or maximum number of resources (200)
- Python will be used to ensure AWS’ API rate limits are respected
- As CloudFormation, AWS CLI and AWS’ SDKs (e.g Boto3) all have exponential backoff mechanisms built into them, this isn’t typically a concern. However, as I’ll cover in a future post, creating a large number of Cloud9 environments simultaneously will result in the rate limit being exceeded
- CloudFormation (AWS) was chosen over Terraform (Hashicorp) as it affords vendor consolidation
- Python
- Use boto3 to orchestrate the entire solution
- Code will be documented using Google style docstrings, pdoc3 to generate the docs and type hints within the code
- Black and pre-commit hooks will be used to enforce code style
- User access
- IAM users, groups and policies
- Cloud9 will enable users to take part without needing to install tools on their laptops
- Secrets
- AWS Secrets Manager will be used to ensure secrets are handled securely
- CI/CD
- Git on Cloud9
- CodeCommit
- CodePipeline
- CodeBuild
- CloudFormation
- Containers
- Docker on Cloud9
- Fargate
- ECR
- Kubernetes
- EKS via CloudFormation was chosen over eksctl to avoid needing to add another tool to the solution
- Serverless
- Lambda
- API Gateway
- Lab guides
- CSS & HTML will be used as the base of the guides
- This will enable the creation of themed labs (e.g virtual class rooms, hack days, etc)
- Jinja2 will be used to:
- Customise the guides for each user (username, password, Cloud9 URL, etc)
- Provide
if
statements to ensure only relevant information & labs are included
- WeasyPrint will convert the HTML guides into PDFs
- Guides will be uploaded to an S3 bucket automatically
- Presigned URLs will be generated automatically for easy distribution
- CSS & HTML will be used as the base of the guides
- Lab configuration
- For ease of use, the entire solution will be driven out of a single YAML file
- Sensible defaults must be provided to easy deployments (see below)
- Infinite scalability
- STS and AWS Organizations will be used to scale the solution horizontally
What does it look like?
This is what the config file looks like:
---
lab_settings:
workshop_name: ExampleLabs
number_of_labs: 50
aws_region: ap-southeast-2
plugins_config:
conformity_existing_resources: {}
conformity_template_scanner: {}
application_security_lambda: {}
application_security_container: {}
workload_security_container: {}
container_image_security: {}
As you can guess, the lab_settings
section is used to set the name of the workshop, the number of labs and the region in which they’ll be deployed. The plugins_config
section is then used to enable the plugins which we’d like to run in this particular workshop.
The {}
are known as maps (or dictionaries). They’re used to to pass non-default settings into each of the plugins.
What does it do?
In a nutshell, the above configuration deploys 50 of the following scenarios:
-
Conformity existing resources: Participants use Conformity to identify and close security gaps in deployed resources
-
Conformity template scanner: Using Conformity’s template scanner in a CI/CD pipeline, participants identify and close security gaps in resources before they’re deployed. Once the template has been secured, the pipeline will automatically deploy the stack
-
Application Security Lambda: Participants exploit a Lambda function using a directory traversal attack. They then protect it using Application Security
-
Application Security Container: Participants exploit a container using SQL injection and remote code execution (RCE) attacks. They then protect it using Application Security
-
Workload Security Container: Participants exploit a container using a RCE attack. They then then protect it, and its host using Workload Security
-
Container Image Security: With Container Image Security embedded in their CI/CD pipeline, participants identify and remove vulnerabilities, secrets and malware from a container before it’s deployed. Once the Dockerfile has been secured, the pipeline allows the image to be put into ECR
What do the guides look like?
Here’s a screenshot from lab49
’s lab guide:
Taking it for a spin
We frequently run virtual classrooms and hands on labs around the world. If you’d like to be a hacker for a day and/or learn more about DevSecOps, please feel free to drop me an email. I’ll be happy to let you know when our next event is going to take place.
What’s next?
In the subsequent posts of this series, I’ll delve deeper into the architecture and inner workings of this solution.
As always, if you have any questions or have a topic that you would like me to discuss, please feel free to post a comment at the bottom of this blog entry, e-mail at will@oznetnerd.com, or drop me a message on Reddit (OzNetNerd).
Note: The opinions expressed in this blog are my own and not those of my employer.
Leave a comment