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.

Sign up for GitHub

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

Jump to bottom

Feature Request: output the client source port to audit devices. #7716

Closed
sischkg opened this issue Oct 23, 2019 · 0 comments · Fixed by #12790
Closed

Feature Request: output the client source port to audit devices. #7716

sischkg opened this issue Oct 23, 2019 · 0 comments · Fixed by #12790
Labels
core/audit enhancement
Milestone
triaged

Comments

@sischkg
Copy link

sischkg commented Oct 23, 2019

Is your feature request related to a problem? Please describe.

Vault outputs the source address of its client as "remote_address" to audit devices.
However, since the source port of the client are not contained in Vault audit logs,
it is difficult to specify the client behind NAT(NAPT) or proxies.

RFC 6302: Logging Recommendations for Internet-Facing Servers

Describe the solution you'd like

Vault outputs the source port of its client as "remote_port".

{
  "time": "2019-10-23T01:47:40.061739097Z",
  "type": "request",
  "auth": {
    "token_type": "default"
  },
  "request": {
    "id": "***********************",
    "operation": "update",
    "namespace": {
      "id": "root"
    },
    "path": "auth/userpass/login/admin-user",
    "data": {
      "password": "hmac-sha256:********************"
    },
    "remote_address": "192.0.2.123",
    "remote_port": 12345
  }
}
@darshanasivakumar darshanasivakumar added this to the not-scheduled milestone Nov 19, 2019
@pbernal pbernal modified the milestones: not-scheduled, triaged May 28, 2020
remilapeyre added a commit to remilapeyre/vault that referenced this issue Oct 10, 2021
@remilapeyre
Add remote_port in the audit logs when it is available
bf7a1a6 
The `request.remote_port` field is now present in the audit log when it
is available:

```
{
  "time": "2021-10-10T13:53:51.760039Z",
  "type": "response",
  "auth": {
    "client_token": "hmac-sha256:1304aab0ac65747684e1b58248cc16715fa8f558f8d27e90fcbcb213220c0edf",
    "accessor": "hmac-sha256:f8cf0601dadd19aac84f205ded44c62898e3746a42108a51105a92ccc39baa43",
    "display_name": "root",
    "policies": [
      "root"
    ],
    "token_policies": [
      "root"
    ],
    "token_type": "service",
    "token_issue_time": "2021-10-10T15:53:44+02:00"
  },
  "request": {
    "id": "829c04a1-0352-2d9d-9bc9-00b928d33df5",
    "operation": "update",
    "mount_type": "system",
    "client_token": "hmac-sha256:1304aab0ac65747684e1b58248cc16715fa8f558f8d27e90fcbcb213220c0edf",
    "client_token_accessor": "hmac-sha256:f8cf0601dadd19aac84f205ded44c62898e3746a42108a51105a92ccc39baa43",
    "namespace": {
      "id": "root"
    },
    "path": "sys/audit/file",
    "data": {
      "description": "hmac-sha256:321a1d105f8c6fd62be4f34c4da4f0e6d1cdee9eb2ff4af0b59e1410950fe86b",
      "local": false,
      "options": {
        "file_path": "hmac-sha256:2421b5bf8dab1f9775b2e6e66e58d7bca99ab729f3f311782fda50717eee55b3"
      },
      "type": "hmac-sha256:30dff9607b4087e3ae6808b4a3aa395b1fc064e467748c55c25ddf0e9b150fcc"
    },
    "remote_address": "127.0.0.1",
    "remote_port": 54798
  },
  "response": {
    "mount_type": "system"
  }
}
```

Closes hashicorp#7716
@remilapeyre remilapeyre mentioned this issue Oct 10, 2021
Merged
HridoyRoy pushed a commit that referenced this issue Jan 26, 2022
@remilapeyre
Add remote_port in the audit logs when it is available (#12790)
385b8e8 
* Add remote_port in the audit logs when it is available

The `request.remote_port` field is now present in the audit log when it
is available:

```
{
  "time": "2021-10-10T13:53:51.760039Z",
  "type": "response",
  "auth": {
    "client_token": "hmac-sha256:1304aab0ac65747684e1b58248cc16715fa8f558f8d27e90fcbcb213220c0edf",
    "accessor": "hmac-sha256:f8cf0601dadd19aac84f205ded44c62898e3746a42108a51105a92ccc39baa43",
    "display_name": "root",
    "policies": [
      "root"
    ],
    "token_policies": [
      "root"
    ],
    "token_type": "service",
    "token_issue_time": "2021-10-10T15:53:44+02:00"
  },
  "request": {
    "id": "829c04a1-0352-2d9d-9bc9-00b928d33df5",
    "operation": "update",
    "mount_type": "system",
    "client_token": "hmac-sha256:1304aab0ac65747684e1b58248cc16715fa8f558f8d27e90fcbcb213220c0edf",
    "client_token_accessor": "hmac-sha256:f8cf0601dadd19aac84f205ded44c62898e3746a42108a51105a92ccc39baa43",
    "namespace": {
      "id": "root"
    },
    "path": "sys/audit/file",
    "data": {
      "description": "hmac-sha256:321a1d105f8c6fd62be4f34c4da4f0e6d1cdee9eb2ff4af0b59e1410950fe86b",
      "local": false,
      "options": {
        "file_path": "hmac-sha256:2421b5bf8dab1f9775b2e6e66e58d7bca99ab729f3f311782fda50717eee55b3"
      },
      "type": "hmac-sha256:30dff9607b4087e3ae6808b4a3aa395b1fc064e467748c55c25ddf0e9b150fcc"
    },
    "remote_address": "127.0.0.1",
    "remote_port": 54798
  },
  "response": {
    "mount_type": "system"
  }
}
```

Closes #7716

* Add changelog entry

* Empty commit to trigger CI

* Add test and explicit error handling

* Change temporary file pattern in test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
core/audit enhancement
Projects
None yet
Milestone
triaged
Development

Successfully merging a pull request may close this issue.

Add remote_port in the audit logs when it is available remilapeyre/vault
4 participants
@pbernal @michelvocks @sischkg @darshanasivakumar