Package io.hawt.web.auth

Class AuthenticationConfiguration

java.lang.Object

io.hawt.web.auth.AuthenticationConfiguration

public class AuthenticationConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH	Shorthand for AUTHENTICATION_ENABLED.
static final String	AUTHENTICATION_CONFIGURATION
static final String	AUTHENTICATION_CONTAINER_DISCOVERY_CLASSES	AuthenticationContainerDiscovery classes divided by comma, which are used to discover container environments.
static final String	AUTHENTICATION_ENABLED	Enable or disable Hawtio's authentication.
static final String	AUTHENTICATION_THROTTLED	Throttle authentication to protect Hawtio from brute force attacks.
static final String	DEFAULT_KARAF_ROLE_PRINCIPAL_CLASSES
static final String	DEFAULT_REALM
static final String	HAWTIO_AUTH
static final String	HAWTIO_AUTH_CONTAINER_DISCOVERY_CLASSES
static final String	HAWTIO_AUTHENTICATION_ENABLED
static final String	HAWTIO_AUTHENTICATION_THROTTLED
static final String	HAWTIO_KEYCLOAK_ENABLED
static final String	HAWTIO_NO_CREDENTIALS_401
static final String	HAWTIO_OIDC_CLIENT_CONFIG
static final String	HAWTIO_REALM
static final String	HAWTIO_ROLE_PRINCIPAL_CLASSES
static final String	HAWTIO_ROLES
static final String	KEYCLOAK_ENABLED	Enable or disable Keycloak integration.
static final String	LOGIN_URL
static final String	NO_CREDENTIALS_401	Whether to return 401 on No Credentials authentication error.
static final String	OIDC_CLIENT_CONFIG	Configuration property to specify a location for OIDC properties file.
static final String	REALM	JAAS realm used to authenticate users.
static final String	ROLE_PRINCIPAL_CLASSES	JAAS class name that would contain the role principal.
static final String	ROLES	Authorized user roles.
static final String	TOMCAT_AUTH_CONTAINER_DISCOVERY
static final String[]	UNSECURED_PATHS

Method Summary

Modifier and Type	Method	Description
void	configureOidc()	Initialize OIDC configuration, so it is available both in AuthConfigurationServlet and ContentSecurityPolicyFilter.
protected String	defaultOidcConfigLocation()	Similarly to Keycloak configuration, we'll try well-known configuration locations.
Configuration	getConfiguration()
static AuthenticationConfiguration	getConfiguration(jakarta.servlet.ServletContext servletContext)
OidcConfiguration	getOidcConfiguration()
String	getRealm()
String	getRolePrincipalClasses()
String	getRoles()
Optional<AuthenticationThrottler>	getThrottler()
boolean	isEnabled()
boolean	isKeycloakEnabled()
boolean	isNoCredentials401()
void	setConfiguration(Configuration configuration)
void	setRolePrincipalClasses(String rolePrincipalClasses)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

LOGIN_URL

public static final String LOGIN_URL

See Also:

• Constant Field Values

UNSECURED_PATHS

public static final String[] UNSECURED_PATHS

AUTHENTICATION_ENABLED

public static final String AUTHENTICATION_ENABLED

Enable or disable Hawtio's authentication. Value should be boolean.

See Also:

• Constant Field Values

AUTH

public static final String AUTH

Shorthand for AUTHENTICATION_ENABLED.

See Also:

• Constant Field Values

AUTHENTICATION_THROTTLED

public static final String AUTHENTICATION_THROTTLED

Throttle authentication to protect Hawtio from brute force attacks.

See Also:

• Constant Field Values

REALM

public static final String REALM

JAAS realm used to authenticate users.

See Also:

• Constant Field Values

ROLES

public static final String ROLES

Authorized user roles. Empty string disables authorization.

See Also:

• Constant Field Values

ROLE_PRINCIPAL_CLASSES

public static final String ROLE_PRINCIPAL_CLASSES

JAAS class name that would contain the role principal. Empty string disables authorization.

See Also:

• Constant Field Values

NO_CREDENTIALS_401

public static final String NO_CREDENTIALS_401

Whether to return 401 on No Credentials authentication error. Value should be boolean.

See Also:

• Constant Field Values

AUTHENTICATION_CONTAINER_DISCOVERY_CLASSES

public static final String AUTHENTICATION_CONTAINER_DISCOVERY_CLASSES

AuthenticationContainerDiscovery classes divided by comma, which are used to discover container environments.

See Also:

• Constant Field Values

KEYCLOAK_ENABLED

public static final String KEYCLOAK_ENABLED

Enable or disable Keycloak integration. Value should be boolean.

See Also:

• Constant Field Values

OIDC_CLIENT_CONFIG

public static final String OIDC_CLIENT_CONFIG

Configuration property to specify a location for OIDC properties file.

See Also:

• Constant Field Values

HAWTIO_OIDC_CLIENT_CONFIG

public static final String HAWTIO_OIDC_CLIENT_CONFIG

See Also:

• Constant Field Values

HAWTIO_AUTHENTICATION_ENABLED

public static final String HAWTIO_AUTHENTICATION_ENABLED

See Also:

• Constant Field Values

HAWTIO_AUTH

public static final String HAWTIO_AUTH

See Also:

• Constant Field Values

HAWTIO_AUTHENTICATION_THROTTLED

public static final String HAWTIO_AUTHENTICATION_THROTTLED

See Also:

• Constant Field Values

HAWTIO_REALM

public static final String HAWTIO_REALM

See Also:

• Constant Field Values

HAWTIO_ROLES

public static final String HAWTIO_ROLES

See Also:

• Constant Field Values

HAWTIO_ROLE_PRINCIPAL_CLASSES

public static final String HAWTIO_ROLE_PRINCIPAL_CLASSES

See Also:

• Constant Field Values

HAWTIO_NO_CREDENTIALS_401

public static final String HAWTIO_NO_CREDENTIALS_401

See Also:

• Constant Field Values

HAWTIO_AUTH_CONTAINER_DISCOVERY_CLASSES

public static final String HAWTIO_AUTH_CONTAINER_DISCOVERY_CLASSES

See Also:

• Constant Field Values

HAWTIO_KEYCLOAK_ENABLED

public static final String HAWTIO_KEYCLOAK_ENABLED

See Also:

• Constant Field Values

AUTHENTICATION_CONFIGURATION

public static final String AUTHENTICATION_CONFIGURATION

See Also:

• Constant Field Values

DEFAULT_REALM

public static final String DEFAULT_REALM

See Also:

• Constant Field Values

DEFAULT_KARAF_ROLE_PRINCIPAL_CLASSES

public static final String DEFAULT_KARAF_ROLE_PRINCIPAL_CLASSES

See Also:

• Constant Field Values

TOMCAT_AUTH_CONTAINER_DISCOVERY

public static final String TOMCAT_AUTH_CONTAINER_DISCOVERY

See Also:

• Constant Field Values

Method Details

getConfiguration

public static AuthenticationConfiguration getConfiguration(jakarta.servlet.ServletContext servletContext)

isEnabled

public boolean isEnabled()

getThrottler

public Optional<AuthenticationThrottler> getThrottler()

isNoCredentials401

public boolean isNoCredentials401()

getRealm

public String getRealm()

getRoles

public String getRoles()

getRolePrincipalClasses

public String getRolePrincipalClasses()

setRolePrincipalClasses

public void setRolePrincipalClasses(String rolePrincipalClasses)

getConfiguration

public Configuration getConfiguration()

setConfiguration

public void setConfiguration(Configuration configuration)

isKeycloakEnabled

public boolean isKeycloakEnabled()

configureOidc

public void configureOidc()

Initialize OIDC configuration, so it is available both in AuthConfigurationServlet and ContentSecurityPolicyFilter.

defaultOidcConfigLocation

protected String defaultOidcConfigLocation()

Similarly to Keycloak configuration, we'll try well-known configuration locations.

Returns:

config location to be used by default

getOidcConfiguration

public OidcConfiguration getOidcConfiguration()

toString

public String toString()

Overrides:

toString in class Object