Package org.apache.solr.security

Commonly used classes for Solr security framework.

See: Description

Interface Summary

Interface	Description
AuditLoggerPlugin.AuditEventFormatter	Interface for formatting the event
AuditLoggerPlugin.MuteRule
AuthorizationPlugin	Authorization interface that needs to be implemented to write an authorization plugin.
BasicAuthPlugin.AuthenticationProvider
ConfigEditablePlugin	An interface to be implemented by a Plugin whose Configuration is runtime editable
HttpClientBuilderPlugin	Plugin interface for configuring internal HttpClients.
PermissionNameProvider	A requestHandler should implement this interface to provide the well known permission at request time
VerifiedUserRoles	Interface used to pass verified user roles in a Principal object.

Class Summary

Class	Description
AuditEvent	Audit event that takes request and auth context as input to be able to audit log custom things.
AuditLoggerPlugin	Base class for Audit logger plugins.
AuditLoggerPlugin.JSONAuditEventFormatter	Event formatter that returns event as JSON string
AuthenticationPlugin
AuthorizationContext	Request context for Solr to be used by Authorization plugin.
AuthorizationContext.CollectionRequest
AuthorizationResponse
BasicAuthPlugin
ConfigurableInternodeAuthHadoopPlugin	This class extends HadoopAuthPlugin by enabling configuration of authentication mechanism for Solr internal communication.
DelegationTokenKerberosFilter	This is an authentication filter based on Hadoop's DelegationTokenAuthenticationFilter.
DelegationTokenKerberosFilter.SolrZkToCuratorCredentialsACLs	Convert Solr Zk Credentials/ACLs to Curator versions
ExternalRoleRuleBasedAuthorizationPlugin	Rule Based Authz plugin implementation which reads user roles from the request.
HadoopAuthFilter	This is an authentication filter based on Hadoop's DelegationTokenAuthenticationFilter.
HadoopAuthFilter.SolrZkToCuratorCredentialsACLs	Convert Solr Zk Credentials/ACLs to Curator versions
HadoopAuthPlugin	This class implements a generic plugin which can use authentication schemes exposed by the Hadoop framework.
JWTAuthPlugin	Authenticaion plugin that finds logged in user by validating the signature of a JWT token
JWTIssuerConfig	Holds information about an IdP (issuer), such as issuer ID, JWK url(s), keys etc
JWTIssuerConfig.WellKnownDiscoveryConfig	Config object for a OpenId Connect well-known config Typically exposed through /.well-known/openid-configuration endpoint
JWTPrincipal	Principal object that carries JWT token and claims for authenticated user.
JWTPrincipalWithUserRoles	JWT principal that contains username, token, claims and a list of roles the user has, so one can keep track of user-role mappings in an Identity Server external to Solr and pass the information to Solr in a signed JWT token.
JWTVerificationkeyResolver	Resolves jws signature verification keys from a set of JWTIssuerConfig objects, which may represent any valid configuration in Solr's security.json, i.e.
KerberosFilter
KerberosPlugin
MultiDestinationAuditLogger	Audit logger that chains other loggers.
PKIAuthenticationPlugin
PKIAuthenticationPlugin.PKIHeaderData
PrintWriterWrapper	Wrapper for PrintWriter that delegates to constructor arg
PublicKeyHandler
RequestContinuesRecorderAuthenticationHandler
RuleBasedAuthorizationPlugin	Original implementation of Rule Based Authz plugin which configures user/role mapping in the security.json configuration
RuleBasedAuthorizationPluginBase	Base class for rule based authorization plugins
SecurityPluginHolder<T>
Sha256AuthenticationProvider
SolrLogAuditLoggerPlugin	Audit logger that writes to the Solr log.

Enum Summary

Enum	Description
AuditEvent.EventType
AuditEvent.Level
AuditEvent.RequestType
AuthorizationContext.RequestType
PermissionNameProvider.Name

Package org.apache.solr.security Description

Commonly used classes for Solr security framework.