StackHawk
Visualize StackHawk Organization, User, Application, Code Repository, and Application Findings, and monitor changes through queries and alerts.
- Installation
- Data Model
- Types
Installation
Requirements
- User must have the Admin access to StackHawk account.
- User must have permission in JupiterOne to install new integrations.
Configuration in StackHawk
Generate API Key and collect Organization ID from StackHawk
- Sign in to your StackHawk account at https://app.stackhawk.com.
- Navigate to Settings > API Keys under Profile Settings.
- Create a new API key and store it securely.
- Find your Organization ID under Settings > Organization Details in ORG Settings.
Configuration in JupiterOne
- From the top navigation of the J1 Search homepage, select Integrations
- Search for the StackHawk and select it.
- Click on the Add Instance button and configure the following settings:
- Enter the StackHawk API Key generated for use by JupiterOne.
- Enter the StackHawk Organization ID generated for use by JupiterOne.
- Enter the Account Name by which you'd like to identify this StackHawk
Cloud instance in JupiterOne. Ingested entities will have this value stored in
tag.AccountName
when Tag with Account Name is checked. - Enter a Description that will further assist your team when identifying the integration instance.
- Select a Polling Interval that you feel is sufficient for your monitoring
needs. You may leave this as
DISABLED
and manually execute the integration.
- Click Create Instance once all values are provided.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Entities
The following entities are created:
Resources | Entity _type | Entity _class |
---|---|---|
Application | stackhawk_application | Application |
CodeRepo | stackhawk_code_repo | CodeRepo |
Finding | stackhawk_finding | Finding |
Organization | stackhawk_account | Account |
User | stackhawk_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
---|---|---|
stackhawk_account | HAS | stackhawk_user |
stackhawk_account | HAS | stackhawk_application |
stackhawk_application | HAS | stackhawk_code_repo |
stackhawk_application | HAS | stackhawk_finding |
Stackhawk Account
stackhawk_account
inherits from Account
Property | Type | Description | Specifications |
---|---|---|---|
orgId * | string |
Stackhawk Application
stackhawk_application
inherits from Application
Property | Type | Description | Specifications |
---|---|---|---|
environment * | string | ||
environmentId * | string | ||
organizationId * | string | ||
riskLevel | string |
Stackhawk Code Repo
stackhawk_code_repo
inherits from CodeRepo
Property | Type | Description | Specifications |
---|---|---|---|
apiDiscoveryScore | number | The StackHawk API Discovery Score. | |
apiDiscoveryStatus | string | The StackHawk API Discovery Status. | |
archived | boolean | ||
commitCount | number | ||
frameworkNames | array of string s | ||
hasGeneratedOpenApiSpec | boolean | ||
hidden | boolean | Whether or not this repository is hidden. | |
integrationId | string | The Integration Id this repository is associated to. | |
isFork | boolean | Whether or not this repository is a fork. | |
isInAttackSurface | boolean | ||
isNewRepository | boolean | ||
isNewToAttackSurface | boolean | ||
lastCommitBranch | string | ||
lastCommitTimestamp | number | ||
namespace | string | Provider dependent, namespace/group/subgroup/folder the repository belongs to. | |
namespaceId | string | ||
providerOrgId | string | ||
providerOrgName | string | The repository providers top level entity this repository is associated with. | |
repoSource | string | The source of the repository. e.i. UNKNOWN, GITHUB, AZURE_DEVOPS, BITBUCKET, GITLAB. |
Stackhawk Finding
stackhawk_finding
inherits from Finding
Property | Type | Description | Specifications |
---|---|---|---|
applicationId | string | ||
applicationName | string | ||
cweId | string | ||
environmentId | string | ||
environmentName | string | ||
findingEvidence | string | ||
findingMethod | string | ||
findingOtherInfo | string | ||
findingUrl | string | ||
firstSeenOn | number | ||
lastSeenOn | number | ||
pluginId | string | ||
pluginName | string | ||
remediationAdvice | string | ||
risk | string | ||
scanDuration | number | ||
scanId | string | ||
scanUserName | string | ||
team | string |
Stackhawk User
stackhawk_user
inherits from User
Property | Type | Description | Specifications |
---|---|---|---|
accessProvider | string | User access provider. For example: GITHUB, GOOGLE, STACKHAWK, SAMLIDP | |
applicationIds | array of string s | ||
avatarUrl | string | ||
providerClientId | string |