java.lang.Object
org.elasticsearch.plugins.Plugin
org.elasticsearch.xpack.security.Security
- All Implemented Interfaces:
Closeable,AutoCloseable,ActionPlugin,ClusterCoordinationPlugin,ClusterPlugin,ExtensiblePlugin,IngestPlugin,RestServerActionPlugin,MapperPlugin,NetworkPlugin,PersistentTaskPlugin,ReloadablePlugin,SearchPlugin,SystemIndexPlugin
public class Security
extends Plugin
implements SystemIndexPlugin, IngestPlugin, NetworkPlugin, ClusterPlugin, ClusterCoordinationPlugin, MapperPlugin, ExtensiblePlugin, SearchPlugin, RestServerActionPlugin, ReloadablePlugin, PersistentTaskPlugin
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.plugins.Plugin
Plugin.PluginServicesNested classes/interfaces inherited from interface org.elasticsearch.plugins.ActionPlugin
ActionPlugin.ActionHandlerNested classes/interfaces inherited from interface org.elasticsearch.plugins.ClusterCoordinationPlugin
ClusterCoordinationPlugin.PersistedClusterStateServiceFactory, ClusterCoordinationPlugin.PersistedStateFactory, ClusterCoordinationPlugin.ReconfiguratorFactoryNested classes/interfaces inherited from interface org.elasticsearch.plugins.ExtensiblePlugin
ExtensiblePlugin.ExtensionLoaderNested classes/interfaces inherited from interface org.elasticsearch.plugins.SearchPlugin
SearchPlugin.AggregationSpec, SearchPlugin.FetchPhaseConstructionContext, SearchPlugin.GenericNamedWriteableSpec, SearchPlugin.PipelineAggregationSpec, SearchPlugin.QuerySpec<T extends QueryBuilder>, SearchPlugin.QueryVectorBuilderSpec<T extends QueryVectorBuilder>, SearchPlugin.RescorerSpec<T extends RescorerBuilder<T>>, SearchPlugin.RetrieverSpec<RB extends RetrieverBuilder>, SearchPlugin.ScoreFunctionSpec<T extends ScoreFunctionBuilder<T>>, SearchPlugin.SearchExtensionSpec<W extends NamedWriteable,P>, SearchPlugin.SearchExtSpec<T extends SearchExtBuilder>, SearchPlugin.SignificanceHeuristicSpec<T extends SignificanceHeuristic>, SearchPlugin.SuggesterSpec<T extends SuggestionBuilder<T>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final LicensedFeature.Persistentstatic final LicensedFeature.MomentaryConfigurable cross cluster access is Enterprise feature.static final LicensedFeature.Momentarystatic final LicensedFeature.Momentarystatic final LicensedFeature.Persistentstatic final LicensedFeature.Persistentstatic final LicensedFeature.Momentarystatic final LicensedFeature.Momentarystatic final LicensedFeature.Persistentstatic final LicensedFeature.Persistentstatic final LicensedFeature.Persistentstatic final LicensedFeature.Persistentstatic final LicensedFeature.Momentarystatic final LicensedFeature.Persistentstatic final LicensedFeature.Persistentstatic final Stringstatic final LicensedFeature.Momentarystatic final LicensedFeature.MomentaryFields inherited from interface org.elasticsearch.plugins.MapperPlugin
NOOP_FIELD_FILTER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Collection<?> createComponents(Plugin.PluginServices services) protected Clientprotected ClockgetClock()List<ExecutorBuilder<?>> getExecutorBuilders(Settings settings) static Netty4HttpServerTransportgetHttpServerTransportWithHeadersValidator(Settings settings, NetworkService networkService, ThreadPool threadPool, org.elasticsearch.xcontent.NamedXContentRegistry xContentRegistry, HttpServerTransport.Dispatcher dispatcher, ClusterSettings clusterSettings, SharedGroupFactory sharedGroupFactory, Tracer tracer, TLSConfig tlsConfig, AcceptChannelHandler.AcceptPredicate acceptPredicate, HttpValidator httpValidator) static Netty4HttpServerTransportgetHttpServerTransportWithHeadersValidator(Settings settings, NetworkService networkService, ThreadPool threadPool, org.elasticsearch.xcontent.NamedXContentRegistry xContentRegistry, HttpServerTransport.Dispatcher dispatcher, ClusterSettings clusterSettings, SharedGroupFactory sharedGroupFactory, Tracer tracer, TLSConfig tlsConfig, AcceptChannelHandler.AcceptPredicate acceptPredicate, HttpValidator httpValidator, HttpValidator httpOptionsValidator) getHttpTransports(Settings settings, ThreadPool threadPool, BigArrays bigArrays, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, org.elasticsearch.xcontent.NamedXContentRegistry xContentRegistry, NetworkService networkService, HttpServerTransport.Dispatcher dispatcher, BiConsumer<HttpPreRequest, ThreadContext> perRequestThreadContext, ClusterSettings clusterSettings, Tracer tracer) protected LicenseServiceprotected XPackLicenseStategetPersistentTasksExecutor(ClusterService clusterService, ThreadPool threadPool, Client client, SettingsModule settingsModule, IndexNameExpressionResolver expressionResolver) getProcessors(Processor.Parameters parameters) protected List<ReloadableSecurityComponent> getRestHandlerInterceptor(ThreadContext threadContext) getRestHandlers(Settings settings, NamedWriteableRegistry namedWriteableRegistry, RestController restController, ClusterSettings clusterSettings, IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver, Supplier<DiscoveryNodes> nodesInCluster, Predicate<NodeFeature> clusterSupportsFeature) getSettings(List<SecurityExtension> securityExtensions) Get thesetting configurationfor all security components, including those defined in extensions.protected SSLServicegetSystemIndexDescriptors(Settings settings) getTransportInterceptors(NamedWriteableRegistry namedWriteableRegistry, ThreadContext threadContext) getTransports(Settings settings, ThreadPool threadPool, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, NamedWriteableRegistry namedWriteableRegistry, NetworkService networkService) voidvoidonIndexModule(IndexModule module) voidvoidstatic PathresolveSecuredConfigFile(Environment env, String file) Methods inherited from class org.elasticsearch.plugins.Plugin
getAdditionalIndexSettingProviders, getNamedWriteables, getNamedXContent, getProjectCustomMetadataUpgradersMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.plugins.ActionPlugin
getMappedActionFilters, getTaskHeaders, indicesAliasesRequestValidators, mappingRequestValidatorsMethods inherited from interface org.elasticsearch.plugins.ClusterCoordinationPlugin
getElectionStrategies, getLeaderHeartbeatService, getPersistedClusterStateServiceFactory, getPersistedStateFactory, getPreVoteCollectorFactory, getReconfiguratorFactoryMethods inherited from interface org.elasticsearch.plugins.ClusterPlugin
createAllocationDeciders, createWriteLoadForecasters, getBalancingWeightsFactory, getExistingShardsAllocators, getShardRoutingRoleStrategy, getShardsAllocatorsMethods inherited from interface org.elasticsearch.plugins.MapperPlugin
getMappers, getMetadataMappers, getRuntimeFieldsMethods inherited from interface org.elasticsearch.plugins.interceptor.RestServerActionPlugin
getRestControllerMethods inherited from interface org.elasticsearch.plugins.SearchPlugin
getAggregationExtentions, getAggregations, getFetchSubPhases, getGenericNamedWriteables, getHighlighters, getPipelineAggregations, getQueries, getQueryVectorBuilders, getRescorers, getRetrievers, getScoreFunctions, getSearchExts, getSignificanceHeuristics, getSuggestersMethods inherited from interface org.elasticsearch.plugins.SystemIndexPlugin
cleanUpFeature, getAssociatedIndexDescriptors, getSystemDataStreamDescriptors, indicesMigrationComplete, prepareForIndicesMigration
-
Field Details
-
SECURITY_CRYPTO_THREAD_POOL_NAME
- See Also:
-
IP_FILTERING_FEATURE
-
AUDITING_FEATURE
-
TOKEN_SERVICE_FEATURE
-
LDAP_REALM_FEATURE
-
AD_REALM_FEATURE
-
PKI_REALM_FEATURE
-
SAML_REALM_FEATURE
-
OIDC_REALM_FEATURE
-
JWT_REALM_FEATURE
-
KERBEROS_REALM_FEATURE
-
CUSTOM_REALMS_FEATURE
-
DELEGATED_AUTHORIZATION_FEATURE
-
AUTHORIZATION_ENGINE_FEATURE
-
CUSTOM_ROLE_PROVIDERS_FEATURE
-
OPERATOR_PRIVILEGES_FEATURE
-
USER_PROFILE_COLLABORATION_FEATURE
-
ADVANCED_REMOTE_CLUSTER_SECURITY_FEATURE
Configurable cross cluster access is Enterprise feature.
-
-
Constructor Details
-
Security
-
-
Method Details
-
getClock
-
getSslService
-
getLicenseService
-
getLicenseState
-
getClient
-
getReloadableSecurityComponents
-
resolveSecuredConfigFile
-
createComponents
- Overrides:
createComponentsin classPlugin
-
additionalSettings
- Overrides:
additionalSettingsin classPlugin
-
getSettings
- Overrides:
getSettingsin classPlugin
-
getSettings
Get thesetting configurationfor all security components, including those defined in extensions. -
getRestHeaders
- Specified by:
getRestHeadersin interfaceActionPlugin
-
getSettingsFilter
- Overrides:
getSettingsFilterin classPlugin
-
getBootstrapChecks
- Overrides:
getBootstrapChecksin classPlugin
-
onIndexModule
- Overrides:
onIndexModulein classPlugin
-
getActions
- Specified by:
getActionsin interfaceActionPlugin
-
getActionFilters
- Specified by:
getActionFiltersin interfaceActionPlugin
-
getRestHandlers
public List<RestHandler> getRestHandlers(Settings settings, NamedWriteableRegistry namedWriteableRegistry, RestController restController, ClusterSettings clusterSettings, IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver, Supplier<DiscoveryNodes> nodesInCluster, Predicate<NodeFeature> clusterSupportsFeature) - Specified by:
getRestHandlersin interfaceActionPlugin
-
getProcessors
- Specified by:
getProcessorsin interfaceIngestPlugin
-
onNodeStarted
public void onNodeStarted()- Specified by:
onNodeStartedin interfaceClusterPlugin
-
getTransportInterceptors
public List<TransportInterceptor> getTransportInterceptors(NamedWriteableRegistry namedWriteableRegistry, ThreadContext threadContext) - Specified by:
getTransportInterceptorsin interfaceNetworkPlugin
-
getTransports
public Map<String,Supplier<Transport>> getTransports(Settings settings, ThreadPool threadPool, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, NamedWriteableRegistry namedWriteableRegistry, NetworkService networkService) - Specified by:
getTransportsin interfaceNetworkPlugin
-
getHttpTransports
public Map<String,Supplier<HttpServerTransport>> getHttpTransports(Settings settings, ThreadPool threadPool, BigArrays bigArrays, PageCacheRecycler pageCacheRecycler, CircuitBreakerService circuitBreakerService, org.elasticsearch.xcontent.NamedXContentRegistry xContentRegistry, NetworkService networkService, HttpServerTransport.Dispatcher dispatcher, BiConsumer<HttpPreRequest, ThreadContext> perRequestThreadContext, ClusterSettings clusterSettings, Tracer tracer) - Specified by:
getHttpTransportsin interfaceNetworkPlugin
-
getRestHandlerInterceptor
- Specified by:
getRestHandlerInterceptorin interfaceRestServerActionPlugin
-
getExecutorBuilders
- Overrides:
getExecutorBuildersin classPlugin
-
getIndexTemplateMetadataUpgrader
- Overrides:
getIndexTemplateMetadataUpgraderin classPlugin
-
getFieldFilter
- Specified by:
getFieldFilterin interfaceMapperPlugin
-
getJoinValidator
- Specified by:
getJoinValidatorin interfaceClusterCoordinationPlugin
-
reload
- Specified by:
reloadin interfaceReloadablePlugin- Throws:
Exception
-
getAuthContextForSlowLog
-
loadExtensions
- Specified by:
loadExtensionsin interfaceExtensiblePlugin
-
getSystemIndexDescriptors
- Specified by:
getSystemIndexDescriptorsin interfaceSystemIndexPlugin
-
getFeatureName
- Specified by:
getFeatureNamein interfaceSystemIndexPlugin
-
getFeatureDescription
- Specified by:
getFeatureDescriptionin interfaceSystemIndexPlugin
-
getRequestCacheKeyDifferentiator
public CheckedBiConsumer<ShardSearchRequest,StreamOutput, getRequestCacheKeyDifferentiator()IOException> - Specified by:
getRequestCacheKeyDifferentiatorin interfaceSearchPlugin
-
getPersistentTasksExecutor
public List<PersistentTasksExecutor<?>> getPersistentTasksExecutor(ClusterService clusterService, ThreadPool threadPool, Client client, SettingsModule settingsModule, IndexNameExpressionResolver expressionResolver) - Specified by:
getPersistentTasksExecutorin interfacePersistentTaskPlugin
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classPlugin- Throws:
IOException
-