Gateway

Authentication improvements for SAML authentication

January 8, 2024

Contributed by:

C S C

This feature is for those with SAML knowledge, and fundamental authentication proficiency is required to use this information. The reader must understand FIPS to use this information.

The following Citrix ADC features can be used with third party applications/servers that are compatible with the SAML 2.0 specification:

SAML Service Provider (SP)
SAML Identity Provider (IdP)

SP and IdP allow a SingleSignOn (SSO) between cloud services. The SAML SP feature provides a way of addressing user claims from an IdP. The IdP can be a third party service or another Citrix ADC appliance. The SAML IdP feature is used to assert user logons and provide claims consumed by SPs.

As part of the SAML support, both IdP and SP modules digitally sign the data that is sent to peers. The digital signature includes an authentication request from SP, Assertion from IdP, and logout messages between these two entities. The digital signature validates the message authenticity.

The current implementation of SAML SP and IdP does the signature computation in a packet engine. These modules use SSL certificates to sign the data. In a FIPS compliant Citrix ADC, the private key of the SSL certificate is not available in the packet engine or user space, so the SAML module today is not ready for FIPS hardware.

This document describes the mechanism to offload signature calculations to the FIPS card. Signature verification is done in the software, as the public key is available.

Solution

The SAML feature set is enhanced to use an SSL API for signature offload. See docs.citrix.com for details about these affected SAML subfeatures:

SAML SP Post Binding – Signing of AuthnRequest
SAML IdP Post Binding – Signing of Assertion/Response/Both
SAML SP Single Logout scenarios – Signing of LogoutRequest in SP initiated model and Signing of LogoutResponse in IdP initiated model
SAML SP Artifact binding – Signing of ArtifactResolve request
SAML SP Redirect Binding – Signing of AuthnRequest
SAML IdP Redirect Binding – Signing of Response/Assertion/Both
SAML SP Encryption support – Decryption of Assertion

Platform

The API can be offloaded only to a FIPS platform.

Configuration

Offload configuration is performed automatically on the FIPS platform.

However, since SSL private keys are not available to user space in FIPS hardware, there is a slight configuration change in creating the SSL certificate on FIPS hardware.

Here’s the configuration information:

add ssl fipsKey fips-key

Create a CSR and use it at the CA server to generate a certificate. You can then copy that certificate in /nsconfig/ssl. Let’s assume that the file is fips3cert.cer.
add ssl certKey fips-cert -cert fips3cert.cer -fipsKey fips-key

Then specify this certificate in the SAML action for the SAML SP module.
set samlAction \<name\> -samlSigningCertName fips-cert

Use this in samlIdpProfile for the SAML IdP module
set samlidpprofile fipstest –samlIdpCertName fips-cert

The FIPS key is not available in the first time. If there’s no FIPS key, create one as described in Create a FIPS key.

create ssl fipskey \<fipsKeyName\> -modulus \<positive\_integer\> \[-exponent ( 3 | F4 )\]
create certreq \<reqFileName\> -fipskeyName \<string\>

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Authentication improvements for SAML authentication

January 8, 2024

Contributed by:

C S C

January 8, 2024

Contributed by:

C S C

Authentication improvements for SAML authentication

Solution

Platform

Configuration

In this article