Certificate authority configuration

This article describes the advanced configuration of Federated Authentication Service (FAS) to integrate with certificate authority (CA) servers. Most of these configurations are not supported by the FAS administration console. The instructions use PowerShell APIs provided by FAS. You should have a basic knowledge of PowerShell before executing any instructions in this article.

Set up multiple CA servers for use in FAS

You can use the FAS administration console to configure FAS with multiple CAs while creating or editing a rule:

All the CAs you select must be publishing the Citrix_SmartcardLogon certificate template (or whatever template you have chosen in your rule).

If one of the CAs you wish to use is not publishing the desired template, perform the Set up a certificate authority step for the CA.

Note:

You do not have to perform the Authorize this service step for every CA, because the authorization certificate configured in this step can be used at any of your CAs.

Expected behavior changes

After you configure the FAS server with multiple CA servers, user certificate generation is distributed among all the configured CA servers. Also, if one of the configured CA servers fails, the FAS server will switch to another available CA server.

Configure the Microsoft certificate authority for TCP access

FAS accesses the Microsoft CA using DCOM. DCOM uses port 135 to discover the port on which the service is listening. By default, the listening port is allocated dynamically. This can result in complexities when implementing firewall security. Therefore, Microsoft has a provision to configure a static port. To configure a static port on Microsoft CA, select Start > Run > dcomcnfg.exe to open the DCOM configuration panel. Expand Computers > My computer > DCOM Config to show the CertSrv Request node. Then, edit the properties of the CertSrv Request DCOM application:

Change the Endpoints to select a static endpoint and specify a TCP port number (900 in the preceding graphic).

In this example, the firewall needs to allow port 135 and port 900.

Restart the Microsoft certificate authority to apply the change.

There is no need to configure the FAS server (or any other machines using the certificate authority) because DCOM has a negotiation stage using the RPC port 135. When a client needs to use DCOM, it connects to the DCOM RPC Service on the server and requests access to a particular DCOM server. This triggers port 900 (in this example) to be opened, and the DCOM server instructs the client to connect to that port.

Pre-generate user certificates

The logon time for users will significantly improve when user certificates are pre-generated within the FAS server. The following sections describe how it can be done, either for single or multiple FAS servers.

Get a list of Active Directory users

You can improve certificate generation by querying the AD and storing the list of users into a file (for example, a .csv file), as shown in the following example.

Import-Module ActiveDirectory

$searchbase = "cn=users,dc=bvt,dc=local" # AD User Base to Look for Users, leave it blank to search all
$filename = "user_list.csv" # Filename to save

if ($searchbase -ne ""){
    Get-ADUser -Filter {(UserPrincipalName -ne "null") -and (Enabled -eq "true")} -SearchBase $searchbase -Properties UserPrincipalName | Select UserPrincipalName | Export-Csv -NoTypeInformation -Encoding utf8 -delimiter "," $filename
} else {
    Get-ADUser -Filter {(UserPrincipalName -ne "null") -and (Enabled -eq "true")} -Properties UserPrincipalName | Select UserPrincipalName | Export-Csv -NoTypeInformation -Encoding utf8 -delimiter "," $filename
}
<!--NeedCopy-->

Get-ADUser is a standard cmdlet to query for a list of users. The example above contains a filter argument to list only users with a UserPrincipalName and an account status of ‘enabled.’

The SearchBase argument narrows which part of the AD to search for users. You can omit this if you want to include all users in AD. Note: This query might return a large number of users.

The CSV looks something like this:

FAS server

The following PowerShell script takes the previously-generated user list and creates a list of user certificates.

Add-PSSnapin Citrix.A*
$csv = "user_list.csv"
$rule = "default" # rule/role in your admin console
$users = Import-Csv -encoding utf8 $csv
foreach ( $user in $users )
{
    $server = Get-FasServerForUser -UserPrincipalNames $user.UserPrincipalName
    if( $server.Server -ne $NULL) {
        New-FasUserCertificate -Address $server.Server -UserPrincipalName $user.UserPrincipalName -CertificateDefinition $rule"_Definition" -Rule $rule
    }
    if( $server.Failover -ne $NULL) {
        New-FasUserCertificate -Address $server.Failover -UserPrincipalName $user.UserPrincipalName -CertificateDefinition $rule"_Definition" -Rule $rule
    }
}
<!--NeedCopy-->

If you have more than one FAS server, a particular user’s certificate will be generated twice: one in the main server, and the other in the failover server.

The script above is catered for a rule named ‘default’. If you have a different rule name (for example, ‘hello’), just change the $rule variable in the script.

Renew registration authority certificates

If more than one FAS server is in use, you can renew a FAS authorization certificate without affecting logged-on users.

Note:

You can also use the GUI to reauthorize FAS:

Complete the following sequence:

1. Create a new authorization certificate: New-FasAuthorizationCertificate

2. Note the GUID of the new authorization certificate, as returned by: Get-FasAuthorizationCertificate

3. Place the FAS server into maintenance mode: Set-FasServer –Address <FAS server> -MaintenanceMode $true

4. Swap the new authorization certificate: Set-FasCertificateDefinition –AuthorizationCertificate <GUID>

5. Take the FAS server out of maintenance mode: Set-FasServer –Address <FAS server> -MaintenanceMode $false

6. Delete the old authorization certificate: Remove-FasAuthorizationCertificate

Related information

• The Install and configure article is the primary reference for FAS installation and configuration.
• The common Federated Authentication Service deployments are summarized in the Deployment architectures article.
• Other “how-to” articles are introduced in the Advanced configuration article.