Git Service Registry

This registry reads services definitions from remote or local git repositories. Service definition files are expected to be either JSON or YAML files. The contents of the repository is pulled at defined intervals and changes to service definitions are committed and pushed to the defined remotes.

Support is enabled by adding the following module into the overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-git-service-registry</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-git-service-registry:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-git-service-registry"
}

dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-git-service-registry"
}

The following settings and properties are available from the CAS configuration catalog:

cas.service-registry.git.active-branchThe branch to checkout and activate, defaults to master .

master

RequiredSpEL

The branch to checkout and activate, defaults to master.

Type: String
Default: master
Defined by: GitServiceRegistryProperties
Supports: Spring Expression Language

cas.service-registry.git.branches-to-cloneIf the repository is to be cloned, this will allow a select list of branches to be fetched.

*

Required

If the repository is to be cloned, this will allow a select list of branches to be fetched. List the branch names separated by commas or use * to clone all branches. Defaults to all branches.

Type: String
Default: *
Defined by: GitServiceRegistryProperties

cas.service-registry.git.clone-directory.locationThe location of the resource.

no default

Required

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

In the event the configured resource is a Groovy script, especially if the script is set to reload on changes, you may need to adjust the total number of inotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.

Type: Resource
Default: none
Defined by: SpringResourceProperties

cas.service-registry.git.private-key.locationThe location of the resource.

no default

Required

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

Type: Resource
Default: none
Defined by: SpringResourceProperties

cas.service-registry.git.repository-urlThe address of the git repository.

no default

RequiredSpEL

The address of the git repository. Could be a URL or a file-system path.

Type: String
Default: none
Defined by: GitServiceRegistryProperties
Supports: Spring Expression Language

cas.service-registry.git.clear-existing-identitiesWhen establishing an ssh session, determine if default identities loaded on the machine should be excluded/removed and identity should only be limited to those loaded from given keys.

false

When establishing an ssh session, determine if default identities loaded on the machine should be excluded/removed and identity should only be limited to those loaded from given keys.

Type: Boolean
Default: false
Defined by: GitServiceRegistryProperties

cas.service-registry.git.group-by-typeDetermine whether service definitions in the git repository should be located/stored in groups and separate folder structures based on the service type.

true

Determine whether service definitions in the git repository should be located/stored in groups and separate folder structures based on the service type. @see #getRootDirectory()

Type: Boolean
Default: true
Defined by: GitServiceRegistryProperties

cas.service-registry.git.http-client-typeImplementation of HTTP client to use when doing git operations via http/https.

JDK

Implementation of HTTP client to use when doing git operations via http/https. The jgit library sets the connection factory statically (globally) so this property should be set to the same value for all git repositories (services, saml, etc). Not doing so might result in one connection factory being used for clone and another for subsequent fetches. Available values are as follows:

JDK: Built-in JDK http/https client.
HTTP_CLIENT: Apache HTTP Client http/https client.

Type: BaseGitProperties.HttpClientTypes
Default: JDK
Defined by: GitServiceRegistryProperties

cas.service-registry.git.orderThe execution order of this registry which will determine its position in a chain in case multiple registries are defined.

no default

The execution order of this registry which will determine its position in a chain in case multiple registries are defined.

Type: Integer
Default: none
Defined by: GitServiceRegistryProperties

cas.service-registry.git.passwordPassword used to access or push to the repository.

no default

Password used to access or push to the repository.

Type: String
Default: none
Defined by: GitServiceRegistryProperties

cas.service-registry.git.private-key-passphrasePassword for the SSH private key.

no default

Password for the SSH private key.

Type: String
Default: none
Defined by: GitServiceRegistryProperties

cas.service-registry.git.push-changesDecide whether changes should be pushed back into the remote repository.

false

Decide whether changes should be pushed back into the remote repository.

Type: Boolean
Default: false
Defined by: GitServiceRegistryProperties

cas.service-registry.git.rebaseWhether to rebase on pulls.

false

Whether to rebase on pulls.

Type: Boolean
Default: false
Defined by: GitServiceRegistryProperties

cas.service-registry.git.root-directoryRoot directory in the git repository structure to track service definition files.

no default

Root directory in the git repository structure to track service definition files. This might be most useful if the git repository is tasked with other types of files and configurations and allowing a separate root directory for service definitions provide a clean separation between services files and everything else. This setting may work in concert with #isGroupByType(). If left blank, the root folder of the git repository itself is used as the root directory for service definitions.

Type: String
Default: none
Defined by: GitServiceRegistryProperties

cas.service-registry.git.sign-commitsWhether commits should be signed.

false

Whether commits should be signed.

Type: Boolean
Default: false
Defined by: GitServiceRegistryProperties

cas.service-registry.git.ssh-session-passwordAs with using SSH with public keys, an SSH session with ssh://user@example.com/repo.git must be specified to use password-secured SSH connections.

no default

As with using SSH with public keys, an SSH session with ssh://user@example.com/repo.git must be specified to use password-secured SSH connections.

Type: String
Default: none
Defined by: GitServiceRegistryProperties

cas.service-registry.git.strict-host-key-checkingWhether on not to turn on strict host key checking. true will be "yes", false will be "no", "ask" not supported.

true

Whether on not to turn on strict host key checking. true will be "yes", false will be "no", "ask" not supported.

Type: Boolean
Default: true
Defined by: GitServiceRegistryProperties

cas.service-registry.git.timeoutTimeout for git operations such as push and pull in seconds.

PT10S

Duration

Timeout for git operations such as push and pull in seconds.

Type: String
Default: PT10S
Defined by: GitServiceRegistryProperties

cas.service-registry.git.usernameUsername used to access or push to the repository.

no default

Username used to access or push to the repository.

Type: String
Default: none
Defined by: GitServiceRegistryProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

No Interference!

Be careful to not manually modify the state of the git repository directory that is cloned on the local server. By doing so, you risk interfering with CAS' own service management processes and ultimately may end up corrupting the state of the git repository.

The service registry is also able to auto detect changes as it will pull changes from defined remotes periodically. It will monitor changes to recognize file additions, removals and updates and will auto-refresh CAS so changes may happen instantly.

Troubleshooting

To enable additional logging, configure the log4j configuration file to add the following levels:

...
<Logger name="org.eclipse.jgit" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>
...

Auto Initialization

Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. See this guide for more info.