├── workflows ├── update_tags.yml └── release.yml ├── .gitignore ├── action.yml ├── README.md └── LICENSE /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 -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Contrast Security SARIF' 2 | description: 'Contrast SARIF file generation' 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 | applicationId: 14 | description: 'The ID of your application.' 15 | required: false 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 | metadata: 21 | description: 'Metadata filter to be passed to the Contrast CLI when running sarif command' 22 | required: false 23 | ghasEnabled: 24 | description: 'When set to true, will upload sarif to the GHAS integration' 25 | required: false 26 | default: 'true' 27 | 28 | runs: 29 | using: "composite" 30 | steps: 31 | - name: Get Latest CLI 32 | run: | 33 | echo "Downloading Contrast CLI 2.3.0" 34 | curl --location 'https://pkg.contrastsecurity.com/artifactory/cli/v2/2.3.0/linux/contrast' --output contrast 35 | shell: bash 36 | - run: chmod +x contrast 37 | shell: bash 38 | 39 | - name: Get CLI Required Arguments 40 | id: required-args 41 | shell: bash 42 | run: | 43 | echo "Setting Required Args..." 44 | args=() 45 | args+=("--api-key ${{ inputs.apiKey }}") 46 | args+=("--authorization ${{ inputs.authHeader }}") 47 | args+=("--organization-id ${{ inputs.orgId }}") 48 | args+=("--host ${{ inputs.apiUrl }}") 49 | 50 | echo "args=${args[@]}" >> $GITHUB_OUTPUT 51 | 52 | - name: Get CLI Optional Arguments 53 | id: optional-args 54 | shell: bash 55 | run: | 56 | echo "Setting Optional Args..." 57 | args=() 58 | if [ -n "${{inputs.metadata}}" ]; then 59 | args+=("--metadata") 60 | args+=("${{ inputs.metadata }}") 61 | fi 62 | if [ -n "${{inputs.applicationId}}" ]; then 63 | args+=("--application-id") 64 | args+=("${{ inputs.applicationId }}") 65 | fi 66 | 67 | echo "args=${args[@]}" >> $GITHUB_OUTPUT 68 | 69 | - name: Run Contrast Sarif CLI Command 70 | continue-on-error: true 71 | id: run-sarif 72 | shell: bash 73 | run: | 74 | echo "Running the Contrast Sarif Command..." 75 | ./contrast sarif ${{ steps.required-args.outputs.args }} ${{ steps.optional-args.outputs.args }} 76 | echo sarif=$(cat contrast.sarif) >> $GITHUB_OUTPUT 77 | - name: Upload sarif file to summary 78 | uses: actions/upload-artifact@v3 79 | with: 80 | name: contrast.sarif 81 | path: contrast.sarif 82 | 83 | - name: Upload SARIF file 84 | if: ${{ inputs.ghasEnabled == 'true'}} 85 | uses: github/codeql-action/upload-sarif@v3 86 | with: 87 | sarif_file: contrast.sarif 88 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Contrast Security SARIF 2 | 3 | This GitHub Action generates a SARIF (Static Analysis Results Interchange Format) file for a specified application using the Contrast Security CLI. The generated SARIF file can then be used for further analysis or uploaded to GitHub Advanced Security (GHAS) for code scanning. 4 | 5 | ## Prerequisites 6 | 7 | Before using this action, ensure you have the following secrets configured in your GitHub repository: 8 | 9 | - CONTRAST_API_KEY: An agent API key provided by Contrast. 10 | - CONTRAST_AUTH_HEADER: User authorization credentials provided by Contrast. 11 | - CONTRAST_ORG_ID: The ID of your organization in Contrast. 12 | 13 | ## Inputs 14 | 15 | | Input | Description | Required | Default | 16 | |---------------|----------------------------------------------------------------------------|----------|-----------------------------------| 17 | | apiKey | An agent API key provided by Contrast. | Yes | - | 18 | | authHeader | User authorization credentials provided by Contrast. | Yes | - | 19 | | orgId | The ID of your organization in Contrast. | Yes | - | 20 | | applicationId | The ID of your application in Contrast. | Yes | - | 21 | | apiUrl | The base URL of your Contrast instance. | No | https://ce.contrastsecurity.com | 22 | | severity | The minimum severity level for vulnerabilities to be included in the SARIF file. Valid values: CRITICAL, HIGH, MEDIUM, LOW, NOTE | No | CRITICAL | 23 | | metadata | Metadata filter to be passed to the Contrast CLI when running the sarif command. | No | - | 24 | | ghasEnabled | Whether to upload the generated SARIF file to GHAS. | No | true | 25 | 26 | ## Functionality 27 | 28 | Downloads the Contrast CLI: The action downloads the latest version of the Contrast CLI. 29 | 30 | Configures CLI Arguments: It sets up required and optional arguments for the CLI based on the provided inputs. 31 | 32 | Runs the sarif Command: The Contrast CLI's sarif command is executed to generate the SARIF file. 33 | 34 | Uploads SARIF File: The SARIF file is uploaded as an artifact for easy access. 35 | 36 | If ghasEnabled is true, the SARIF file is also uploaded to GHAS for code scanning. 37 | 38 | ## Example Usage 39 | 40 | ``` yaml 41 | name: Contrast SARIF Generation 42 | 43 | on: 44 | push: 45 | branches: 46 | - main 47 | 48 | jobs: 49 | generate-sarif: 50 | runs-on: ubuntu-latest 51 | steps: 52 | - uses: actions/checkout@v3 53 | - name: Contrast Security SARIF 54 | uses: Contrast-Security-OSS/contrast-sarif-action@v1 55 | with: 56 | apiKey: ${{ secrets.CONTRAST_API_KEY }} 57 | authHeader: ${{ secrets.CONTRAST_AUTH_HEADER }} 58 | orgId: ${{ secrets.CONTRAST_ORG_ID }} 59 | applicationId: 'your-application-id' 60 | ``` 61 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------