├── .gitignore ├── .github ├── CODEOWNERS ├── dependabot.yml └── workflows │ ├── publish.yml │ └── test_action.yaml ├── images ├── github.png ├── Critical.png ├── logo-arm.png ├── logo-cdk.png ├── logo-cf.png ├── logo-gdm.png ├── logo-k8s.png ├── logo-sam.png ├── icon-32x32.png ├── logo-docker.png ├── logo-grpc.png ├── logo-helm.png ├── logo-pulumi.png ├── logo-ansible.png ├── logo-knative.png ├── logo-nifcloud.png ├── logo-openapi.png ├── logo-opentofu.png ├── logo-crossplane.png ├── logo-databricks.png ├── logo-github-icon.png ├── logo-terraform.png ├── logo-dockercompose.png ├── logo-serverlessfw.png ├── logo-tencentcloud.png ├── annotations-preview.png └── logo-azure-blueprints.png ├── Dockerfile ├── test └── samples │ ├── positive2.tf │ └── positive1.tf ├── src ├── annotator.js ├── main.js └── commenter.js ├── package.json ├── entrypoint.sh ├── action.yml ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .vscode -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @checkmarx/kics 2 | -------------------------------------------------------------------------------- /images/github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/github.png -------------------------------------------------------------------------------- /images/Critical.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/Critical.png -------------------------------------------------------------------------------- /images/logo-arm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-arm.png -------------------------------------------------------------------------------- /images/logo-cdk.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-cdk.png -------------------------------------------------------------------------------- /images/logo-cf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-cf.png -------------------------------------------------------------------------------- /images/logo-gdm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-gdm.png -------------------------------------------------------------------------------- /images/logo-k8s.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-k8s.png -------------------------------------------------------------------------------- /images/logo-sam.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-sam.png -------------------------------------------------------------------------------- /images/icon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/icon-32x32.png -------------------------------------------------------------------------------- /images/logo-docker.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-docker.png -------------------------------------------------------------------------------- /images/logo-grpc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-grpc.png -------------------------------------------------------------------------------- /images/logo-helm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-helm.png -------------------------------------------------------------------------------- /images/logo-pulumi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-pulumi.png -------------------------------------------------------------------------------- /images/logo-ansible.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-ansible.png -------------------------------------------------------------------------------- /images/logo-knative.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-knative.png -------------------------------------------------------------------------------- /images/logo-nifcloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-nifcloud.png -------------------------------------------------------------------------------- /images/logo-openapi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-openapi.png -------------------------------------------------------------------------------- /images/logo-opentofu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-opentofu.png -------------------------------------------------------------------------------- /images/logo-crossplane.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-crossplane.png -------------------------------------------------------------------------------- /images/logo-databricks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-databricks.png -------------------------------------------------------------------------------- /images/logo-github-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-github-icon.png -------------------------------------------------------------------------------- /images/logo-terraform.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-terraform.png -------------------------------------------------------------------------------- /images/logo-dockercompose.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-dockercompose.png -------------------------------------------------------------------------------- /images/logo-serverlessfw.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-serverlessfw.png -------------------------------------------------------------------------------- /images/logo-tencentcloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-tencentcloud.png -------------------------------------------------------------------------------- /images/annotations-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/annotations-preview.png -------------------------------------------------------------------------------- /images/logo-azure-blueprints.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Checkmarx/kics-github-action/HEAD/images/logo-azure-blueprints.png -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM checkmarx/kics:v2.1.18 as kics-env 2 | 3 | FROM cgr.dev/chainguard/wolfi-base:latest 4 | 5 | COPY --from=kics-env /app /app 6 | 7 | COPY ./entrypoint.sh /entrypoint.sh 8 | 9 | RUN chmod +x /entrypoint.sh 10 | 11 | COPY ./ /app 12 | 13 | ENTRYPOINT ["/entrypoint.sh"] 14 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 2 | 3 | version: 2 4 | updates: 5 | # Maintain dependencies for Github Actions 6 | - package-ecosystem: "github-actions" 7 | directory: "/" 8 | schedule: 9 | interval: "weekly" 10 | # Maintain dependencies for docker 11 | - package-ecosystem: "docker" 12 | directory: "/" 13 | schedule: 14 | interval: "weekly" 15 | -------------------------------------------------------------------------------- /test/samples/positive2.tf: -------------------------------------------------------------------------------- 1 | resource "azurerm_resource_group" "positive1" { 2 | name = "resourceGroup1" 3 | location = "West US" 4 | } 5 | 6 | resource "azurerm_container_registry" "positive2" { 7 | name = "containerRegistry1" 8 | resource_group_name = azurerm_resource_group.rg.name 9 | location = azurerm_resource_group.rg.location 10 | sku = "Premium" 11 | admin_enabled = true 12 | georeplication_locations = ["East US", "West Europe"] 13 | } 14 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish kics GitHub Action 2 | 3 | # Run this workflow on Tags matching v* pattern and publish a new release 4 | on: 5 | push: 6 | tags: 7 | - 'v*' 8 | 9 | jobs: 10 | publish: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v6 14 | - uses: haya14busa/action-update-semver@v1 15 | with: 16 | major_version_tag_only: true 17 | - name: Create a Release 18 | uses: actions/create-release@v1 19 | env: 20 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token 21 | with: 22 | tag_name: ${{ github.ref }} 23 | release_name: ${{ github.ref }} 24 | -------------------------------------------------------------------------------- /test/samples/positive1.tf: -------------------------------------------------------------------------------- 1 | resource "azurerm_resource_group" "positive1" { 2 | name = "acceptanceTestResourceGroup1" 3 | location = "West US" 4 | } 5 | 6 | resource "azurerm_sql_server" "positive2" { 7 | name = "mysqlserver1" 8 | resource_group_name = "acceptanceTestResourceGroup1" 9 | location = "West US" 10 | version = "12.0" 11 | administrator_login = "4dm1n157r470r" 12 | administrator_login_password = "4-v3ry-53cr37-p455w0rd" 13 | } 14 | 15 | resource "azurerm_sql_active_directory_administrator" "positive3" { 16 | server_name = "mysqlserver2" 17 | resource_group_name = "acceptanceTestResourceGroup1" 18 | login = "sqladmin" 19 | tenant_id = data.azurerm_client_config.current.tenant_id 20 | object_id = data.azurerm_client_config.current.object_id 21 | } 22 | -------------------------------------------------------------------------------- /.github/workflows/test_action.yaml: -------------------------------------------------------------------------------- 1 | name: Test KICS action 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | 7 | jobs: 8 | test: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v6 12 | - run: mkdir -p myoutput 13 | - name: Test KICS action 14 | uses: ./ 15 | with: 16 | path: test/samples/positive1.tf,test/samples/positive2.tf 17 | token: ${{ secrets.GITHUB_TOKEN }} 18 | timeout: 60 19 | output_path: myoutput/ 20 | output_formats: sarif 21 | ignore_on_exit: results 22 | enable_comments: true 23 | enable_annotations: true 24 | enable_jobs_summary: true 25 | comments_with_queries: true 26 | excluded_column_for_comments_with_queries: "description_id,similarity_id,search_line,search_value,cis_description_id,cis_description_title,cis_description_text,cloud_provider" 27 | - run: ls -la && ls -la myoutput 28 | if: always() 29 | -------------------------------------------------------------------------------- /src/annotator.js: -------------------------------------------------------------------------------- 1 | const core = require("@actions/core"); 2 | 3 | function extractAnnotations(results) { 4 | let annotations = []; 5 | for (i in results.queries) { 6 | let query = results.queries[i]; 7 | for (j in query.files) { 8 | let file = query.files[j]; 9 | annotations.push({ 10 | file: file['file_name'], 11 | startLine: file['line'], 12 | endLine: file['line'], 13 | severity: query['severity'], 14 | queryName: query['query_name'], 15 | description: query['description'], 16 | }); 17 | } 18 | } 19 | 20 | return annotations; 21 | } 22 | 23 | function annotateChangesWithResults(results) { 24 | const annotations = extractAnnotations(results); 25 | annotations.forEach(annotation => { 26 | core.warning(annotation.description, { 27 | title: `[${annotation.severity}] ${annotation.queryName}`, 28 | startLine: annotation.startLine, 29 | endLine: annotation.endLine, 30 | file: annotation.file, 31 | }); 32 | }); 33 | 34 | } 35 | 36 | module.exports = { 37 | annotateChangesWithResults 38 | } 39 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "kics-github-action", 3 | "version": "1.0.0", 4 | "description": "[![License: GPL-3.0](https://img.shields.io/badge/License-GPL3.0-yellow.svg)](https://www.gnu.org/licenses) [![Latest Release](https://img.shields.io/github/v/release/checkmarx/kics-github-action)](https://github.com/checkmarx/kics-github-action/releases) [![Open Issues](https://img.shields.io/github/issues-raw/checkmarx/kics-github-action)](https://github.com/checkmarx/kics-github-action/issues)", 5 | "main": "index.js", 6 | "scripts": { 7 | "build": "ncc build src/main.js", 8 | "format": "prettier --write **/*.ts" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "git+https://github.com/Checkmarx/kics-github-action.git" 13 | }, 14 | "keywords": [], 15 | "author": "", 16 | "license": "GNU GENERAL PUBLIC LICENSE", 17 | "bugs": { 18 | "url": "https://github.com/Checkmarx/kics-github-action/issues" 19 | }, 20 | "homepage": "https://github.com/Checkmarx/kics-github-action#readme", 21 | "dependencies": { 22 | "@actions/core": "^1.10.1", 23 | "@actions/exec": "^1.1.0", 24 | "@actions/github": "^5.0.0", 25 | "@actions/io": "^1.1.1", 26 | "@actions/tool-cache": "^2.0.1", 27 | "moment": "^2.29.4", 28 | "uuid": "^8.3.2" 29 | }, 30 | "devDependencies": { 31 | "@vercel/ncc": "^0.36.1", 32 | "prettier": "^2.4.1", 33 | "@types/uuid": "^8.3.4" 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/main.js: -------------------------------------------------------------------------------- 1 | const commenter = require("./commenter"); 2 | const annotator = require("./annotator"); 3 | const core = require("@actions/core"); 4 | const github = require("@actions/github"); 5 | const io = require("@actions/io"); 6 | const filepath = require('path'); 7 | const fs = require("fs"); 8 | 9 | function readJSON(filename) { 10 | const rawdata = fs.readFileSync(filename); 11 | const parsedJSON = JSON.parse(rawdata.toString()); 12 | return parsedJSON; 13 | } 14 | 15 | function cleanupOutput(resultsJSONFile, outputFormats) { 16 | if (!outputFormats.toLowerCase().includes('json') || outputFormats === '') { 17 | io.rmRF(resultsJSONFile); 18 | } 19 | } 20 | 21 | function processOutputPath(output) { 22 | if (output === '') { 23 | return { 24 | path: "./", 25 | resultsJSONFile: "./results.json" 26 | } 27 | } 28 | 29 | return { 30 | path: output, 31 | resultsJSONFile: filepath.join(output, "/results.json") 32 | } 33 | } 34 | 35 | function setWorkflowStatus(statusCode) { 36 | console.log(`KICS scan status code: ${statusCode}`); 37 | 38 | if (statusCode === "0") { 39 | return; 40 | } 41 | 42 | core.setFailed(`KICS scan failed with exit code ${statusCode}`); 43 | } 44 | 45 | async function main() { 46 | console.log("Running KICS action..."); 47 | 48 | // Get ENV variables 49 | const githubToken = process.env.INPUT_TOKEN; 50 | let enableAnnotations = process.env.INPUT_ENABLE_ANNOTATIONS; 51 | let enableComments = process.env.INPUT_ENABLE_COMMENTS; 52 | let enableJobsSummary = process.env.INPUT_ENABLE_JOBS_SUMMARY; 53 | const commentsWithQueries = process.env.INPUT_COMMENTS_WITH_QUERIES; 54 | const excludedColumnsForCommentsWithQueries = process.env.INPUT_EXCLUDED_COLUMNS_FOR_COMMENTS_WITH_QUERIES.split(','); 55 | const outputPath = processOutputPath(process.env.INPUT_OUTPUT_PATH); 56 | const outputFormats = process.env.INPUT_OUTPUT_FORMATS; 57 | const exitCode = process.env.KICS_EXIT_CODE 58 | 59 | try { 60 | const octokit = github.getOctokit(githubToken); 61 | let context = {}; 62 | let repo = ''; 63 | let prNumber = ''; 64 | 65 | if (github.context) { 66 | context = github.context; 67 | if (context.repo) { 68 | repo = context.repo; 69 | } 70 | if (context.payload && context.payload.pull_request) { 71 | prNumber = context.payload.pull_request.number; 72 | } 73 | } 74 | 75 | enableAnnotations = enableAnnotations ? enableAnnotations : "false" 76 | enableComments = enableComments ? enableComments : "false" 77 | enableJobsSummary = enableJobsSummary ? enableJobsSummary : "false" 78 | 79 | const parsedResults = readJSON(outputPath.resultsJSONFile); 80 | if (enableAnnotations.toLocaleLowerCase() === "true") { 81 | annotator.annotateChangesWithResults(parsedResults); 82 | } 83 | if (enableComments.toLocaleLowerCase() === "true") { 84 | await commenter.postPRComment(parsedResults, repo, prNumber, octokit, commentsWithQueries.toLocaleLowerCase() === "true", excludedColumnsForCommentsWithQueries); 85 | } 86 | if (enableJobsSummary.toLocaleLowerCase() === "true") { 87 | await commenter.postJobSummary(parsedResults, commentsWithQueries.toLocaleLowerCase() === "true", excludedColumnsForCommentsWithQueries); 88 | } 89 | 90 | setWorkflowStatus(exitCode); 91 | cleanupOutput(outputPath.resultsJSONFile, outputFormats); 92 | } catch (e) { 93 | console.error(e); 94 | } 95 | } 96 | 97 | main(); 98 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/ash 2 | DATETIME="$(date '+%H:%M')" 3 | 4 | #################################### 5 | # Check if Scan Path is Present # 6 | #################################### 7 | if [ -z "$INPUT_PATH" ]; then 8 | echo "${DATETIME} - ERR input path can't be empty" 9 | exit 1 10 | else 11 | INPUT_PATH=$(echo $INPUT_PATH | sed -e 's/^"//' -e 's/"$//') 12 | INPUT_PARAM="-p $INPUT_PATH" 13 | fi 14 | 15 | ########################### 16 | # Set KICS Flags Values # 17 | ########################### 18 | [[ ! -z "$INPUT_PAYLOAD_PATH" ]] && PAYLOAD_PATH_PARAM="-d $INPUT_PAYLOAD_PATH" 19 | [[ ! -z "$INPUT_CONFIG_PATH" ]] && CONFIG_PATH_PARAM="--config $INPUT_CONFIG_PATH" 20 | [[ ! -z "$INPUT_EXCLUDE_PATHS" ]] && EXCLUDE_PATHS_PARAM="-e $INPUT_EXCLUDE_PATHS" 21 | [[ ! -z "$INPUT_EXCLUDE_RESULTS" ]] && EXCLUDE_RESULTS_PARAM="-x $INPUT_EXCLUDE_RESULTS" 22 | [[ ! -z "$INPUT_EXCLUDE_SEVERITIES" ]] && EXCLUDE_SEVERITIES_PARAM="--exclude-severities $INPUT_EXCLUDE_SEVERITIES" 23 | [[ ! -z "$INPUT_EXCLUDE_QUERIES" ]] && EXCLUDE_QUERIES_PARAM="--exclude-queries $INPUT_EXCLUDE_QUERIES" 24 | [[ ! -z "$INPUT_EXCLUDE_CATEGORIES" ]] && EXCLUDE_CATEGORIES_PARAM="--exclude-categories $INPUT_EXCLUDE_CATEGORIES" 25 | [[ ! -z "$INPUT_EXCLUDE_GITIGNORE" ]] && EXCLUDE_GITIGNORE="--exclude-gitignore" 26 | [[ ! -z "$INPUT_PLATFORM_TYPE" ]] && PLATFORM_TYPE_PARAM="--type $INPUT_PLATFORM_TYPE" 27 | [[ ! -z "$INPUT_FAIL_ON" ]] && FAIL_ON_PARAM="--fail-on $INPUT_FAIL_ON" 28 | [[ ! -z "$INPUT_TIMEOUT" ]] && TIMEOUT_PARAM="--timeout $INPUT_TIMEOUT" 29 | [[ ! -z "$INPUT_PROFILING" ]] && PROFILING_PARAM="--profiling $INPUT_PROFILING" 30 | [[ ! -z "$INPUT_BOM" ]] && BOM_PARAM="-m $INPUT_PROFILING" 31 | [[ ! -z "$INPUT_INCLUDE_QUERIES" ]] && INCLUDE_QUERIES_PARAM="-i $INPUT_PROFILING" 32 | [[ ! -z "$INPUT_DISABLE_SECRETS" ]] && DISABLE_SECRETS_PARAM="--disable-secrets" 33 | [[ ! -z "$INPUT_DISABLE_FULL_DESCRIPTIONS" ]] && DISABLE_FULL_DESCRIPTIONS_PARAM="--disable-full-descriptions" 34 | [[ ! -z "$INPUT_LIBRARIES_PATH" ]] && LIBRARIES_PATH_PARAM="-b $INPUT_LIBRARIES_PATH" 35 | [[ ! -z "$INPUT_SECRETS_REGEXES_PATH" ]] && SECRETS_REGEXES_PATH_PARAM="-r $INPUT_SECRETS_REGEXES_PATH" 36 | [[ ! -z "$INPUT_IGNORE_ON_EXIT" ]] && IGNORE_ON_EXIT_PARAM="--ignore-on-exit $INPUT_IGNORE_ON_EXIT" 37 | [[ ! -z "$INPUT_CLOUD_PROVIDER" ]] && CLOUD_PROVIDER="--cloud-provider $INPUT_CLOUD_PROVIDER" 38 | 39 | [[ ! -z "$INPUT_VERBOSE" ]] && VERBOSE_PARAM="-v" 40 | 41 | ####################### 42 | # Set Queries Path # 43 | ####################### 44 | if [ ! -z "$INPUT_QUERIES" ]; then 45 | QUERIES_PARAM="-q $INPUT_QUERIES" 46 | else 47 | QUERIES_PARAM="-q /app/bin/assets/queries" 48 | fi 49 | 50 | ############################################### 51 | # Add JSON as Report Format if not present # 52 | ############################################### 53 | if [ -n "$INPUT_OUTPUT_FORMATS" ]; then 54 | if [[ $INPUT_OUTPUT_FORMATS == *"json"* ]]; then 55 | OUTPUT_FORMATS_PARAM="--report-formats $INPUT_OUTPUT_FORMATS" 56 | else 57 | OUTPUT_FORMATS_PARAM="--report-formats $INPUT_OUTPUT_FORMATS,json" 58 | fi 59 | else 60 | OUTPUT_FORMATS_PARAM="--report-formats json" 61 | fi 62 | 63 | ############################ 64 | # Check for Output Path # 65 | ############################ 66 | 67 | CP_PATH="./results.json" 68 | if [ ! -z "$INPUT_OUTPUT_PATH" ]; then 69 | OUTPUT_PATH_PARAM="-o $INPUT_OUTPUT_PATH" 70 | CP_PATH=$INPUT_OUTPUT_PATH 71 | else 72 | OUTPUT_PATH_PARAM="-o ./" 73 | fi 74 | 75 | #################### 76 | # Run KICS Scan # 77 | #################### 78 | cd $GITHUB_WORKSPACE 79 | echo "${DATETIME} - INF : about to scan directory $INPUT_PATH" 80 | echo "${DATETIME} - INF : kics command kics $INPUT_PARAM $OUTPUT_PATH_PARAM $OUTPUT_FORMATS_PARAM $PLATFORM_TYPE_PARAM $PAYLOAD_PATH_PARAM $CONFIG_PATH_PARAM $EXCLUDE_PATHS_PARAM $EXCLUDE_CATEGORIES_PARAM $EXCLUDE_RESULTS_PARAM $EXCLUDE_SEVERITIES_PARAM $EXCLUDE_QUERIES_PARAM $EXCLUDE_GITIGNORE $QUERIES_PARAM $VERBOSE_PARAM $IGNORE_ON_EXIT_PARAM $FAIL_ON_PARAM $TIMEOUT_PARAM $PROFILING_PARAM $BOM_PARAM $INCLUDE_QUERIES_PARAM $DISABLE_SECRETS_PARAM $DISABLE_FULL_DESCRIPTIONS_PARAM $LIBRARIES_PATH_PARAM $SECRETS_REGEXES_PATH_PARAM $CLOUD_PROVIDER" 81 | /app/bin/kics scan --no-progress $INPUT_PARAM $OUTPUT_PATH_PARAM $OUTPUT_FORMATS_PARAM $PLATFORM_TYPE_PARAM $PAYLOAD_PATH_PARAM $CONFIG_PATH_PARAM $EXCLUDE_PATHS_PARAM $EXCLUDE_CATEGORIES_PARAM $EXCLUDE_RESULTS_PARAM $EXCLUDE_SEVERITIES_PARAM $EXCLUDE_QUERIES_PARAM $EXCLUDE_GITIGNORE $QUERIES_PARAM $VERBOSE_PARAM $IGNORE_ON_EXIT_PARAM $FAIL_ON_PARAM $TIMEOUT_PARAM $PROFILING_PARAM $BOM_PARAM $INCLUDE_QUERIES_PARAM $DISABLE_SECRETS_PARAM $DISABLE_FULL_DESCRIPTIONS_PARAM $LIBRARIES_PATH_PARAM $SECRETS_REGEXES_PATH_PARAM $CLOUD_PROVIDER 82 | 83 | export KICS_EXIT_CODE=$? 84 | 85 | cp -r "${CP_PATH}" "/app/" 86 | 87 | cd /app 88 | 89 | # install and run nodejs 90 | apk add --update nodejs npm 91 | npm ci 92 | npm run build --if-present 93 | node dist/index.js 94 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | # action.yml 2 | name: "KICS Github Action" 3 | description: "Run KICS scan against IaC projects" 4 | inputs: 5 | token: 6 | description: "The GITHUB_TOKEN for the current workflow run" 7 | required: false 8 | default: ${{github.token}} 9 | enable_annotations: 10 | required: false 11 | default: "true" 12 | description: "Enable annotations report" 13 | enable_comments: 14 | required: false 15 | default: "false" 16 | description: "Enable pull request report comments" 17 | enable_jobs_summary: 18 | required: false 19 | default: "false" 20 | description: "Enable report as jobs summary" 21 | comments_with_queries: 22 | required: false 23 | default: "false" 24 | description: "Add queries in th pull request report comments (available when enable_comments = true)" 25 | excluded_column_for_comments_with_queries: 26 | required: false 27 | default: "description_id,similarity_id,search_line,search_value" 28 | description: "Excluded columns for the comment with queries, accepts a comma separated list" 29 | path: 30 | description: "paths to a file or directories to scan, accepts a comma separated list" 31 | required: true 32 | ignore_on_exit: 33 | description: "defines which non-zero exit codes should be ignored (all, results, errors, none)" 34 | required: false 35 | fail_on: 36 | description: "comma separated list of which severities returns exit code !=0" 37 | required: false 38 | timeout: 39 | description: "number of seconds the query has to execute before being canceled" 40 | required: false 41 | profiling: 42 | description: "turns on profiler that prints resource consumption in the logs during the execution (CPU, MEM)" 43 | required: false 44 | config_path: 45 | description: "path to configuration file" 46 | required: false 47 | platform_type: 48 | description: "case insensitive list of platform types to scan" 49 | required: false 50 | exclude_paths: 51 | description: "exclude paths from scan, supports glob, quoted comma separated string example: './shouldNotScan/*,somefile.txt'" 52 | required: false 53 | exclude_queries: 54 | description: exclude queries by providing the query ID 55 | required: false 56 | exclude_categories: 57 | description: exclude categories by providing its name, can be provided multiple times or as a comma separated string 58 | required: false 59 | exclude_results: 60 | description: "exclude results by providing the similarity ID of a result" 61 | required: false 62 | exclude_severities: 63 | description: "exclude results by providing the severity of a result" 64 | required: false 65 | exclude_gitignore: 66 | description: "disables the exclusion of paths specified within .gitignore file" 67 | required: false 68 | output_formats: 69 | description: "formats in which the results report will be exported (json, sarif)" 70 | required: false 71 | output_path: 72 | description: "directory to store results report" 73 | required: false 74 | payload_path: 75 | description: "file path to store source internal representation in JSON format" 76 | required: false 77 | queries: 78 | description: 'path to directory with queries (default "./assets/queries")' 79 | required: false 80 | secrets_regexes_path: 81 | description: "path to secrets regex rules configuration file" 82 | required: false 83 | libraries_path: 84 | description: "path to directory with Rego libraries" 85 | required: false 86 | disable_full_descriptions: 87 | description: "disable request for full descriptions and use default vulnerability descriptions" 88 | required: false 89 | disable_secrets: 90 | description: "disable secrets detection" 91 | required: false 92 | type: 93 | description: "case insensitive comma-separated list of platform types to scan (Ansible, AzureResourceManager, CloudFormation, Dockerfile, Kubernetes, OpenAPI, Terraform)" 94 | required: false 95 | verbose: 96 | description: "verbose scan" 97 | required: false 98 | include_queries: 99 | description: "comma separated list of queries ID's to include, cannot be provided with query exclusion flags" 100 | required: false 101 | bom: 102 | description: "include bill of materials (BoM) in results output" 103 | required: false 104 | cloud_provider: 105 | description: "list of cloud providers to scan (alicloud, aws, azure, gcp)" 106 | required: false 107 | branding: 108 | icon: "shield" 109 | color: "green" 110 | runs: 111 | using: "docker" 112 | image: Dockerfile 113 | env: 114 | INPUT_TOKEN: ${{ inputs.token }} 115 | INPUT_OUTPUT_PATH: ${{ inputs.output_path }} 116 | INPUT_ENABLE_ANNOTATIONS: ${{ inputs.enable_annotations }} 117 | INPUT_ENABLE_COMMENTS: ${{ inputs.enable_comments }} 118 | INPUT_ENABLE_JOBS_SUMMARY: ${{ inputs.enable_jobs_summary }} 119 | INPUT_COMMENTS_WITH_QUERIES: ${{ inputs.comments_with_queries }} 120 | INPUT_EXCLUDED_COLUMNS_FOR_COMMENTS_WITH_QUERIES: ${{ inputs.excluded_column_for_comments_with_queries }} 121 | INPUT_OUTPUT_FORMATS: ${{ inputs.output_formats }} 122 | WORKSPACE_PATH: $GITHUB_WORKSPACE 123 | args: 124 | - ${{ inputs.path }} 125 | - ${{ inputs.fail_on }} 126 | - ${{ inputs.timeout }} 127 | - ${{ inputs.profiling }} 128 | - ${{ inputs.config }} 129 | - ${{ inputs.platform_type }} 130 | - ${{ inputs.exclude_paths }} 131 | - ${{ inputs.exclude_queries }} 132 | - ${{ inputs.include_queries }} 133 | - ${{ inputs.exclude_categories }} 134 | - ${{ inputs.exclude_results }} 135 | - ${{ inputs.exclude_severities }} 136 | - ${{ inputs.exclude_gitignore}} 137 | - ${{ inputs.output_formats }} 138 | - ${{ inputs.output_path }} 139 | - ${{ inputs.payload_path }} 140 | - ${{ inputs.queries }} 141 | - ${{ inputs.verbose }} 142 | - ${{ inputs.bom }} 143 | - ${{ inputs.ignore_on_exit }} 144 | - ${{ inputs.disable_secrets }} 145 | - ${{ inputs.disable_full_descriptions }} 146 | - ${{ inputs.libraries_path }} 147 | - ${{ inputs.secrets_regexes_path}} 148 | - ${{ inputs.cloud_provider}} 149 | -------------------------------------------------------------------------------- /src/commenter.js: -------------------------------------------------------------------------------- 1 | const moment = require('moment') 2 | const { summary } = require('@actions/core/lib/summary'); 3 | 4 | const kicsLogo = "https://user-images.githubusercontent.com/111127232/203838108-ad537fea-4573-495a-9619-18500ee81dd9.png" 5 | const severityOrder = ["CRITICAL","HIGH", "MEDIUM", "LOW", "INFO", "TRACE"]; 6 | const severityIcons = { 7 | "CRITICAL": "https://raw.githubusercontent.com/Checkmarx/kics-github-action/88fa5c6bfb020c2ad298af00c4cd5b8dfbced92d/images/Critical.png", 8 | "HIGH": "https://user-images.githubusercontent.com/23239410/92157087-97285600-ee32-11ea-988f-0aca12c4c126.png", 9 | "MEDIUM": "https://user-images.githubusercontent.com/23239410/92157093-98598300-ee32-11ea-83d7-af52251a011b.png", 10 | "LOW": "https://user-images.githubusercontent.com/23239410/92157091-98598300-ee32-11ea-8498-19bd7d62019b.png", 11 | "INFO": "https://user-images.githubusercontent.com/75368139/137872145-b13b5200-6919-43c2-a49b-d3fdbbc20f63.png", 12 | "TRACE": "https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png", 13 | } 14 | const emptyIcon = "https://user-images.githubusercontent.com/75368139/137874724-5118ebc4-9769-4eb2-923d-e4ca479f747f.png" 15 | 16 | function createComment(results, withQueries = false, excludedColumnsForCommentsWithQueries) { 17 | let message = "![kics-logo](" + kicsLogo + ")\n"; 18 | message += `\n**KICS version: ${results['kics_version']}**\n` 19 | 20 | message += "\n"; 21 | message += "\n"; 22 | message += "\n
\n\n"; 23 | 24 | message += "| | Category | Results |\n"; 25 | message += "| --- |--- | --- |\n"; 26 | let severityCounters = results['severity_counters'] 27 | for (let severity of severityOrder) { 28 | if (severity in severityCounters) { 29 | message += `| ![${severity}](${severityIcons[severity]}) | ${severity.toUpperCase()} | ${severityCounters[severity.toUpperCase()]} |\n`; 30 | } 31 | } 32 | message += `| ![TOTAL](${emptyIcon}) | TOTAL | ${results['total_counter']} |`; 33 | 34 | message += "\n\n\n\n"; 35 | 36 | message += "| Metric | Values |\n"; 37 | message += "| --- | --- |\n"; 38 | message += `| Files scanned ![placeholder](${emptyIcon}) | ${results['files_scanned']}\n`; 39 | message += `| Files parsed ![placeholder](${emptyIcon}) | ${results['files_parsed']}\n`; 40 | message += `| Files failed to scan ![placeholder](${emptyIcon}) | ${results['files_failed_to_scan']}\n`; 41 | message += `| Total executed queries ![placeholder](${emptyIcon}) | ${results['queries_total']}\n`; 42 | message += `| Queries failed to execute ![placeholder](${emptyIcon}) | ${results['queries_failed_to_execute']}\n`; 43 | message += `| Execution time ![placeholder](${emptyIcon}) | ${moment(results['end']).diff(moment(results['start']), 'seconds')}\n`; 44 | 45 | message += "\n
\n\n"; 46 | 47 | if (withQueries === false) { 48 | return message; 49 | } 50 | message += "### Queries Results\n" 51 | 52 | message += "\n"; 53 | message += "\n"; 54 | message += "\n
\n\n"; 55 | 56 | const flattenedQueries = computeFlattenedQueries(results) 57 | const headers = computeHeaders(flattenedQueries) 58 | 59 | const excludedColumns = [ 60 | "query_url", 61 | ... excludedColumnsForCommentsWithQueries 62 | ] 63 | 64 | // display header 65 | for (let i in headers) { 66 | if (excludedColumns.includes(headers[i])) { 67 | continue 68 | } 69 | let title = headers[i] 70 | .match(/([^\W_]+)/g) 71 | .map(v => v.charAt(0).toUpperCase() + v.substr(1).toLowerCase()) 72 | .join(" ") 73 | message += `| ${title}` 74 | } 75 | message += "|\n" 76 | 77 | // display line separation 78 | for (let i in headers) { 79 | if (excludedColumns.includes(headers[i])) { 80 | continue 81 | } 82 | message += "|:---" 83 | } 84 | message += "|\n" 85 | 86 | flattenedQueries.forEach(function (query) { 87 | headers.forEach(function (header) { 88 | if (excludedColumns.includes(header)) { 89 | return 90 | } 91 | if (query[header] === undefined) { 92 | message += "| " 93 | return 94 | } 95 | if (header === "query_name") { 96 | message += `| [${query[header]}](${query["query_url"]})` 97 | return 98 | } 99 | message += `| ${query[header].toString().replace("\n", " ")}` 100 | }) 101 | message += "|\n" 102 | }) 103 | 104 | message += "\n
\n\n"; 105 | 106 | return message; 107 | } 108 | 109 | function computeFlattenedQueries(results) { 110 | let flattenedQueries = [] 111 | for (let index in results["queries"]) { 112 | let value = results["queries"][index] 113 | const { ['files']: files, ...valueWithoutFiles } = value 114 | 115 | for (let idx in value["files"]) { 116 | flattenedQueries.push({...valueWithoutFiles, ...value["files"][idx]}) 117 | } 118 | } 119 | return flattenedQueries 120 | } 121 | 122 | function computeHeaders(flattenedQueries) { 123 | let tmpHeader = [] 124 | for (let ft in flattenedQueries) { 125 | tmpHeader = [ 126 | ... tmpHeader, 127 | ... Object.entries(flattenedQueries[ft]).map(v => v[0]) 128 | ] 129 | } 130 | return [...new Set(tmpHeader.map(v => v))] 131 | } 132 | 133 | async function postPRComment(results, repo, prNumber, octokit, commentWithQueries = false, excludedColumnsForCommentsWithQueries) { 134 | const message = createComment(results, commentWithQueries, excludedColumnsForCommentsWithQueries); 135 | 136 | const {data: comments} = await octokit.rest.issues.listComments({ 137 | ...repo, 138 | issue_number: prNumber, 139 | }); 140 | 141 | const comment = comments.find((comment) => { 142 | return ( 143 | comment.user.login === "github-actions[bot]" && 144 | comment.body.startsWith("![kics-logo](") 145 | ); 146 | }); 147 | 148 | if (comment) { 149 | await octokit.rest.issues.updateComment({ 150 | ...repo, 151 | comment_id: comment.id, 152 | body: message 153 | }); 154 | } else { 155 | await octokit.rest.issues.createComment({ 156 | ...repo, 157 | issue_number: prNumber, 158 | body: message 159 | }); 160 | } 161 | } 162 | 163 | async function postJobSummary(results, commentWithQueries = false, excludedColumnsForCommentsWithQueries) { 164 | const message = createComment(results, commentWithQueries, excludedColumnsForCommentsWithQueries); 165 | await summary.addRaw(message).write() 166 | } 167 | 168 | module.exports = { 169 | postPRComment, 170 | postJobSummary 171 | }; 172 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # KICS GitHub Action 2 | 3 | [![License: GPL-3.0](https://img.shields.io/badge/License-GPL3.0-yellow.svg)](https://www.gnu.org/licenses) 4 | [![Latest Release](https://img.shields.io/github/v/release/checkmarx/kics-github-action)](https://github.com/checkmarx/kics-github-action/releases) 5 | [![Open Issues](https://img.shields.io/github/issues-raw/checkmarx/kics-github-action)](https://github.com/checkmarx/kics-github-action/issues) 6 | 7 | - [KICS GitHub Action](#kics-github-action) 8 | - [Integrate KICS into your GitHub workflows](#integrate-kics-into-your-github-workflows) 9 | - [Supported Platforms](#supported-platforms) 10 | - [Please find more info in the official website: kics.io](#please-find-more-info-in-the-official-website-kicsio) 11 | - [Inputs](#inputs) 12 | - [Simple usage example](#simple-usage-example) 13 | - [Workflow failures](#workflow-failures) 14 | - [Don't fail on results](#dont-fail-on-results) 15 | - [Fail by severity usage example](#fail-by-severity-usage-example) 16 | - [Enabling Pull Request Comment](#enabling-pull-request-comment) 17 | - [PR Comment Example](#pr-comment-example) 18 | - [Annotations](#annotations) 19 | - [Profiling KICS](#profiling-kics) 20 | - [Uploading SARIF report](#uploading-sarif-report) 21 | - [Using configuration file](#using-configuration-file) 22 | - [How To Contribute](#how-to-contribute) 23 | - [License](#license) 24 | 25 | ## Integrate KICS into your GitHub workflows 26 | 27 | 28 | **KICS** (pronounced as 'kick-s') or **Kicscan** is an open source solution for static code analysis of Infrastructure as Code. 29 | 30 | **K**eeping **I**nfrastructure as **C**ode **S**ecure (in short **KICS**) is a must-have for any cloud native project. With KICS, finding security vulnerabilities, compliance issues, and infrastructure misconfigurations happens early in the development cycle, when fixing these is straightforward and cheap. 31 | 32 | It is as simple as running a CLI tool, making it easy to integrate into any project CI. 33 | 34 | #### Supported Platforms 35 | 36 | Terraform    37 | Kubernetes    38 | Docker    39 |
40 |
41 | CloudFormation    42 | Ansible    43 | Helm    44 |
45 |
46 | OpenAPI    47 | gRPC    48 | Azure Resource Manager    49 | Google Deployment Manager    50 |
51 |
52 | Cloud Deployment Kit    53 | SAM    54 | Docker Compose    55 | Knative    56 |
57 |
58 | Crossplane    59 | Pulumi    60 | ServerlessFW    61 |
62 |
63 | Azure BluePrints    64 | GitHub Workflows    65 | OpenTofu    66 | NIFCloud    67 | 68 | #### Beta Features 69 | Databricks    70 | TencentCloud    71 | 72 | In order to run the Databricks and TencentCloud queries, use the `--experimental-queries` flag when running KICS. 73 | 74 | Official documentation page docs.kics.io 75 | 76 | Ensure that you're using the latest KICS Github Action release when creating a workflow. 77 | 78 | ## Inputs 79 | 80 | | Variable | Example Value   | Description   | Type | Required | Default | 81 | |-------------------------------------------|--------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| -------- |--------------------------------------------------------| 82 | | enable_comments | true | Enable pull request report comments | Boolean | No | false | 83 | | enable_jobs_summary | true | Enable report as jobs summary | Boolean | No | false | 84 | | enable_annotations | true | Enable annotations report | Boolean | No | true | 85 | | comments_with_queries | true | Add queries in th pull request report comments (available when enable_comments = true) | Boolean | No | false | 86 | | excluded_column_for_comments_with_queries | description_id,similarity_id,search_line,search_value | Excluded columns for the comment with queries, accepts a comma separated list | String | No | description_id,similarity_id,search_line,search_value | 87 | | path | terraform/main.tf,Dockerfile | paths to a file or directories to scan, comma separated list | String | Yes | N/A | 88 | | ignore_on_exit | results | defines which non-zero exit codes should be ignored (all, results, errors, none) | String | No | none | 89 | | fail_on | high,medium | comma separated list of which severities returns exit code !=0 | String | No | high,medium,low,info | 90 | | timeout | 75 | number of seconds the query has to execute before being canceled | String | No | 60 | 91 | | profiling | CPU | turns on profiler that prints resource consumption in the logs during the execution (CPU, MEM) | String | No | N/A | 92 | | config_path | ./kics.config | path to configuration file | String | No | N/A | 93 | | platform_type | terraform,ansible | case insensitive list of platform types to scan | String | No | All platforms | 94 | | exclude_paths | ./shouldNotScan/*,somefile.txt | exclude paths from scan, supports glob, comma separated list | String | No | N/A | 95 | | exclude_queries | a227ec01-f97a-4084-91a4-47b350c1db54 | exclude queries by providing the query ID, comma separated list | String | No | N/A | 96 | | exclude_categories | 'Observability,Networking and Firewall' | exclude categories by providing its name, comma separated list | String | No | N/A | 97 | | exclude_results | 'd4a1fa80-d9d8-450f-87c2-e1f6669c41f8' | exclude results by providing the similarity ID of a result | String | No | N/A | 98 | | exclude_severities | 'info,low' | exclude results by providing the severity of a result | String | No | N/A | 99 | | exclude_gitignore (available only from KICS version 1.6) | | disables the exclusion of paths specified within .gitignore file | Boolean | No | false | 100 | | include_queries | a227ec01-f97a-4084-91a4-47b350c1db54 | include only specified list of queries to the scan, cannot be provided with query exclusion flags | String | No | N/A | 101 | | output_formats | 'json,sarif' | formats in which the results report will be exported | String | No | json | 102 | | output_path | myResults/ | file path to store result in json format | String | No | "./" | 103 | | payload_path | /tmp/mypayload.json | file path to store source internal representation in JSON format | String | No | N/A | 104 | | queries | | path to directory with queries (default "./assets/queries") | String | No | ./assets/queries downloaded with the binaries | 105 | | verbose | true | verbose scan | Boolean | No | false | 106 | | type | Ansible,Dockerfile | case insensitive comma-separated list of platform types to scan (Ansible, AzureResourceManager, CloudFormation, Dockerfile, Kubernetes, OpenAPI, Terraform) | String | No | all types | 107 | | bom | true | include bill of materials (BoM) in results.json output | Boolean | No | false | 108 | | disable_full_descriptions | false | disable request for full descriptions and use default vulnerability descriptions | Boolean | false | 109 | | disable_secrets | false | disable secrets detection | Boolean | false | 110 | | secrets_regexes_path | ./mydir/secrets-config.json | path to custom secrets regex rules configuration file | String | No | N/A | 111 | | libraries_path | ./myLibsDir | path to directory with Rego libraries | String | No | N/A | 112 | | cloud_provider | aws,azure | list of cloud providers to scan (alicloud, aws, azure, gcp) | String | No | N/A | 113 | 114 | 115 | ## Simple usage example 116 | 117 | ```yaml 118 | # Steps represent a sequence of tasks that will be executed as part of the job 119 | steps: 120 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 121 | - uses: actions/checkout@v3 122 | # Scan Iac with kics 123 | - name: run kics Scan 124 | uses: checkmarx/kics-github-action@v2.1.18 125 | with: 126 | # scanning two directories: ./terraform/ ./cfn-templates/ plus a single file 127 | path: 'terraform,cfn-templates,my-other-sub-folder/Dockerfile' 128 | output_path: myResults/ 129 | # Display the results in json format 130 | - name: display kics results 131 | run: | 132 | cat myResults/results.json 133 | ``` 134 | 135 | ## Workflow failures 136 | 137 | By default KICS will fail your workflow on any results found. 138 | 139 | ### Don't fail on results 140 | 141 | If you want KICS to ignore the results and return exit status code 0 unless a KICS engine error happens: 142 | 143 | ```yaml 144 | steps: 145 | - uses: actions/checkout@v3 146 | - name: run kics Scan 147 | uses: checkmarx/kics-github-action@v2.1.18 148 | with: 149 | path: 'terraform' 150 | ignore_on_exit: results 151 | output_path: myResults/ 152 | - name: display kics results 153 | run: | 154 | cat myResults/results.json 155 | ``` 156 | 157 | ### Fail by severity usage example 158 | 159 | If want your pipeline just to fail on HIGH and MEDIUM severity results and KICS engine execution errors: 160 | 161 | ```yaml 162 | steps: 163 | - uses: actions/checkout@v3 164 | - name: run kics Scan 165 | uses: checkmarx/kics-github-action@v2.1.18 166 | with: 167 | path: 'terraform,my-other-sub-folder/Dockerfile' 168 | fail_on: high,medium 169 | output_path: myResults/ 170 | - name: display kics results 171 | run: | 172 | cat myResults/results.json 173 | ``` 174 | 175 | ## Enabling Pull Request Comment 176 | 177 | `GITHUB_TOKEN` enables this github action to access github API and post comments in a pull request: 178 | 179 | ```yaml 180 | name: Test KICS action PR comment 181 | 182 | on: 183 | pull_request: 184 | 185 | jobs: 186 | test: 187 | runs-on: ubuntu-latest 188 | steps: 189 | - uses: actions/checkout@v3 190 | - name: run kics Scan 191 | uses: checkmarx/kics-github-action@v2.1.18 192 | with: 193 | path: test/samples/positive1.tf,test/samples/positive2.tf 194 | token: ${{ secrets.GITHUB_TOKEN }} 195 | output_path: myResults/ 196 | ignore_on_exit: results 197 | enable_comments: true 198 | ``` 199 | 200 | ### PR Comment Example 201 | 202 | 203 | KICS Logo 204 | 205 | **KICS version: 2.1.5** 206 | 207 | 208 | 209 |
210 | 211 | | | Category | Results | 212 | | --------------------------------------------------------------------------------------------------------------- | -------- | ------- | 213 | | ![HIGH](https://user-images.githubusercontent.com/23239410/92157087-97285600-ee32-11ea-988f-0aca12c4c126.png) | HIGH | 3 | 214 | | ![MEDIUM](https://user-images.githubusercontent.com/23239410/92157093-98598300-ee32-11ea-83d7-af52251a011b.png) | MEDIUM | 2 | 215 | | ![LOW](https://user-images.githubusercontent.com/23239410/92157091-98598300-ee32-11ea-8498-19bd7d62019b.png) | LOW | 0 | 216 | | ![INFO](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | INFO | 0 | 217 | | ![TRACE](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | TRACE | 0 | 218 | | ![TOTAL](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | TOTAL | 5 | 219 | 220 | 221 | 222 | | | Metric | Values | 223 | | -------------------------------------------------------------------------------------------------------------------- | ------------------------- | ------ | 224 | | ![placeholder](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | Files scanned | 2 | 225 | | ![placeholder](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | Files parsed | 2 | 226 | | ![placeholder](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | Files failed to scan | 0 | 227 | | ![placeholder](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | Total queries | 821 | 228 | | ![placeholder](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | Queries failed to execute | 0 | 229 | | ![placeholder](https://user-images.githubusercontent.com/23239410/92157090-97c0ec80-ee32-11ea-9b2e-aa6b32b03d54.png) | Execution time | 13s | 230 | 231 |
232 | 233 | 234 | ## Annotations 235 | 236 | After scanning, [kics-github-action](https://github.com/Checkmarx/kics-github-action) will add the results as annotations in a pull request: 237 | 238 | annotations-preview 239 | 240 | ## Profiling KICS 241 | 242 | You can only enable one profiler at a time, CPU or MEM. 243 | 244 | > 📝   Please note that execution time may be impacted by enabling performance profiler due to sampling 245 | 246 | ```yaml 247 | steps: 248 | - uses: actions/checkout@v3 249 | - name: run kics Scan 250 | uses: checkmarx/kics-github-action@v2.1.18 251 | with: 252 | path: 'terraform' 253 | profiling: MEM 254 | output_path: myResults/ 255 | - name: display kics results 256 | run: | 257 | cat myResults/results.json 258 | ``` 259 | 260 | ## Uploading SARIF report 261 | 262 | 263 | ```yaml 264 | name: scan with KICS and upload SARIF 265 | 266 | on: 267 | pull_request: 268 | branches: [master] 269 | 270 | jobs: 271 | kics-job: 272 | runs-on: ubuntu-latest 273 | name: kics-action 274 | steps: 275 | - name: Checkout repo 276 | uses: actions/checkout@v3 277 | - name: Mkdir results-dir 278 | # make sure results dir is created 279 | run: mkdir -p results-dir 280 | - name: Run KICS Scan with SARIF result 281 | uses: checkmarx/kics-github-action@v2.1.18 282 | with: 283 | path: 'terraform' 284 | # when provided with a directory on output_path 285 | # it will generate the specified reports file named 'results.{extension}' 286 | # in this example it will generate: 287 | # - results-dir/results.json 288 | # - results-dir/results.sarif 289 | ignore_on_exit: results 290 | output_path: results-dir 291 | platform_type: terraform 292 | output_formats: 'json,sarif' 293 | exclude_paths: "terraform/gcp/big_data.tf,terraform/azure" 294 | # seek query id in it's metadata.json 295 | exclude_queries: 0437633b-daa6-4bbc-8526-c0d2443b946e 296 | - name: Show results 297 | run: | 298 | cat results-dir/results.sarif 299 | cat results-dir/results.json 300 | - name: Upload SARIF file 301 | uses: github/codeql-action/upload-sarif@v3 302 | with: 303 | sarif_file: results-dir/results.sarif 304 | ``` 305 | 306 | ## Using configuration file 307 | 308 | Check [configuration file](https://github.com/Checkmarx/kics/blob/master/docs/configuration-file.md) reference for more options. 309 | 310 | ```yaml 311 | name: scan with KICS using config file 312 | 313 | on: 314 | pull_request: 315 | branches: [master] 316 | 317 | jobs: 318 | kics-job: 319 | runs-on: ubuntu-latest 320 | name: kics-action 321 | steps: 322 | - name: Checkout repo 323 | uses: actions/checkout@v3 324 | - name: Mkdir results-dir 325 | # make sure results dir is created 326 | run: mkdir -p results-dir 327 | - name: Create config file 328 | # creating a heredoc config file 329 | run: | 330 | cat <>kics.config 331 | { 332 | "exclude-categories": "Encryption", 333 | "exclude-paths": "terraform/gcp/big_data.tf,terraform/gcp/gcs.tf", 334 | "log-file": true, 335 | "minimal-ui": false, 336 | "no-color": false, 337 | "no-progress": true, 338 | "output-path": "./results-dir", 339 | "payload-path": "file path to store source internal representation in JSON format", 340 | "preview-lines": 5, 341 | "report-formats": "json,sarif", 342 | "type": "terraform", 343 | "verbose": true 344 | } 345 | EOF 346 | - name: Run KICS Scan using config 347 | uses: checkmarx/kics-github-action@v2.1.18 348 | with: 349 | path: 'terraform' 350 | config_path: ./kics.config 351 | - name: Upload SARIF file 352 | uses: github/codeql-action/upload-sarif@v3 353 | with: 354 | sarif_file: results-dir/results.sarif 355 | ``` 356 | ## How To Contribute 357 | 358 | We welcome [issues](https://github.com/checkmarx/kics-github-action/issues) to and [pull requests](https://github.com/checkmarx/kics-github-action/pulls) against this repository! 359 | 360 | # License 361 | 362 | KICS Github Action 363 | 364 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 365 | 366 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 367 | 368 | You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/. 369 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------