Skip to main content
Code42 Support

Configure Microsoft AD FS for SSO in your Code42 cloud environment

Available in:

  • CrashPlan PRO
    • Standard
    • Premium
    • Enterprise
Applies to:

Overview

This tutorial explains how to configure your Code42 cloud environment to use single sign-on (SSO) with Microsoft Active Directory Federation Services (AD FS) 3.0. If you have an on-premises authority server, see this article instead.

This article assumes you are already familiar with SSO and the SAML standard. For more information about how the Code42 platform implements SSO, see our Introduction To Single Sign-On.

Compatible Code42 platform components

Compatible With SSO
  • Code42 app for Windows, OS X, and Linux
  • Administration console
Incompatible With SSO
  • Code42 apps for iOS, Android, and Windows Phone

Considerations

  • You must have access to a web server where you can place the PingOne metadata file.
  • You must define users with the same usernames in both your Code42 environment and your SSO data.
  • The administration console supports service provider-initiated SSO but does not support identity provider-initiated SSO. This means that users cannot sign in to your Code42 environment from an identity provider website or application.

Authentication and user management

  • Users that sign in with SSO must exist in your Code42 environment, and their Code42 environment usernames must match their SSO usernames.
  • SSO provides user authentication but does not provide user management. Use the Code42 administration console to manage users.
External authentication systems
Our Customer Champions can help with authentication issues caused by interaction with Code42 products. However, troubleshooting authentication issues outside your Code42 environment is beyond the scope of our Customer Champions.
For assistance with external authentication systems, contact your authentication vendor.
  • You must have access to a web server where you can place the PingOne metadata file.
  • You must define users with the same usernames in both your Code42 environment and your SSO data.
  • The administration console supports service provider-initiated SSO but does not support identity provider-initiated SSO. This means that users cannot sign in to your Code42 environment from an identity provider website or application.

Authentication and user management

  • Users that sign in with SSO must exist in your Code42 environment, and their Code42 environment usernames must match their SSO usernames.
  • SSO provides user authentication but does not provide user management. Use the Code42 administration console to manage users.
External authentication systems
Our Customer Champions can help with authentication issues caused by interaction with Code42 products. However, troubleshooting authentication issues outside your Code42 environment is beyond the scope of our Customer Champions.
For assistance with external authentication systems, contact your authentication vendor.

Before you begin

Verify Identity Provider Configuration
  • Make sure the SSL certificate of your SSO identity provider has been signed by a trusted Certificate Authority (CA).
  • Make sure you have administrative access to the identity provider or have contact with an identity provider administrator.
Verify Network Configuration
  • Configure your private network, Internet, and VPN settings to allow client devices to communicate with your identity provider on ports 80 and 443. Test client connectivity to the identity provider before you proceed.
  • If you want to use URL-based metadata exchange to configure your authority server and identity provider to work together, make sure two-way communication is available between them on TCP ports 80 and 443. If two-way communication is not available or not allowed, you must download the identity provider's metadata file and make it accessible to your administration console.
  • Confirm the required ports with your identity provider to determine if custom ports are being used.

Step 1: Prepare Microsoft AD FS

  1. Verify that AD FS is deployed according to Microsoft's instructions.
  2. If there is a mix of Windows, Mac, and Linux computers in your Code42 environment, go to Edit Global Authentication Policy in AD FS, and enable both Windows authentication and Forms authentication. See Microsoft's instructions
  3. Create a relying party trust between AD FS and your Code42 administration console.
    1. Follow the wizard steps to configure the relying party trust.
    2. When you are prompted for the relying party metadata, go to the administration console, navigate to Settings > Security, and copy the Service Provider Metadata URL for your administration console. 
  4. Configure the relying party trust for Code42 to use the SHA-1 hash algorithm.
    1. Right-click the relying party trust, then select Properties.
    2. Click Advanced.
    3. From Secure hash algorithm, select SHA-1.

Step 2: Add AD FS to your administration console

The AD FS metadata file, which is available at https://<adfs-server>/federationmetadata/2007-06/federationmetadata.xml, must be accessible to your administration console to complete this step. If your network configuration prevents URL-based metadata exchange, or if you need to manually edit the identity provider's metadata file, see Make The AD FS Metadata File Accessible below.

  1. Sign in to the Code42 administration console.
  2. Navigate to Settings > Security.
  3. Click Add Identity Provider or Federation.
  4. In Identity Provider metadata URL, enter the URL for the PingOne metadata file.
  5. Click Continue.
    Additional identity provider settings appear.
    Identity_Provider_Edit-42-export (1).png
  6. In Display name, enter an identity provider name to display to users who sign in with SSO.
    If more than one SSO identity provider is offered by your Code42 environment, users are presented with a list of identity providers to choose from. The list includes all identity providers offered throughout your Code42 environment because the users' organizations are not known until they sign in.
  7. (Optional) Code42 recommends using the default settings, but you can customize mappings between Code42 platform user attributes and identity provider SSO assertion attributes.
    1. Deselect Use default mapping.
    2. Configure mapping settings for each Code42 platform user attribute:
      • Username: Specify the SSO identifier or attribute that maps to the Code42 platform username.
        • Select Use nameId to use the SSO name identifier.
        • Select Use Attribute tag to enter a custom SSO attribute.
      • Email: Enter the SSO attribute that contains user email addresses.
      • First name: Enter the SSO attribute that contains user first names.
      • Last name: Enter the SSO attribute that contains user last names.
  8. Click Save.

(Optional) Step 3: Add additional SSO Override users

Create at least one override user, a user who signs in to the administration console with local authentication—never SSO. An override user is absolutely essential for accessing your administration console if you have problems with SSO.

First user automatically added to SSO override
The SSO override list automatically includes your environment's first user. Adding additional users is optional. 
  • Users in the override list can never use SSO. They must sign in with a passwords defined in the console.
  • You should always have at least one user in the SSO overrride list
  1. Sign in to the administration console.
  2. Select Settings > Security.
  3. Under SSO Override, enter a username into the box.
    We recommend adding users with either the Org Admin or Customer Cloud Admin role.
  4. Click + to add the admin to the list.
    cloudsso-security-blank-ssooverride-highlight-export-(1) (1).png
  5. Add the password for the SSO override user:
    1. Go to Users, and select the SSO override user. 
    2. Click the action menu, and choose Edit
    3. Add the password for the user. 

Step 4: Test SSO authentication

  1. Create a test user in AD FS. 
  1. Sign in to the Code42 administration console.
  2. Create a test organization.
  3. Create a user in the test organization who matches the identity provider test user.
  4. Configure the test organization to use SSO.
    1. Navigate to Organizations, then select the organization.
    2. From the Action menu, select Edit.
    3. Click Security.
      SSO-security-generic-idp-export (1).png
    4. Deselect Inherit security settings from parent.
    5. From Select an authentication method, choose SSO.
      The configured SSO identity providers appear.
    6. Select the identity providers that you want to offer for the organization.
    7. From Select a directory service, select Local.
    8. Click Save.
  5. Sign in to the Code42 administration console as the test user to verify that SSO is working.

Step 5: Configure production organizations to use SSO

Enable SSO for one or more organizations in your Code42 environment. If two or more identity providers are offered in your Code42 environment, tell the users in each organization which identity provider they should choose when they sign in.

Disabled inheritance
If you disable inheritance for an organization, that organization is not affected by changes to its parent organization.

Option A: Enable SSO for a specific organization

  1. Sign in to the administration console.
  2. Navigate to Organizations, then select the organization.
  3. From the action menu, select Edit.
  4. Click Security.
    SSO-security-generic-idp-export (3).png
  5. Deselect Inherit security settings from parent.
  6. From Select an authentication method, choose SSO.
    The configured SSO identity providers appear.
  7. Select the identity providers that you want to offer for the organization.
  8. From Select a directory service, select Local.
  9. Click Save.

Option B: Enable SSO for all organizations

Modify the system-wide organization settings to enable SSO for all organizations.

  1. Sign in to the administration console.
  2. Go to Organization.
    organizations
  3. Click on the top-level organization.
    The organization details appear
  4. From the action menu, select Edit.
  5. Click Security.
  6. From Select an authentication method, choose SSO.
    The configured SSO identity providers appear.
  7. Select the identity providers that you want to offer to your organizations.
  8. From Select a directory service, select Local.
  9. Click Save.
  10. Under each child organization, make sure that Inherit security settings from parent is enabled.
    1. Click the child organization.
    2. From the action menu, select Edit.
    3. Click Security.
    4. Enable Inherit security settings from parent.

Step 6: Add new users that sign in with SSO

Option A: Add users in the administration console

Use the administration console to add users to an organization that uses SSO.

  • Verify that the users in the organization exist in the SSO identity provider used by the organization.
  • Make sure that the Code42 environment usernames match the SSO usernames.

Option B: Deploy the Code42 app

New users can register accounts in your Code42 environment:

  1. Distribute the Code42 app installer to new users
  2. Choose Sign up for an account when you open the Code42 app.
  3. Create an account using the SSO credentials. The Code42 app username match the SSO username.

What to expect

Reduced authentication prompts

When a user signs in with SSO, the user does not need to reenter credentials for subsequent authentication attempts until the SAML authentication token expires. A SAML token applies to an application rather than a device, which means that a user might need to enter credentials again when signing into a different app. Signing in to the Code42 app does not also authenticate the administration console because one is an app on the device and the other is accessed via a web browser.

Losing access to an identity provider

If a user loses access to the identity provider, the Code42 app continues to back up, uninterrupted.

Make the AD FS metadata file accessible

If your identity provider or network configuration prevents URL-based metadata exchange, or if you need to manually edit the identity provider's metadata file, you must make the identity provider metadata file accessible to your Code42 administration console.

Place the metadata file on a corporate web server

  1. Add the identity provider metadata file to a web server that is accessible to your administration console.
  2. Record the URL for the metadata file.
  3. Use a web browser to verify that you can access the metadata file.