You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
The CAS protocol is a simple and powerful ticket-based protocol. The complete protocol specification may be found here.
It involves one or many clients and one server. Clients are embedded in CASified applications (called “CAS services”) whereas the CAS server is a standalone component:
- The CAS server is responsible for authenticating users and granting accesses to applications
- The CAS clients protect the CAS applications and retrieve the identity of the granted users from the CAS server.
The key concepts are:
TGT(Ticket Granting Ticket), stored in the
TGCcookie, represents a SSO session for a user.
ST(Service Ticket), transmitted as a
GETparameter in urls, stands for the access granted by the CAS server to the CASified application for a specific user.
The following specification versions are recognized and implemented by Apereo CAS.
The current CAS protocol specification is
3.0.3. The actual protocol specification is available here, which is hereby implemented by the Apereo CAS Server as the official reference implementation. It’s mainly a capture of the most common enhancements built on top of the CAS protocol revision
2.0. Among other features, the most noticeable update between versions
3.0 is the ability to return the authentication/user attributes through the new
2.0 protocol specification is available at CAS-Protocol-Specification.
To enable additional logging, configure the log4j configuration file to add the following levels:
1 2 3 4 5 6 ... <Logger name="PROTOCOL_MESSAGE" level="debug" additivity="false"> <AppenderRef ref="console"/> <AppenderRef ref="file"/> </Logger> ...
Web flow diagram
Proxy web flow diagram
One of the most powerful feature of the CAS protocol is the ability for a CAS service to act as a proxy for another CAS service, transmitting the user identity.
Even if the primary goal of the CAS server is to implement the CAS protocol, other protocols are also supported as extensions:
Using the CAS protocol, the CAS server can also be configured to delegate the authentication to another CAS server.