Black Duck by Synopsys cloud application

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

Using Security Assertion Markup Language (SAML), your users can use their Google Cloud credentials to sign in to enterprise-cloud applications.

Note: Black Duck must be deployed on Google Compute Engine (GCE), Amazon Web Services (AWS) or Azure. For deployment instructions please refer to Black Duck’s cloud platform documentation.

Set up SSO via SAML for Black Duck

Step 1: Set up Google as a SAML identity provider (IdP)

1. Sign in to your Google Admin console.

   Sign in using an account with super administrator privileges (does not end in @gmail.com).

2. In the Admin console, go to Menu  AppsWeb and mobile apps.
3. Click Add appSearch for apps.
4. Enter Black Duck by Synopsys in the search field.
5. In the search results, hover over the Black Duck SAML app and click Select.
6. On the Google Identity Provider details page, download the IDP metadata file.
7. Click Continue.
8. On the Service provider details page, edit the ACS URL and Entity ID replacing {your-domain} with the the domain where Black Duck is installed.
9. Click Continue.
10. On the Attribute Mapping page, set the Select category and Select user field values as follows for the listed attributes:
     

    Application attribute	Select category	Select user field
    FirstName	Basic Information	First Name
    LastName	Basic Information	Last Name
    Email	Basic Information	Primary Email
    Name	Basic Information	Primary Email

11. (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 service provider’s corresponding groups attribute name.

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

12. Click Finish.

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

1. Open a new incognito browser window.
2. Sign in to Black Duck with your admin account.
3. Click Administration and select SAML Integration.
4. Check Enable SAML.
5. In the Service Providers Entity URL enter the URL to the Hub.
6. In the Identity Provider Metadata text box, paste the contents of the IDP metadata file you downloaded in Step 1.
7. Click Save.
8. Connect via Secure Shell (SSH) to the Hub server.
9. In the docker-compose directory, edit the hub-proxy.env file as follows: add the following line to the end of the file, replacing {url-to-the-hub} with the URL of the instance where Black Duck is deployed:
   • HUB_SAML_EXTERNAL_URL={url-to-the-hub}
10.  Restart the Hub Instance.

Step 3: Enable the Black Duck app

1. Sign in to your Google Admin console.

   Sign in using an account with super administrator privileges (does not end in @gmail.com).

2. In the Admin console, go to Menu  AppsWeb and mobile apps.
3. Select Black Duck.
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.
        Note: Learn more about organizational structure.
7. To turn on a service for a set of users across or within organizational units, select an access group. For details, go to Use groups to customize service access.
8. Ensure that your Black Duck user account email IDs match those in your Google domain.

Step 4: Verify that the SSO is working

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

1. Sign in to your Google Admin console.

   Sign in using an account with super administrator privileges (does not end in @gmail.com).

2. In the Admin console, go to Menu  AppsWeb and mobile apps.
3. Select Black Duck.
4. At the top left, click Test SAML login. 

   Black Duck should open in a separate tab. If it doesn’t, use the information in the resulting SAML error messages to update your IdP and SP settings as needed, then retest SAML login.

_{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.}