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

[Filebeat][Gsuite] Make GSuite docs more clear #19981

Merged
merged 3 commits into from
Jul 20, 2020
Merged

[Filebeat][Gsuite] Make GSuite docs more clear #19981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a690862
Make GSuite docs more clear
marc-gr Jul 16, 2020
960d36d
Add links to help and summary
marc-gr Jul 16, 2020
cc1d5d0
Convert filesets info to a table
marc-gr Jul 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 46 additions & 23 deletions filebeat/docs/modules/gsuite.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,25 @@ include::../include/gs-link.asciidoc[]

It is compatible with a subset of applications under the https://developers.google.com/admin-sdk/reports/v1/get-start/getting-started[Google Reports API v1]. As of today it supports:

- https://developers.google.com/admin-sdk/reports/v1/appendix/activity/saml[SAML Audit Activity Events]
- https://developers.google.com/admin-sdk/reports/v1/appendix/activity/user-accounts[User Accounts Activity Events]
- https://developers.google.com/admin-sdk/reports/v1/appendix/activity/login[Login Audit Activity Events]
- https://developers.google.com/admin-sdk/reports/v1/appendix/activity/admin-application-settings[Admin Audit Activity Events]
- https://developers.google.com/admin-sdk/reports/v1/appendix/activity/drive[Drive Activity Events]
- https://developers.google.com/admin-sdk/reports/v1/appendix/activity/groups[Groups Audit Activity Events]
[options="header"]
|===========================================================================================================================================================================================================================
| GSuite Service | Description |
| SAML https://developers.google.com/admin-sdk/reports/v1/appendix/activity/saml[api docs] https://support.google.com/a/answer/7007375?hl=en&ref_topic=9027054[help] | View users’ successful and failed sign-ins to SAML applications. |
| User Accounts https://developers.google.com/admin-sdk/reports/v1/appendix/activity/user-accounts[api docs] https://support.google.com/a/answer/9022875?hl=en&ref_topic=9027054[help] | Audit actions carried out by users on their own accounts including password changes, account recovery details and 2-Step Verification enrollment. |
| Login https://developers.google.com/admin-sdk/reports/v1/appendix/activity/login[api docs] https://support.google.com/a/answer/4580120?hl=en&ref_topic=9027054[help] | Track user sign-in activity to your domain. |
| Admin https://developers.google.com/admin-sdk/reports/v1/appendix/activity/admin-application-settings[api docs] https://support.google.com/a/answer/4579579?hl=en&ref_topic=9027054[help] | View administrator activity performed within the Google Admin console. |
| Drive https://developers.google.com/admin-sdk/reports/v1/appendix/activity/drive[api docs] https://support.google.com/a/answer/4579696?hl=en&ref_topic=9027054[help] | Record user activity within Google Drive including content creation in such as Google Docs, as well as content created elsewhere that your users upload to Drive such as PDFs and Microsoft Word files. |
| Groups https://developers.google.com/admin-sdk/reports/v1/appendix/activity/groups[api docs] https://support.google.com/a/answer/6270454?hl=en&ref_topic=9027054[help] | Track changes to groups, group memberships and group messages. |
|===========================================================================================================================================================================================================================

=== Configure the module

In order for filebeat to ingest data from the Google Reports API you must set up a `ServiceAccount` that has access to the `Admin SDK API`. Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly.
In order for filebeat to ingest data from the Google Reports API you must https://support.google.com/gsuitemigrate/answer/9222993?hl=en[set up a ServiceAccount] that https://support.google.com/gsuitemigrate/answer/9222865?hl=en[has access to the Admin SDK API].


This module will make use of the following `oauth2 scope`:
Additionally https://developers.google.com/admin-sdk/reports/v1/guides/delegation[Domain-Wide Delegation] is required for your application to work properly.

This module will make use of the following *oauth2 scope*:

- `https://www.googleapis.com/auth/admin.reports.audit.readonly`

Expand All @@ -57,6 +64,18 @@ you can set up your module:
enabled: true
var.jwt_file: "./credentials_file.json"
var.delegated_account: "[email protected]"
admin:
enabled: true
var.jwt_file: "./credentials_file.json"
var.delegated_account: "[email protected]"
drive:
enabled: true
var.jwt_file: "./credentials_file.json"
var.delegated_account: "[email protected]"
groups:
enabled: true
var.jwt_file: "./credentials_file.json"
var.delegated_account: "[email protected]"
----

Every fileset has the following configuration options:
Expand All @@ -76,35 +95,39 @@ Duration of the time limit on HTTP requests made by the module. Defaults to

*`var.interval`*::

Duration between requests to the API. Defaults to `60s`.
Duration between requests to the API. Defaults to `2h`.

NOTE: GSuite defaults to a 2 hour polling interval because Google reports can go from
some minutes up to 3 days of delay. For more details on this, you can read more https://support.google.com/a/answer/7061566[here].

*`var.user_key`*::

Specifies the user key to fetch reports from. Defaults to `all`.

*`var.initial_interval`*::

It will poll events up to this time period when the module starts. This is to prevent polling too many or repeated events on module restarts. Defaults to `24h`.

[float]
==== GSuite Reports ECS fields

This is a list of GSuite Reports fields that are mapped to ECS.

[options="header"]
|=======================================================================================
| GSuite Reports | ECS Fields |
| items[].id.time | @timestamp |
| items[].id.uniqueQualifier | event.id |
| items[].id.applicationName | event.provider |
| items[].events[].name | event.action |
| items[].customerId | organization.id |
| items[].ipAddress | source.ip, related.ip, source.as.*, source.geo.* |
| items[].actor.email | source.user.email, source.user.name, source.user.domain |
| items[].actor.profileId | source.user.id |
|=======================================================================================
|===============================================================================================
| GSuite Reports | ECS Fields |
| `items[].id.time` | `@timestamp` |
| `items[].id.uniqueQualifier` | `event.id` |
| `items[].id.applicationName` | `event.provider` |
| `items[].events[].name` | `event.action` |
| `items[].customerId` | `organization.id` |
| `items[].ipAddress` | `source.ip`, related.ip`, `source.as.*`, `source.geo.*` |
| `items[].actor.email` | `source.user.email`, `source.user.name`, `source.user.domain` |
| `items[].actor.profileId` | `source.user.id` |
|===============================================================================================

These are the common ones to all filesets.

Note: GSuite defaults to a 2 hours polling interval because Google admin lag times can go from
some minutes up to 3 days. For more details on this, please read more https://support.google.com/a/answer/7061566[here].

:has-dashboards!:

:modulename!:
Expand Down
12 changes: 6 additions & 6 deletions x-pack/filebeat/filebeat.reference.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,47 +718,47 @@ filebeat.modules:
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
user_accounts:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
login:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
admin:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
drive:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
groups:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h

#------------------------------- HAProxy Module -------------------------------
- module: haproxy
Expand Down
12 changes: 6 additions & 6 deletions x-pack/filebeat/module/gsuite/_meta/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,44 @@
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
user_accounts:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
login:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
admin:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
drive:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
groups:
enabled: true
# var.jwt_file: credentials.json
# var.delegated_account: [email protected]
# var.initial_interval: 24h
# var.http_client_timeout: 60s
# var.user_key: all
# var.interval: 5s
# var.interval: 2h
Loading