audit-log: Only capture API method args when asked #8222
Merged
Conversation
This file contains 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
wallyworld
approved these changes
Dec 14, 2017
apiserver/observer/recorder.go
Outdated
| @@ -16,20 +16,26 @@ import ( | |||
| // recorders that that will update the observer and the auditlog | |||
| // recorder when it records a request or reply. The auditlog recorder | |||
| // can be nil. | |||
| func NewRecorderFactory(observerFactory rpc.ObserverFactory, recorder *auditlog.Recorder) rpc.RecorderFactory { | |||
| func NewRecorderFactory( | |||
| captureArgs bool, | |||
There was a problem hiding this comment.
Personal preference, but this arg IMO should go to the end of the param list.
So (factory, record, capture)
It looks icky to see callers go NewRecorderFactory(true, factory, recorder)
Also, we should define consts for RecordArgs and NoRecordArgs and use those instead of true/false
apiserver/observer/recorder.go
Outdated
| } | ||
| } | ||
| } | ||
|
|
||
| // combinedRecorder wraps an observer (which might be a multiplexer) | ||
| // up with an auditlog recorder into an rpc.Recorder. | ||
| type combinedRecorder struct { | ||
| observer rpc.Observer | ||
| recorder *auditlog.Recorder | ||
| captureArgs bool |
There was a problem hiding this comment.
same as before - make it go to the end
babbageclunk
force-pushed
the
audit-capture-args
branch
from
bca4774
to
823729c
Compare
|
|
|
Status: merge request accepted. Url: http://ci.jujucharms.com/job/github-merge-juju |
|
Looks like AWS killed it? |
|
Build failed: Tests failed |
|
|
|
Status: merge request accepted. Url: http://ci.jujucharms.com/job/github-merge-juju |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of change
In general we don't think it will be necessary to save the API method arguments in the audit log (because people using it will be more interested in the client commands), and there's some risk of there being secrets in the log. If
audit-log-capture-args=trueis specified in the controller config then we still capture them, but by default we don't.QA steps
Bootstrap with
--config="auditing-enabled=true". Therequestmessages in the audit log don't include arguments for the API calls.Bootstrap with
--config="auditing-enabled=true" --config="audit-log-capture-args=true".requestmessages include serialised JSON method parameters.