GitHub Action
SecureStack Secrets Analysis
v0.1.3
Latest version
A GitHub Action that analyses your source code for secrets, credentials, API keys, server and database hostnames/URLS, and a lot more! When you add this to GitHub Actions we will analyze your source code to make sure there is no sensitive data in your commit. See below for the specific types of credentials and files we scan for.
name: Example SecureStack Secrets Analysis GitHub Action
on: push
jobs:
security:
runs-on: ubuntu-latest
steps:
- name: Checkout repo for running secrets analysis within workflow
id: checkout
uses: actions/checkout@v2.4.0
with:
fetch-depth: 0
- name: Secrets Analysis Step
id: secrets
uses: SecureStackCo/actions-secrets@v0.1.3
with:
securestack_api_key: ${{ secrets.SECURESTACK_API_KEY }}
securestack_app_id: ${{ secrets.SECURESTACK_APP_ID }}
severity: critical
flags: '-d 1'
NOTE - to understand possible values for the action input flags
, run the SecureStack cli locally:
$ bloodhound-cli code --help
- Log in to SecureStack with your GitHub credentials.
- Go to Settings in the lower left corner, and then select the 6th tab: API.
- Generate a new API key and copy the value.
- Now back in GitHub, go to Settings for your GitHub repository and click on Secrets, and then Actions at the bottom left.
- Create a new secret named SECURESTACK_API_KEY and paste the value from step 2 into the field and click "Add secret".
- Log in to SecureStack.
- In the application drop down at the top left choose the application you want to use and click on "Copy Application ID"
- Create a new secret named SECURESTACK_APP_ID and paste the value from step 2 into the field and click "Add secret".
- When completed the two GitHub Secrets should look like this
- API keys like Stripe, AWS, Amplitude and a bazillion more
- Server and database hostnames or URLS
- Passwords and Usernames
- .env files and git indexes
-
You can view the analysis output right in the GitHub Action workflow output
-
You can run a local secrets analysis with our bloodhound-cli :
bloodhound-cli code -s -d 1 -a <app_id>
-
You can interact with the analysis output in the SecureStack SaaS
- SecureStack Software Composition Analysis (SCA) - Scan your application for vulnerable third-party and open source libraries.
- SecureStack SBOM - Create a software bill of materials (SBOM) for your application.
- SecureStack Web Vulnerability & Cloud Misconfiguration Analysis - Scan your running application url for cloud misconfigurations and web vulnerabilities.
- SecureStack Log4j Analysis - Scan your application for Log4j/Log4Shell vulnerabilities.
- Or, our All-in-One GitHub Action - We've put all of our actions together into one "Action to rule them ALL"!
Coming soon!
Made with 💜 by SecureStack