Class Authorization

java.lang.Object

org.forgerock.opendj.hdap.authz.Authorization

public final class Authorization
extends Object

Factory methods to create Filter performing authentication and authorizations.

Method Summary

Modifier and Type	Method	Description
static org.forgerock.http.Filter	newAuthorizationFilter(Iterable<? extends ConditionalFilters.ConditionalFilter> filters)	Creates a new Filter in charge of injecting an LdapClientContext.
static ConditionalFilters.ConditionalFilter	newConditionalDirectConnectionFilter(LdapClient ldapClient, Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier)	Creates a ConditionalFilters.ConditionalFilter injecting an LdapClientContext with a connection issued from the given connectionFactory.
static ConditionalFilters.ConditionalFilter	newConditionalHttpBasicAuthenticationFilter(AuthenticationStrategy authenticationStrategy, Function<org.forgerock.http.protocol.Headers, Pair<String,String>, NeverThrowsException> credentialsExtractor)	Creates a new ConditionalFilters.ConditionalFilter performing authentication.
static org.forgerock.http.Filter	newProxyAuthorizationFilter(LdapClient ldapClient, Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier)	Creates a filter injecting an LdapClientContext given the information provided in the SecurityContext.

Methods inherited from class Object

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

Method Details

newAuthorizationFilter

public static org.forgerock.http.Filter newAuthorizationFilter(Iterable<? extends ConditionalFilters.ConditionalFilter> filters)

Creates a new Filter in charge of injecting an LdapClientContext. This Filter tries each of the provided filters until one can apply. If no filter can be applied, the last filter in the list will be applied allowing it to formulate a valid, implementation specific, error response.

Parameters:

filters - Iterable of authorization ConditionalFilters to try. If empty, the returned filter will always respond with 403 Forbidden.

Returns:

A new authorization Filter

newConditionalHttpBasicAuthenticationFilter

public static ConditionalFilters.ConditionalFilter newConditionalHttpBasicAuthenticationFilter(AuthenticationStrategy authenticationStrategy,
 Function<org.forgerock.http.protocol.Headers, Pair<String,String>, NeverThrowsException> credentialsExtractor)

Creates a new ConditionalFilters.ConditionalFilter performing authentication. If authentication succeed, it injects a SecurityContext with the authenticationId provided by the user. Otherwise, returns a HTTP 401 - Unauthorized response. The condition of this ConditionalFilters.ConditionalFilter will return true if the supplied requests contains credentials information, false otherwise.

Parameters:

authenticationStrategy - AuthenticationStrategy to validate the user's provided credentials.

credentialsExtractor - Function to extract the credentials from the received request.

Returns:

a new ConditionalFilters.ConditionalFilter

Throws:

NullPointerException - if a parameter is null.

newConditionalDirectConnectionFilter

public static ConditionalFilters.ConditionalFilter newConditionalDirectConnectionFilter(LdapClient ldapClient,
 Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier)

Creates a ConditionalFilters.ConditionalFilter injecting an LdapClientContext with a connection issued from the given connectionFactory. The condition is always true.

Parameters:

ldapClient - The ldap client used to get the LdapClientSocket to inject

openTelemetrySupplier - A supplier for the openTelemetry instance

Returns:

A new ConditionalFilters.ConditionalFilter.

Throws:

NullPointerException - if connectionFactory is null

newProxyAuthorizationFilter

public static org.forgerock.http.Filter newProxyAuthorizationFilter(LdapClient ldapClient,
 Supplier<io.opentelemetry.api.OpenTelemetry> openTelemetrySupplier)

Creates a filter injecting an LdapClientContext given the information provided in the SecurityContext. The connection contained in the created LdapClientContext will add a ProxiedAuthV2RequestControl to each LDAP requests.

Parameters:

ldapClient - The ldap client used to create the connection which will be injected in the LdapClientContext

openTelemetrySupplier - A supplier for the openTelemetry instance

Returns:

A new filter.

Throws:

NullPointerException - if connectionFactory is null