Skip to content

Commit e0aa719

Browse files
authored
Updated Readme, changelog, and notice (#138)
* Updated solution documentation * Removed whitespace/added AWS to standard
1 parent 0b8e41f commit e0aa719

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77
## [2.0.0] - 2023-01-17
88

99
### Added
10-
- New remediations contributed by 6Pillars: AFSBP IAM.1/CIS v1.2.0 1.22/PCI.IAM.3, CIS v1.2.0 1.16, CIS v1.2.0 1.20
10+
- New remediations contributed by 6Pillars: CIS v1.2.0 1.20
11+
- New AFSBP remediations for CloudFormation.1, EC2.15, SNS.1, SNS.2, SQS.1
12+
- Service Catalog AppRegistry integration
13+
- New support for Security Controls, finding deduplication
14+
- New support for CIS v1.4.0 standard
1115

1216
### Changed
13-
- Added support for Security Controls, finding deduplication
17+
- Added protections to avoid deployment failure due to SSM document throttling
1418

1519
## [1.5.1] - 2022-12-22
1620

NOTICE.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ THIRD PARTY COMPONENTS
1111
**********************
1212
This software includes third party software subject to the following copyrights:
1313

14-
@aws-cdk/assert under the Apache License 2.0
1514
@aws-cdk/aws-servicecatalogappregistry-alpha under the Apache License 2.0
1615
@cdklabs/cdk-ssm-documents under the Apache License 2.0
1716
@types/jest under the MIT License
@@ -35,19 +34,13 @@ ts-jest under the MIT License
3534
ts-node under the MIT License
3635
typescript under the Apache License 2.0
3736

38-
attrs under the MIT License
3937
boto3 under the Apache License 2.0
4038
botocore under the Apache License 2.0
4139
certifi under the Mozilla Public License 2.0
42-
charset-normalizer under the MIT License
4340
coverage under the Apache License 2.0
44-
exceptiongroup under the MIT License
4541
idna under the BSD 3-Clause "New" or "Revised" License
46-
iniconfig under the MIT License
4742
jmespath under the MIT License
48-
packaging under the Apache License 2.0
4943
pip under the MIT License
50-
pluggy under the MIT License
5144
pytest under the MIT License
5245
pytest-cov under the MIT License
5346
pytest-env under the MIT License
@@ -57,6 +50,5 @@ requests under the Apache License 2.0
5750
s3transfer under the Apache License 2.0
5851
setuptools under the MIT License
5952
six under the MIT License
60-
tomli under the MIT License
6153
urllib3 under the MIT License
6254
virtualenv under the MIT License

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# AWS Security Hub Automated Response and Remediation
1+
# Automated Security Response on AWS
22

33
[🚀 Solution Landing
4-
Page](https://aws.amazon.com/solutions/implementations/aws-security-hub-automated-response-and-remediation/)
4+
Page](https://aws.amazon.com/solutions/implementations/automated-security-response-on-aws/)
55
\| [🚧 Feature
66
request](https://github.com/aws-solutions/aws-security-hub-automated-response-and-remediation/issues/new?assignees=&labels=feature-request%2C+enhancement&template=feature_request.md&title=)
77
\| [🐛 Bug
@@ -12,7 +12,7 @@ Solution Landing Page
1212

1313
## Table of contents
1414

15-
- [AWS Security Hub Automated Response and Remediation](#aws-security-hub-automated-response-and-remediation)
15+
- [Automated Security Response on AWS](#automated-security-response-on-aws)
1616
- [Table of contents](#table-of-contents)
1717
- [Solution Overview](#solution-overview)
1818
- [Architecture Diagram](#architecture-diagram)
@@ -36,7 +36,7 @@ Solution Landing Page
3636

3737
## Solution Overview
3838

39-
AWS Security Hub Automated Response and Remediation is an add-on solution that
39+
Automated Security Response on AWS is an add-on solution that
4040
enables AWS Security Hub customers to remediate security findings with a single
4141
click using predefined response and remediation actions called “Playbooks”.
4242
Alternately the playbooks can also be configured to remediate findings in AWS
@@ -45,8 +45,8 @@ some cases using AWS Systems Manager, the playbooks execute steps to remediate
4545
security issues, such as unused keys, open security groups, password policies,
4646
VPC configurations and public S3 buckets. The solution contains the playbook
4747
remediations for some of the security standards defined as part of CIS AWS
48-
Foundations Benchmark v1.2.0 and for AWS Foundational Security Best Practices
49-
v1.0.0.
48+
Foundations Benchmark v1.2.0, CIS AWS Foundations Benchmark v1.4.0,
49+
AWS Foundational Security Best Practices v1.0.0, and PCI-DSS v3.2.1.
5050

5151
<a name="architecture-diagram"></a>
5252

@@ -64,7 +64,7 @@ v1.0.0.
6464

6565
## Customizing the Solution
6666

67-
**Note**: If your goal is just to deploy the solution, please use the template on the [AWS Security Hub Automated Response and Remediation Landing Page](https://aws.amazon.com/solutions/implementations/aws-security-hub-automated-response-and-remediation/). *There is no need to build the solution from source.*
67+
**Note**: If your goal is just to deploy the solution, please use the template on the [Automated Security Response on AWS Landing Page](https://aws.amazon.com/solutions/implementations/automated-security-response-on-aws/). *There is no need to build the solution from source.*
6868

6969
Detailed instructions for creating a new automated remediation in an existing Playbook can be found in the Implementation Guide. Instructions for creating an entirely new Playbook are below.
7070

@@ -174,7 +174,9 @@ AWS Solutions use two buckets: a bucket for global access to templates, which is
174174

175175
#### Build the solution
176176

177-
From the *deployment* folder in your cloned repo, run build-s3-dist.sh, passing the root name of your bucket (ex. mybucket) and the version you are building (ex. v1.0.0). We recommend using a semver version based on the version downloaded from GitHub (ex. GitHub: v1.0.0, your build: v1.0.0.mybuild)
177+
First ensure that you've run `npm install` in the *source* folder.
178+
179+
Next from the *deployment* folder in your cloned repo, run build-s3-dist.sh, passing the root name of your bucket (ex. mybucket) and the version you are building (ex. v1.0.0). We recommend using a semver version based on the version downloaded from GitHub (ex. GitHub: v1.0.0, your build: v1.0.0.mybuild)
178180

179181
```bash
180182
chmod +x build-s3-dist.sh
@@ -207,7 +209,7 @@ Use a tool such as the AWS S3 CLI "sync" command to upload your templates to the
207209

208210
## Deploy
209211

210-
See the [AWS Security Hub Automated Response and Remediation Implementation Guide](http://docs.aws.amazon.com/solutions/latest/aws-security-hub-automated-response-and-remediation/welcome.html) for deployment instructions, using the link to the SolutionDeployStack.template from your bucket, rather than the one for AWS Solutions. Ex. https://mybucket-reference.s3.amazonaws.com/aws-security-hub-automated-response-and-remediation/v1.3.0.mybuild/aws-sharr-deploy.template
212+
See the [Automated Security Response on AWS Implementation Guide](https://docs.aws.amazon.com/solutions/latest/automated-security-response-on-aws/solution-overview.html) for deployment instructions, using the link to the SolutionDeployStack.template from your bucket, rather than the one for AWS Solutions. Ex. https://mybucket-reference.s3.amazonaws.com/aws-security-hub-automated-response-and-remediation/v1.3.0.mybuild/aws-sharr-deploy.template
211213

212214
<a name="file-structure"></a>
213215
# File structure
@@ -220,7 +222,9 @@ aws-security-hub-automated-response-and-remediation uses AWS CDK for generating
220222
|-playbooks [ Playbooks CloudDevelopment Kit Code and lambda source code]
221223
|- AFSBP/ [ AFSBP v1.0.0 playbook code ]
222224
|- CIS120/ [ CIS v1.2.0 playbook code ]
225+
|- CIS140/ [ CIS v1.4.0 playbook code ]
223226
|- PCI321/ [ PCI-DSS v3.2.1 playbook code ]
227+
|- SC/ [ SC v2.0.0 playbook code ]
224228
|-remediation_runbooks [ Shared remediation runbooks ]
225229
|-solution_deploy [ Solution Cloud Development Kit node module ]
226230
|-test [ CDK unit tests ]
@@ -232,7 +236,7 @@ aws-security-hub-automated-response-and-remediation uses AWS CDK for generating
232236
This solution collects anonymous operational metrics to help AWS improve the
233237
quality of features of the solution. For more information, including how to disable
234238
this capability, please see the
235-
[Implementation Guide](https://docs.aws.amazon.com/solutions/latest/aws-security-hub-automated-response-and-remediation/collection-of-operational-metrics.html)
239+
[Implementation Guide](https://docs.aws.amazon.com/solutions/latest/automated-security-response-on-aws/collection-of-operational-metrics.html)
236240

237241
<a name="license"></a>
238242
# License

0 commit comments

Comments
 (0)