Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

OpenID is an open, decentralized, free framework for user-centric digital identity. Users represent themselves using URIs. For more information see the http://www.openid.net. As of CAS 3.5, CAS supports both the "dumb" and "smart" modes of the OpenID protocol. Dumb mode acts in a similar fashion to the existing CAS protocol. The smart mode differs in that it establishes an association between the client and the openId provider (OP) at the begining. Thanks to that association and the key exchange done during association, information exchanged between the client and the provider are signed and verified using this key. There is no need for the final request (which is equivalent in CAS protocol to the ticket validation).

Giving your users URIs

Configuring your users to have URIs.

OpenId identifiers are URIs. The default mechanism in CAS support is an uri ending with the actual user login (ie. http://my.cas.server/openid/fesnault where the actual user login is fesnault). This is not recommended and you should think of a more elaborated way of providing URIs to your users.

Add OpenId support module to CAS server

The first thing, with a CAS server webapp, is to add the OpenId support module dependency. This is done by adding this in the cas server webapp pom.xml.

Code Block
languagehtml/xml
        <dependency>
            <groupId>org.jasig.cas</groupId>
            <artifactId>cas-server-support-openid</artifactId>
            <version>${project.version}</version>
        </dependency>
Warning
titleBe Careful

You must change the server prefix property of the cas server to an https url. Otherwise SSO will not work. Find the cas.properties file and edit the server.prefix url to something like this : https://localhost:443/cas.

...

Warning
titleNew CAS documentation site

CAS documentation has moved over to apereo.github.io/cas, starting with CAS version 4.x. The wiki will no longer be maintained. For the most recent version of the documentation, please refer to the aforementioned link.

Tip

Since CAS version 4.0, in addition to this server support, a new OpenID client support is available in the CAS server through the cas-server-support-pac4j module. It means that the CAS authentication can be delegated to www.myopenid.com.

 

OpenID is an open, decentralized, free framework for user-centric digital identity. Users represent themselves using URIs. For more information see the http://www.openid.net. As of CAS 3.5, CAS supports both the "dumb" and "smart" modes of the OpenID protocol. Dumb mode acts in a similar fashion to the existing CAS protocol. The smart mode differs in that it establishes an association between the client and the openId provider (OP) at the begining. Thanks to that association and the key exchange done during association, information exchanged between the client and the provider are signed and verified using this key. There is no need for the final request (which is equivalent in CAS protocol to the ticket validation).

A demo of the OpenId support in CAS server is available at : https://github.com/leleuj/cas-openid-demo.

Giving your users URIs

Configuring your users to have URIs.

OpenId identifiers are URIs. The default mechanism in CAS support is an uri ending with the actual user login (ie. http://my.cas.server/openid/fesnault where the actual user login is fesnault). This is not recommended and you should think of a more elaborated way of providing URIs to your users.

Add OpenId support module to CAS server

The first thing, with a CAS server webapp, is to add the OpenId support module dependency. This is done by adding this in the cas server webapp pom.xml.

Code Block
languagehtml/xml
<dependency>
    <groupId>org.jasig.cas</groupId>
    <artifactId>cas-server-support-openid</artifactId>
    <version>${project.version}</version>
</dependency>
Warning
titleBe Careful

You must change the server prefix property of the cas server to an https url. Otherwise SSO will not work. Find the cas.properties file and edit the server.prefix url to something like this : https://localhost:443/cas.

Now let's dive into CAS configuration itself.

Declare the OpenID endpoint (since CAS 4.0)

Since CAS 4.0, the OpenID endpoint for discovery is no more enabled by default in the CAS server (in fact, it is no more available in the cas-server-support-webapp module : it has been moved to the cas-server-support-openid module).

The OpenID discovery endpoint should be enabled during the configuration process. In the web.xml file, the following mapping must be added :

Code Block
languagehtml/xml
titleweb.xml
  <servlet-mapping>
    <servlet-name>cas</servlet-name>
    <url-pattern>/openid/*</url-pattern>
  </servlet-mapping>

In the cas-servlet.xml file, the following mapping and bean must be added :

Code Block
languagehtml/xml
titlecas-servlet.xml
  <bean id="handlerMappingC" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
    <property name="mappings">
      <props>
        <prop key="/logout">logoutController</prop>
        ...
        <prop key="/openid/*">openIdProviderController</prop>
        ...


 
  <bean
      id="openIdProviderController"
      class="org.jasig.cas.support.openid.web.OpenIdProviderController"
      p:loginUrl="${server.prefix}/login"/>

Add the OpenID entry in the unique id generator map (since CAS 4.0)

Since CAS 4.0, the OpenID entry in the unique id generator map is no more defined by default in the CAS server.

The OpenID entry should be added to the uniqueIdGenerators.xml file :

Code Block
languagehtml/xml
titleweb.xml
<util:map id="uniqueIdGeneratorsMap">
  ...
  <entry
    key="org.jasig.cas.support.openid.authentication.principal.OpenIdService"
    value-ref="serviceTicketUniqueIdGenerator" />
</util:map>

Update webflow

CAS uses a spring webflow to describe the the authentication process. We need to change it a little bit to allow CAS to switch to OpenId authentication if it recognizes one. This is done in the login-webflow.xml fie. After the on-start element just add these two blocks :

...

Then, in the authentication handler property, add this bean definitio definition :

Code Block
languagehtml/xml
     <!-- The open id authentication handler -->
     <bean class="org.jasig.cas.support.openid.authentication.handler.support.OpenIdCredentialsAuthenticationHandler" p:ticketRegistry-ref="ticketRegistry" />

...

We now have to make CAS handle nicely the OpenId request he will be presented with. First, we'll add a handler for the /login url, when called to validate a ticket (CAS is implementing the dumb OpenId mode, which means it does not create an association at the beginning of the authentication process. It must then check the received authentication success notification, which is done by one extra HTTP request at the end of the process). Anywhere in the cas-servlet.xml file, add this bean definition :

...

Code Block
languagehtml/xml
   <bean id="delegatingController" class="org.jasig.cas.web.DelegatingController".web.DelegatingController"
    p:delegates-ref="delegateControllers"/>
  
   <util:list id="delegateControllers">
        <ref bean="smartOpenIdAssociationController"/>
      p:delegates-ref  <ref bean="delegateControllersopenIdValidateController"/>
  
   <util:list id="delegateControllers">
        <ref bean="smartOpenIdAssociationController"/>
        <ref bean="openIdValidateController"/>
    </util:list>

 

Next we must provide a ServerManager, which is a class from the openid4java library, which allows us to handle the Diffie-Hellman algorithm used by the association process.

Code Block
languagehtml/xml
<bean id="serverManager" class="org.openid4java.server.ServerManager"
          p:oPEndpointUrl="${cas.securityContext.casProcessingFilterEntryPoint.loginUrl}"
          p:enforceRpId="false"  /
    </util:list>

Also, add the indicated lines to the <beans> definition at the top of the file, if they're not already there:

Code Block
languagehtml/xml
<beans xmlns="http://www.springframework.org/schema/beans"
       ...
       xmlns:util="http://www.springframework.org/schema/util"
       xsi:schemaLocation="...
       http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.1.xsd
       ...">

 

Next, we'll give CAS a handler for the OpenIdSingleSignOnAction we added in the spring webflow definition file. So add this bean definition anywhere :

...

Code Block
languagehtml/xml
     <util:list id="argumentExtractors">
        <ref bean="casArgumentExtractor" />
        <!-- The OpenId arguments extractor -->
        <ref bean="openIdArgumentExtractor" />
        <ref bean="samlArgumentExtractor" />
     </util:list>

Reference new views

We just added a controller which uses new jsp views. We must reference them.

Open the protocol_views.properties file and add these lines : 

 

...

languagebash

...

 

Next we must provide a ServerManager, which is a class from the openid4java library, which allows us to handle the Diffie-Hellman algorithm used by the association process. In the spring-configuration/applicationContext.xml file, add this bean definition :

Code Block
languagehtml/xml
<bean id="serverManager" class="org.openid4java.server.ServerManager"
          p:oPEndpointUrl="${cas.securityContext.casProcessingFilterEntryPoint.loginUrl}"
          p:enforceRpId="false"  />

And finally, we need an applicationContext provider , so add this bean into spring-configuration/applicationContext.xml :

Code Block
languagehtml/xml
<bean id="applicationContextProvider" class="org.jasig.cas.util.ApplicationContextProvider" />

You're done ! CAS is now configured to work as an OpenId Provider.