Skip to main content

Who is this article for?
Find your product plan in the Code42 console on the Account menu.

Incydr Professional and Enterprise
Incydr Basic and Advanced
Other product plans

Incydr Professional and Enterprise, yes.

Incydr Basic and Advanced, yes.

CrashPlan Cloud, yes.

Other product plans, yes.

CrashPlan for Small Business, no.

This article applies to Code42 cloud environments.

Other available versions:

On-premises

HOME
GETTING STARTED
RELEASE NOTES
FAQs
APIs
SYSTEM STATUS
Code42 Support

Configure Shibboleth for SSO in your Code42 cloud environment

Who is this article for?
Find your product plan in the Code42 console on the Account menu.

Incydr Professional and Enterprise
Incydr Basic and Advanced
Other product plans

Incydr Professional and Enterprise, yes.

Incydr Basic and Advanced, yes.

CrashPlan Cloud, yes.

Other product plans, yes.

CrashPlan for Small Business, no.

This article applies to Code42 cloud environments.

Other available versions:

On-premises

Overview

This tutorial explains how to configure your Code42 cloud environment to use single sign-on (SSO) with Shibboleth. If you have an on-premises authority server, see the instructions for configuring Shibboleth

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, Mac, and Linux
  • Code42 console
Incompatible with SSO
  • Code42 apps for iOS, Android, and Windows Phone

Considerations

  • Code42 usernames must match SSO usernames. How you accomplish this depends on how you deploy Code42 apps.
  • Code42 supports service provider-initiated SSO but does not support identity provider-initiated SSO. Therefore, users cannot sign in to your Code42 environment from the identity provider's website or application, but instead must log in using a browser bookmark. 
  • SSO provides user authentication but does not provide user management. Set up SCIM provisioning or use the Code42 console to manage users
  • Code42 does not support Single Logout (SLO). Users must sign out of the identity provider to end their single sign-on session.
  • To configure Code42 to support advanced SAML request configurations using the Code42 API, see Use the Code42 API to set SAML attributes
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 port 443. Test client connectivity to the identity provider before you proceed.
  • If you want to use URL-based metadata exchange to configure Code42 and the identity provider to work together, make sure two-way communication is available between them on TCP port 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 Code42.
  • Confirm the required ports with your identity provider to determine if custom ports are being used.

Determine whether you need to configure multiple Code42 tenants

Before you begin configuring SSO for Code42, consider whether your company has more than one Code42 tenant that you need to connect to your SSO identity provider. Large companies and organizations often have separate, dedicated Code42 cloud instances (or "tenants") in use by different groups or departments. 

If you have more than one Code42 tenant to connect to your SSO identity provider, you need to obtain an entity ID URL for each Code42 tenant. An entity ID is a unique string that identifies a specific tenant to your SSO identity provider. The tenant-specific entity ID URL is composed of the Code42 domain followed by the tenant ID, and can be found in the Code42 service provider metadata URL file in each tenant. For example:

"entityId": "https://example.com/42424daa-424c-4e42-42c4-c424242420d4" 

Step 1: Add an authentication provider

Follow the steps below for adding the authentication provider's metadata URL to the Code42 console. If your organization is part of the InCommon federation, you can add the InCommon metadata, and select your organization's metadata URL from the list. Follow the steps under Shibboleth if you are not part of the InCommon federation. 

InCommon

Shibboleth

Step 2: Prepare Shibboleth

There are two ways to exchange metadata between your Code42 environment and the Shibboleth identity provider:

  • If two-way communication is possible between Shibboleth and your {{c42cloud}} instance, use URL-based metadata exchange. This method periodically retrieves metadata from a given URL and stores the metadata file locally, so it can be used if the remote source is unavailable. 
  • If two-way communication is not available, use file-based metadata exchange.

For more information about adding a service provider to Shibboleth, see the Shibboleth documentation.

Shibboleth option A: URL-based metadata exchange

Shibboleth option B: File-based metadata exchange

Configure your Shibboleth identity provider to sign assertions

The Code42 console expects assertions to be signed. See Shibboleth's documentation for more information. 

  1. Edit the file ${Shibboleth}/conf/relying-party.xml. 
  2. Add or modify the ProfileConfiguration element, for example: 
Copied!
<RelyingParty id="urn:example.org" provider="https://idp.example.org" defaultSigningCredentialRef="ExampleOrgCred">
    <ProfileConfiguration xsi:type="saml:SAML2SSOProfile" signAssertions="always"/>
</RelyingParty>
  1. Set the signAssertions attribute to always.

Step 4: Test SSO authentication

Incydr Professional and Enterprise

Incydr Basic and Advanced, CrashPlan Cloud, and other plans

Step 5: Configure organizations to use SSO

Incydr Professional and Enterprise

Incydr Basic and Advanced, CrashPlan Cloud, and other plans

Step 6: Add new users that sign in with SSO

Option A: Add users in the Code42 console

Use the Code42 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

Distribute the Code42 app to new users

  • Incydr Professional and Enterprise
    New user accounts created with SSO registration are created automatically in Code42. 
  • Incydr Basic and Advanced, CrashPlan Cloud, and other plans
    • New user accounts created silent SSO registration are created automatically in Code42. 
    • New user accounts created with manual registration requires new users to register in the Code42 environment. Users choose Sign up for an account when they open the Code42 app and they create an account using their SSO credentials. (The Code42 app username must match the SSO username.)

What to expect

Reduced authentication prompts

When users sign in with SSO, they do not need to re-enter 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. 

For example, the single sign-in process differs whether users sign in to the Code42 console or the Code42 app:

  • Code42 console: When users sign in to the Code42 console, they are redirected in the web browser to sign in to their SSO identity provider. As soon as they sign in to their identity provider, the Code42 console launches. 
  • Code42 app (Incydr Basic and Advanced, CrashPlan Cloud, and other plans only): When users sign in to the Code42 app, following message appears: "To complete the sign in process, go to your web browser. This screen updates automatically once login is successful." A web browser window is automatically opened so they can complete the sign-in process in their SSO identity provider.  As soon as they sign in to their SSO identity provider in the provided web browser window, the Code42 app launches.

Losing access to an identity provider

Incydr Basic and Advanced, CrashPlan Cloud, and other plans only

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

External resources

Related topics

  • Was this article helpful?