advanced-security-compliance
This Action was designed to allow users to configure their Risk threshold for security issues reported by GitHub Code Scanning, Secret Scanning and Dependabot Security.
Setup
Action
Here is how you can quickly setup advanced-security-compliance.
# Compliance
- name: Advance Security Compliance Action
uses: GeekMasher/[email protected]
Action Examples
CLI
The CLI tool primarily using pipenv to manage dependencies and pip virtual environments to not mismatch dependencies.
# Install dependencies and virtual environment
pipenv install
# [option] Install system wide
pipenv install --system
Once installed, you can just call the module using the following command(s):
# Using pipenv script
pipenv run main --help
# ... or
pipenv run python -m ghascompliance
CLI Examples
Policy as Code / PaC
Here is an example of using a simple yet cross-organization using Policy as Code:
# Compliance
- name: Advance Security Compliance Action
uses: GeekMasher/[email protected]
with:
# The owner/repo of where the policy is stored
policy: GeekMasher/security-queries
# The local (within the workspace) or repository
policy-path: policies/default.yml
# The branch you want to target
policy-branch: main
PaC Configuration file
The Policy as Code configuration file is very simple yet powerful allowing a user to define 4 types of rules per technologies you want to use.
# This is the technology you want to write a rule for
licensing:
# The four main rules types to do everything you need to do for all things
# compliance
# Warnings will always occur if the rule applies and continues executing to
# other rules.
warnings:
ids:
- Other
- NA
# Ignores are run next so if an ignored rule is hit that matches the level,
# it will be skipped
ignores:
ids:
- MIT License
# Conditions will only trigger and raise an error when an exact match is hit
conditions:
ids:
- GPL-2.0
names:
- tunnel-agent
# The simplest and ultimate rule which checks the severity of the alert and
# reports an issue if the level matches or higher (see PaC Levels for more info)
level: error
PaC Levels
There are many different levels of severities with the addition of all and none (self explanatory). When a level is selected like for example error, all higher level severities (critical and high in this example) will also be added.
- critical
- high
- error
- medium
- moderate
- low
- warning
- notes
PaC Rule Blocks
For each rule you can choose either or both of the two different criteria's matches; ids and names
You can also use imports to side load data from other files to supplement the data already in the rule block
codescanning:
conditions:
# When the `ids` of the technologies/tool alert matches any one of the ID's in
# the list specified, the rule will the triggered and report the alert.
ids:
# In this example case, the CodeQL rule ID below will always be reported if
# present event if the severity is low or even note.
- js/sql-injection
# Side note: Check to see what different tools consider id's verses names,
# for example `licensing` considers the "Licence" name itself as the id
# while the name of the package/library as the "name"
# `names` allows you to specify the names of alerts or packages.
names:
- "Missing rate limiting"
# The `imports` allows you to supplement your existing data with a list
# from a file on the system.
imports:
ids: "path/to/ids/supplement/file.txt"
names: "path/to/names/supplement/file.txt"
Wildcards
For both types of criteria matching you can use wildcards to easily match requirements in a quicker way. The matching is done using a Unix shell-style wildcards module called fnmatch which supports * for matching everything.
codescanning:
conditions:
ids:
- '*/sql-injection'
Time to Remediate
The feature allows a user to define a time frame to which a security alert/vulnerability of a certain severity has before the alert triggered a violation in the Action.
By default, if this section is not defined in any part of the policy then no checks are done. Existing policy files should act the same without the new section.
general:
# All other blocks will be inheriting the remediate section if they don't have
# their own defined.
remediate:
# Only `error`'s and above have got 7 days to remediate according to the
# policy. Any time before that, nothing will occur and post the remediation
# time frame the alert will be raised.
error: 7
codescanning:
# the `codescanning` block will inherit the `general` block
# ...
dependabot:
remediate:
# high and critical security issues
high: 7
# moderate security issues
moderate: 30
# all other security issues
all: 90
secretscanning:
remediate:
# All secrets by default are set to 'critical' severity so only `critical`
# or `all` will work
critical: 7
Time to Remediate Examples
Data Importing
Some things to consider when using imports:
- Imports appending to existing lists and do not replace a previously generated list.
- Imports are relative to:
Working DirectoryGitHub Action / CLI directoryCloned Repository Directory
- Imports are only allowed from a number of predefined paths to prevent loading data on the system (AKA, path traversal).
Licensing Notice
MIT License
Copyright (c) 2021 Mathew Payne
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
4 Dec 14, 2021
15 Nov 26, 2022
3 Oct 05, 2022
4 Aug 08, 2022
8 Jul 05, 2022
1 Feb 20, 2022
8 Nov 03, 2022
0 Jan 10, 2022
1 Nov 02, 2021
7 Feb 26, 2022
20 Apr 07, 2022
123 Jan 08, 2023
36 Dec 20, 2022
2 Jan 11, 2022
170 Dec 11, 2022
1 Jan 11, 2022
133 Dec 24, 2022
10 Dec 30, 2022
893 Jan 04, 2023
181 Jan 02, 2023