├── .github └── workflows │ ├── update_tags.yml │ └── release.yml ├── .gitignore ├── action.yml ├── README.md └── LICENSE /.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 26 | -------------------------------------------------------------------------------- /.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 -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Contrast Scan Analyze' 2 | description: 'Perform SAST analysis of a project' 3 | inputs: 4 | apiKey: 5 | description: 'An agent API key provided by Contrast (required).' 6 | required: true 7 | authHeader: 8 | description: 'User authorization credentials provided by Contrast (required).' 9 | required: true 10 | orgId: 11 | description: 'The ID of your organization in Contrast (required).' 12 | required: true 13 | artifact: 14 | description: 'The Artifact to Scan on the Contrast Platform.' 15 | required: true 16 | apiUrl: 17 | description: 'The name of the host. Includes the protocol section of the URL (https://). Defaults to https://ce.contrastsecurity.com. (optional)' 18 | required: false 19 | default: "https://ce.contrastsecurity.com" 20 | projectName: 21 | description: 'The name of the project you want to scan in Contrast.' 22 | required: false 23 | projectId: 24 | description: 'The ID of your project in Contrast.' 25 | required: false 26 | language: 27 | description: 'The language of your project.' 28 | required: false 29 | timeout: 30 | description: 'Set a specific time span (in seconds) before the function times out. The default timeout is 10 minutes if timeout is not set.' 31 | required: false 32 | default: 600 33 | severity: 34 | description: 'Allows user to report 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 | fail: 37 | description: 'When set to true, fails the action if CVEs have been detected that match at least the severity option specified.' 38 | required: false 39 | 40 | runs: 41 | using: "composite" 42 | steps: 43 | - name: Get Latest CLI 44 | run: | 45 | echo "Downloading Contrast CLI 2.1.5" 46 | curl --location 'https://pkg.contrastsecurity.com/artifactory/cli/v2/2.1.5/linux/contrast' --output contrast 47 | shell: bash 48 | - run: chmod +x contrast 49 | shell: bash 50 | 51 | - name: Get CLI Required Arguments 52 | id: required-args 53 | shell: bash 54 | run: | 55 | echo "Setting Required Args..." 56 | args=() 57 | args+=("--api-key ${{ inputs.apiKey }}") 58 | args+=("--authorization ${{ inputs.authHeader }}") 59 | args+=("--organization-id ${{ inputs.orgId }}") 60 | args+=("--file ${{ inputs.artifact }}") 61 | args+=("--host ${{ inputs.apiUrl }}") 62 | 63 | echo "args=${args[@]}" >> $GITHUB_OUTPUT 64 | 65 | - name: Get CLI Optional Arguments 66 | id: optional-args 67 | shell: bash 68 | run: | 69 | echo "Setting Optional Args..." 70 | args=() 71 | if [ -n "${{ inputs.projectName }}" ]; then 72 | args+=("--name") 73 | args+=("${{ inputs.projectName }}") 74 | fi 75 | if [ -n "${{ inputs.projectId }}" ]; then 76 | args+=("--project-id") 77 | args+=("${{ inputs.projectId }}") 78 | fi 79 | if [ -n "${{ inputs.language }}" ]; then 80 | args+=("--language") 81 | args+=("${{ inputs.language }}") 82 | fi 83 | if [ -n "${{ inputs.timeout }}" ]; then 84 | args+=("--timeout") 85 | args+=("${{ inputs.timeout }}") 86 | fi 87 | if [ -n "${{inputs.severity}}" ]; then 88 | args+=("--severity") 89 | args+=("${{ inputs.severity }}") 90 | fi 91 | if [ "${{inputs.fail}}" = true ]; then 92 | args+=("--fail") 93 | fi 94 | 95 | echo "args=${args[@]}" >> $GITHUB_OUTPUT 96 | 97 | - name: Run Contrast Scan CLI Command 98 | id: run-scan 99 | shell: bash 100 | run: | 101 | echo "Running the Contrast Scan Command..." 102 | ./contrast scan ${{ steps.required-args.outputs.args }} ${{ steps.optional-args.outputs.args }} -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Use Contrast Scan to analyze your code 2 | 3 | This GitHub action lets you use Contrast Security's industry leading Code Scanner (Contrast Scan) to find vulnerabilities in your code. 4 | The Action compares the code scanning analysis of the PR to the last code scan analysis of the destination branch. GitHub fails the check if new vulnerabilities have been introduced. 5 | 6 | - **Supported languages:** Java, Javascript and .NET 7 | 8 | ## **Initial steps for using the action** 9 | If you are not familiar with GitHub actions read the 10 | [GitHub Actions](https://docs.github.com/en/actions) documentation to learn what GitHub Actions are and how to set them 11 | up. After which, complete the following steps: 12 | 13 | 1. Configure the following GitHub secrets CONTRAST_API_KEY, CONTRAST_ORGANIZATION_ID, CONTRAST_AUTH_HEADER and CONTRAST_API_URL 14 | 15 | ![image](https://user-images.githubusercontent.com/24421341/195881793-1ae0c552-8701-4501-a5b9-25863b0c84a5.png) 16 | 17 | - **CodeSec by Contrast Security users:** Retrieve authentication details for the secrets using the CLI. 18 | - Installation instructions here : [https://www.contrastsecurity.com/developer/codesec](https://www.contrastsecurity.com/developer/codesec) 19 | - If you are a new user, create an account with the 'contrast auth' command 20 | - Run the 'contrast config' command in the CLI to collect the required credentials 21 | 22 | ![image](https://user-images.githubusercontent.com/24421341/195882697-cd56ea93-01d3-43d4-99e6-9005e7683111.png) 23 | 24 | - **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 25 | - Organization ID 26 | - Your API key 27 | - Authorization header 28 | - You will also need the URL of your Contrast UI host. This input includes the protocol section of the URL (https://). 29 | 30 | ![image](https://user-images.githubusercontent.com/24421341/195883255-b436a666-a040-478a-a9d5-15314097695b.png) 31 | 32 | 2. Copy sample workflow below and create a branch of your code to add Contrast security Scan. This branch is typically located at `.github/workflows/build.yml` 33 | 34 | 3. Update the workflow file to specify when the action should run (for example on pull_request, on push) 35 | 36 | ```yaml 37 | on: 38 | # Trigger analysis when pushing to main or an existing pull requests. Also trigger on 39 | # new pull requests 40 | push: 41 | branches: 42 | - main 43 | pull_request: 44 | types: [opened, synchronize, reopened] 45 | ``` 46 | 47 | 48 | 4. Update the filepath in the workflow file to specfy the location of the built artifact or file to scan 49 | 50 | ```yaml 51 | with: 52 | artifact: mypath/target/myartifact.jar 53 | ``` 54 | 55 | 5. To fail based on severity of vulnerability found set severity (critical/high/medium or low) and fail to true 56 | 57 | ```yaml 58 | severity: high 59 | fail: true 60 | ``` 61 | 62 | 6. In order for GitHub to list vulnerabilities in the **Security** Tab of the repo, the contrast action must be accompanied by this GitHub action 63 | 64 | ```yaml 65 | - name: Upload SARIF file 66 | uses: github/codeql-action/upload-sarif@v2 67 | with: 68 | sarif_file: results.sarif 69 | ``` 70 | 71 | The value of `sarif_file` *must* be `results.sarif` which is the name that Contrast Scan Action will write the sarif to. 72 | 73 | 7. After committing, create a Pull Request (PR) to merge the update back to your main branch. Creating the PR triggers the scan to run. The extra "Code Scanning" check appears in the PR 74 | 75 | Since it’s likely there will be new findings when you add Contrast Scan, we don't want to fail and block merging the PR that adds Contrast Scan, forcing the owner of the PR to now fix all the newly exposed vulnerabilities that already existed in the code base. 76 | 77 | After Contrast Scan runs on the main branch, all new PRs that you create where the Contrast Scan is run fail the code scanning check if they introduce new vulnerabilities beyond the baseline you just established. 78 | 79 | ## Usage 80 | All Contrast-related account secrets should be configured as GitHub secrets and will be passed to the scanner via 81 | environment variables in the GitHub runner. 82 | A simple workflow to get going is: 83 | ```yaml 84 | on: 85 | # Trigger analysis when pushing to main or an existing pull requests. Also trigger on 86 | # new pull requests 87 | push: 88 | branches: 89 | - main 90 | pull_request: 91 | types: [opened, synchronize, reopened] 92 | name: Contrast Security Scan 93 | jobs: 94 | build_and_scan: 95 | permissions: 96 | contents: read # for actions/checkout 97 | security-events: write # for github/codeql-action/upload-sarif 98 | actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status 99 | runs-on: ubuntu-latest 100 | # check out project 101 | steps: 102 | - uses: actions/checkout@v2 103 | # steps to build the artifact you want to scan 104 | # -name: Build Project 105 | # ... 106 | # Scan Artifact 107 | - name: Contrast Scan Action 108 | uses: Contrast-Security-OSS/contrastscan-action@v2.0.3 109 | with: 110 | artifact: mypath/target/myartifact.jar 111 | apiKey: ${{ secrets.CONTRAST_API_KEY }} 112 | orgId: ${{ secrets.CONTRAST_ORGANIZATION_ID }} 113 | authHeader: ${{ secrets.CONTRAST_AUTH_HEADER }} 114 | severity: high 115 | fail: true 116 | # To list vulnerabilities in the GitHub Security Tab of the repo include GitHub upload-sarif action 117 | # The value of `sarif_file` must be `results.sarif` 118 | - name: Upload SARIF file 119 | uses: github/codeql-action/upload-sarif@v2 120 | with: 121 | sarif_file: results.sarif 122 | ``` 123 | 124 | 125 | ## Required inputs 126 | - apiKey - An API key from the Contrast platform. 127 | - authHeader - User authorization credentials from Contrast. 128 | - orgId - The ID of your organization in Contrast. 129 | - artifact - The artifact to scan on the Contrast platform. 130 | ## Optional inputs 131 | - apiUrl - The URL of the host. This input includes the protocol section of the URL (https://). The default value is [https://ce.contrastsecurity.com](https://ce.contrastsecurity.com/) (Contrast Community Edition). 132 | - severity - Specify severity of vulnerability. Values for severity are critical, high, medium or low. Fail must also be set to true to fail the check 133 | - fail - When set to true, fails the check if vulnerabilities have been detected that match at least the severity option specified. 134 | - projectName - The name of the scan project in Contrast. 135 | If you don’t specify a project name, Contrast Scan uses the artifact file name for the project name. 136 | - projectId - The ID of your project in Contrast. 137 | - If a project ID already exists, Contrast Scan uses that ID instead of one you specify. 138 | - If you don’t specify a project ID, Contrast Scan creates a project ID for the specified project name. 139 | - timeout - Sets a specific time span (in seconds) before the function times out. The default timeout is five minutes. 140 | 141 | ## **If you are using the Contrast Maven plugin** 142 | This GitHub action and the **[Contrast Maven plugin](https://github.com/Contrast-Security-OSS/contrast-maven-plugin)** accomplish the same thing. You cannot use both at the same time. 143 | For example, if you are using maven to build your code and you run org.contrastsecurity.maven:scan during the build, do not use the Contrast Scan GitHub action. 144 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------