Package org.apache.solr.security

Class PKIAuthenticationPlugin

java.lang.Object

org.apache.solr.security.AuthenticationPlugin

org.apache.solr.security.PKIAuthenticationPlugin

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, HttpClientBuilderPlugin

public class PKIAuthenticationPlugin
extends AuthenticationPlugin
implements HttpClientBuilderPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PKIAuthenticationPlugin.PKIHeaderData

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_VERSIONS
static final Principal	CLUSTER_MEMBER_NODE
static final String	HEADER
static final String	HEADER_V2
static final String	NODE_IS_USER
static final String	SEND_VERSION

Fields inherited from class org.apache.solr.security.AuthenticationPlugin

AUTHENTICATION_PLUGIN_PROP, HTTP_HEADER_X_SOLR_AUTHDATA, numAuthenticated, numErrors, numMissingCredentials, numPassThrough, numWrongCredentials, requests, requestTimes, solrMetricsContext

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

Constructor Summary

Constructors

Constructor	Description
PKIAuthenticationPlugin(CoreContainer cores, String nodeName, PublicKeyHandler publicKeyHandler)

Method Summary

Modifier and Type	Method	Description
void	close()	Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered.
boolean	doAuthenticate(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)	This method attempts to authenticate the request.
String	getPublicKey()
void	init(Map<String,Object> pluginConfig)	This is called upon loading up of a plugin, used for setting it up.
boolean	isInterceptorRegistered()
boolean	needsAuthorization(jakarta.servlet.http.HttpServletRequest req)
void	setup(HttpJettySolrClient client)
static void	withServerIdentity(boolean enabled)	Mark the current thread as a server thread and set a flag in SolrRequestInfo to indicate you want to send a request as the server identity instead of as the authenticated user.

Methods inherited from class org.apache.solr.security.AuthenticationPlugin

authenticate, closeRequest, getCategory, getDescription, getName, getSolrMetricsContext, initializeMetrics, interceptInternodeRequest, wrapWithPrincipal, wrapWithPrincipal

Methods inherited from class java.lang.Object

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

Field Details

ACCEPT_VERSIONS

public static final String ACCEPT_VERSIONS

See Also:

• Constant Field Values

SEND_VERSION

public static final String SEND_VERSION

See Also:

• Constant Field Values

HEADER

public static final String HEADER

See Also:

• Constant Field Values

HEADER_V2

public static final String HEADER_V2

See Also:

• Constant Field Values

NODE_IS_USER

public static final String NODE_IS_USER

See Also:

• Constant Field Values

CLUSTER_MEMBER_NODE

public static final Principal CLUSTER_MEMBER_NODE

Constructor Details

PKIAuthenticationPlugin

public PKIAuthenticationPlugin(CoreContainer cores,
 String nodeName,
 PublicKeyHandler publicKeyHandler)

Method Details

withServerIdentity

public static void withServerIdentity(boolean enabled)

Mark the current thread as a server thread and set a flag in SolrRequestInfo to indicate you want to send a request as the server identity instead of as the authenticated user.

Parameters:

enabled - If true, enable the current thread to make requests with the server identity.

See Also:

• SolrRequestInfo.setUseServerToken(boolean)

isInterceptorRegistered

public boolean isInterceptorRegistered()

init

public void init(Map<String,Object> pluginConfig)

Description copied from class: AuthenticationPlugin

This is called upon loading up of a plugin, used for setting it up.

Specified by:

init in class AuthenticationPlugin

Parameters:

pluginConfig - Config parameters, possibly from a ZK source

doAuthenticate

public boolean doAuthenticate(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain filterChain)
                       throws Exception

Description copied from class: AuthenticationPlugin

This method attempts to authenticate the request. Upon a successful authentication, this must call the next filter in the filter chain and set the user principal of the request, or else, upon an error or an authentication failure, throw an exception.

Specified by:

doAuthenticate in class AuthenticationPlugin

Parameters:

request - the http request

response - the http response

filterChain - the servlet filter chain

Returns:

false if the request not be processed by Solr (not continue), i.e. the response and status code have already been sent.

Throws:

Exception - any exception thrown during the authentication, e.g. PrivilegedActionException

setup

public void setup(HttpJettySolrClient client)

Specified by:

setup in interface HttpClientBuilderPlugin

needsAuthorization

public boolean needsAuthorization(jakarta.servlet.http.HttpServletRequest req)

close

public void close()
           throws IOException

Description copied from interface: SolrMetricProducer

Implementations should always call SolrMetricProducer.super.close() to ensure that metrics with the same life-cycle as this component are properly unregistered. This prevents obscure memory leaks.

from: https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html While this interface method is declared to throw Exception, implementers are strongly encouraged to declare concrete implementations of the close method to throw more specific exceptions, or to throw no exception at all if the close operation cannot fail.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SolrMetricProducer

Throws:

IOException

getPublicKey

public String getPublicKey()