├── .github └── workflows │ ├── update_tags.yml │ ├── regression.yml │ └── release.yml ├── .gitignore ├── security.md ├── README.md ├── LICENSE └── action.yml /.github/workflows/update_tags.yml: -------------------------------------------------------------------------------- 1 | name: Keep the versions up-to-date 2 | 3 | on: 4 | release: 5 | types: [published, edited] 6 | 7 | permissions: 8 | contents: write 9 | jobs: 10 | actions-tagger: 11 | runs-on: "ubuntu-latest" 12 | steps: 13 | - uses: Actions-R-Us/actions-tagger@330ddfac760021349fef7ff62b372f2f691c20fb 14 | with: 15 | publish_latest_tag: false -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | #*.jar 15 | *.war 16 | *.nar 17 | *.ear 18 | *.zip 19 | *.tar.gz 20 | *.rar 21 | 22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 23 | hs_err_pid* 24 | 25 | .idea -------------------------------------------------------------------------------- /.github/workflows/regression.yml: -------------------------------------------------------------------------------- 1 | name: Contrast Audit Action Regression 2 | on: 3 | pull_request: 4 | branches: 5 | - releases/v1 6 | jobs: 7 | trigger_tests: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Trigger Tests and Wait 11 | uses: convictional/trigger-workflow-and-wait@v1.6.1 12 | with: 13 | owner: Contrast-Security-Inc 14 | repo: contrast-github-actions-regression 15 | github_token: ${{ secrets.SCAN_PAT }} 16 | ref: master 17 | client_payload: '{"branch_name": "${{ github.event.pull_request.head.ref }}","trigger_repo_url": "${{ github.event.repository.html_url }}","trigger_commit_url": "${{ github.event.head_commit.url }}"}' 18 | workflow_file_name: test-run-audit.yml 19 | wait_interval: 10 20 | propagate_failure: true 21 | trigger_workflow: true 22 | wait_workflow: true 23 | -------------------------------------------------------------------------------- /security.md: -------------------------------------------------------------------------------- 1 | # Reporting Security Issues 2 | 3 | Contrast takes security vulnerabilities seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. 4 | 5 | To report a security issue, please see our official [Vulnerability Disclosure Policy 6 | ](https://www.contrastsecurity.com/disclosure-policy) 7 | 8 | Contrast will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. 9 | 10 | Report security bugs in third-party modules to the person or team maintaining the module. 11 | 12 | ## Learning More About Security 13 | 14 | To learn more about securing your applications with Contrast, please see the [our docs](https://docs.contrastsecurity.com/?lang=en). 15 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: create-release 2 | 3 | 4 | on: 5 | workflow_dispatch: 6 | pull_request: 7 | branches: 8 | - 'main' 9 | types: 10 | - closed 11 | 12 | 13 | permissions: 14 | contents: write 15 | jobs: 16 | tagged-release: 17 | name: "Tagged Release" 18 | runs-on: "ubuntu-latest" 19 | steps: 20 | - uses: actions/checkout@v2.3.3 21 | with: 22 | fetch-depth: 0 23 | 24 | - name: Git Version 25 | id: version 26 | uses: codacy/git-version@80c816f11db8dea5e3a81025f598193015b51832 27 | with: 28 | release-branch: main 29 | prefix: v 30 | 31 | - name: Create Release 32 | uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 33 | with: 34 | tag_name: ${{ steps.version.outputs.version }} 35 | token: ${{secrets.SCA_OSS_PAT}} # Used so pipeline gets triggered from this one 36 | #See https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Use Contrast Security SCA to find your vulnerable dependencies 2 | This GitHub action lets you use Contrast Security to detect vulnerable dependencies in your code. The action looks at project configuration files, identifies vulnerable dependencies and provides guidance on the versions to update. 3 | 4 | ## Initial steps for using the action 5 | If you are not familiar with GitHub actions read the 6 | [GitHub Actions](https://docs.github.com/en/actions) documentation to learn what GitHub Actions are and how to set them 7 | up. After which, complete the following steps: 8 | 9 | 1. Configure the following GitHub secrets CONTRAST_API_KEY, CONTRAST_ORGANIZATION_ID, CONTRAST_AUTH_HEADER and CONTRAST_API_URL 10 | 11 | image 12 | 13 | - **CodeSec by Contrast Security users:** Retrieve authentication details for the secrets using the CLI. 14 | - Installation instructions here : [https://www.contrastsecurity.com/developer/codesec](https://www.contrastsecurity.com/developer/codesec) 15 | - If you are a new user, create an account with the 'contrast auth' command 16 | - Run the 'contrast config' command in the CLI to collect the required credentials 17 | 18 | image 19 | 20 | - **Licensed Contrast Security users:** Get your authentication details for the secrets from the 'User Settings' menu in the Contrast web interface: You will need the following 21 | - Organization ID 22 | - Your API key 23 | - Authorization header 24 | - You will also need the URL of your Contrast UI host. This input includes the protocol section of the URL (https://). 25 | 26 | image 27 | 28 | 2. Copy one of the sample workflows below and create a branch of your code to add Contrast Security SCA. This branch is typically located at `.github/workflows/build.yml` 29 | 30 | 3. Update the workflow file to specify when the action should run (for example on pull_request, on push) 31 | 32 | ```yaml 33 | on: 34 | pull_request: 35 | branches: 36 | - "main" 37 | ``` 38 | 4. Update the filepath in the workflow file to specfy the location of the project configuration file where dependencies are declared 39 | 40 | ```yaml 41 | filePath: package.json 42 | ``` 43 | 44 | 5. To fail based on severity of CVEs found set severity (critical/high/medium or low) and fail to true 45 | 46 | ```yaml 47 | severity: medium 48 | fail: true 49 | ``` 50 | 51 | 6. After committing, create a Pull Request (PR) to merge the update back to your main branch. Creating the PR triggers the Contrast Security SCA action to run. 52 | 53 | 54 | ## Usage 55 | 56 | The following are sample workflows to get started in Java, Node, PHP. 57 | 58 | ### Java 59 | 60 | ```yaml 61 | name: Contrast Security SCA 62 | on: 63 | push: 64 | branches: 65 | - "main" 66 | jobs: 67 | Check-Dependency-Vulnerabilities: 68 | runs-on: ubuntu-latest 69 | steps: 70 | - uses: actions/checkout@v3 71 | 72 | - name: Set up JDK 11 73 | uses: actions/setup-java@v3 74 | with: 75 | java-version: '11' 76 | distribution: 'adopt' 77 | 78 | - name: build jar 79 | run: | 80 | mvn clean install -DskipTests 81 | 82 | - name: Contrast SCA Action 83 | uses: Contrast-Security-OSS/contrast-sca-action@v1 84 | with: 85 | apiKey: ${{ secrets.CONTRAST_API_KEY }} 86 | orgId: ${{ secrets.CONTRAST_ORGANIZATION_ID }} 87 | authHeader: ${{ secrets.CONTRAST_AUTH_HEADER }} 88 | apiUrl: ${{ secrets.CONTRAST_API_URL }} 89 | filePath: mypath/to/config/files 90 | severity: medium 91 | fail: true 92 | ``` 93 | 94 | ### Node 95 | 96 | ```yaml 97 | name: Contrast Security SCA 98 | 99 | on: 100 | pull_request: 101 | branches: 102 | - "main" 103 | 104 | jobs: 105 | Check-Dependency-Vulnerabilities: 106 | runs-on: ubuntu-latest 107 | steps: 108 | # Checkout/build your application/install Node 109 | - uses: actions/checkout@v3 110 | 111 | - name: Contrast SCA Action 112 | uses: Contrast-Security-OSS/contrast-sca-action@v1 113 | with: 114 | apiKey: ${{ secrets.CONTRAST_API_KEY }} 115 | orgId: ${{ secrets.CONTRAST_ORGANIZATION_ID }} 116 | authHeader: ${{ secrets.CONTRAST_AUTH_HEADER }} 117 | apiUrl: ${{ secrets.CONTRAST_API_URL }} 118 | filePath: mypath/to/config/files 119 | severity: medium 120 | fail: true 121 | 122 | ``` 123 | 124 | ### PHP 125 | 126 | ```yaml 127 | name: Contrast Security SCA 128 | 129 | on: 130 | push: 131 | branches: 132 | - "main" 133 | 134 | jobs: 135 | Check-Dependency-Vulnerabilities: 136 | runs-on: ubuntu-latest 137 | steps: 138 | # Check out/build your application 139 | - uses: actions/checkout@v3 140 | 141 | # Install composer 142 | - uses: php-actions/composer@v6 143 | 144 | - name: Contrast SCA Action 145 | uses: Contrast-Security-OSS/contrast-sca-action@v1 146 | with: 147 | apiKey: ${{ secrets.CONTRAST_API_KEY }} 148 | orgId: ${{ secrets.CONTRAST_ORGANIZATION_ID }} 149 | authHeader: ${{ secrets.CONTRAST_AUTH_HEADER }} 150 | apiUrl: ${{ secrets.CONTRAST_API_URL }} 151 | filePath: mypath/to/config/files 152 | severity: medium 153 | fail: true 154 | 155 | ``` 156 | 157 | - **Supported languages and their requirements:** 158 | - **Java:** pom.xml and Maven build platform including the dependency plugin 159 | *or* build.gradle and gradle dependencies or ./gradlew dependencies must be 160 | supported 161 | - **.NET core:** MSBuild 15.0 or greater and a 162 | packages.lock.json file. 163 | Note: If the packages.lock.json file is unavailable it can be generated by 164 | setting RestorePackagesWithLockFile to true within each *.csproj file and 165 | running dotnet build. 166 | - **Node:** package.json and a lock file (either .package-lock.json or .yarn.lock.) 167 | - **Ruby:** gemfile and gemfile.lock 168 | - **Python:** pipfile and pipfile.lock 169 | - **Go:** go.mod 170 | - **PHP:** composer.json and composer.lock 171 | 172 | All Contrast Security related account secrets should be configured as GitHub secrets and will be passed via environment variables in the GitHub runner. 173 | 174 | This section details the various inputs you can use with this Contrast Security GitHub Action. Inputs marked as "required" must be provided for the action to function correctly. 175 | 176 | ## Inputs 177 | 178 | ### Required Inputs 179 | 180 | - apiKey: An agent API key provided by Contrast (required). 181 | - authHeader: User authorization credentials provided by Contrast (required). 182 | - orgId: The ID of your organization in Contrast (required). 183 | - filePath: Specify the directory in which to search for project configuration files (required). 184 | 185 | ### Command Input 186 | 187 | - command: Command to run cli with audit/fingerprint/sarif (optional, defaults to "audit") 188 | ### Optional Inputs 189 | 190 | - repositoryId: The ID of your repo. (optional) 191 | - projectGroupId: The ID of your project Groups. (optional) 192 | - applicationId: The ID of your application. (optional) 193 | - apiUrl: The name of the host. Includes the protocol section of the URL (https://). Defaults to https://ce.contrastsecurity.com. (optional, defaults to "https://ce.contrastsecurity.com") 194 | - severity: Allows user to report libraries with vulnerabilities above a chosen severity level. Values for level are high, medium or low. (Note: Use this input in combination with the fail input, otherwise the action will exit) (optional, defaults to "CRITICAL")   195 | - fail: When set to true, fails the action if CVEs have been detected that match at least the severity option specified. (optional) 196 | - ignoreDev: When set to true, excludes developer dependencies from the results. (optional) 197 | - outputSummary: Defaults to true. When set to true, writes the output of the audit to the GitHub Actions Summary. (optional, defaults to "true") 198 | - repoUrl: When set, will pass the optional repo url parameter to the contrast cli (optional) 199 | - repoName: When set, will pass the optional repo name parameter to the contrast cli (optional) 200 | - externalId: When set, will pass the optional external id parameter to the contrast cli (optional) 201 | - auditTimeout: Sets the timeout for an audit in seconds, Default: 600 (10 minutes) (optional, defaults to "600") 202 | - metadata: Metadata filter to be passed to the Contrast CLI when running sarif command (optional) 203 | - ghasEnabled: When set to true, will upload sarif to the GHAS integration (optional, defaults to "true") 204 | - legacy: When set to true, uses the legacy audit command. (optional) 205 | - modifier: When set this will be added as a suffix to the output file names for logs and sboms uploaded to the summary page. (optional, defaults to a random string) 206 | - resourceGroup: Name of the resource group for a new project to be associated with. 207 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [2021] [Contrast Security, Inc] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Contrast Security SCA' 2 | description: 'Contrast Source Composition Analysis' 3 | outputs: 4 | fingerprint: 5 | description: "Output from the fingerprint command" 6 | value: ${{ steps.run-fingerprint.outputs.fingerprint }} 7 | inputs: 8 | apiKey: 9 | description: 'An agent API key provided by Contrast (required).' 10 | required: true 11 | authHeader: 12 | description: 'User authorization credentials provided by Contrast (required).' 13 | required: true 14 | orgId: 15 | description: 'The ID of your organization in Contrast (required).' 16 | required: true 17 | filePath: 18 | description: 'Specify the directory in which to search for project configuration files (required).' 19 | required: true 20 | repositoryId: 21 | description: 'The ID of your repo.' 22 | required: false 23 | projectGroupId: 24 | description: 'The ID of your project Groups.' 25 | required: false 26 | applicationId: 27 | description: 'The ID of your application.' 28 | required: false 29 | apiUrl: 30 | description: 'The name of the host. Includes the protocol section of the URL (https://). Defaults to https://ce.contrastsecurity.com. (optional)' 31 | required: false 32 | default: "https://ce.contrastsecurity.com" 33 | severity: 34 | description: 'Allows user to report libraries with vulnerabilities above a chosen severity level. Values for level are high, medium or low. (Note: Use this input in combination with the fail input, otherwise the action will exit)' 35 | required: false 36 | default: "CRITICAL" 37 | fail: 38 | description: 'When set to true, fails the action if CVEs have been detected that match at least the severity option specified.' 39 | required: false 40 | ignoreDev: 41 | description: 'When set to true, excludes developer dependencies from the results.' 42 | required: false 43 | outputSummary: 44 | description: 'Defaults to true. When set to true, writes the output of the audit to the GitHub Actions Summary.' 45 | required: false 46 | default: 'true' 47 | proxy: 48 | description: 'When set will pass the proxy url to the contrast cli' 49 | required: false 50 | repoUrl: 51 | description: 'When set, will pass the optional repo url parameter to the contrast cli' 52 | required: false 53 | repoName: 54 | description: 'When set, will pass the optional repo name parameter to the contrast cli' 55 | required: false 56 | externalId: 57 | description: 'When set, will pass the optional external id parameter to the contrast cli' 58 | required: false 59 | auditTimeout: 60 | description: 'Sets the timeout for an audit in seconds, Default: 600 (10 minutes)' 61 | required: false 62 | default: '600' 63 | metadata: 64 | description: 'Metadata filter to be passed to the Contrast CLI when running sarif command' 65 | required: false 66 | ghasEnabled: 67 | description: 'When set to true, will upload sarif to the GHAS integration' 68 | required: false 69 | default: 'true' 70 | legacy: 71 | description: 'When set to true, uses the legacy audit command.' 72 | required: false 73 | modifier: 74 | description: 'When set this will be added as a suffix to the output file name.' 75 | required: false 76 | name: 77 | description: 'Contrast project name. If not specified, Contrast uses the file folder name to identify the project or creates a new project' 78 | required: false 79 | resourceGroup: 80 | description: 'Resource group to assign newly created projects to' 81 | required: false 82 | 83 | command: 84 | description: 'Command to run cli with audit/fingerprint/sarif' 85 | required: false 86 | default: audit 87 | 88 | runs: 89 | using: "composite" 90 | steps: 91 | - name: Get Latest CLI 92 | run: | 93 | echo "Downloading Contrast CLI 3.2.4" 94 | curl --location 'https://pkg.contrastsecurity.com/artifactory/cli/v2/3.2.4/linux/contrast' --output contrast 95 | shell: bash 96 | - run: chmod +x contrast 97 | shell: bash 98 | 99 | - name: Get CLI Required Arguments 100 | id: required-args 101 | shell: bash 102 | run: | 103 | echo "Setting Required Args..." 104 | args=() 105 | args+=("--api-key ${{ inputs.apiKey }}") 106 | args+=("--authorization ${{ inputs.authHeader }}") 107 | args+=("--organization-id ${{ inputs.orgId }}") 108 | args+=("--host ${{ inputs.apiUrl }}") 109 | 110 | echo "args=${args[@]}" >> $GITHUB_OUTPUT 111 | 112 | - name: Get CLI Optional Arguments 113 | id: optional-args 114 | shell: bash 115 | run: | 116 | echo "Setting Optional Args..." 117 | args=() 118 | if [ -n "${{ inputs.repositoryId }}" ]; then 119 | args+=("--repository-id") 120 | args+=("${{ inputs.repositoryId }}") 121 | fi 122 | if [ -n "${{ inputs.repoUrl }}" ]; then 123 | args+=("--repository-url") 124 | args+=("${{ inputs.repoUrl }}") 125 | fi 126 | if [ -n "${{ inputs.repoName }}" ]; then 127 | args+=("--repository-name") 128 | args+=("${{ inputs.repoName }}") 129 | fi 130 | if [ -n "${{ inputs.externalId }}" ]; then 131 | args+=("--external-id") 132 | args+=("${{ inputs.externalId }}") 133 | fi 134 | if [ -n "${{inputs.filePath}}" ]; then 135 | args+=("--file") 136 | args+=("${{ inputs.filePath }}") 137 | fi 138 | if [ "${{ inputs.command}}" = 'audit' ]; then 139 | args+=("--severity") 140 | args+=("${{ inputs.severity }}") 141 | args+=("--timeout") 142 | args+=("${{ inputs.auditTimeout }}") 143 | fi 144 | if [ "${{ inputs.command}}" = 'sarif' ]; then 145 | args+=("--severity") 146 | args+=("${{ inputs.severity }}") 147 | fi 148 | if [ -n "${{inputs.metadata}}" ]; then 149 | args+=("--metadata") 150 | args+=("${{ inputs.metadata }}") 151 | fi 152 | if [ -n "${{inputs.applicationId}}" ]; then 153 | args+=("--application-id") 154 | args+=("${{ inputs.applicationId }}") 155 | fi 156 | if [ -n "${{inputs.projectGroupId}}" ]; then 157 | args+=("--project-group-id") 158 | args+=("${{ inputs.projectGroupId }}") 159 | fi 160 | if [ "${{inputs.fail}}" = true ]; then 161 | args+=("--fail") 162 | fi 163 | if [ "${{inputs.ignoreDev}}" = true ]; then 164 | args+=("--ignore-dev") 165 | fi 166 | if [ "${{inputs.legacy}}" = true ]; then 167 | args+=("--legacy") 168 | fi 169 | if [ -n "${{inputs.name}}" ]; then 170 | args+=("--name") 171 | args+=("${{ inputs.name }}") 172 | fi 173 | if [ -n "${{inputs.resourceGroup}}" ]; then 174 | args+=("--resource-group") 175 | args+=("${{ inputs.resourceGroup }}") 176 | fi 177 | if [ -n "${{inputs.proxy}}" ]; then 178 | args+=("--proxy") 179 | args+=("${{ inputs.proxy }}") 180 | fi 181 | if [ "${{inputs.outputSummary}}" = true ]; then 182 | echo "OUTPUT_SUMMARY=true" >> $GITHUB_ENV 183 | else 184 | echo "OUTPUT_SUMMARY=" >> $GITHUB_ENV 185 | fi 186 | 187 | echo "args=${args[@]}" >> $GITHUB_OUTPUT 188 | 189 | - name: Generate Upload Suffix 190 | id: upload-suffix 191 | shell: bash 192 | run: | 193 | if [ -n "${{ inputs.modifier }}" ]; then 194 | echo "suffix=-${{ inputs.modifier }}" >> "$GITHUB_OUTPUT" 195 | else 196 | random_suffix=$(openssl rand -base64 3 | tr -dc 'a-zA-Z0-9') 197 | echo "suffix=-$random_suffix" >> "$GITHUB_OUTPUT" 198 | fi 199 | 200 | - name: Run Contrast Fingerprint CLI Command 201 | if: ${{ inputs.command == 'fingerprint' }} 202 | id: run-fingerprint 203 | shell: bash 204 | run: | 205 | echo "Running the Contrast Fingerprint Command..." 206 | ./contrast fingerprint ${{ steps.required-args.outputs.args }} ${{ steps.optional-args.outputs.args }} --log 207 | ls 208 | echo fingerprint=$(cat fingerPrintInfo.json) >> $GITHUB_OUTPUT 209 | 210 | - name: Upload output file 211 | if: ${{ inputs.command == 'fingerprint' }} 212 | uses: actions/upload-artifact@v4 213 | with: 214 | name: fingerPrintInfo${{steps.upload-suffix.outputs.suffix}}.json 215 | path: fingerPrintInfo.json 216 | 217 | - name: Upload log file 218 | if: ${{ inputs.command == 'fingerprint' }} 219 | uses: actions/upload-artifact@v4 220 | with: 221 | name: fingerPrint${{steps.upload-suffix.outputs.suffix}}.log 222 | path: contrast.log 223 | 224 | - name: Run Contrast Audit CLI Command 225 | if: ${{ inputs.command == 'audit' }} 226 | continue-on-error: true 227 | id: run-audit 228 | shell: bash 229 | run: | 230 | echo "Running the Contrast Audit Command..." 231 | ./contrast audit ${{ steps.required-args.outputs.args }} ${{ steps.optional-args.outputs.args }} --track --log --save >> output.txt 232 | 233 | - name: Send Output to Step Summary 234 | if: ${{ inputs.command == 'audit' }} 235 | shell: bash 236 | run: | 237 | eval cat ./output.txt ${OUTPUT_SUMMARY:+" >> $GITHUB_STEP_SUMMARY "} 238 | 239 | - name: Get Log output name 240 | if: ${{ inputs.command == 'audit' }} 241 | id: get-log-out-name 242 | shell: bash 243 | run: | 244 | dir=${{ github.workspace }} 245 | filename=$(echo '${{ inputs.filepath }}' | sed "s|$dir/||; s|/|-|g") 246 | echo "log_out_name=$filename" >> "$GITHUB_OUTPUT" 247 | 248 | - name: Upload log file 249 | if: ${{ inputs.command == 'audit' }} 250 | uses: actions/upload-artifact@v4 251 | with: 252 | name: ${{ steps.get-log-out-name.outputs.log_out_name }}${{steps.upload-suffix.outputs.suffix}}.contrast.log 253 | path: contrast.log 254 | 255 | - name: Get SBOM filename 256 | if: ${{ inputs.command == 'audit' && steps.run-audit.outcome=='success'}} 257 | id: get-sbom-filename 258 | shell: bash 259 | run: | 260 | filename=$(cat ./output.txt | grep -o -E '[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}-sbom-.*\.json') 261 | echo "sbom_filename=$filename" >> "$GITHUB_OUTPUT" 262 | 263 | - name: Upload sbom file 264 | if: ${{ inputs.command == 'audit' && steps.run-audit.outcome=='success'}} 265 | uses: actions/upload-artifact@v4 266 | with: 267 | name: sbom${{steps.upload-suffix.outputs.suffix}}.json 268 | path: ${{ steps.get-sbom-filename.outputs.sbom_filename }} 269 | 270 | 271 | - name: Check Audit outcome 272 | if: ${{ inputs.command == 'audit' }} 273 | shell: bash 274 | run: | 275 | if [[ "${{ steps.run-audit.outcome }}" != "success" ]]; then 276 | echo "Audit failed check logs in ${{ steps.get-log-out-name.outputs.log_out_name }}.contrast.log for more info" 277 | exit 1 278 | fi 279 | 280 | - name: Run Contrast Sarif CLI Command 281 | if: ${{ inputs.command == 'sarif' }} 282 | continue-on-error: true 283 | id: run-sarif 284 | shell: bash 285 | run: | 286 | echo "Running the Contrast Sarif Command..." 287 | ./contrast sarif ${{ steps.required-args.outputs.args }} ${{ steps.optional-args.outputs.args }} 288 | echo sarif=$(cat contrast.sarif) >> $GITHUB_OUTPUT 289 | - name: Upload sarif file to summary 290 | if: ${{ inputs.command == 'sarif' }} 291 | uses: actions/upload-artifact@v4 292 | with: 293 | name: contrast${{steps.upload-suffix.outputs.suffix}}.sarif 294 | path: contrast.sarif 295 | 296 | - name: Upload SARIF file 297 | if: ${{ inputs.command == 'sarif' && inputs.ghasEnabled == 'true'}} 298 | uses: github/codeql-action/upload-sarif@v3 299 | with: 300 | sarif_file: contrast.sarif 301 | 302 | --------------------------------------------------------------------------------