Related Adaptive Authentication configurations
Edit an FQDN
You cannot edit an FQDN if Adaptive Authentication is selected as the authentication method in the Workspace configuration. You must switch to a different authentication method to edit the FQDN. However, you can edit the certificate if necessary.
Important:
- Before modifying the FQDN, ensure that the new FQDN is mapped to the IdP virtual server public IP address.
- Existing users who are connected to Citrix Gateway using OAuth policies must migrate your authentication method to Adaptive Authentication. For details, see Migrate your authentication method to Adaptive Authentication.
To edit an FQDN, perform the following:
-
Switch to a different authentication method from Adaptive Authentication.
-
Select I understand the impact on the subscriber experience, and then click Confirm.
When you click Confirm, the workspace login to end users is impacted and Adaptive Authentication is not used for authentication until Adaptive Authentication is enabled again. Therefore, it is recommended that you modify the FQDN during a maintenance window.
-
In the Upload Certificate screen, modify the FQDN.
-
Click Save Changes.
Important:
If you edit an FQDN, you must also upload the certificate again.
-
Enable the Adaptive Authentication method again by clicking Enable (step 3) in the Adaptive Authentication home page.
-
Click Refresh.
Custom workspace URL or vanity URL
For the custom workspace URL or vanity URL, configure a new OAuthIDP profile with the same client ID, secret, and audience as your current one but with a redirect URL of https://your.company.com/core/login-cip. In this example, your.company.com
is the custom workspace URL corresponding to your domain. For example, nssvctesting.net
is the domain and custom workspace URL is ws1.nssvctesting.net
.
Create a new OAuthIDP policy and bind it to the authentication and authorization virtual server.
Note:
Both OAuthIDP policies can co-exist and a user can access Workspace using the default Workspace URL or the custom workspace URL or both.
Schedule upgrade of your Adaptive Authentication instances
For the current site or deployment, you can select the maintenance window for upgrade.
Important:
Do not upgrade the Adaptive Authentication instances to random RTM builds. All upgrades are managed by Citrix Cloud.
-
On the Adaptive Authentication UI, in the Provision Adaptive Authentication instances section, click the ellipsis button.
- Click Schedule upgrades.
- Select the day and time for the upgrade.
Deprovision your Adaptive Authentication instances
Customers can deprovision the Adaptive Authentication instances in the following cases and as per the suggestion from Citrix support.
- The Adaptive Authentication instances are not accessible (especially after a scheduled upgrade), though this scenario might not occur.
- If the customer has to switch from VNet peering mode to connector mode or conversely.
- If the customer selected a wrong subnet at the time of provisioning VNet peering mode (the subnet conflicts with other subnets in their data center or Azure VNet).
Note:
Deprovisioning also deletes the config backup of the instances. Therefore you must download the backup files and save it before you deprovision your Adaptive Authentication instances.
Perform the following to deprovision an Adaptive Authentication instance:
-
On the Adaptive Authentication UI, in the Provision Adaptive Authentication instances section, click the ellipsis button.
-
Click Deprovision.
Note:
Before deprovisioning, you must disconnect Citrix Gateway from the Workspace Configuration.
-
Enter the customer ID to deprovision the Adaptive Authentication instances.
Enable secure access to the gateway
- On the Adaptive Authentication UI, in the Provision Adaptive Authentication instances section, click the ellipsis button.
-
Click Secure Management Access.
- In Keys should expire in, select an expiration duration for the new SSH key.
-
Click Generate and Download keys. Copy or download the SSH private key for later use as it is not displayed after the page is closed. This key can be used to log in to the Adaptive Authentication instances with the user name
authadmin
.You can click Generate and Download keys to create a new key pair if the earlier key pair expires. However, only one key pair can be active.
- Click Done.
Important:
If you are using PuTTY on Windows to connect to Adaptive Authentication instances, you must convert the downloaded private key to PEM. For details, see https://www.puttygen.com/convert-pem-to-ppk.
- It is recommended to use the following command to connect to the Adaptive Authentication instances via the terminal from the MAC or PowerShell/Command prompt from Windows (version 10).
ssh -i <path-to-private-key> authadmin@<ip address of ADC>
- If you want the AD users to access the Adaptive Authentication GUI, you must add them as new administrators to the LDAP group. For details, see https://support.citrix.com/article/CTX123782. For all other configurations, Citrix recommends that you use the Adaptive Authentication GUI and not the CLI commands.
Set up connectivity to on-premises authentication servers using Azure VNet peering
You must set up this configuration only if you have selected the connectivity type as Azure VNet peering.
Note:
If you are using third-party IDPs like Okta, Azure AD, Ping, this step is not required.
-
On the Connect Adaptive Authentication UI, click Provision, and then click Azure VNet Peering.
The Citrix Managed Service Principal field contains the application ID of an Azure Service Principal created by Citrix for your customer. This service principal is required to allow Citrix to add a VNet peering to a VNet in your subscription and tenant.
To allow this service principal to log in to the customer tenant, the admin at the customer site (global admin of the tenant) must run the following PowerShell commands to add the SPN to the tenant. CloudShell can also be used.
Connect-AzureAD
New-AzureADServicePrincipal -AppId $App_ID
Where$App_ID
is an SPN Application ID shared by Citrix.Note:
- The earlier-mentioned command outputs a service principal name that must be used for the role assignments.
- To allow this service principal to add an Azure VNet peering, the admin at the customer site (not limited to global admin) must add a “Network Contributor” role to the VNet that must be linked to the Citrix Managed VNet.
- SPN is a unique identifier that is used to associate the Citrix virtual network in Azure. Associating the SPN with VNet enables Citrix virtual network to connect to the customers’ on-premises network through Azure’s VNet.
-
Create a VNet peering.
- Enter the tenant ID for which the earlier steps were run and click Fetch.
This populates the customer-managed VNet resource ID with the candidate VNets for which the network contributor role is added for the SPN. If you do not see your VNet, make sure that the earlier steps are run correctly or repeat the steps.
Note:
For details on how to find your tenant ID, see https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant.
- Select Use Azure VPN Gateway to connect your on-premises networks to Azure.
- In Customer managed VNet Resource ID, select the VNet identified for peering, and click Add. The VNet is added to the table with the status initially as In Progress. Once the peering is completed successfully, the Status changes to Done.
- Click Done.
-
Continue with the configuration, see Step 1: Provision Adaptive Authentication.
Important:
- For traffic to flow between the Citrix managed VNet and the on-premises network, firewall and routing rules might be changed on the on-premises to direct the traffic to the Citrix Managed VNet.
- You can add only one VNet peer at a time. Multiple VNet peerings are not allowed currently. You can delete a VNet peering or create one as required.
Config backup and restore
Application Delivery Management service performs backup management for the Adaptive Authentication instances. For details, see Back up and restore Citrix ADC instances.
- On the Application Delivery Management tile, click Manage.
- Navigate to Infrastructure > Instances and access the backups.
Note:
If you do not see the service onboarded, onboard the Application Delivery Management service. For details, see Getting started.
Sample load balanced LDAP/LDAPS configuration
The Citrix Adaptive Authentication instance provides LDAP/LDAPS support using a load balancing virtual server. The load balancing virtual server handles the TLS encryption/decryption in this case. If you are using load balancing virtual server for authentication, make sure that you add your load balancing virtual server IP address instead of your actual LDAP server IP address in your LDAP action.
Prerequisites
Private IP address of the load balancing virtual server. It can be a dummy IP address as this address is used for internal configuration.
How to configure by using the Citrix ADC GUI
- Navigate to Traffic Management > Load Balancing and click Virtual Servers.
- Create a virtual server of type TCP and port 636 or 389 according to your server type.
-
Create a service of type SSL_TCP and port 636 or TCP and port 389 for your actual AD server IP.
Note:
By default, a TCP monitor is bound to the service that you create. On the Adaptive Authentication ADC instances, the service is marked as UP by default if a TCP monitor is used.
- Bind a custom monitor.
- Navigate to Traffic Management > Load Balancing > Monitors.
- Create monitor type LDAP and add the required details.
- Bind this monitor to your service.
- Ensure that you set the monitor probe interval to 15 seconds and the response timeout to 10 sec.
Example CLI configuration
add lb vserver LDAP-vsrv TCP 10.1.1.1 636
add service LDAP-vsvc 10.1.1.5 SSL_TCP 636
bind lb vserver LDAP-vsrv LDAP_vsvc
set authentication ldapAction ldap_act -serverIP 10.1.1.1 -serverPort 636 -secTYPE PLAINTEXT -ldapBase <> -ldapBindDn <> -ldapBindDnPassword <> -ldapLoginName <>
add lb monitor mon_ldaps LDAP -baseDN <> -bindDN <> -password <> -secure YES
bind service LDAP-vsvc -monitorName mon_ldaps
set mon mon_ldaps LDAP -interval 15 SEC (15 sec is recommended) -resptimeout 10
enable lb monitor LDAP-vsvc
<!--NeedCopy-->
Migrate your authentication method to Adaptive Authentication
Customers already using Adaptive Authentication with authentication method as Citrix Gateway must migrate Adaptive Authentication and then remove the OAuth configuration from the Adaptive Authentication instance.
- Switch to a different authentication method other than Citrix Gateway.
-
In Citrix Cloud > Identity and Access Management, click the ellipsis button corresponding to Citrix Gateway and then click Disconnect.
-
Select I understand the impact on the subscriber experience, and then click Confirm.
When you click Confirm, the workspace login to end users is impacted and Adaptive Authentication is not used for authentication until Adaptive Authentication is enabled again.
-
In the Adaptive Authentication instance management console, remove the OAuth related configuration.
By using the CLI:
unbind authentication vs <authvsName> -policy <oauthIdpPolName> rm authentication oauthIdpPolicy <oauthIdpPolName> rm authentication oauthIdpProfile <oauthIdpProfName> <!--NeedCopy-->
By using the GUI:
- Navigate to Security > AAA - Application Traffic > Virtual Servers.
- Unbind the OAuth policy.
- Navigate to Security > AAA - Application Traffic > Policies > Authentication > Advanced Policies > OAuth IDP.
- Delete the OAuth policy and profile.
-
Navigate to Citrix Cloud > Identity and Access Management. In the Authentication tab, in Adaptive Authentication, click the ellipsis menu and select Manage.
- Click See Details.
- In the Upload Certificate screen, do the following:
- Add the Adaptive Authentication FQDN.
- Remove the certificates and key files and upload it again.
Important:
If you edit an FQDN or the certificate-key pair directly without migrating to Adaptive Authentication, connection to Identity and Access Management fails and the following errors are displayed. You must migrate to the Adaptive Authentication method to fix these errors.
- ADC command failed with an error. A policy is already bound to the specified priority.
- ADC command failed with an error. Cannot unbind a policy that is not bound.
-
Click Save Changes.
At this point, Identity and Access Management displays Adaptive Authentication as Connected and the Adaptive Authentication instance has the OAuth profile auto configured.
You can validate this from the GUI.
- Access your Adaptive Authentication instance and log in with your credentials.
- Navigate to Security > AAA - Application Traffic > Virtual Servers. You must see that the OAuth IdP profile created.
- Navigate to Citrix Cloud > Identity and Access Management. Adaptive authentication is in the Connected status.
-
Enable the Adaptive Authentication method again by clicking Enable (step 3) in the adaptive authentication home page.
This step enables the authentication method as Adaptive Authentication in your workspace configuration.
- Click the workspace link on step 3 after clicking Enable. You must see that the authentication method is changed to Adaptive Authentication.
Note:
New users must follow the same steps excluding the step to remove the OAuth related configuration.
Sample authentication configurations
Customers can configure an authentication policy of their choice and bind it to the authentication virtual server. Authentication profile bindings are not required for the authentication virtual server. Only the authentication policies can be configured. The following are some of the use cases.
Important:
Authentication configuration must be done on the primary nodes only.
Multifactor authentication with conditional authentication
- Dual factor authentication with LDAP and RADIUS using dual factor schema (taking user input only once)
- Authentication log on method according to user’s departments (Employee, Partner, Vendor) in organization with drop-down menu to select the department
- Authentication log on method according to user domains with drop-down menu
- Configure email ID (or user name) input as first factor with conditional access based on group extraction with email ID at first factor and provide different logon type for each group
- Multifactor authentication using Certificate authentication for users with user certificates and Native OTP registration for non-cert users
- Different authentication type with conditional authentication according to user host name inputs
- Dual factor authentication with Native OTP authentication
- Google Re-CAPTCHA
Third-party integration with multifactor authentication
- Configure Azure AD as SAML IdP (Configure next factor as LDAP policy - NO_AUTH to complete OAuth trust)
- Conditional authentication with First factor as SAML and then custom login to certificate or LDAP based on SAML attributes
- First factor as webauth login followed by LDAP
Device posture scans (EPA)
- Device posture check for version check followed by customized login for compliant (RADIUS) and non-compliant users(LDAP)
- LDAP authentication followed by mandatory device posture scan
- Device posture check before and after AD authentication - Pre and Post-EPA as a factor
- Device Certificate as an EPA factor
Miscellaneous scenarios
In this article
- Edit an FQDN
- Custom workspace URL or vanity URL
- Schedule upgrade of your Adaptive Authentication instances
- Deprovision your Adaptive Authentication instances
- Enable secure access to the gateway
- Set up connectivity to on-premises authentication servers using Azure VNet peering
- Config backup and restore
- Sample load balanced LDAP/LDAPS configuration
- Migrate your authentication method to Adaptive Authentication
- Sample authentication configurations