Skip to content

Commit f649168

Browse files
committed
Documentation fixes
1 parent 6286830 commit f649168

10 files changed

+13
-10
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Use a one-liner command to backdoor an AWS account's resources with a rogue AWS
1919

2020
```bash
2121
# this will ruin your day
22-
endgame smash --service all --evil-principal "*" --dry-run
22+
endgame smash --service all --evil-principal "*"
2323
# This will show you how your day could have been ruined
2424
endgame smash --service all --evil-principal "*" --dry-run
2525
# Atone for your sins
@@ -224,7 +224,7 @@ We recommend that AWS take the following measures in response:
224224
* Increase Access Advisor Support to cover the resources that can be exposed via Resource-based Policy modification, AWS RAM resource sharing, and resource-specific sharing APIs (such as RDS snapshots, EBS snapshots, and EC2 AMIs)
225225
* Create GuardDuty rules that detect anomalous exposure of resources outside your AWS Organization.
226226
* Expand the current limit of 5 SCPs per AWS account to 200. (for comparison, the Azure equivalent - Azure Policies - has a limit of [200 Policy or Initiative Assignments per subscription](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-policy-limits))
227-
* Improve the AWS SCP service to support "Audit" mode, which will increase customer adoption and make it easier for customers to both pilot and roll out new guardrails.
227+
* Improve the AWS SCP service to support an "Audit" mode that would record in CloudTrail whether API calls would have been denied had the SCP not been in audit mode. This would increase customer adoption and make it easier for customers to both pilot and roll out new guardrails. (for comparison, the Azure Equivalent - Azure Policies - already [supports Audit mode](https://docs.microsoft.com/en-us/azure/governance/policy/concepts/effects#audit).
228228
* Support the usage of `sts:AssumeRole` to prevent calls from outside your AWS Organization, with targeted exceptions.
229229

230230
## Recommendations to Blue Teams
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/contributing/testing.md

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ make integration-test
3636
```
3737

3838
This does the following:
39+
3940
* Sets up your local dev environment (see `setup-dev`) in the `Makefile`
4041
* Creates the Terraform infrastructure (see `terraform-demo` in the `Makefile`)
4142
* Runs `list-resources`, `exploit --dry-run`, and `expose` against this live infrastructure

docs/iam-permissions.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
The IAM Permissions listed below are used to create these backdoors.
44

5-
> **NOTE**: You don't need **all** of these permissions to run the tool. You just need enough from each service. So, `s3:ListAllMyBuckets`, `s3:GetBucketPolicy`, and `s3:PutBucketPolicy` are all the permissions needed to leverage this tool to expose S3 buckets.
6-
5+
You don't need **all** of these permissions to run the tool. You just need enough from each service. For example, `s3:ListAllMyBuckets`, `s3:GetBucketPolicy`, and `s3:PutBucketPolicy` are all the permissions needed to leverage this tool to expose S3 buckets.
76

87
```json
98
{

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
endgame
22
=======
33

4-
Introduction goes here.
4+
Introduction from the main README should go here after we iron it out.

docs/risks/sns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SNS
1+
# SNS Topics
22

33
* [Steps to Reproduce](#steps-to-reproduce)
44
* [Exploitation](#exploitation)

docs/risks/sqs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SQS
1+
# SQS Queues
22

33
* [Steps to Reproduce](#steps-to-reproduce)
44
* [Exploitation](#exploitation)

mkdocs.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ nav:
4040
- RDS Snapshots: 'risks/rds-snapshots.md'
4141
- S3 Buckets: 'risks/s3.md'
4242
- Secrets Manager: 'risks/secretsmanager.md'
43-
- SES: 'risks/ses.md'
44-
- SNS: 'risks/sns.md'
45-
- SQS: 'risks/sqs.md'
43+
- SES Authorized Senders: 'risks/ses.md'
44+
- SNS Topics: 'risks/sns.md'
45+
- SQS Queues: 'risks/sqs.md'
4646

4747
- "<b>Contributing</b>":
4848
- Contributing: 'contributing/contributing.md'
@@ -51,3 +51,6 @@ nav:
5151
- "<b>Appendices</b>":
5252
- Terraform Demo Infrastructure: 'appendices/terraform-demo-infrastructure.md'
5353
- ACM PCA Activation: 'appendices/acm-pca-activation.md'
54+
- User-Agent Detection: 'appendices/user-agent-detection.md'
55+
- Roadmap: 'appendices/roadmap.md'
56+
- FAQ: 'appendices/faq.md'

0 commit comments

Comments
 (0)