Using Active Directory server as an authentication source (Federation)

Last updated 5th December 2022

Objective

This guide aims at explaining the details of implementing an Active Directory server as an authentication source on the OVHcloud Hosted Private Cloud.

Discover how to use your Active Directory server as an authentication source for your vSphere users.

Requirements

• A Hosted Private Cloud offer.
• An Active Directory service reachable from a public IP address and with a valid SSL certificate on LDAPS service.
• A user access on the associated Active Directory with at least read-only access (for LDAPS connection).
• Access to the Hosted Private Cloud vSphere management interface.

Instructions

Retrieve needed information

vCenter to Active Directory connection is done using LDAPS protocol exposed by the Active Directory server.

Preparing configuration setup, you need to retrieve the following information:

• Active Directory domain name (FQDN).
• Active Directory domain alias (NetBIOS name).
• Active Directory public IP address.
• Active Directory LDAPS hostname. This is the name used inside the SSL certificate of the LDAPS service, it must resolve to the public IP address of the Active Directory server.
• LDAPS service port (636 by default)
• Base DN (Base Distinguished Name) for users. This is the DN from which users will be searched. For example: dc=example,dc=com
• Base DN (Base Distinguished Name) for groups. This is the DN from which groups will be searched. For example: dc=example,dc=com
• Username and password of a domain user that will be used to connect to the LDAPS server. It must be at least a read-only user on the Active Directory server sections specified on the two "Base DN" fields above. Must be a pre-Windows 2000 username, in the UPN format (user@example.com).

For more information, you can refer to the VMware documentation.

In addition to the previous information, you will need to retrieve the SSL certificate fingerprint (SHA1 Fingerprint) of the Active Directory LDAPS service.

You can retrieve this information with the method of your choice.

• You can use this PowerShell command on the Active Directory server:

Get-ChildItem -Path Cert:\LocalMachine\MY | Select-Object -property FriendlyName, Subject, NotBefore, NotAfter, @{label='Thumbprint';'Expression'={$_.thumbprint -replace '(..(?!$))','$1:'}}

Here, it is the value on the right side of the colon sign:

> Thumbprint : BB:46:CA:6B:FC:92:4E:96:B4:BB:6E:44:7E:8F:AD:4C:C9:32:AB:AB

• You can also use the following OpenSSL command (from a distant Linux/Unix/Mac machine):

openssl s_client -connect ad.example.com:636 < /dev/null 2>/dev/null | openssl x509 -fingerprint -noout -in /dev/stdin

Here, it is the value on the right side of the equal sign:

> SHA1 Fingerprint=BB:46:CA:6B:FC:92:4E:96:B4:BB:6E:44:7E:8F:AD:4C:C9:32:AB:AB

Allow Active Directory access from the Hosted Private Cloud

Retrieve your Hosted Private Cloud IP address with the method of your choice.

You can use this command on the Active Directory server or any remote Windows machine:

nslookup pcc-198-51-100-121.ovh.com

Here, it is the value at the end of the last line:

> Address:  198.51.100.121

You can alternatively use the following command (from a remote Linux/Unix/Mac machine):

host pcc-198-51-100-121.ovh.com

Here, it is the value at the end of the line:

> pcc-198-51-100-121.ovh.com has address 198.51.100.121

Use the retrieved IP address to allow your Hosted Private Cloud to access the Active Directory LDAPS server (by default on TCP port 636).

This operation can be done on your Active Directory server firewall or your company firewall.

Here is a firewall rule configuration example:

Adapt this configuration to your company and apply that rule on your firewall.

Add your Active Directory server as an authentication source

From your OVHcloud Control Panel, go to the OVHcloud VMware cluster settings.

Go to the Users tab and click Add an Active Directory LDAPS in the Active Directories (LDAPS) section.

Enter the following information :

• Active Directory domain name : Active directory domain name.
• Active Directory domain alias: NetBIOS domain name.
• Description (optional) : Active directory domain name.
• Active Directory server IP address : Public IP address to access your LDAPS server.
• Active Directory LDAPS server host name : Public FQDN name of your Active Directory server.
• LDAPS service port : LDAPS service port number.
• SSL certificate thumbprint : SSL Thumbprint certificate retrieved earlier.
• Active Directory username : Pre-Windows 2000 username, in the UPN format (user@example.com).
• Active Directory user password : Active Directory user password.
• DN base for users : DN (Distinguish Name) containing users such as dc=example,dc=com for the example.com domain.
• DN base for groups : DN (Distinguish Name) containing the groups, such as dc=example,dc=com for the example.com domain.

Then click Submit.

A window will pop up to show progress, wait until it's fully completed and click Close.

Allow an Active Directory user to access your Hosted Private Cloud

You can allow an Active Directory user to access your Hosted Private Cloud from your OVHcloud Control Panel.

Click Import User.

Select your Active Directory, click Import User, enter your Active Directory Username in the UPN format (user@example.com) and click Next.

A task status window appears, wait until it's fully completed and click Close.

A new user will be displayed in the Control Panel. You can use this user to log in to the vSphere interface.

Allow an Active Directory group to access your Hosted Private Cloud

You can authorise directly a set of users (groups) from your Active Directory server to access your Hosted Private Cloud from the OVHcloud Control Panel.

Click on Import user.

Select your Active Directory, click Import Group, type the name of your group and click Next.

A task status window appears, wait until it's fully completed and click Close. Select your Active Directory, click Import Group, type your group name and click Next.

The group appears in the users list for your cluster, and members of this group can log in to your cluster’s administration interface.

Using the OVHcloud API

You can use the OVHcloud API to perform the same operations (adding a directory and allowing a group or user to connect to your vCenter interface).

Add your Active Directory server

Retrieve your « serviceName » using the following API call:

Then, use the following API call to add your Active Directory server as an authentication source.

You will have to specify information retrieved from the previous steps. Do not check the "noSsl" checkbox.

Make sure the return operation is successful. You can follow its progress in the OVHcloud Control Panel in your Hosted Private Cloud Operations tab.

Allow an Active Directory user to access your Hosted Private Cloud

You can allow an Active Directory user to access your Hosted Private Cloud through the OVHcloud API.

Retrieve your « activeDirectoryId » using the following API call:

Then, use the following API call to allow an Active Directory user to access your Hosted Private Cloud.

You will have to specify the "pre-Windows 2000" username as it is inside your Active Directory.

Make sure the return operation is successful. You can follow its progress in the OVHcloud Control Panel in your Hosted Private Cloud Operations tab.
If the provided information is invalid, the operation will be cancelled and a message will show the returned error.

Once allowed, the user and its permissions will be manageable directly from your OVHcloud Control Panel as any other Hosted Private Cloud user.

Allow an Active Directory group to access your Hosted Private Cloud

You can allow directly an Active Directory user set (group) to access your Hosted Private Cloud through the OVHcloud API.

Retrieve your « activeDirectoryId » using the following API call:

Then, use the following API call to allow an Active Directory group to access your Hosted Private Cloud.

You will have to specify the "pre-Windows 2000" group name as it is inside your Active Directory.

Make sure the return operation is successful. You can follow its progress in the OVHcloud Control Panel in your Hosted Private Cloud Operations tab.
If the provided information is invalid, the operation will be cancelled and a message will show the returned error.

Go further

Join our community of users on https://community.ovh.com/en/.

These guides might also interest you...