Skip to main content Skip to navigation

SSO XML Config

Example SSO XML config file (assuming the latest SSO Client version). It uses an Apache style certificate and key file instead of a keystore, but if you would rather use a keystore file then see the alternative below.

<?xml version="1.0" encoding="UTF-8"?>
 <!-- Do you want to allow HTTP BASIC auth on this filter? -->
 <!-- mode can be 'old' or 'new' this defines if the SSOClientFilter should use 
  the old WarwickSSO cookie or the newer SSO-SSC-* cookies -->
  <!-- This is the key that the filter will put the User object under in the request
   You should be able to get a user with request.getAttribute("SSO_USER") -->
  <!-- If your app proxies through another server like Apache, you should configure it
   to place the requested URL into a header with this name: -->

  <!-- location of this services SHIRE, should be mapped in the web.xml -->
   <!-- Name of the service specific cookie (SSC) that will be used for keeping a session -->
   <!-- path scope of this cookie -->
   <!-- domain scope of this cookie...should be as restrictive as possible -->
   <!-- whether the Secure flag is set, default: false, since v2.12 -->
   <!-- the value of the SameSite flag for the service specific cookie, since v2.58 -->
   <samesite>Lax</samesite> <!-- Strict, Lax or None -->
   <!-- Note: since version 2.7, the cookie is automatically set to HttpOnly -->
  <!-- provider id, as assigned by single sign on -->

 <!-- Use this if not using keystore.location above -->

Alternative configurations

If you are using a keystore instead of .crt and .key files, comment out the credentials element and insert this into the <shire> element (with the appropriate values for your keystore).

   <!-- password for that keystore -->
   <!-- keystore alias for the client service machine -->
   <!-- keystore alias for the single sign on origin machine -->

If you're proxying through another server and can't set a request header, but can add a request parameter, replace the uri-headerelement with this:

 <!-- if there are some rewrites which are done internally to 
      apache where querystring parameters are added
      and you don't want them showing up after a redirect, 
      add in the parameter names here and they will be stripped -->