README.md

@@ -1,23 +1,28 @@
# keycloak-protocol-cas
This plugin for Keycloak Identity and Access Management (http://www.keycloak.org) adds the CAS 3.0 SSO protocol as an available client protocol to the Keycloak system. It implements the required Service Provider Interfaces (SPIs) for a Login Protocol and will be picked up and made available by Keycloak automatically once installed.

[![Build Status](https://travis-ci.org/Doccrazy/keycloak-protocol-cas.svg?branch=master)](https://travis-ci.org/Doccrazy/keycloak-protocol-cas)

## Features
The following CAS features are currently implemented:
* CAS 1.0/2.0/3.0 compliant Login/Logout and Service Ticket Validation
* Single Logout (SLO)
* Filtering of provided `service` against configured redirect URIs
* JSON and XML response types
* Mapping of custom user attributes to CAS assertion attributes

The following features are **curently missing**:
* Proxy ticket service and proxy ticket validation [CAS 2.0]
The following features are **currently missing**:
* #2: Proxy ticket service and proxy ticket validation [CAS 2.0]
* #1: SAML request/response [CAS 3.0 - optional]

The following features are out of scope:
* Long-Term Tickets - Remember-Me [CAS 3.0 - optional]
* SAML request/response [CAS 3.0 - optional]

## Installation
1. Clone or download this repository (pre-compiled releases will follow!)
2. Run `mvn package` to build the plugin JAR
3. Copy the JAR file generated in the `target` folder into the `providers` directory in your Keycloak server's root
4. Restart Keycloak
3. Copy the JAR file generated in the `target` folder into the `standalone/deployments` directory in your Keycloak server's root
4. Restart Keycloak (optional, hot deployment should work)

## Configuration
To use the new protocol, you have to create a client within Keycloak as usual.