|
| 1 | +# This workflow uses actions that are not certified by GitHub. |
| 2 | +# They are provided by a third-party and are governed by |
| 3 | +# separate terms of service, privacy policy, and support |
| 4 | +# documentation. |
| 5 | + |
| 6 | +# This workflow locates REST API file contracts |
| 7 | +# (Swagger or OpenAPI format, v2 and v3, JSON and YAML) |
| 8 | +# and runs 200+ security checks on them using 42Crunch Security Audit technology. |
| 9 | +# |
| 10 | +# Documentation is located here: https://docs.42crunch.com/latest/content/tasks/integrate_github_actions.htm |
| 11 | +# |
| 12 | +# To use this workflow, you will need to complete the following setup steps. |
| 13 | +# |
| 14 | +# 1. Create a free 42Crunch account at https://platform.42crunch.com/register |
| 15 | +# |
| 16 | +# 2. Follow steps at https://docs.42crunch.com/latest/content/tasks/integrate_github_actions.htm |
| 17 | +# to create an API Token on the 42Crunch platform |
| 18 | +# |
| 19 | +# 3. Add a secret in GitHub as explained in https://docs.42crunch.com/latest/content/tasks/integrate_github_actions.htm, |
| 20 | +# store the 42Crunch API Token in that secret, and supply the secret's name as api-token parameter in this workflow |
| 21 | +# |
| 22 | +# If you have any questions or need help contact https://support.42crunch.com |
| 23 | + |
| 24 | +name: "42Crunch REST API Static Security Testing" |
| 25 | + |
| 26 | +# follow standard Code Scanning triggers |
| 27 | +on: |
| 28 | + push: |
| 29 | + branches: [ main ] |
| 30 | + pull_request: |
| 31 | + # The branches below must be a subset of the branches above |
| 32 | + branches: [ main ] |
| 33 | + schedule: |
| 34 | + - cron: '20 15 * * 4' |
| 35 | + |
| 36 | +jobs: |
| 37 | + rest-api-static-security-testing: |
| 38 | + runs-on: ubuntu-latest |
| 39 | + steps: |
| 40 | + - uses: actions/checkout@v2 |
| 41 | + |
| 42 | + - name: 42Crunch REST API Static Security Testing |
| 43 | + uses: 42Crunch/api-security-audit-action@96228d9c48873fe001354047d47fb62be42abeb1 |
| 44 | + with: |
| 45 | + # Please create free account at https://platform.42crunch.com/register |
| 46 | + # Follow these steps to configure API_TOKEN https://docs.42crunch.com/latest/content/tasks/integrate_github_actions.htm |
| 47 | + api-token: ${{ secrets.API_TOKEN }} |
| 48 | + # Fail if any OpenAPI file scores lower than 75 |
| 49 | + min-score: 75 |
| 50 | + # Upload results to Github code scanning |
| 51 | + upload-to-code-scanning: true |
| 52 | + # Github token for uploading the results |
| 53 | + github-token: ${{ github.token }} |
0 commit comments