Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d2a8dac
feat(cfn-guard-action): Adding cfn guard run to pr linter
QuantumNeuralCoder Apr 11, 2025
a92e50c
feat(cfn-guard-action): Testing PR files changed testcase
QuantumNeuralCoder Apr 11, 2025
e3bbb21
feat(cfn-guard-action): Testing action
QuantumNeuralCoder Apr 11, 2025
cedaa29
feat(cfn-guard-action): Correcting input validation
QuantumNeuralCoder Apr 11, 2025
52656dd
feat(cfn-guard-action): test
QuantumNeuralCoder Apr 11, 2025
9467c57
feat(cfn-guard-action): test
QuantumNeuralCoder Apr 11, 2025
db2fa71
adding ReadMe
QuantumNeuralCoder Apr 11, 2025
9ab2a88
adding security guardian tool
QuantumNeuralCoder Apr 12, 2025
2c1516e
adding security guardian tool
QuantumNeuralCoder Apr 12, 2025
c4d7711
adding security guardian tool
QuantumNeuralCoder Apr 12, 2025
d1f9fdd
adding security guardian tool
QuantumNeuralCoder Apr 12, 2025
01be751
Update security-guardian.yml
moelasmar Apr 12, 2025
687452c
temp Update security-guardian.yml
moelasmar Apr 12, 2025
923bdd0
Update security-guardian.yml
moelasmar Apr 12, 2025
62b80d8
testing security-guardian.yml
moelasmar Apr 12, 2025
497f5d5
Removed unwanted integ files
QuantumNeuralCoder Apr 14, 2025
a8021a9
fetching full history since it failed in test with bad object
QuantumNeuralCoder Apr 14, 2025
80f41e3
Removing unwanted integ files. Adding a test file.
QuantumNeuralCoder Apr 14, 2025
4737586
test2 - s-g
QuantumNeuralCoder Apr 14, 2025
db4f8ca
modifying s-g action to minimize to required jobs
QuantumNeuralCoder Apr 14, 2025
b52d3d3
test s-g action
QuantumNeuralCoder Apr 14, 2025
cf0ddb7
clarifying documentation, license and removing workflow run dependency
QuantumNeuralCoder Apr 14, 2025
2c51d10
clarifying documentation, license and removing workflow run dependency
QuantumNeuralCoder Apr 14, 2025
d29abc9
Removing checkout@v4
QuantumNeuralCoder Apr 14, 2025
4dc17c9
Emojis everywhere. Thanks QCli
QuantumNeuralCoder Apr 14, 2025
c3edcd0
Formatting readme
QuantumNeuralCoder Apr 14, 2025
47e230a
Resolving fatal: not a git repository (or any of the parent directori…
QuantumNeuralCoder Apr 14, 2025
e47ce0a
Removing action.yml since this is not planned standalone
QuantumNeuralCoder Apr 14, 2025
b4e9d8d
Adding action.yml required by cfn-guard
QuantumNeuralCoder Apr 14, 2025
ea70076
Resolving codecov upload issue
QuantumNeuralCoder Apr 14, 2025
dde70db
Resolving codecov upload issue
QuantumNeuralCoder Apr 14, 2025
55ba67a
on pull_request_target for broader access
QuantumNeuralCoder Apr 14, 2025
1cae91b
Resolving codecov upload issue
QuantumNeuralCoder Apr 14, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ jobs:
runs-on: ubuntu-latest
permissions:
id-token: write
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
67 changes: 67 additions & 0 deletions .github/workflows/security-guardian.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Security Guardian
on:
pull_request_target: {}

jobs:
run-security-guardian:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetches full history

- name: Get list of changed .template.json files
id: filter_files
run: |
echo "Getting changed CloudFormation templates..."
mkdir -p changed_templates

git fetch origin main --depth=1

base_sha="${{ github.event.pull_request.base.sha }}"
head_sha="${{ github.event.pull_request.head.sha }}"
if [[ -z "$base_sha" ]]; then base_sha=$(git merge-base origin/main HEAD); fi
if [[ -z "$head_sha" ]]; then head_sha=HEAD; fi

git diff --name-status "$base_sha" "$head_sha" \
| grep -E '^(A|M)\s+.*\.template\.json$' \
| awk '{print $2}' > changed_files.txt || true

while IFS= read -r file; do
if [ -f "$file" ]; then
safe_name=$(echo "$file" | sed 's|/|_|g')
cp "$file" "changed_templates/$safe_name"
else
echo "::warning::Changed file not found in workspace: $file"
fi
done < changed_files.txt

if [ -s changed_files.txt ]; then
echo "files_changed=true" >> $GITHUB_OUTPUT
else
echo "files_changed=false" >> $GITHUB_OUTPUT
fi

- name: Install cfn-guard
if: steps.filter_files.outputs.files_changed == 'true'
run: |
mkdir -p $HOME/.local/bin
curl -L -o cfn-guard.tar.gz https://github.com/aws-cloudformation/cloudformation-guard/releases/latest/download/cfn-guard-v3-x86_64-ubuntu-latest.tar.gz
tar -xzf cfn-guard.tar.gz
mv cfn-guard-v3-*/cfn-guard $HOME/.local/bin/cfn-guard
chmod +x $HOME/.local/bin/cfn-guard
echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: Install & Build security-guardian
if: steps.filter_files.outputs.files_changed == 'true'
run: yarn install --frozen-lockfile && cd tools/@aws-cdk/security-guardian && yarn build

- name: Run cfn-guard if templates changed
if: steps.filter_files.outputs.files_changed == 'true'
uses: ./tools/@aws-cdk/security-guardian
with:
data_directory: './changed_templates'
rule_set_path: './tools/@aws-cdk/security-guardian/rules/trust_scope_rules.guard'
show_summary: 'fail'
output_format: 'single-line-summary'
5 changes: 5 additions & 0 deletions tools/@aws-cdk/security-guardian/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.js
*.js.map
*.d.ts
dist
node_modules
201 changes: 201 additions & 0 deletions tools/@aws-cdk/security-guardian/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2018-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
71 changes: 71 additions & 0 deletions tools/@aws-cdk/security-guardian/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Security Guardian

A GitHub Action tool designed to
- detect broadly scoped inline policies in `*.template.json` files in incoming PRs and validate changed AWS CloudFormation templates against custom [cfn-guard](https://github.com/aws-cloudformation/cloudformation-guard) rules. Supports local paths for custom rule sets.
- [in future] detect broadly scoped CFN intrinsic statements

---

## Features

- Validates only changed `*.template.json` files in PRs
- Supports `cfn-guard v3`
- Accepts rules from a local file or remote URL
- Outputs validation results in summary format

---

## Inputs

| Name | Description | Required | Default |
|------------------|-------------------------------------------------------------------|----------|-----------------------|
| `data_directory` | Directory containing templates to validate | Yes | |
| `rule_file_path` | Local path to the rules file | Yes | |
| `show_summary` | Whether to show summary output (`fail`, `warn`, `none`) | No | `fail` |
| `output_format` | Output format (`single-line-summary`, `json`, etc.) | No | `single-line-summary` |

> `data_directory` and `rule_file_path` must be set.

---

## Usage

```yaml
- name: Run CFN Guard
uses: ./tools/@aws-cdk/security-guardian
with:
data_directory: './changed_templates'
rule_set_path: './tools/@aws-cdk/security-guardian/rules/trust_scope_rules.guard'
show_summary: 'fail'
output_format: 'single-line-summary'
```

---

## Local Development

### 1. Build
```bash
npm install
npm run build
```

### 2. Run Locally
```bash
node dist/index.js \
--data_directory=./changed_templates \
--rule_file_path=./rules.guard \
--output_format=single-line-summary \
--show_summary=fail
```

---

## Acknowledgments

Built on top of [cfn-guard](https://github.com/aws-cloudformation/cloudformation-guard) and [GitHub Actions Toolkit](https://github.com/actions/toolkit).

---

Happy Guarding!

26 changes: 26 additions & 0 deletions tools/@aws-cdk/security-guardian/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 'Security Guardian'
description: 'Security Guardian for custom or granular guard rules'

inputs:
data_directory:
description: "Path to CloudFormation templates"
required: true
rule_set_path:
description: "Path to a single .guard file locally"
required: true
show_summary:
description: "cfn-guard summary output. Options are all, pass, fail, skip or none"
required: false
default: "fail"
output_format:
description: "cfn-guard output format. Options: json, yaml, single-line-summary"
required: false
default: "single-line-summary"

runs:
using: node20
main: dist/index.js

branding:
icon: shield
color: red
Loading
Loading