Google Cloud Pub/Sub Ticket Registry

This registry is very much an extension of the default ticket registry. The difference is that ticket operations applied to the registry are broadcasted using Google Cloud’s PubSub.

Each node keeps copies of ticket state on its own and only instructs others to keep their copy accurate by broadcasting messages and data associated with each. Each message and ticket registry instance running inside a CAS node in the cluster is tagged with a unique identifier in order to avoid endless looping behavior and recursive needless inbound operations.

:information_source: Message Ordering

This registry implementation requires you to enable message ordering via CAS settings.

Support is enabled by including the following dependency in the overlay:

1
2
3
4
5
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-gcp-pubsub-ticket-registry</artifactId>
    <version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-gcp-pubsub-ticket-registry:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-gcp-pubsub-ticket-registry"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
    /*
    The following platform references should be included automatically and are listed here 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-gcp-pubsub-ticket-registry"
}

Integration support is backed by the Spring Cloud GCP project. Their reference documentation provides detailed information on how to integrate Google Cloud APIs with CAS.

To understand how to set up application default credentials, please review this page.

CAS Configuration

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

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.ticket.registry.in-memory.crypto.encryption.key=
  • The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.signing.key=
  • The signing key is a JWT whose length is defined by the signing key size setting.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

  • cas.ticket.registry.in-memory.cache=false
  • Allow the ticket registry to cache ticket items for period of time and auto-evict and clean up, removing the need to running a ticket registry cleaner in the background.

    org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.concurrency=20
  • The estimated number of concurrently updating threads. The implementation performs internal sizing to try to accommodate this many threads.

    org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.initial-capacity=1000
  • The initial capacity of the underlying memory store. The implementation performs internal sizing to accommodate this many elements.

    org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.load-factor=1
  • The load factor threshold, used to control resizing. Resizing may be performed when the average number of elements per bin exceeds this threshold.

    org.apereo.cas.configuration.model.core.ticket.registry.InMemoryTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.alg=AES
  • The signing/encryption algorithm to use.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.enabled=true
  • Whether crypto operations are enabled.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.encryption.key-size=16
  • Encryption key size.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.signing.key-size=512
  • The signing key size.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

    The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.

  • spring.cloud.gcp.pubsub.binder.enabled=true
  • Auto-configure Google Cloud Pub/Sub Stream Binder components.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.credentials.default-scopes=
  • com.google.cloud.spring.core.Credentials.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.emulator-host=
  • The host and port of the local running emulator. If provided, this will setup the client to connect against a running pub/sub emulator.

    com.google.cloud.spring.autoconfigure.pubsub.GcpPubSubProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.enabled=true
  • Auto-configure Google Cloud Pub/Sub components.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.fully-qualified-subscriber-properties=
  • com.google.cloud.spring.autoconfigure.pubsub.GcpPubSubProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.acknowledge-messages=false
  • Whether to acknowledge messages pulled from #subscription.

    com.google.cloud.spring.autoconfigure.pubsub.health.PubSubHealthIndicatorProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.backlog-threshold=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Health.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.executor-threads=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Health.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.lag-threshold=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Health.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.look-up-interval=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Health.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.subscription=
  • Subscription to health check against by pulling a message.

    com.google.cloud.spring.autoconfigure.pubsub.health.PubSubHealthIndicatorProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.health.timeout-millis=2000
  • Milliseconds to wait for response from Pub/Sub before timing out.

    com.google.cloud.spring.autoconfigure.pubsub.health.PubSubHealthIndicatorProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.keep-alive-interval-minutes=5
  • How often to ping the server to keep the channel alive.

    com.google.cloud.spring.autoconfigure.pubsub.GcpPubSubProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.project-id=
  • Overrides the GCP project ID specified in the Core module.

    com.google.cloud.spring.autoconfigure.pubsub.GcpPubSubProperties.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.delay-threshold-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Batching.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.element-count-threshold=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Batching.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.enabled=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Batching.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.flow-control.limit-exceeded-behavior=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$FlowControl.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.flow-control.max-outstanding-element-count=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$FlowControl.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.flow-control.max-outstanding-request-bytes=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$FlowControl.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.batching.request-byte-threshold=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Batching.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.enable-message-ordering=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Publisher.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.endpoint=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Publisher.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.executor-threads=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Publisher.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.initial-retry-delay-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.initial-rpc-timeout-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.jittered=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.max-attempts=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.max-retry-delay-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.max-rpc-timeout-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.retry-delay-multiplier=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.rpc-timeout-multiplier=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.publisher.retry.total-timeout-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.reactive.enabled=true
  • Auto-configure Google Cloud Pub/Sub Reactive components.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.executor-threads=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.flow-control.limit-exceeded-behavior=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$FlowControl.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.flow-control.max-outstanding-element-count=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$FlowControl.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.flow-control.max-outstanding-request-bytes=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$FlowControl.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.fully-qualified-name=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.max-ack-extension-period=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.max-acknowledgement-threads=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.max-duration-per-ack-extension=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.min-duration-per-ack-extension=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.parallel-pull-count=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.pull-endpoint=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.initial-retry-delay-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.initial-rpc-timeout-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.jittered=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.max-attempts=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.max-retry-delay-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.max-rpc-timeout-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.retry-delay-multiplier=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.rpc-timeout-multiplier=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retry.total-timeout-seconds=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Retry.

    How can I configure this property?

  • spring.cloud.gcp.pubsub.subscriber.retryable-codes=
  • com.google.cloud.spring.pubsub.core.PubSubConfiguration$Subscriber.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.encryption.key=
  • The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.signing.key=
  • The signing key is a JWT whose length is defined by the signing key size setting.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.alg=AES
  • The signing/encryption algorithm to use.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.enabled=true
  • Whether crypto operations are enabled.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.encryption.key-size=16
  • Encryption key size.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.in-memory.crypto.signing.key-size=512
  • The signing key size.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

    This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

    Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

    1
    2
    
    wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
    java -jar jwk-gen.jar -t oct -s [size]
    

    The outcome would be similar to:

    1
    2
    3
    4
    5
    
    {
      "kty": "oct",
      "kid": "...",
      "k": "..."
    }
    

    The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.


    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.

    :information_source: 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, specially 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.

    Actuator Endpoints

    The following endpoints are provided by CAS:

     Reports back general health status of the system, produced by various monitors.

     Reports back general health status of the system, produced by various monitors.


    :information_source: Cloud Monitoring

    To successfully use the Spring Cloud GCP actuator endpoints, you will also need to enable the Cloud Monitoring API.

    Troubleshooting

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

    1
    2
    3
    4
    5
    6
    
    ...
    <Logger name="com.google.cloud" level="debug" additivity="false">
        <AppenderRef ref="casConsole"/>
        <AppenderRef ref="casFile"/>
    </Logger>
    ...