Update plugins documentation for Entitlements #125292
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ldematte
added
>docs
elasticsearchmachine
added
Team:Core/Infra
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
mosche
approved these changes
Mar 20, 2025
|
|
||
| {{es}} limits the ability to perform certain security-sensitive actions as part of its _Entitlement_ security mechanism (e.g. to limit the potential fallout from remote code execution (RCE) vulnerabilities). | ||
|
|
||
| The Entitlement model is _scope_-based: the subset of code to which we grant the ability to perform a security-sensitive action is called a _scope_. |
There was a problem hiding this comment.
Suggested change
| The Entitlement model is _scope_-based: the subset of code to which we grant the ability to perform a security-sensitive action is called a _scope_. | |
| The Entitlement model is _scope_-based: the subset of code to which the ability to perform a security-sensitive action is granted, is called a _scope_. |
| {{es}} limits the ability to perform certain security-sensitive actions as part of its _Entitlement_ security mechanism (e.g. to limit the potential fallout from remote code execution (RCE) vulnerabilities). | ||
|
|
||
| The Entitlement model is _scope_-based: the subset of code to which we grant the ability to perform a security-sensitive action is called a _scope_. | ||
| Currently, scope granularity is at java-module level; in other words, an _entitlement scope_ corresponds to a java module. |
There was a problem hiding this comment.
Suggested change
| Currently, scope granularity is at java-module level; in other words, an _entitlement scope_ corresponds to a java module. | |
| Currently, scope granularity is at the Java module level; in other words, an _entitlement scope_ corresponds to a Java module. |
prdoyle
reviewed
Mar 20, 2025
prdoyle
reviewed
Mar 20, 2025
| Each of the 3 types has some additional fields: | ||
| - `mode` (required): can be either `read` or `read_write` | ||
| - `platform` (optional): if a path is specific to a platform. Can be `linux`, `macos` or `windows`. If not specified, the path is assumed to be valid on all platforms. | ||
| - `platform` (optional): indicates the entitlement groups be granted on only one platform, which can be one of `linux`, `macos` or `windows`. On other platforms, the entitlement is ignored. If this field is not specified, the entitlement is granted on all platforms. |
There was a problem hiding this comment.
Should this last "entitlement" be "entitlement groups"?
ldematte
added a commit
to ldematte/elasticsearch
that referenced
this pull request
Mar 21, 2025
This PR updates the documentation for Creating classic plugins, replacing the instructions relative to the Java SecurityManager with information on Entitlements. Relates to ES-10846
💔 Backport failed
You can use sqren/backport to manually backport by running |
elasticsearchmachine
pushed a commit
that referenced
this pull request
Mar 21, 2025
ldematte
added a commit
that referenced
this pull request
Mar 21, 2025
This PR updates the documentation for Creating classic plugins, replacing the instructions relative to the Java SecurityManager with information on Entitlements. Relates to ES-10846
afoucret
pushed a commit
to afoucret/elasticsearch
that referenced
this pull request
Mar 21, 2025
This PR updates the documentation for Creating classic plugins, replacing the instructions relative to the Java SecurityManager with information on Entitlements. Relates to ES-10846
smalyshev
pushed a commit
to smalyshev/elasticsearch
that referenced
this pull request
Mar 21, 2025
This PR updates the documentation for Creating classic plugins, replacing the instructions relative to the Java SecurityManager with information on Entitlements. Relates to ES-10846
omricohenn
pushed a commit
to omricohenn/elasticsearch
that referenced
this pull request
Mar 28, 2025
This PR updates the documentation for Creating classic plugins, replacing the instructions relative to the Java SecurityManager with information on Entitlements. Relates to ES-10846
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation for Creating classic plugins, replacing the instructions relative to the Java SecurityManager with information on Entitlements.
Relates to ES-10846