Skip to main content

FireStore-Guardium Logstash filter plug-in

Meet FireStore​

  • Tested versions: V1
  • Environment: Google Cloud Platform (GCP)
  • Supported inputs: Pub/Sub (pull)
  • Supported Guardium versions:
    • Guardium Data Protection: 11.4 and above

This is a Logstash filter plug-in for the universal connector that is featured in IBM Security Guardium. It parses GCP (Google Cloud Platform) event logs into a Guardium record instance (which is a standard structure made out of several parts). The information is then sent over to Guardium. Guardium records include the accessor (the person who tried to access the data), the session, data, and exceptions. If there are no errors, the data contains details about the query "construct". The construct details the main action (verb) and collections (objects) involved.The Firestore plugin only supports Guardium Data Protection as of now.

The plug-in is free and open-source (Apache 2.0). It can be used as a starting point to develop additional filter plug-ins for the Guardium universal connector.

Note​

This plug-in contains a runtime dependency of Logstash Google PubSub input plug-in (version ~> 1.2.1, i.e. at least 1.2.1).

This version is for GDP v11.4, i.e. a stable version.Please refer to the input plug-in repository for more information.

1. Configuring the FireStore on GCP​

Access Permission for Firestore​

Ensure you have Firebase Admin permissions set up in your profile to access Firestore:

  1. Go to IAM > PRINCIPALS > Firebase Admin
  2. Click on Save.

Configure logging & filter the logs using resources, logs, and severity levels to display​

  1. Select a Google Cloud project.Go to the Google Cloud navigation menu and select Logging > Logs Explorer.
  2. Filter the logs in logs explorer
    • Resources: The resources available in your current project.
    • Logs: The log types available for the current resources in your project.
    • Log severity: The log severity levels.

Permissions and role details​

Grant Permission Required for log view/ download​

User can view and download the generated logs. The following Identity and Access Management roles are required to view and download logs:

  • Logs view: roles/logging.viewer (Logs Viewer) roles/logging.privateLogViewer (Private Logs Viewer)
  • Download logs: Logging Admin (roles/logging.admin) Logs View Accessor (roles/logging.viewAccessor)

Steps to set destination(TOPIC & SUBSCRIPTION) permissions​

To set permissions for log sink to route to its destination, do the following:

  • Copy the sink's writer identity—an email address—from the new sink.
  1. Go to the Log Router page, and select menu > View sink details.
  2. The writer identity appears in the Sink details panel.
  • If the user has owner access to the destination:
    1. add the sink's writer identity to the topic and give it the Pub/Sub Publisher role and subscriber role.
    2. add the sink's writer identity to the subscription and give it the Pub/Sub subscriber role.

2. Configuration on GCP for Input Plugin​

Steps to create Topic in Pub/Sub​

  • Go to the Pub/Sub topics page in the Cloud Console.
  • Click on Create a topic
  • In the Topic ID field, provide a unique topic name. For example, MyTopic.
  • Click on Create Topic.

Steps to create subscription in Pub/Sub​

  • Display the menu for the topic created in the previous step and click New subscription.
  • Type a name for the subscription, such as MySub.
  • Leave the delivery type as Pull.
  • Click Create.

Steps to create log sink in Pub/Sub​

  • In the Cloud Console, go to the Logging > Log Router page.
  • Click on Create sink button.
  • In the Sink details panel, enter the following details:
  • Sink name: Provide an identifier for the sink; note that after you create the sink, you cannot rename it. However, you can delete it and create a new sink.
  • Sink description (optional): Describe the purpose or use case for the sink.
  • In the Sink destination panel, select the Pub/Sub topic as sink service and destination.
  • Choose logs to include in the sink in the Build inclusion filter panel.
  • The user can filter the logs using log name, resource, and severity.
  • In cases of multiple regions, use the same set of configurations for all regions. Use different configuration files for the input plug-in based on the region.

Steps to Create service account credentials​

  • Go to the Service accounts section of IAM & Admin console.
  • Select project and click on Create Service Account.
  • Enter a Service account name, such as firestore-pubsub.
  • Click Create.
  • The service account needs access to a subscription that was created earlier. Use the Select a role drop-down menu to add the Owner role.
  • Click Continue. The user does not need to grant users access to this service account.
  • Click the Create Key. The key is used by the logstash input plug-in configuration file.
  • Select JSON and click Create.
  • Rename the key file to key.json.

Inclusion Filter.​

Edit the Sink via Logs Router > Sink Inclusion Filter:

Description​

The purpose of this inclusion filter is to exclude unnecessary logs and include required logs with resource types datastore_database, audited_resource, datastore_index and service firestore.googleapis.com.

  resource.type=("datastore_database" OR "audited_resource" OR "datastore_index") AND protoPayload.serviceName="firestore.googleapis.com" AND -(protoPayload.methodName=~"Listen" OR protoPayload.methodName=~"ListCollectionIds" OR protoPayload.methodName=~"GetDatabase" OR protoPayload.methodName=~"GetIndex" OR protoPayload.methodName=~"ListFields" OR protoPayload.methodName=~"GetField" OR protoPayload.methodName=~"ListIndexes" OR protoPayload.request.mask.fieldPaths="__name__" OR protoPayload.request.structuredQuery.select.fields.fieldPath="__name__" )

3. Viewing the Audit logs​

The inclusion filter mentioned above will be used to view the Audit logs in the GCP Logs Explorer.

Supported audit logs​

  1. Firestore Audit Logs - ACTIVITY, DATA_ACCESS logs
  2. Firestore other Logs - EMERGENCY, ALERT, CRITICAL, NOTICE, DEBUG, DEFAULT

Supported Data-access/activity events​

  • ListDocumentsRequest
  • GetDocumentRequest
  • StructuredQuery
  • Write
  • Index(Create and Delete)

4. Configuring the Firestore filter in Guardium​

The Guardium universal connector is the Guardium entry point for native audit/data_access logs. The Guardium universal connector identifies and parses the received events, and converts them to a standard Guardium format. The output of the Guardium universal connector is forwarded to the Guardium sniffer on the collector, for policy and auditing enforcements. Configure Guardium to read the native audit/data_access logs by customizing the Firestore template.

Before you begin​

  • Configure the policies you require. See policies for more information.
  • You must have permission for the S-Tap Management role. The admin user includes this role by default.
  • FireStore-Guardium Logstash filter plug-in is automatically available with Guardium Data Protection versions 12.x, 11.4 with appliance bundle 11.0p490 or later or Guardium Data Protection version 11.5 with appliance bundle 11.0p540 or later releases.

Note: For Guardium Data Protection version 11.4 without appliance bundle 11.0p490 or prior or Guardium Data Protection version 11.5 without appliance bundle 11.0p540 or prior, download the Logstash_Offline_package_7.x plug-in. (Do not unzip the offline-package file throughout the procedure).

Procedure​

  1. On the collector, go to Setup > Tools and Views > Configure Universal Connector.
  2. First, enable the Universal Guardium connector if it is disabled.
  3. Click Upload File and select the offline guardium_logstash-offline-plugins-ps-firestore.zip plug-in. After it is uploaded, click OK. This step is not necessary for Guardium Data Protection v11.0p490 or later, v11.0p540 or later, v12.0 or later.
  4. Click the plus icon to open the Connector Configuration dialog box.
  5. Type a name in the Connector name field.
  6. Update the input section to add the details from the firestore_pubsub_run.conf file's input part, omitting the keyword "input{" at the beginning and its corresponding "}" at the end.
  7. Update the filter section to add the details from the firestore_pubsub_run.conf file's filter part, omitting the keyword "filter {" at the beginning and its corresponding "}" at the end.
  8. The "type" fields should match in the input and filter configuration sections. This field should be unique for every individual connector added.
  9. Click Save. Guardium validates the new connector and displays it in the Configure Universal Connector page.
  10. After the offline plug-in is installed and the configuration is uploaded and saved in the Guardium machine, restart the Universal Connector using the Disable/Enable button.

5. Limitations​

  • LOGIN FAILED logs are not generated in GCP for Firestore.
  • The audit/data access log doesn't have a server IP. The default value for server IPs is set as 0.0.0.0.
  • Some fields could not be mapped as no such fields were found in the logs. The following important fields couldn't be mapped-
    • Source program : Not available with logs
    • OS User : Not available with logs
    • Client HostName : Not available with logs
  • Error queries are not supported in GCP for Firestore.