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 Audit security config change #66839

Conversation

albertzaharovits
Copy link
Contributor

@albertzaharovits albertzaharovits commented Dec 28, 2020

Audit log doc changes about:

  • the new security_config_change event type (main scope of this PR)
  • remove mentions of the 6.5 audit format changes (the JSON format)
  • mention the new archiving and rotation by size (in v8 only)
  • mention the request.id event attribute used to correlate audit events
  • mention that audit is only available on certain subscription levels
  • add an exhaustive audit event example list (because schema became too complex to explain in words 😢 given the new security_config_change events)
  • move the ignore policies are explained on a separate page (it was collocated with the logfile output since we had multiple outputs and the policies were specific the the logfile only).

Relates #62916 .
Closes #29912 .

Co-authored-by: Lisa Cawley [email protected]

Preview

@albertzaharovits albertzaharovits added the >docs General docs changes label Dec 28, 2020
@albertzaharovits albertzaharovits self-assigned this Dec 28, 2020
@albertzaharovits albertzaharovits added the :Security/Audit X-Pack Audit logging label Dec 31, 2020
@albertzaharovits
Copy link
Contributor Author

albertzaharovits commented Jan 4, 2021

Thanks for the thorough review Lisa!
This is ready for another round.

@albertzaharovits albertzaharovits requested a review from lcawl January 4, 2021 21:57
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Added a fix for table formatting and two minor suggestions. Otherwise, LGTM!

@albertzaharovits
Copy link
Contributor Author

Added a fix for table formatting

Niice, thank you!

x-pack/docs/en/security/auditing/event-types.asciidoc Outdated Show resolved Hide resolved
x-pack/docs/en/security/auditing/event-types.asciidoc Outdated Show resolved Hide resolved

| `put_user`
| Logged when the <<security-api-put-user,put user API>> is invoked to create or
update a native or built-in user. Note that user updates can also change the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
update a native or built-in user. Note that user updates can also change the
update a native user. Note that user updates can also change the

You cannot call the put user API on a reserved user.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ha! yeah, that's right. I think I remember looking specifically about that, but I must've not looked in the transport action for the validation.
Though, technically, the put_user event will be emitted for reserved users too, because auditing happens before validation.
But I'll go with your suggestion.

x-pack/docs/en/security/auditing/event-types.asciidoc Outdated Show resolved Hide resolved
@albertzaharovits
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/packaging-sample-unix

@albertzaharovits albertzaharovits merged commit e05d83f into elastic:master Jan 16, 2021
@albertzaharovits albertzaharovits deleted the docs_audit_request_body_for_certain_transport_requests branch January 16, 2021 17:09
albertzaharovits added a commit to albertzaharovits/elasticsearch that referenced this pull request Jan 16, 2021
Audit log doc changes about:
* the new security_config_change event type (main scope of this PR)
* remove mentions of the 6.5 audit format changes (the JSON format)
* mention the new archiving and rotation by size (in v8 only)
* mention the request.id event attribute used to correlate audit events
* mention that audit is only available on certain subscription levels
* add an exhaustive audit event example list (because schema became too complex to explain in words 😢 given the new security_config_change events)
* move the ignore policies are explained on a separate page (it was collocated with the logfile output since we had multiple outputs and the policies were specific the the logfile only).

Co-authored-by: Lisa Cawley [email protected]

Relates elastic#62916
Closes elastic#29912
albertzaharovits added a commit that referenced this pull request Jan 16, 2021
Audit log doc changes about:
* the new security_config_change event type (main scope of this PR)
* remove mentions of the 6.5 audit format changes (the JSON format)
* mention the new archiving and rotation by size (in v8 only)
* mention the request.id event attribute used to correlate audit events
* mention that audit is only available on certain subscription levels
* add an exhaustive audit event example list (because schema became too complex to explain in words 😢 given the new security_config_change events)
* move the ignore policies are explained on a separate page (it was collocated with the logfile output since we had multiple outputs and the policies were specific the the logfile only).

Co-authored-by: Lisa Cawley [email protected]

Relates #62916
Closes #29912
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Security/Audit X-Pack Audit logging Team:Docs Meta label for docs team Team:Security Meta label for security team v7.11.0 v7.12.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify emit_request_body description for successfully authenticated requests
5 participants