Black Duck Documentation

Version: 2024.10

Black Duck SCA Help Center
Welcome to Black Duck SCA 2024.10.1
Getting started with Black Duck SCA
About Black Duck - Binary Analysis
Scanning Components
Understanding Component Scanning
Using Black Duck Detect (Desktop)
About container scanning
About Rapid Scanning
About ReversingLabs Scanning
About correlated scanning
About SCA Scan Service
Signature Scanner
Using the Signature Scanner
Signature Scanner client requirements
Downloading and installing the Signature Scanner CLI
Defining your version of JRE for Signature Scanner
Accessing the Black Duck server via a proxy
Running a component scan using the Signature Scanner command line
Reducing the number of parameters entered on the command line for Signature Scanner
Minimum Scan Interval
Running an offline component scan using Signature Scanner
Using certificate-based authentication with Signature Scanner
About Reduced Persistence Signature Scanning
About Stateless Scanning
About duplicate BOM detection
About component dependency duplication
Troubleshooting
Resolving memory issues
Resolving proxy errors
About snippet matching
Snippet extensions
About custom scan signatures
Approved signature lists
Managing scans in the Black Duck UI
Filtering scans
Defining the scan name
Uploading a scan file in Black Duck SCA
Browsing scans
Viewing an audit log for a BOM file
Mapping a scan to a project
Removing a scan from a project
Deleting a scan
Exporting a scan file or scan results
Understanding projects in Black Duck
Creating a project
Creating a SCM project
Deleting a project
Watching projects
Cloning projects
Updating project settings
Managing project team membership
Managing tags
Changing the project's SBOM alias
Viewing a project's or project version's activity
About project versions
Creating a new version of a project
Updating project version information
Cloning project versions
Deleting a project version
About project version phases
About Long-Term support (LTS) projects
Converting a project version to LTS
Viewing LTS project versions
About project version BOMs
Viewing a project version's BOM
Understanding the information in a project version's BOM
Header information
Risk graphs
Unconfirmed snippets and unmatched components
Infrastructure as Code
Data table
Reviewing the contents of a BOM
Editing a project version BOM
Applying edits to all versions of a project
Manually adding a component to a BOM
Excluding a component from a BOM
Deleting a component from a BOM
Removing components from a BOM
Ignoring a component in a BOM
Adjusting the component and/or component version in a BOM
Editing an origin or origin ID
Editing the component usage type
Modifying licenses in a BOM
Selecting the license term fulfillment status
Managing subprojects
Editing license text in the BOM
Reviewing snippet matches
Viewing snippet matches in the Source tab
Using the Snippet View
Managing comments in a BOM
Managing files associated with BOM components
Generating project version reports
Version Details report
Vulnerability report
Notices File report
Excluding a component or subproject from the Notices File report
Software Bill of Materials (SBOM) report
Black Duck to SPDX field mapping
Black Duck to CycloneDX field mapping
Dependency relationships in SBOM reports
Importing a SBOM file
Comparing BOMs
Printing a BOM
Viewing issues in a project
Viewing component versions with encryption
About Linux distributions in Black Duck
About SCM read-only BOMs
Viewing risk in Black Duck
Viewing the health of your projects
Viewing your dashboards
Viewing overall risk
About security risk
Viewing the security vulnerabilities of your projects, project versions, and component versions
Viewing project version vulnerabilities
Analyzing the impact of a vulnerability
Viewing vulnerability details
Black Duck Security Advisories
CVE record
Remediating security vulnerabilities
Getting remediation guidance for components with security vulnerabilities
Managing global remediation for a vulnerability
Finding data in Black Duck
Searching for projects
Searching for components
Searching for vulnerabilities
Saving and managing search results
Filtering the data shown in tables
Generating global reports
Vulnerability Remediation report
Vulnerability Status report
Vulnerability Update report
Deleting reports
Managing Black Duck
Managing components
About custom components
Managing custom components
Managing custom component versions
Unmatched component auto-creation on SBOM import
About Black Duck KnowledgeBase components
Understanding the component information available from the Black Duck KB
Understanding the component version information available from the Black Duck KB
Modifying KB components
Resetting a Black Duck KB component's values
About the KnowledgeBase Feedback Service
About unmatched origin components
Managing unmatched origin components
Setting or modify a component's status
Managing open source licenses
About license families
About custom license families
Creating custom license families
Editing custom license families
Deleting custom license families
Viewing licenses
Viewing license text
Viewing license use
Determining license risk
Managing deep license data
Detecting embedded licenses
Modifying licenses for a component
About custom licenses
Creating custom licenses
Editing a custom license
Deleting custom licenses
About license terms
Viewing license terms
About license term fulfillment
Defining fulfillment when viewing terms for a license
Creating license terms
Managing license term categories
Associating a license term to a license
Editing a custom license term
Deleting a license term
Deprecating or removing the deprecation status of a custom license term
Removing a license term
Deactivating a KnowledgeBase term
Restoring a KnowledgeBase license term
KnowledgeBase licenses
Editing a KnowledgeBase license
Restoring the original text and family of a KnowledgeBase license
Viewing detected copyright statements
Managing copyrights
Managing attribution statements
About license conflicts
Defining conflicts for customer license terms
Enabling management of license term conflicts
Managing project license conflicts
Managing policies
Default policy rules
Creating a policy rule
Creating policy rules for approved or barred items
Editing a policy rule
Copying a policy rule
Deleting a policy rule
Disabling or enabling a policy rule
Overriding policy violations
Removing policy overrides
Managing Project Groups
Creating a Project Group
Editing a Project Group
Managing SBOM templates
Creating a SBOM template
Editing a SBOM template
Setting a default SBOM template
Deleting a SBOM template
Activating or deactivating a SBOM template
Viewing SBOM fields
Administering Black Duck
Creating system announcements
Viewing jobs
Finished jobs table
Scheduled jobs table
Processing jobs table
Downloading log files and heatmap data
Creating heatmap data from terminal-data endpoint
Creating a Heatmap using Excel
Creating a heatmap in Excel on Mac
Creating a heatmap in Excel on Windows
Viewing heatmap data
Administering user accounts
Configuring password requirements
Creating a user account
Disabling a user
Converting a user account
Viewing a user's groups
Viewing a user's projects
Changing your Black Duck password
Changing user account information
Changing a user's password
Resetting your or a user's MFA configuration
Understanding roles
Managing user roles
Viewing your roles
Black Duck user role matrix
Managing the Project Manager and Project Group Manager roles
About locked out user accounts
Administering user groups
Viewing your user groups
Creating user groups
Managing user group information
Managing user group projects
Managing user group roles
Adding or removing members from a user group
Deleting user groups
Access Tokens
Managing user access tokens
Configuring Integrations
Setting up SCM providers
Managing SCM providers
Authenticating users for SCM providers
Configuring SCM repositories auto-scanning
Artifactory Integration
Authenticating users with LDAP
Configuring secure LDAP
Configuring SAML for Single Sign-On
Configuring System Settings
Customizing your branding
Managing custom fields
Creating a custom field
Editing a custom field
Deleting a custom field
Activating or deactivating a custom field
Determining the order of custom fields shown in the UI
Viewing custom fields
Defining the default security risk calculation
Enabling license term fulfillment
Configuring Multi-Factor Authentication (MFA)
Changing notification subscriptions
Hosting location for Black Duck Detect
Viewing product registration information
Data Retention
Project version auto-deletion
Changing the data retention period for unmapped scans
SBOM Retention
Retain Unmatched File Data
Scan auto-unmapping
Activity Audit Trail
BDSA Auto Remediation
Configuring match score threshold
Configuring the default license for unmatched components
Configuring copyright options
Viewing project and project version audit information
Managing your code size limits
Working with notifications
About the Tools page
Hosted KnowledgeBase vs On-Prem KnowledgeBase
Integrating Protex with Black Duck
Downloading the Protex BOM tool
Exporting a Protex BOM
Importing the Protex BOM file
Mapping or unmapping a Protex BOM
Black Duck C/CPP Tool
Black Duck integrations & APIs
Legal Information
Customer support
Black Duck Community
Getting Started with Black Duck
About Black Duck
Logging in to Black Duck
Scanning your code
Using Black Duck Detect (Desktop)
Creating a project
Mapping a scan to a project
Viewing risk in Black Duck
Viewing your dashboards
Viewing the health of your projects
About security risk
Viewing your BOM
Adjusting the component and/or component version in a BOM
Getting Started with Black Duck SDK
Accessing the REST APIs
Example of using the Black Duck SDK
CSRF security
API list
Architecture and Network Communications
Black Duck architecture overview
Black Duck on-premise architecture overview
Communication with Black Duck services
Data retention policy
Required URLs for proxy access
Black Duck Binary Analysis
Hosted Architecture and Network Communications
Architecture Overview
Black Duck hosted architecture overview
Black Duck Detect
The Scan Client
Black Duck web application
Black Duck upload service
Web services hosted on Black Duck servers
Communication between the Scan Client, Black Duck, and Black Duck services
Data retention policy
Required URLs for Proxy Access
Black Duck Binary Analysis
Installing Black Duck using Kubernetes and OpenShift
Hardware requirements
PostgreSQL versions
Installing Black Duck using Helm
Black Duck helm chart
Getting started
Configuring your Black Duck instance
Exposing the Black Duck UI
Installing the chart
Uninstalling the chart
Upgrading the chart
Configuration parameters
Common configuration
Authentication pod configuration
Binary scanner pod configuration
BOM engine pod configuration
CFSSL pod configuration
Datadog pod configuration
Documentation pod configuration
Integration pod configuration
Job runner pod configuration
Logstash pod configuration
Match engine pod configuration
PostgreSQL pod configuration
PostgreSQL readiness init container configuration
PostgreSQL upgrade job configuration
RabbitMQ pod configuration
Redis pod configuration
Registration pod configuration
Scan pod configuration
Storage pod configuration
Webapp pod configuration
Webserver pod configuration
Administrative Tasks
Configuring secrets encryption in Kubernetes
Generating seeds in Kubernetes
Configuring a backup seed
Managing secret rotation in Kubernetes
Configuring custom volumes for Blackduck Storage
Configuring jobrunner thread pools
Configuring readiness probes
Configuring HUB_MAX_MEMORY setting
Migrating on OpenShift with Helm
Provisioning JWT public/private key pairs
Enabling SCM Integration
Installing Black Duck using Docker Swarm
Overview of Black Duck Deployment with Docker Swarm
Components hosted on Black Duck servers
Installation planning
Getting started
Hardware requirements
Docker requirements
Operating systems
Software requirements
Network requirements
Database requirements
PostgreSQL versions
Migrating on Swarm Overview
Proxy server requirements
Configuring your NGiNX server to work with Black Duck
Amazon services
Additional port information
Configuring the keepalive setting
KnowledgeBase Feedback Service
Installing Black Duck
Installation files
Distribution
Installing Black Duck
Rapid Scanning in Black Duck
Administrative tasks
Environment files and variables
Duplicate BOM Detection
Changing the expiration time for a bearer token
About the KBMATCH_SENDPATH parameter
Accessing the API documentation through a proxy server
Providing access to the REST APIs from a non-Black Duck server
Configuring the Dashboard refresh rate
Managing certificates
Using custom certificates
Using a custom certificate authority for certificate authentication
Getting component migration data from the KnowledgeBase
Including ignored components in reports
Configuring secure LDAP
LDAP trust store password
Downloading log files and heatmap data
Viewing log files
Changing the default memory limits
Changing hostname for logstash
Cleaning up unmapped code locations
Clearing stuck BOM events
Using the override file
Configuring analytics in Black Duck
Configuring an external PostgreSQL instance
Modifying the PostgreSQL usernames for an existing external database
Configuring proxy settings
Configuring the report database password
Scaling job runner, scan, bomengine, and binaryscanner containers
Configuring SAML for Single Sign-On
Uploading source files
Starting or stopping Black Duck
Configuring user session timeout
Providing your Black Duck system information to Customer Support
Understanding the default sysadmin user
Configuring Black Duck reporting delay
Configuring the containers' time zone
Modifying the default usage
Customizing user IDs of Black Duck containers
Configuring Web server settings
Create BOM reports using UTF8 character encoding
Scan monitoring
Configuring HTML report download size
Configuring KB license update and security update jobs
Configuring secrets encryption in Black Duck
Generating seeds
Configuring a backup seed
Managing secret rotation
Configuring custom volumes for Blackduck Storage
Configuring multiple volumes
Migrating between volumes
Configuring storage volumes for reports
Configuring jobrunner thread pools
Configuring Rapid Scan for BOM support
Changing the long running job threshold
Enabling SCM Integration
Configuring automatic scan retry header
Configuring hierarchical subproject license conflicts
Provisioning JWT public/private key pairs
Configuring session token invalidation
Configuring SCA Scan Service
Uninstalling Black Duck
Upgrading Black Duck
Installation files
Migration script to purge unused rows in the audit event table
Upgrading from an existing Docker architecture
Backing up and restoring data
Docker containers
Authentication container
Binaryscanner container
Bomengine container
CA container
DB container
Documentation container
Integration container
Jobrunner container
Logstash container
Matchengine container
Rabbitmq container
Redis container
Registration container
ReversingLabs container
Scan container
Storage container
Webapp container
Webserver container
Scanning best practices
Rapid Scan Overview
Troubleshooting scanning issues
Frequently recommended Black Duck Detect options
Reporting Database
About the report database
Report Database Schema
Component table (component)
Component table (Ignored components only) (component_ignored)
Component Comments table (component_comments)
Component Custom Fields table (component_custom_fields)
Component License table (component_license)
Component Match Type table (component_match_types)
Component Matches table (component_matches)
Component Policies table (component_policies)
Component Usage table (component_usages)
Component Vulnerability table (component_vulnerability)
Project table (project)
Project Custom Fields table
Project Mapping table (project_mapping)
Project Version table (project_version)
Project Version Code Location table (project_version_code_location)
Project Version Custom Fields table (project_version_custom_fields)
Rapid Scan aggregate stats view table (scan_rapid_aggregate_stats_view)
Scan stats view table (scan_stats_view)
Scan view table (scan_view)
User table (user)
User group project mapping table (user_group_project_mapping)
Vulnerability Method Matches table (vulnerability_method_matches)
Release Notes
Black Duck 2024.10.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Previous Releases
Black Duck 2024.10.x
Black Duck 2024.10.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.7.x
Black Duck 2024.7.3
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.7.2
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.7.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.7.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.4.x
Black Duck 2024.4.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.4.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.1.x
Black Duck 2024.1.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2024.1.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2023.10.x
Black Duck version 2023.10.2
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.10.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.10.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2023.7.x
Black Duck version 2023.7.3
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.7.2
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck Version 2023.7.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.7.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2023.4.x
Black Duck version 2023.4.2
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.4.1
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.4.0
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck 2023.1.x
Black Duck version 2023.1.2
Announcements
New and changed features
API enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.1.1
Announcements
New and changed features
API Enhancements
Binary scanner information
Fixed issues
Black Duck version 2023.1.0
Announcements
New and changed features
API Enhancements
Binary scanner information
Fixed issues
Black Duck 2022.10.x
Black Duck version 2022.10.3
Announcements
New and changed features
API Enhancements
Binary scanner information
Fixed issues
Black Duck version 2022.10.2
Announcements
New and changed features
API Enhancements
Binary scanner information
Fixed issues
Black Duck version 2022.10.1
Announcements
New and changed features
API Enhancements
Binary scanner information
Fixed issues
Black Duck version 2022.10.0
Announcements for 2022.10.0
New and changed features in 2022.10.0
API enhancements
Binary scanner information
Fixed issues in 2022.10.0
Black Duck 2022.7.x
Announcements for Version 2022.7.2
New and changed features in version 2022.7.2
API Enhancements
Fixed Issues in 2022.7.2
Announcements for Version 2022.7.1
New and changed features in version 2022.7.1
API Enhancements
Fixed Issues in 2022.7.1
Announcements for Version 2022.7.0
ReleaseNotes/2022.7.x/ReleaseInfo_2022.7.0_new_and_changed_features.html
API Enhancements
Fixed Issues in 2022.7.0
Black Duck 2022.4.x
New and Changed Features in Version 2022.4.2
API Enhancements
Fixed Issues in 2022.4.2
New and Changed Features in Version 2022.4.1
API Enhancements
Fixed Issues in 2022.4.1
Announcements for Version 2022.4.0
New and Changed Features in Version 2022.4.0
API Enhancements
Fixed Issues in 2022.4.0
Black Duck 2022.2.x
New and Changed Features in Version 2022.2.2
API Enhancements
Fixed Issues in 2022.2.2
New and Changed Features in Version 2022.2.1
API Enhancements
Fixed Issues in 2022.2.1
Announcements for Version 2022.2.0
New and Changed Features in Version 2022.2.0
API Enhancements
Fixed Issues in 2022.2.0
Black Duck 2021.10.x
Announcements for Version 2021.10.3
New and Changed Features in Version 2021.10.3
Fixed Issues in 2021.10.3
Announcements for Version 2021.10.2
New and Changed Features in Version 2021.10.2
Fixed Issues in 2021.10.2
New and Changed Features in Version 2021.10.1
Fixed Issues in 2021.10.1
Announcements for Version 2021.10.0
New and Changed Features in Version 2021.10.0
API Enhancements
Fixed Issues in 2021.10.0
Black Duck 2021.8.x
New and Changed Features in Version 2021.8.8
Fixed Issues in 2021.8.8
Announcements for Version 2021.8.7
New and Changed Features in Version 2021.8.7
Fixed Issues in 2021.8.7
Announcements for Version 2021.8.6
New and Changed Features in Version 2021.8.6
Fixed Issues in 2021.8.6
New and Changed Features in Version 2021.8.5
Fixed Issues in 2021.8.5
New and Changed Features in Version 2021.8.4
Fixed Issues in 2021.8.4
New and Changed Features in Version 2021.8.3
Fixed Issues in 2021.8.3
New and Changed Features in Version 2021.8.2
Fixed Issues in 2021.8.2
New and Changed Features in Version 2021.8.1
Fixed Issues in 2021.8.1
Announcements for Version 2021.8.0
New and Changed Features in Version 2021.8.0
API enhancements
Fixed Issues in 2021.8.0
Black Duck 2021.6.x
New and Changed Features in Version 2021.6.2
Fixed Issues in 2021.6.2
New and Changed Features in Version 2021.6.1
Fixed Issues in 2021.6.1
Announcements for Version 2021.6.0
New and Changed Features in Version 2021.6.0
API enhancements
Fixed Issues in 2021.6.0
Black Duck 2021.4.x
New and Changed Features in Version 2021.4.1
Fixed Issues in 2021.4.1
Announcements for Version 2021.4.0
New and Changed Features in Version 2021.4.0
API enhancements
Fixed Issues in 2021.4.0
Black Duck 2021.2.x
New and Changed Features in Version 2021.2.1
Fixed Issues in 2021.2.1
Announcements for Version 2021.2.0
New and Changed Features in Version 2021.2.0
API enhancements
Fixed Issues in 2021.2.0
Black Duck 2020.12.x
Announcements for Version 2020.12.0
New and Changed Features in Version 2020.12.0
API enhancements
Fixed Issues in 2020.12.0
Black Duck 2020.10.x
New and Changed Features in Version 2020.10.1
Fixed Issues in 2020.10.1
Announcements for Version 2020.10.0
New and Changed Features in Version 2020.10.0
API enhancements
Fixed Issues in 2020.10.0
Known Issues and Limitations

Back to home page