Skip to content

Commit

Permalink
QINT-15645: GitHub App for WAS
Browse files Browse the repository at this point in the history
Updated readme file
  • Loading branch information
qsadhav authored Feb 8, 2024
1 parent f8397ca commit 49be849
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,13 @@

## Description

The workflow of GitHub Actions has four main steps:
1. Prerequisites
2. Configure GitHub Environment Parameters
3. Configure GitHub Action
4. Download Scan Results
The Qualys GitHub Actions for Web Application Scanning (WAS) allows DevOps teams to build application vulnerability scans into their existing CI/CD processes. By integrating web application scans in this manner, application security testing is accomplished earlier in the Software Development Life Cycle (SDLC) to catch and eliminate security flaws.

This README document explains how to use the Qualys WAS GitHub Action and gives some samples for your reference.

## How to use the Qualys WAS GitHub Action

1. Visit [GitHub configuration a workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) to enable GitHub Action in your repository.
[configuring-a-workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)
2. Subscribe to Qualys WAS module and obtain Qualys credentials.
3. Create GitHub Secrets and variables. Refer to GitHub Action Parameter section below to learn about the parameters.
Refer to [Encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) for more details on how to set up secrets.
Expand Down Expand Up @@ -294,4 +289,4 @@ If repository is private, then add PAT (personal access token) token in the chec
| TIMEOUT | Use the numeric value to set the timeout duration in minutes to check the scan results. For example, 60. The default value of TIMEOUT is 350 min. Note: The timeout limit for GitHub-hosted runners is 360 minutes. On GitHub-hosted runners, you cannot run the job for more than 360 minutes. However, in self-hosted runners, there is no limit on timeout, and you can set a timeout for more than 360 minutes. | Optional | 350 | Variable |
| EXCLUDE | Use the QIDs separated by commas to exclude them from the scan. For example, 1234, 1345. This will exclude these two QIDs for vulnerability severity level failure conditions. | Optional | "" | Variable |

Note: The Parameter values given in the above table are case-sensitive.
Note: The Parameter values given in the above table are case-sensitive.

0 comments on commit 49be849

Please sign in to comment.