Skip to main content
Druva Documentation

How to install and configure ADFS on Windows Server 2016 with DCP

This article applies to:

  • OS: Windows Server 2016
  • Product edition: Druva Cloud Platform (DCP)
  • Only a Druva Cloud administrator can set up Single Sign-on. 
  • Configure Single Sign-on based on the applicable scenarios:
    • New Druva customers that is; Phoenix customers on-boarded after July 02, 2018, and inSync customers on-boarded after July 14, 2018, must refer to the instructions given in this article.
    • Existing Phoenix and inSync customers who already have configured Single Sign-on, must continue to use the existing Single Sign-on settings of Phoenix and the Single Sign-on settings of inSync as applicable.

 

Overview

This article provides the steps to install and configure Active Directory Federation Services (ADFS) on Windows Server 2016 with Druva Cloud Platform (DCP).

Before configuring ADFS 

  • Register your Windows Server 2016 server as a member of the existing domain.
  • Log in to ADFS server as a domain administrator.
  • Obtain a valid certificate of the ADFS server.

Install and configure ADFS on Windows Server 2016 with DCP

Installation and configuration steps:

  1. Install the ADFS role
  2. Configure the federation server
  3. Configure ADFS to integrate with DCP

Install the ADFS role

To install the ADFS role:

  1. Open Server Manager>Manage>Add roles and features. The Add Roles and Features wizard is launched.
  2. On the Before you begin page, click Next.
  3. On the Select installation type page, select Role-based or Feature-based installation, and then click Next.
  4. On the Select destination server page, click Select a server from the server pool and click Next.
  5. On the Select server roles page, select Active Directory Federation Services and click Next.
  6. On the confirmation page, click Install. The wizard displays the installation progress.
  7. Verify the installed component and click Close.

Configure the federation server

To configure the federation server:

  1. On the Server Manager Dashboard, click the Notifications flag and then click Configure the federation service on the server. The Active Directory Federation Service Configuration Wizard is launched.

    ADFSConfWizLaunch.png
  2. On the Welcome page, select Create the first federation server in a federation server farm and click Next.
  3. On the Connect to Active Directory Domain Services page, specify an account with domain administrator rights for the Active Directory domain that this system is connected to and then click Next.
  4. On the Specify Service Properties page, enter the following details before clicking Next:
    • Browse to the location of the SSL certificate and import it.
    • Enter a Federation Service Name. This is the same value provided when you enrolled an SSL certificate in Active Directory Certificate Services (AD CS).
    • Enter a Federation Service Display Name.
  5. On the Specify Service Account page, select Use an existing domain user account and click Next.
  6. On the Specify Configuration Database page, select Create a database on this server using Windows Internal Database and click Next.
  7. On the Pre-requisite Checks page, verify that all prerequisite checks were successfully completed and click Configure.
  8. Review the results and check whether the configuration has completed successfully on the Results page.

    PreReqCheck.png

Configure ADFS to integrate with DCP

After installing the ADFS role on Windows Server 2016, configure ADFS to integrate with DCP as follows:

  1. Create a relying party
  2. Create a new claim
  3. Create a custom rule
  4. Get the IdP certificate
  5. Configure the SSO settings
  6. Enable SSO for administrators

Create a relying party

To create a relying party:

  1. On the Start menu, click Administrative Tools > AD FS Management. The ADFS Management console is launched.
  2. Click Relying Party Trusts. The wizard to add a relying party is launched.

    RelyingPartyTrusts.png
  3. On the Add Relying Party Trusts Wizard, select Claims Aware and then click Start.
  4. Under Select Data Source, select Enter data about the relying party manually.

    EnterRelyingPartyData.png
  5. In Specify Display Name field, enter Druva Cloud Platform.
  6. In the Configure URL section, select Enable Support for SAML 2.0 WebSSO Protocol and enter Relying party service URL as https://login.druva.com/api/commonlogin/samlconsume.

    EnableSAMLSupport.png
  7. On the Configure Identifiers page, enter Relying Party Trust Identifier as DCP-login.

    ConfigIdentifiers.png
  8. Under Choose Access Control Policy, select Permit everyone and click Next. This allows all users to access the relying party, these policies can later be modified as required.

    ChooseAccessControl.png
  9. On the Finish page, select Configure claims issuance policy for this application and click Close. The Claim Issuance policy page is launched.

    FinishPage.png

 If the Claim Issuance Policy page does not open, open AD FS Management Snap and right-click Relying party trust > select Edit Claim Issuance Policy.

Create a new claim

  1. Right-click Druva Cloud under Relying Party Trusts list and select Edit Claim Issuance Policy from the menu.

    EditClaimIssuance.png
  2. On the Issuance Transform Rules tab, click Add Rule.

    AddRule.png
  3. Under Select Rule Template, set Send LDAP attributes as Claims as the rule template and click Next.

    SelectRoleTemplate.png
  4. In the Edit Rule section, set the claim rule name as Active Directory.

    EditRule.png
  5. Enter the appropriate values in each field based on the descriptions provided below.
     
    Field Action
    Claim rule name Enter a name for the claim rule.
    Attribute store Select Active Directory from the list.
    Mapping of LDAP attributes to outgoing claim types
    LDAP Attribute Enter the outgoing claim type.
    E-mail Addresses Enter the Name ID.
    E-mail Addresses Enter the e-mail address.
    User-Principal-Name  Enter the user name.
    ​​​​​​​
  6. Click OK.

Create a custom rule

  1. On the Edit Claim Issuance Policy window, under Issuance Transform Rules tab, click Add Rule. The Select Rule Template page is displayed.

    SelectRuleTemplate.png
  2. From the Claim rule template list, select Send Claims Using a Custom Rule and click Next. The Edit Rule – LDAP EMAIL window is displayed.
  3. Enter appropriate values based on the actions suggested below for each field.
     
    Field Action
    Claim rule name Enter the name of the customer rule.
    Custom rule => issue(Type = "druva_auth_token", Value = "value of SSO Token generated from  Druva Cloud Platform");

    ConfigClaimRule.png
  4. Click Finish.

Get the IdP certificate

IdP certificate is required before configuring the Single Sign-On with DCP.  To get the IdP certificate:

  1. On the Start menu, click Administrative Tools > AD FS Management
  2. Expand to the Service folder and click Certificates.
  3. Double-click on the Token-signing certificate.
  4. Click Details and click Copy to File.

    CertificateDetails.png
  5. On the Certificate Export Wizard, select Base-64 encoded X.509 (.CER) and click Next.

    ExpFileFormat.png
  6. On the File to Export page, enter the file name as idpcert.cer, and then click Next.
  7. Copy the contents of the idpcert.cer certificate and provide it while configuring the single sign-on settings on the DCP Console.

Configure the Single Sign-On settings

To configure the single sign-on settings login to Druva admin console.

  1. On the Druva Cloud Platform console, go to Settings.

    DCPSettings.png
  2. Open the Single Sign-On tab and click Edit.
  3. Enter appropriate attribute values based on the descriptions provided below for each field.
     
    SAML Attribute Description and value
    ID Provider Login URL https://{fqdn-name of the ADFS server}/adfs/ls (for e.g. https://sts.druva.ga/adfs/ls
    ID Provider Certificate  Provide the content of the idpcert.cer certificate.
    AuthnRequests Signed Select this check box to get signed SAML Authentication Requests. By default, SAML Authentication Requests are not signed.
     
    Want Assertions Encrypted Select this check box to enable encryption for the SAML assertions. By default, encryption is disabled.
     

    EditSSOSettingsDCP.png

  4. Click Save.
    After this configuration, SSO can be enabled for administrators (inSync and Phoenix)  and users.
     

Enable SSO for Administrators

  1. On the Druva Cloud Platform console, got to Settings.

    DCPSettings.png
  2.  On the Single Sign-On settings, click Edit. The Single Sign-On Settings page is displayed.

    EnableSSOforAdmins.png
  3. Select Enable single sign-on for administrators
  4. Ensure Failsafe for administrators is selected by default.
  5. Failsafe for Administrators enables the administrator to use both SSO and DCP password to access the DCP Console. Hence, Druva recommends enabling Failsafe for administrators as they can access the respective management console in case of any failures in IdP (ADFS).
  6. Click Save.

See also

To enable SSO for users (inSync), refer Enable SSO for users