Redis backed Proxy/Service Ticket Managers for the Apereo .NET CAS Client

Introduction

This project is an add-on to the Apereo .NET CAS Client that implements the proxy and service ticket managers backed by a Redis data store.

By storing your proxy and service tickets in a centralized data store your applications running in a distributed, clustered or load balanced environment will all have access to the same proxy and service ticket data. This is not possible to achieve with the default in-memory proxy and service ticket managers that ships with the Apereo .NET CAS Client.

Configuration

You will need to make modifications to your application's web.config file after installing this NuGet package.

First Modification:

The first modification will be to add a connection string for Redis. This project has a dependency on StackExchange.Redis in order to integrate with Redis. Upon the installation of this NuGet package, the web.config file will be transformed to include a new appSetting variable called cas:Redis:ConnectionString. A default value is provided, but you should configure it to fit your needs. The format of this connection string is the same format that StackExchange.Redis uses, so please see their documentation for how to format it and what options are available.

Second Modification:

The second modification will be to modify the <casClientConfig> xml element in your web.config file. Specifically we will be changing the proxyTicketManager (if you use that) and the serviceTicketManager XML attribute values.

Set the serviceTicketManager attribute value to: DotNetCasClient.State.RedisServiceTicketManager, DotNetCasClient.Redis

Set the proxyTicketManager attribute value to: DotNetCasClient.State.RedisProxyTicketManager, DotNetCasClient.Redis

Also, don't forget to wire-up the rest of the .NET Cas Client configuration too.

After all that configuration you should be good to go!

Notes

The proxy and service tickets that are stored in a Redis database have their keys namespaced (see Redis documentation if you are unfamiliar with that concept.)

The namespace for proxy tickets is CasTicket:PGTIOU and the namespace for service tickets is CasTicket:ST. Under each of those name spaces you will find the actual keys.

Contributing

If you have already identified an enhancement or a bug, it is STRONGLY recommended that you simply submit a pull request to address the case. There is no need for special ceremony to create separate issues. The pull request IS the issue and it will be tracked and tagged as such.

This project follows the GitFlow branching/workflow model. As such, please base all of the code changes in your pull request off of the develop branch in our repo. We will merge your pull request, if accepted, into our develop branch.

Also take a look at the Apereo Contributor Guidelines article for an more information about contributing.