Third-party integrations for Snyk AppRisk

The Integrations page shows all active integrations, including data from your existing Snyk Organizations that are automatically synced and provides access to the Integration Hub.

The Loaded package risk factor is not supported by Snyk for operating system packages (such as Debian packages), only for packages which are hosted under package managers such as npm, Maven, or PyPI.

You can customize your AppRisk integrations from the Integrations Hub where the following integrations are available:

• Veracode SAST

• Checkmarx SAST

• SonarQube

• Nightfall

• GitGuardian

• Dynatrace

• Sysdig

Data synchronization may take up to two hours after receiving the Connected status from a new integration setup.

Veracode setup guide

Release status

Veracode for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

Prerequisites

The Veracode application concept is matched into the Snyk AppRisk repository assets. You need to create and utilize the Veracode custom field by using the Veracode API. Access the Veracode custom metadata field for more details.

Ensure you are adding a custom field called repoURL:

{
"name": "repoURL", 
"value": <YOUR GITHUB URL>
}

Required parameters

• API ID and API Key - API credentials associated with a user account. For more information, access the Veracode API credentials link.

Integration Hub setup

1. Open the Integration Hub menu.

2. Select the SAST tag and search for Veracode.

3. Click the Add button.

4. Add the profile name for this integration.

5. Add the API ID from your Veracode account.

6. Add the API key from your Veracode account.

7. Click the Done button.

8. When the connection is established, the status of the Veracode integration is changed to Connected.

Checkmarx setup guide

Release status

Checkmarx for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

Use the following instructions to set up your Checkmarx SAST integration. Checkmarx SAST integration is only working for the Checkmarx SAST, we are not yet supporting Checkmarx One.

Snyk AppRisk Pro does not support the Checkmarx One integration.

Prerequisites

• Install and configure your Snyk Broker connection for Snyk AppRisk.

• Ensure you have properly used Git Setting for your Checkmarx Project. Access the Checkmarx Set project's remote source settings as GIT documentation page for more details.

Required parameters

1. API URL - The URL of Checkmarx API, for example, checkmarx.customer.com.

2. Username and Password - Credentials for a user account with Checkmarx SAST access.

Integration Hub setup

After you have installed and configured Snyk Broker for AppRisk and you successfully established a connection for Checkmarx SAST, you also need to configure the integration from the Snyk AppRisk Integration Hub.

1. Open the Integration Hub menu.

2. Select the SAST tag and search for Checkmarx.

3. Click the Add button.

4. Add the profile name for this integration.

5. Add the Broker token for the Snyk AppRisk Checkmarx integration.

6. Add the Checkmarx host. For example checkmarx.customer.com

7. Click the Done button.

8. When the connection is established, the status of the Checkmarx integration is changed to Connected.

SonarQube setup guide

Release status

SonarQube for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

Required parameters

• API Key. Here you can find more details about the SonarQube API Key.

Integration Hub setup

• Open the Integration Hub menu.

• Select the SAST tag and search for SonarQube.

• Click the Add button.

• Add the Profile name for this integration.

• Add the Host URL for this integration.

• Add the API token. Navigate to your SonarQube account, select User, select My Account, select Security, and then User Token. Access the SonarQube generating and using tokens documentation page for more details about the SonarQube API Key.

• Click the Done button.

• When the connection is established, the status of the SonarQube integration is changed to Connected.

Nightfall setup guide

Release status

Nightfall for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

Required parameters

• API Key. Access the Nightfall Creating an API Key documentation page for more details about how to create a Nightfall API key.

Integration Hub setup

1. Open the Integration Hub menu.

2. Select the Secrets tag and search for Nightfall.

3. Click the Add button.

4. Add the Profile name for this integration.

5. Add the Base API URL for this integration.

6. Add the API Key for this integration.

7. Click the Done button.

8. When the connection is established, the status of the Nightfall integration is changed to Connected.

The following video provides an overview of the Nightfall configuration from the Integration Hub:

Liked the video? Checkout the rest of the course on Snyk Learn!

After you set up your Nightfall integration using the Integration Hub, you can see the secrets detection coverage.

Liked the video? Checkout the rest of the course on Snyk Learn!

GitGuardian setup guide

Release status

GitGuardian for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

Required parameters

• API Key. Access the GitGuardian authentication documentation page for more details about how to create a GitGuardian API Key.

When you create a GitGuardian API Key, remember that it works for both service accounts and personal access token.

Ensure that the following permissions are set as READ:

• Incident (mandatory)

• Teams (recommended for GitGuardian paid accounts)

Integration Hub setup

1. Open the Integration Hub menu.

2. Select the Secrets tag and search for GitGuardian.

3. Click the Add button.

4. Add the Profile name for this integration.

5. Add the API Token for this integration.

6. Click the Done button.

7. When the connection is established, the status of the GitGuardian integration is changed to Connected.

The following video provides an overview of the GitGuardian configuration from the Integration Hub:

Liked the video? Checkout the rest of the course on Snyk Learn!

After you set up your GitGuardian integration using the Integration Hub, you can see the secrets detection coverage:

Liked the video? Checkout the rest of the course on Snyk Learn!

Dynatrace setup guide

Release status

Dynatrace for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

The following risk factors are reported from the Dynatrace runtime integration: Deployed, and Loaded package.

The supported languages for the Loaded package risk factor reported from the Dynatrace integration are detailed on the Dynatrace Supported technologies page.

Prerequisites

• Use Dynatrace SaaS on the DPS licensing model.

• The Dynatrace Kubernetes app is configured to monitor at least one cluster.

• The user is associated with a group that has permissions (through policies) to query the entity model. In the Dynayrace policy, set the following permission: storage:entities:read.

Comply with the following steps before integrating Dynatrace with Snyk AppRisk:

1. Retrieve the account-uuid from your Dynatrace account. Navigate to the Dynatrace accounts page and select the account whose environment you want to integrate into Snyk. Identify the account-uuid in the URL and save it for later use.

2. Ensure you have OneAgent deployed in your Kubernetes environment. Navigate to Settings then Environments and select the environment you want to integrate into Snyk. Save the environment ID for later use (available in the URL of the new window as well). Click Deploy OneAgent then Kubernetes and follow the instructions. Ensure OneAgent is running in full-stack mode.

3. Ensure your deployment is activated. On your environment's page, click Kubernetes , then Recommendations and activate the cluster where you deployed OneAgent.

4. Create an OAuth client with the right permissions. Navigate to the Dynatrace accounts page, then to Identity & access management. Select OAuth clients and click Create client. Fill in the details and check the following permissions; then click Create client:

storage:entities:read

1. Save the Client ID and Client secret for later and click Finish.

Required parameters

1. Account UUID - the account-uuid of your Dynatrace account.

2. Environment ID - the ID of the environment monitored in Dynatrace.

3. OAuth client ID - the ID of the OAuth client created in the prerequisites.

4. OAuth client secret - the secret of the OAuth client created in the prerequisites.

Integration Hub setup

• Open the Integration Hub menu.

• Select the Runtime tag and search for Dynatrace.

• Click the Add button.

• Edit the Profile name of your integration.

• Enter the Account UUID.

• Enter the Environment ID.

• Enter the OAuth client ID.

• Enter the OAuth client secret.

• Click the Done button.

• When the connection is established, the Dynatrace integration status changes to Connected.

After the Dynatrace runtime data becomes available from the runtime integration, it will appear in Snyk AppRisk within a few hours.

Sysdig setup guide

Release status

Sysdig for Snyk AppRisk Pro is in Early Access and available only with Snyk Enterprise plans with Snyk AppRisk Pro. If you want to set it up in your Group, contact your Snyk account team.

The following risk factors are reported from the Sysdig runtime integration: Deployed, and Loaded package.

The supported languages for the Loaded package risk factor are: Go, Java, JavaScript/TypeScript and Python.

Prerequisites

• The account must have access to Sysdig Secure product.

• Contact your Sysdig representative to activate the in-use packages feature flag.

Required parameters

• Service Account API Token - Navigate to the Service Account setup instructions page for details on how to create a Sysdig Service Account in order to obtain an API Token.

  • Set View Only as the Role for this Service Account.

  • Set an Expiration Date for the Service Account. After the Service Account expires, the Sysdig integration will no longer be able to pull information until updated with a new Service Account.

The created Service Account must be under Sysdig Secure, not Sysdig Monitor.

• Region - Navigate to the Sysdig SAAS regions and IP ranges page for details about the Sysdig region URLs.

Known limitations

• If the Sysdig Agent is not deployed on every node of a cluster, runtime data available from this integration may be incomplete.

• Various Sysdig scans run at different intervals, which may cause a delay between applying changes to a resource within a cluster and reporting this information through the integration.

Integration Hub setup

• Open the Integration Hub menu.

• Select the Runtime tag and search for Sysdig.

• Click the Add button.

• Add the Profile name for this integration.

• Add the Account API Token.

• Set the Sysdig region.

• Click the Done button.

• When the connection is established, the status of the Sysdig integration is changed to Connected.

After the Sysdig runtime data becomes available from the runtime integration, it will appear in Snyk AppRisk within a few hours.