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

[DOCS] Security domain splitting impacts API keys #88677

Merged
merged 21 commits into from
Jul 28, 2022

Conversation

n1v0lg
Copy link
Contributor

@n1v0lg n1v0lg commented Jul 21, 2022

This PR documents the impact of domain splitting on API keys. API key
ownership is determined via username and user realm information,
including the user's security domain. API key ownership is shared
across users with the same username that are part of the same security
domain. A user loses ownership over an API key if their realm is
removed from the security domain that previously enabled ownership
through cross-realm resource sharing.

@n1v0lg n1v0lg added >docs General docs changes :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) labels Jul 21, 2022
@n1v0lg n1v0lg self-assigned this Jul 21, 2022
@@ -22,7 +22,8 @@ Some types of resources in {es} are owned by a single user, such as
<<async-search,async search contexts>>, <<security-api-create-api-key,API keys>>,
and <<user-profile,user profiles>>. When a user creates a resource, {es}
captures the user's username and realm information as part of the resource's
metadata.
metadata. Likewise, if a user updates a resource, such as an API key,
Copy link
Contributor Author

@n1v0lg n1v0lg Jul 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not strictly necessary but feels like a worthwhile callout. It makes the transition to the next paragraph slightly more clunky so I can drop the proposed change/push it somewhere else.

@n1v0lg n1v0lg requested a review from ywangd July 21, 2022 12:57
@n1v0lg n1v0lg marked this pull request as ready for review July 22, 2022 12:29
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Security Meta label for security team labels Jul 22, 2022
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@n1v0lg n1v0lg requested a review from lockewritesdocs July 22, 2022 12:32
@n1v0lg
Copy link
Contributor Author

n1v0lg commented Jul 22, 2022

@lockewritesdocs being mindful of on-week next week, I've requested your review now although there is still the possibility that the current content is not what we want. For your review, lets assume that it is. If @ywangd agrees with the current form on Monday, we will be able to merge before feature freeze. Otherwise, we will defer until after feature freeze. This should be fine, since it's a small doc change as opposed to feature work. Cheers!

@elasticsearchmachine elasticsearchmachine changed the base branch from master to main July 22, 2022 23:04
Copy link
Member

@ywangd ywangd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Content is accurate and follows the current way of explaining things. We agreed that ownership can and should be explained better in a separate PR.

@mark-vieira mark-vieira added v8.5.0 and removed v8.4.0 labels Jul 27, 2022
Copy link
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit -- LGTM otherwise 🧇

@n1v0lg n1v0lg added v8.4.0 auto-backport Automatically create backport pull requests when merged labels Jul 28, 2022
@n1v0lg n1v0lg merged commit 9bc2549 into elastic:main Jul 28, 2022
@n1v0lg n1v0lg deleted the update-api-keys-domain-splitting branch July 28, 2022 09:44
n1v0lg added a commit to n1v0lg/elasticsearch that referenced this pull request Jul 28, 2022
This PR documents the impact of domain splitting on API keys. API key
ownership is determined via username and user realm information,
including the user's security domain. API key ownership is shared
across users with the same username that are part of the same security
domain. A user loses ownership over an API key if their realm is
removed from the security domain that previously enabled ownership
through cross-realm resource sharing.
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.4

n1v0lg added a commit that referenced this pull request Jul 28, 2022
This PR documents the impact of domain splitting on API keys. API key
ownership is determined via username and user realm information,
including the user's security domain. API key ownership is shared
across users with the same username that are part of the same security
domain. A user loses ownership over an API key if their realm is
removed from the security domain that previously enabled ownership
through cross-realm resource sharing.
weizijun added a commit to weizijun/elasticsearch that referenced this pull request Jul 29, 2022
* upstream/main:
  Add 8.5 migration docs (elastic#88923)
  Script: Reindex & UpdateByQuery Metadata (elastic#88665)
  Remove unused plugins dir var from server CLI (elastic#88917)
  Use tracing API in TaskManager (elastic#88885)
  Add source fallback for keyword fields using operation (elastic#88735)
  Prune changelogs after 8.3.3 release
  Bump versions after 8.3.3 release
  Add a test for checking for misspelled "dry_run" parameters for Desired Nodes API (elastic#88898)
  Speedup BalanceUnbalancedClusterTests (elastic#88794)
  Preventing exceptions on node shutdown in integration tests (elastic#88827)
  Do not trigger check part3 for test mute and docs PRs (elastic#88895)
  Add troubleshooting docs about data corruption (elastic#88760)
  Mute RollupActionSingleNodeTests#testRollupDatastream (elastic#88891)
  [DOCS] Domain splitting impacts API keys (elastic#88677)
  Fix SqlSearchIT testAllTypesWithRequestToOldNodes (elastic#88866) (elastic#88883)
  Update synthetic-source.asciidoc (elastic#88880)
  Log more details in TaskAssertions (elastic#88864)
  Make Tuple a record (elastic#88280)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes :Security/Authentication Logging in, Usernames/passwords, Realms (Native/LDAP/AD/SAML/PKI/etc) Team:Docs Meta label for docs team Team:Security Meta label for security team v8.4.0 v8.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants