Skip to content

Commit 6cbb544

Browse files
author
Mathieu Martin
authored
[RFC] Multiple users in an event, stage 3 PR (#1017)
1 parent fad7fa8 commit 6cbb544

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

rfcs/text/0007-multiple-users.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 0007: Multiple users in an event
22
<!-- Leave this ID at 0000. The ECS team will assign a unique, contiguous RFC number upon merging the initial stage of this RFC. -->
33

4-
- Stage: **2 (proposal)** <!-- Update to reflect target stage. See https://elastic.github.io/ecs/stages.html -->
5-
- Date: **2020-10-02** <!-- The ECS team sets this date at merge time. This is the date of the latest stage advancement. -->
4+
- Stage: **3 (candidate)** <!-- Update to reflect target stage. See https://elastic.github.io/ecs/stages.html -->
5+
- Date: **2020-11-11** <!-- The ECS team sets this date at merge time. This is the date of the latest stage advancement. -->
66

77
Many log events refer to more than one user at the same time.
88
Examples of this are remote logons as someone else, user management and privilege escalation.
@@ -67,7 +67,7 @@ This can be seen in more detail on PR [ecs#869](https://github.com/elastic/ecs/p
6767

6868
The examples below will only populate `user.name` and sometimes `user.id` inside
6969
the various `user` nestings, for readability.
70-
However in implementations, otherwise noted all `user` fields that can reasonably
70+
However in implementations, unless otherwise noted, all `user` fields that can reasonably
7171
be populated in each location should be populated.
7272

7373
### User fields at the Root of an Event
@@ -636,14 +636,6 @@ and the assumed role in the `userIdentity`. This makes it easy to keep track of
636636
the real user at `user.*` and the escalated privileges at `user.effective.*` in
637637
all subsequent activity after privilege escalation.
638638

639-
<!--
640-
Stage 2: Included a real world example source document. Ideally this example comes from the source(s) identified in stage 1. If not, it should replace them. The goal here is to validate the utility of these field changes in the context of a real world example. Format with the source name as a ### header and the example document in a GitHub code block with json formatting.
641-
-->
642-
643-
<!--
644-
Stage 3: Add more real world example source documents so we have at least 2 total, but ideally 3. Format as described in stage 2.
645-
-->
646-
647639
## Scope of impact
648640

649641
### New fields for IAM
@@ -671,12 +663,12 @@ These came up while working on this RFC; this is not guidance that was given
671663
in the past. Data sources that populate these fields will need to be revisited
672664
and adjusted accordingly.
673665

674-
<!-- TODO
666+
### host.user fields are deprecated for removal
675667

676-
Depending on the outcome of the discussion on `host.user.*`, mention it here.
677-
It's currently listed in the concerns below.
668+
Seeing no use in the wild, it was decided to remove the reuse of the user fields at `host.user.*`.
669+
We will start by deprecating them in ECS 1.8, and will remove them at the next major version.
678670

679-
-->
671+
Please let us know before the next major ECS release if you disagree with this, and share how you're using them.
680672

681673
## Concerns
682674

@@ -686,11 +678,11 @@ In past discussions and recent research, we have not identified a clear purpose
686678
for the user fields nested at `host.user.*`.
687679

688680
We are considering deprecating these fields with the intent to remove them completely.
689-
Please let us know if you disagree with this, and share how you're using them.
690681

691682
#### Resolution
692683

693-
No resolution yet.
684+
They will be marked as deprecated starting with ECS 1.8, and will be removed in
685+
the next ECS major release.
694686

695687
### Documenting the purpose of each usage of the user fields
696688

@@ -727,7 +719,7 @@ Stage 4: Identify at least one real-world, production-ready implementation that
727719
The following are the people that consulted on the contents of this RFC.
728720

729721
* @webmat | author
730-
* TBD | sponsor
722+
* @jonathan-buttner | sponsor
731723
* @leehinman | subject matter expert
732724
* @janniten | subject matter expert
733725
* @willemdh | subject matter expert
@@ -765,6 +757,7 @@ e.g.:
765757

766758
* Stage 2: https://github.com/elastic/ecs/pull/914
767759
* Stage 2 correction: https://github.com/elastic/ecs/pull/996
760+
* Stage 3: https://github.com/elastic/ecs/pull/1017
768761

769762
Note: This RFC was initially proposed via a PR that targeted stage 2,
770763
given the amount of discussion that has already has happened on this subject.

0 commit comments

Comments
 (0)