Commonly used classes for Solr security framework.
Interface Summary Interface Description AuditLoggerPlugin.AuditEventFormatterInterface for formatting the event AuditLoggerPlugin.MuteRule AuthorizationPluginAuthorization interface that needs to be implemented to write an authorization plugin. BasicAuthPlugin.AuthenticationProvider ConfigEditablePluginAn interface to be implemented by a Plugin whose Configuration is runtime editable HttpClientBuilderPluginPlugin interface for configuring internal HttpClients. PermissionNameProviderA requestHandler should implement this interface to provide the well known permission at request time VerifiedUserRolesInterface used to pass verified user roles in a Principal object.
Class Summary Class Description AuditEventAudit event that takes request and auth context as input to be able to audit log custom things. AuditLoggerPluginBase class for Audit logger plugins. AuditLoggerPlugin.JSONAuditEventFormatterEvent formatter that returns event as JSON string AuthenticationPlugin AuthorizationContextRequest context for Solr to be used by Authorization plugin. AuthorizationContext.CollectionRequest AuthorizationResponse BasicAuthPlugin ConfigurableInternodeAuthHadoopPluginThis class extends HadoopAuthPlugin by enabling configuration of authentication mechanism for Solr internal communication. DelegationTokenKerberosFilterThis is an authentication filter based on Hadoop's
DelegationTokenKerberosFilter.SolrZkToCuratorCredentialsACLsConvert Solr Zk Credentials/ACLs to Curator versions ExternalRoleRuleBasedAuthorizationPluginRule Based Authz plugin implementation which reads user roles from the request. HadoopAuthFilterThis is an authentication filter based on Hadoop's
HadoopAuthFilter.SolrZkToCuratorCredentialsACLsConvert Solr Zk Credentials/ACLs to Curator versions HadoopAuthPluginThis class implements a generic plugin which can use authentication schemes exposed by the Hadoop framework. JWTAuthPluginAuthenticaion plugin that finds logged in user by validating the signature of a JWT token JWTIssuerConfigHolds information about an IdP (issuer), such as issuer ID, JWK url(s), keys etc JWTIssuerConfig.WellKnownDiscoveryConfigConfig object for a OpenId Connect well-known config Typically exposed through /.well-known/openid-configuration endpoint JWTPrincipalPrincipal object that carries JWT token and claims for authenticated user. JWTPrincipalWithUserRolesJWT 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. JWTVerificationkeyResolverResolves jws signature verification keys from a set of
JWTIssuerConfigobjects, which may represent any valid configuration in Solr's security.json, i.e.
KerberosFilter KerberosPlugin MultiDestinationAuditLoggerAudit logger that chains other loggers. PKIAuthenticationPlugin PKIAuthenticationPlugin.PKIHeaderData PrintWriterWrapperWrapper for PrintWriter that delegates to constructor arg PublicKeyHandler RequestContinuesRecorderAuthenticationHandler RuleBasedAuthorizationPluginOriginal implementation of Rule Based Authz plugin which configures user/role mapping in the security.json configuration RuleBasedAuthorizationPluginBaseBase class for rule based authorization plugins SecurityPluginHolder<T> Sha256AuthenticationProvider SolrLogAuditLoggerPluginAudit logger that writes to the Solr log.
Enum Summary Enum Description AuditEvent.EventType AuditEvent.Level AuditEvent.RequestType AuthorizationContext.RequestType PermissionNameProvider.Name