-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Add ES security principles #76850
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
lockewritesdocs
merged 12 commits into
elastic:master
from
lockewritesdocs:docs__clarify-exposing-clusters
Aug 31, 2021
Merged
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
fa952d7
[DOCS] Add ES security principles
e26921b
Incorporating review feedback
6f35a97
Merge branch 'master' into docs__clarify-exposing-clusters
elasticmachine 47c94cf
More changes from review feedback
7a3e350
Fix cross-link to Painless guide
f9b1ca4
Merge branch 'master' into docs__clarify-exposing-clusters
elasticmachine d8908a2
Clarify callout text
96230dc
Add information about elasticsearch user
cca3bdf
Minor wording edits
86496a4
Consolidate Java Security Manager description, plus other edits
3d3eabc
Clarify not running as root
05933a1
Merge branch 'master' into docs__clarify-exposing-clusters
elasticmachine File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| [[es-security-principles]] | ||
| == {es} security principles | ||
| Protecting your {es} cluster and the data it contains is of utmost importance. | ||
| There are numerous security practices and considerations for keeping your | ||
| cluster safe, such as not saving passwords in plain text files or making sure | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| that users have appropriate permissions (most users shouldn't be a superuser). | ||
| These guidelines are important, but the following information provides something | ||
| greater. These principles are foundational to running {es} in a secure manner. | ||
|
|
||
| [discrete] | ||
| [[security-dont-run-without]] | ||
| === Run {es} with security enabled | ||
| Never run an {es} cluster without security enabled. This principle cannot be | ||
| overstated. Running {es} without security leaves your cluster exposed to anyone | ||
| on the internet, permitting anyone to download, modify, or delete any data in | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| your cluster. | ||
| <<configuring-stack-security,Start the {stack} with security enabled>> or | ||
| <<manually-configure-security,manually configure security>> to prevent | ||
| unauthorized access to your clusters and ensure that internode communication | ||
| is secure. | ||
|
|
||
| [discrete] | ||
| [[security-dont-expose]] | ||
| === Protect {es} from public internet traffic | ||
| Even with security enabled, never expose {es} to public internet traffic. | ||
| Using an application to sanitize requests to {es} still poses risks, such as | ||
lockewritesdocs marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| a malicious user writing <<search,`_search`>> requests that could overwhelm an | ||
| {es} cluster and bring it down. If you need to connect devices from the internet | ||
| to {es}, use some combination of a proxy, firewall, and VPN. The best | ||
| combination of these technologies depends on your security needs and risks. | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [discrete] | ||
| [[security-dont-expose-to-users]] | ||
| === Implement a barrier between {es} and users | ||
| While you absolutely shouldn't expose {es} directly to the internet, you also | ||
| shouldn't expose {es} directly to users. The following configurations provide | ||
| different methods of user interaction with {es}: | ||
|
|
||
| * *Best*: Use an application to make requests on behalf of users. | ||
| * *Better*: If the previous configuration isn't possible, use an application to | ||
| sanitize requests from users. | ||
| * *Good*: If either of the previous configurations isn't possible, implement | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| some mechanism to track user behaviors, such as requests that are submitted to | ||
| specific nodes in the cluster. | ||
|
|
||
| [discrete] | ||
| [[security-dont-run-as-root]] | ||
| === Create appropriate users to run {es} | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Never run {es} as the `root` user. Running as the `root` user provides an avenue | ||
| to circumvent the other security layers and permit a user to do *anything* on | ||
| your server. {es} will refuse to start if it detects that it is running as | ||
| `root`, but it's worth double (or triple) checking the user that {es} runs as. | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <<defining-roles,Define roles>> for your users and | ||
| <<security-privileges,assign appropriate privileges>> to ensure that users have | ||
| access only to the resources that they need. | ||
lockewritesdocs marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.