Apereo CAS - HappyFox SAML2 Integration


Collaborate
The blog is managed and hosted on GitHub. If you wish to update the contents of this post or if you have found an inaccuracy and wish to make corrections, we recommend that you please submit a pull request to this repository.

HappyFox is an all-in-one help desk ticketing system. As a SAML2 service provider, HappyFox can be integrated with CAS running as a SAML identity provider and this blog post provides a quick walkthrough of how to make that integration possible.

Our starting position is based on the following:

HappyFox Configuration

Use these instructions to set up HappyFox as a SAML2 service provider.

CAS Configuration

First, ensure that your CAS deployment is equipped to act as a SAML2 identity provider. Next, you may also use the JSON Service Registry to keep track of the HappyFox relying-party registration record in JSON definition files.

The JSON file to contain the service provider relying-party record would be as follows:

{
  "@class" : "org.apereo.cas.support.saml.services.SamlRegisteredService",
  "serviceId" : "https://[name].happyfox.com/saml/metadata/",
  "name" : "HappyFox",
  "description": "HappyFox",
  "id" : 1,
  "evaluationOrder" : 1,
  "metadataLocation" : "file:/etc/cas/config/saml/happyfox-metadata.xml",
  "usernameAttributeProvider" : {
    "@class" : "org.apereo.cas.services.PrincipalAttributeRegisteredServiceUsernameProvider",
    "usernameAttribute" : "mail"
  }
}

Note that HappyFox does not provide its own SP metadata and you will have to create it youself. The following is example of what that metadata may look like:

<?xml version="1.0"?>
<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"
                     validUntil="2050-12-05T19:27:46Z"
                     cacheDuration="PT604800S"
                     entityID="https://[name].happyfox.com/saml/metadata/">
    <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="false"
                        protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>
        <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
                                     Location="https://[name].happyfox.com/saml/callback/"
                                     index="0" />
    </md:SPSSODescriptor>
</md:EntityDescriptor>

A few things to point out:

  • You will need to adjust the serviceId and metadataLocation to match your data and the HappyFox instance.
  • Make sure CAS has retrieved the allowed attributes (i.e. mail etc) listed in the JSON definition file. This is required in the final generated SAML2 response to create the proper NameIDFormat element.
  • Make sure the SP metadata has the correct entity id, matching your HappyFox instance address.

Finale

If you too have an integration with a well-known SAML2 service provider, please consider sharing that guide in form of a blog post here as well.

Misagh Moayyed

Related Posts

CAS 6.2.0 RC1 Feature Release

...in which I present an overview of CAS 6.2.0 RC1 release.

Apereo CAS - Simple Multifactor Authentication

Learn to configure Apereo CAS to act as a simple multifactor provider itself.

Apereo CAS 2019 Survey Results

...in which I present a summarized view of the latest CAS community survey.

CAS 6.1.0 RC6 Feature Release

...in which I present an overview of CAS 6.1.0 RC6 release.

Apereo CAS - Managing Services via Git

Learn to configure Apereo CAS to fetch application policy files and service records for its service registry from remote git repositories.

Apereo CAS - Ticket Distribution with JMS

Learn to configure Apereo CAS to JMS and messages queues to broadcast tickets and tokens across a deployment cluster.

CAS Vulnerability Disclosure

Disclosure of a security issue with the CAS software.

Apereo CAS - SMS Notifications via Twilio

Learn to configure Apereo CAS for SMS notifications via Twilio.

CAS 6.1.0 RC5 Feature Release

...in which I present an overview of CAS 6.1.0 RC5 release.

Apereo CAS - Passwordless Authentication

Learn how to modify Apereo CAS to allow users to login without the need to remember a password.