Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 4.67 KB

home.md

File metadata and controls

82 lines (59 loc) · 4.67 KB

Google Analyze Code Security

The Google Analyze Code Security plugin for Jenkins identifies insecure configurations in Infrastructure as Code (IaC) files for Google Cloud resources. This plugin requires Terraform plan files in JSON format for scanning.

Note: Don’t enter any sensitive information such as passwords and other personal identifiable information in the Terraform plan files.

Set up credentials

Service Account Based Credential

  1. In the Google Cloud organization which includes the resources that you want to change, create a service account.
  2. Add the Security Posture Admin role or the Security Posture Shift-Left Validator role to the service account.
  3. Create the service account key in JSON format and download the JSON file.

Configure the plugin

  1. In the Jenkins console, click Manage Jenkins > Configure System.
  2. In the Google Analyze Code Security section, click Add to add the service account key. add_credential
  3. Add the service account key. credential_pair
    • OrganizationId: Enter the organization ID for the Google Cloud organization that includes the resources.
    • SCC Credentials: Add the service account key.
  4. [Optional] To validate the credentials, click Test Connection.
  5. To add additional service account keys, click Add.
  6. Click Save.

Add the plugin to your build project

  1. In the Jenkins console, click Corresponding Project > Configuration.
  2. Click Add build step > Perform Code Scan during Build. project_add_build_step
  3. Complete the following fields: project_configuration
    • OrganizationID: The Google Cloud organization ID.
    • Scan File Name: The name of the Terraform plan file (in JSON format) that you want to scan. The plugin scans the workspace directory and its subdirectories for the file, if you don’t enter a {Scan File Path}.
    • Scan File Path [Optional]: The path to the JSON plan file, relative to the project workspace directory. For example, if the file is located in /xyz/abc/myplanfile.json, the file path is /xyz/abc.
    • Scan Time Out[Millisecond]: The time after which the plugin stops and changes the build status to failure.
    • Plugin Failure Configuration: Determines build status when the plugin runs into an error. If you set this field to true, the build status is marked as SUCCESS. Otherwise, if you set this field to false, the build status is marked as FAILED.
  4. Complete one of the following actions to determine how a build proceeds:
    • To configure a build to fail depending on how many issues are found, complete the following: add_violation_config
      • Click Add Asset Violation Config.
      • Select a severity class and enter a corresponding violation count threshold.
      • Select the aggregator value (either OR or AND).
        Sample Configuration: asset_violation_config
    • To configure a build to finish, regardless of the number of issues found, select Ignore violations reported in the Code Scan while evaluating build Status. ignore_violation_config
  5. Click Save.
  6. To run the project, click Build Now.
  7. To view the plugin report, click the most recent workflow.
    • If the plugin ran, it publishes a violation report under Build Artifacts. violation_summary
    • If the plugin failed, it publishes an error report under Build Artifacts. plugin_error_summary

Supported asset types and policies

For information about supported asset types and policies, see IaC Validation - Supported assets and policies.