Black Duck cloud app

Using the SAML 2.0 standard, you can configure single sign-on (SSO) for a number of cloud apps. After you set up SSO, your users can use their Google Workspace credentials to sign in to an app using SSO.

Use SAML to set up SSO for Black Duck

Expand all  |  Collapse all

You must be signed in as a super administrator for this task.

Before you begin

You can use Black Duck on Google Compute Engine (GCE), Amazon Web Services (AWS), or Azure. For installation instructions, refer to Black Duck’s cloud platform documentation.

Step 1: Set up Google as a SAML identity provider

1. Sign in with a super administrator account to the Google Admin console.

   If you aren’t using a super administrator account, you can’t complete these steps.

2. Go to Menu  Apps > Web and mobile apps.
3. Click Add appSearch for apps.
4. For Enter app name, enter Blackduck.
5. In the search results, point to Blackduck and click Select.
6. In the Google Identity Provider details window, download the identity provider metadata.
7. Click Continue.
8. On the Service provider details page, for ACS URL and Entity ID, replace {your-domain} with the domain where Black Duck is installed.
9. Click Continue.
10. In the Attribute Mapping window, click Select field and map the following Google directory attributes to their corresponding Black Duck attributes. The FirstName, LastName, Email, and Name attributes are required.

    Google directory attribute	Black Duck attribute
    Basic Information > First Name	FirstName
    Basic Information > Last Name	LastName
    Basic Information > Primary Email	Email
    Basic Information > Primary Email	Name

11. (Optional) To add additional mappings, click Add Mapping and select the fields that you need to map.
12. (Optional) To enter group names that are relevant for this app:

    1. For Group membership (optional), click Search for a group, enter one or more letters of the group name, and select the group name.
    2. Add additional groups as needed (maximum of 75 groups).
    3. For App attribute, enter the corresponding groups attribute name of the service provider.

    Regardless of how many group names you enter, the SAML response includes only groups that a user is a member of (directly or indirectly). For more information, go to About group membership mapping.

13. Click Finish.

Step 2: Set up Black Duck as a SAML 2.0 service provider

1. Open an Incognito browser window, go to the Black Duck sign-in page, and sign in with your Black Duck administrator account.
2. Click Administration and select SAML Integration.
3. Check the Enable SAML box.
4. For Service Providers Entity URL, enter the URL to the Hub.
5. For Identity Provider Metadata, paste the identity provider metadata that you downloaded in Step 1.
6. Click Save.
7. Connect to the Hub server using Secure Shell (SSH).
8. In the docker-compose directory, add the following line to the end of the hub-proxy.env file: HUB_SAML_EXTERNAL_URL={url-to-the-hub}.
9. Replace {url-to-the-hub} with the URL of the instance where Black Duck is installed.
10. Restart the Hub Instance.

Step 3: Turn on app for users

Before you begin: To turn a service on or off for certain users, put their accounts in an organizational unit (to control access by department) or add them to an access group (to allow access for users across or within departments).

1. Sign in with a super administrator account to the Google Admin console.

   If you aren’t using a super administrator account, you can’t complete these steps.

2. Go to Menu  Apps > Web and mobile apps.
3. Click Blackduck.
4. Click User access.

5. To turn a service on or off for everyone in your organization, click On for everyone or Off for everyone, and then click Save.

6. (Optional) To turn a service on or off for an organizational unit:

   1. At the left, select the organizational unit.
   2. To change the Service status, select On or Off.
   3. Choose one:
      • If the Service status is set to Inherited and you want to keep the updated setting, even if the parent setting changes, click Override.
      • If the Service status is set to Overridden, either click Inherit to revert to the same setting as its parent, or click Save to keep the new setting, even if the parent setting changes.
        Learn more about organizational structure.
7. (Optional) To turn on a service for a set of users across or within organizational units, select an access group. For details, go to Customize service access using access groups.
8. Ensure that the email domains for your Black Duck user account match the primary domain of your organization’s managed Google Account.

Step 4: Verify SSO is working

Black Duck supports SSO only if you sign in from Google. You can’t use SSO if you sign in directly to Black Duck.

Verify identity provider-initiated SSO

1. Sign in with a super administrator account to the Google Admin console.

   If you aren’t using a super administrator account, you can’t complete these steps.

2. Go to Menu  Apps > Web and mobile apps.
3. Click Blackduck.
4. In the Blackduck section, click Test SAML Login.

   The app should open in a separate tab. If it doesn’t, troubleshoot the error message and try again. For details on troubleshooting, go to SAML app error messages.

Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.