Skip to content
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

[DOC] Add a new section in documentation for security best practices and recommendations. #5782

Closed
Tracked by #816
hdhalter opened this issue Dec 4, 2023 · 9 comments · Fixed by #7113
Closed
Tracked by #816
Assignees
Labels
3 - Done Issue is done/complete security

Comments

@hdhalter
Copy link
Contributor

hdhalter commented Dec 4, 2023

Add a new section in documentation for security best practices and recommendations

@stephen-crawford
Copy link
Contributor

Examples:

  1. Don't use default credentials
  2. Use the password tool to create a very strong password
  3. Don't use the demo certificates for anything other than demos
  4. Don't mix standard role and backend role DLS and FLS configurations (i.e. a user has DLS configured through normal roles but also their backend role)
  5. Don't mix multiple DLS/FLS configured roles: [BUG] "Field level security" and "Field masking definitions" don't work together with "Document level security" security#3274
  6. Don't give default user level write permissions (should be read-only)

@DarshitChanpura @cwperks @peternied any other suggestions for good common practices we can add

@hdhalter
Copy link
Contributor Author

hdhalter commented Dec 6, 2023

Please add a note about #3084. Thanks!

@cwperks
Copy link
Member

cwperks commented Dec 7, 2023

@scrawfor99 You may also want to consider adding a section on dashboards security setup as well.

  1. Make sure the cookie is secure
opensearch_security.cookie.secure: true
opensearch_security.cookie.password: <secret_for_cookie_encryption>
  1. Setup TLS (don't run with opensearch.ssl.verificationMode: none)

Instead:

opensearch.ssl.verificationMode: full
opensearch.ssl.certificateAuthorities: </path/to/root-ca.pem>

Link to: https://opensearch.org/docs/latest/install-and-configure/install-dashboards/tls/

@peternied
Copy link
Member

Thanks for calling this out @hdhalter just a couple more to add on:

  1. [Serious] Do you think we could get away with linking to XKCD for what 'strong' password practically means - its memorable and insightful? https://xkcd.com/936/
  2. Follow the principle of least privilege for secrets used to configure the cluster and the roles used to access the cluster.
  3. Enable audit logging and verify that the audit data has the information needed by your organizations information security policies.

@rursprung
Copy link
Contributor

linking xkcd is certainly never wrong 😉 👍 (i don't know how often i've sent a link to this specific comic - it's just a very good way of explaining the very hard concept of "safe" passwords)

what about TLS settings? i guess they should also be documented (i remember that the default settings for OS have been updated; for OSD the PR is AFAIK still hanging to even add support for TLS v1.3, much less make it the default?). though in the best case the default is already the current "strong" default and no further documentation is needed as it just works out of the box.

@john-eliatra
Copy link
Contributor

Hi @hdhalter , adding my comment to be assigned to this one. Thx, John

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. 1 - Backlog - CON labels Dec 21, 2023
@hdhalter hdhalter changed the title Add a new section in documentation for security best practices and recommendations. [Doc] Add a new section in documentation for security best practices and recommendations. Jan 17, 2024
@hdhalter hdhalter changed the title [Doc] Add a new section in documentation for security best practices and recommendations. [DOC] Add a new section in documentation for security best practices and recommendations. Jan 17, 2024
@hdhalter
Copy link
Contributor Author

hdhalter commented May 8, 2024

@leanneeliatra/@anton - Can you please add a comment so I can assign you?

@leanneeliatra
Copy link
Contributor

leanneeliatra commented May 14, 2024

@hdhalter Please assign me! Thank you.

@leanneeliatra
Copy link
Contributor

leanneeliatra commented May 14, 2024

PR submitted for review #7113

Naarcha-AWS added a commit that referenced this issue May 30, 2024
* adding top ten security best practices

Signed-off-by: [email protected] <[email protected]>

* changing nav order

Signed-off-by: [email protected] <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding bonus tip

Signed-off-by: [email protected] <[email protected]>

* updates to best practices

Signed-off-by: [email protected] <[email protected]>

* integrating Darshits suggestions for improvement and reviewdog fixes

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* reviewdog update

Signed-off-by: [email protected] <[email protected]>

* Apply suggestions from code review

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>

* reviewdog updates

Signed-off-by: [email protected] <[email protected]>

* Update _security/configuration/best-practices.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Add editorial comment

Signed-off-by: Naarcha-AWS <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update _security/configuration/best-practices.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue May 30, 2024
* adding top ten security best practices

Signed-off-by: [email protected] <[email protected]>

* changing nav order

Signed-off-by: [email protected] <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding bonus tip

Signed-off-by: [email protected] <[email protected]>

* updates to best practices

Signed-off-by: [email protected] <[email protected]>

* integrating Darshits suggestions for improvement and reviewdog fixes

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* reviewdog update

Signed-off-by: [email protected] <[email protected]>

* Apply suggestions from code review

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>

* reviewdog updates

Signed-off-by: [email protected] <[email protected]>

* Update _security/configuration/best-practices.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Add editorial comment

Signed-off-by: Naarcha-AWS <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update _security/configuration/best-practices.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 8e049cd)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
epugh pushed a commit to o19s/documentation-website that referenced this issue May 30, 2024
…5782 (opensearch-project#7113)

* adding top ten security best practices

Signed-off-by: [email protected] <[email protected]>

* changing nav order

Signed-off-by: [email protected] <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding to best practices

Signed-off-by: AntonEliatra <[email protected]>

* adding bonus tip

Signed-off-by: [email protected] <[email protected]>

* updates to best practices

Signed-off-by: [email protected] <[email protected]>

* integrating Darshits suggestions for improvement and reviewdog fixes

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* review suggestions to grammer

Signed-off-by: [email protected] <[email protected]>

* reviewdog update

Signed-off-by: [email protected] <[email protected]>

* Apply suggestions from code review

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>

* reviewdog updates

Signed-off-by: [email protected] <[email protected]>

* Update _security/configuration/best-practices.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Add editorial comment

Signed-off-by: Naarcha-AWS <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update _security/configuration/best-practices.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: AntonEliatra <[email protected]>

* Update best-practices.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: AntonEliatra <[email protected]>
Signed-off-by: leanneeliatra <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete security
Projects
None yet
7 participants