Configure build tools

Endor Labs uses build tools to scan projects, generate reliable Software Bill of Materials (SBOM), and detect security or operational risks. For languages like Java, Python, and .NET that depend on the build environment, it relies on specific runtime or package manager versions to ensure precise results. When tools are missing, you can define and install them in the CLI, and Endor Labs sets them up in an isolated sandbox during the scan. This feature is supported on Linux and macOS.

You need to install and initialize endorctl, before configuring the build toolchains in a scan profile.

Toolchain priority in GitHub App scans

Endor Labs GitHub App continuously monitors your projects for security and operational risks. The app monitors all the projects included in your GitHub workspace and scans run once every 24 hours.

For performing scans, the GitHub App checks the toolchain specifications in the following order:

1. Scan workflow, if present.
2. Toolchain configuration specified through endorctl API.
3. Toolchain configuration specified in scanprofile.yaml file.
4. Uses the system defaults.
5. Enable auto detection and automatically detect the toolchains from your manifest files.

Configure build tools for endorctl scans

After installing and initializing the endorctl, run the endorctl scan with the --install-build-tools flag to automatically download and install any missing toolchains in an isolated sandbox to properly execute language-specific scans and dependency resolution.

1. For the first time, run the endorctl scan to create a project with Endor Labs.

   endorctl scan
   

2. Run the following command to automatically download and install build tools as part of your scan.

   endorctl scan --install-build-tools
   

3. The system checks for the required toolchain specifications in the following order before installing them in the sandbox.

   • Configure scan workflow through endorctl API
   • Configure toolchain profile through endorctl API
   • Configure toolchain profile in the profile.yaml file
   • Uses the system defaults
   • Automatically detect toolchain profiles

System default toolchain versions

If you do not provide a tool profile, the default toolchains are installed in the sandbox while performing the endorctl scan with the install-build-tools flag. See Toolchain support matrix for details on default versions.

Toolchain support matrix

The following table outlines the toolchain profile support details across different languages and platforms.

Configure automated scan parameters

Automated scan parameters are endorctl parameters and environment variables that you define in a scan profile. They apply to projects linked to that profile and help customize scan behavior during cloud scans.

You can define the following parameters in your scan profile:

• included_paths: Enable to specify a list of paths to include in the scan.

• excluded_paths: Enable to specify a list of path to exclude from the scan.

• languages: Enable to specify a list of languages to scan. If empty, default values are used.

• call_graph_languages: Enable to specify a list of language to use for generating call graphs. If empty, default values are used.

• additional_environment_variables: Enable to specify additional environment variables to set during the scan. Only the environment variables starting with ENDOR_ are passed to the scan, all others are ignored.

• enable_automated_pr_scans: Enables automatic scanning of pull request changes.

• enable_pr_comments: Enables adding scan results as comments in pull requests.

• enable_sast_scan: Enables SAST during the scanning process.

• disable_code_snippet_storage: Disables the storage of code snippets.

If you are using Bazel in your build, you can further configure:

• bazel_configuration: Enable to specify configuration settings for Bazel scans. See Bazel flags for more details.

• bazel_show_internal_targets: Enable to include internal build targets in the dependency analysis.

• bazel_workspace_path: Enable to specify the path to the Bazel workspace.

• bazel_include_targets: Enable to specify Bazel targets to include in the scan.

• bazel_exclude_target: Enable to specify Bazel targets to exclude from the scan.

The following toolchain profile shows a yaml definition with configured automated scan parameters:

kind: AutomatedScanParameters
spec:
  automated_scan_parameters:
    included_paths:
      - python/**
    excluded_paths:
      - java/**
    languages:
      - python
    call_graph_languages:
      - python
    additional_environment_variables:
      - ENDOR_LOG_VERBOSE=true
      - ENDOR_LOG_LEVEL=debug
    enable_automated_pr_scans: true
    enable_pr_comments: true
    enable_sast_scan: true
    disable_code_snippet_storage: true
    bazel_configuration:
      bazel_show_internal_targets: true
      bazel_workspace_path: "go-bazel-repo/"
      bazel_include_targets:
      bazel_abs:
        - "//cmd:cmd"