Service Management

The CAS service management facility allows CAS server administrators to declare and configure which services (CAS clients) may make use of CAS in which ways. The core component of the service management facility is the service registry that stores one or more registered services containing metadata that drives a number of CAS behaviors:

  • Authorized services - Control which services may participate in a CAS SSO session.
  • Forced authentication - Provides administrative control for forced authentication.
  • Attribute release - Provide user details to services for authorization and personalization.
  • Proxy control - Further restrict authorized services by granting/denying proxy authentication capability.
  • Theme control - Define alternate CAS themes to be used for particular services.

To see the relevant list of CAS properties, please review this guide.

Service Management Web Application

The service management webapp is a standalone web application that may be deployed along side CAS that provides a GUI to manage service registry data. The management web application MUST share the same registry configuration as the CAS server itself so the entire system can load the same services data. To learn more about the management webapp, please see this guide.

Registered Services

Registered services present the following metadata:

Field Description
id Required unique identifier. This MUST be a valid numeric value.
name Required name (255 characters or less).
description Optional free-text description of the service. (255 characters or less)
informationUrl Optional free-text link to the service information guide.
privacyUrl Optional free-text link to the service privacy policy.
logo Optional path to an image file that is the logo for this service. The image will be displayed on the login page along with the service description and name. The value may be a relative path to the images directory of the CAS web application or it may be a full URL.
serviceId Required regular expression describing a logical service. A logical service defines one or more URLs where a service or services are located. The definition of the url pattern must be done carefully because it can open security breaches.
theme Optional theme name that may be used to customize the CAS UI when the service requests a ticket. See this guide for more details.
proxyPolicy Determines whether the service is able to proxy authentication.
evaluationOrder Determines relative order of evaluation of registered services. This flag is particularly important in cases where two service URL expressions cover the same services; evaluation order determines which registration is evaluated first and acts as an internal sorting factor.
requiredHandlers Set of authentication handler names that must successfully authenticate credentials in order to access the service. If defined, only the selected required handlers are chosen to respond to authentication requests from this registered service.
attributeReleasePolicy The policy that describes the set of attributes allows to be released to the application, as well as any other filtering logic needed to weed some out. See this guide for more details on attribute release and filters.
logoutType Defines how this service should be treated once the logout protocol is initiated. Acceptable values are LogoutType.BACK_CHANNEL, LogoutType.FRONT_CHANNEL or LogoutType.NONE. See this guide for more details on logout.
usernameAttributeProvider The provider configuration which dictates what value as the “username” should be sent back to the application. See this guide for more details on attribute release and filters.
accessStrategy The strategy configuration that outlines and access rules for this service. It describes whether the service is allowed, authorized to participate in SSO, or can be granted access from the CAS perspective based on a particular attribute-defined role, aka RBAC. See this guide for more details on attribute release and filters.
publicKey The public key associated with this service that is used to authorize the request by encrypting certain elements and attributes in the CAS validation protocol response, such as the PGT or the credential. See this guide for more details on attribute release and filters.
logoutUrl URL endpoint for this service to receive logout requests. See this guide for more details
properties Extra metadata associated with this service in form of key/value pairs. This is used to inject custom fields into the service definition, to be used later by extension modules to define additional behavior on a per-service basis. See this guide for more info please.
multifactorPolicy The policy that describes the configuration required for this service authentication, typically for multifactor authentication.
contacts Specify the collection of contacts associated with service that own the application. See this guide for more info.
Service Types

Note that while the above properties apply to all generic service definitions, there are additional service types in CAS that may be activated and required depending on the protocol used and the nature of the client application. Always check the dedicated guide for the capability you have in mind (i.e. OAuth, SAML, etc).

Service Access Strategy

See this guide for more info please.

Proxy Authentication Policy

See this guide for more info please.

Tags & Properties

See this guide for more info please.

Contacts & Owners

See this guide for more info please.

Expiration Policy

See this guide for more info please.

Storage

The following options may be used to store services in CAS.

Storage Description Usage
Memory See this guide. Store service definitions XML stored in memory. Changes require CAS repackaging and server restarts
JSON See this guide. Store service definitions in flat JSON files. HA deployments require replication of service definitions.
YAML See this guide. Same as JSON.
MongoDb See this guide. Store service definitions in MongoDb. Candidate for HA deployments.
Redis See this guide. Store service definitions in Redis. Candidate for HA deployments.
LDAP See this guide. Store service definitions in a directory server. Candidate for HA deployments.
JPA See this guide. Store service definitions in a relational database (Oracle, MySQL, etc). Candidate for HA deployments.
Couchbase See this guide. Store service definitions in Couchbase. Candidate for HA deployments.
DynamoDb See this guide. Store service definitions in DynamoDb. Candidate for HA deployments.
REST See this guide. Design your own service registry implementation as a REST API. Candidate for HA deployments.
Custom See this guide. Design your own service registry using CAS APIs as an extension. Candidate for HA deployments.

How Do I Choose?

There are is a wide range of service registries on the menu. The selection criteria is outlined below:

  • Choose a technology that you are most familiar with and have the skills and patience to troubleshoot, tune and scale for the win.
  • Choose a technology that does not force your CAS configuration to be tied to any individual servers/nodes in the cluster, as this will present auto-scaling issues and manual effort.
  • Choose a technology that works well with your network and firewall configuration and is performant and reliable enough based on your network topology.
  • Choose a technology that shows promising results under your expected load, having run performance and stress tests.
  • Choose a technology that does not depend on outside processes, systems and manual work as much as possible, is self-reliant and self contained.