Class: KeycloakRack::Config

Inherits:
Anyway::Config
  • Object
show all
Defined in:
lib/keycloak_rack/config.rb

Overview

Configuration model for KeycloakRack.

Uses anyway_config to permit flexible approaches to configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_anonymous ⇒ Boolean

Returns:

  • (Boolean) 

56
 
# File 'lib/keycloak_rack/config.rb', line 56

attr_config allow_anonymous: false

#ca_certificate_file ⇒ String?

The optional path to the CA Certificate to validate connections to a keycloak server.

Returns:

  • (String, nil) 

32
 
# File 'lib/keycloak_rack/config.rb', line 32

attr_config :ca_certificate_file

#cache_ttl ⇒ Integer

The interval (in seconds) that cached public keys in KeyResolver should be cached.

Returns:

  • (Integer) 

48
 
# File 'lib/keycloak_rack/config.rb', line 48

attr_config cache_ttl: 86_400

#halt_on_auth_failure ⇒ Boolean

Returns:

  • (Boolean) 

52
 
# File 'lib/keycloak_rack/config.rb', line 52

attr_config halt_on_auth_failure: true

#realm_id ⇒ String

Note:

Required config value

The ID of the realm used to authenticate requests.

Returns:

  • (String) 

27
 
# File 'lib/keycloak_rack/config.rb', line 27

attr_config :realm_id

#server_url ⇒ String

Note:

Required config value

The URL of your Keycloak installation. Be sure to include /auth if necessary.

Returns:

  • (String) 

19
 
# File 'lib/keycloak_rack/config.rb', line 19

attr_config :server_url

#skip_paths ⇒ { #to_s => <String, Regexp> }

Returns:

  • ({ #to_s => <String, Regexp> }) 

36
 
# File 'lib/keycloak_rack/config.rb', line 36

attr_config skip_paths: {}

#token_leeway ⇒ Integer

The number of seconds to allow for tokens to be expired to allow for clock drift.

Returns:

  • (Integer)

See Also:


43
 
# File 'lib/keycloak_rack/config.rb', line 43

attr_config token_leeway: 10