Pub/Sub Source

Onboarding Google Cloud Pub/Sub as a Data Transport log source in the Panther Console

Overview

Panther supports configuring Google Pub/Sub as a Data Transport to pull log data directly from Pub/Sub topics.

Panther can authenticate against your source using Google Cloud Workload Identity Federation or a service account.

How to set up a Cloud Pub/Sub log source in Panther

Step 1: Configure the Pub/Sub source in Panther

In the left-hand navigation bar of your Panther Console, click Configure > Log Sources.
In the upper-right corner, click Create New.
Click the Custom Log Formats tile.
On the Google Cloud Pub/Sub tile, click Start.
On the Basic Info page, fill in the fields:
- Name: Enter a descriptive name for the log source.
- Log Types: Select the log types Panther should use to parse your logs.
Click Setup.
On the Log Format page, select the stream type of the incoming logs:
- Auto
- Lines
- JSON
- JSON Array
Click Continue.
On the Configuration page, follow the steps to create the required infrastructure components.
- The instructions below are based on using a Terraform template. If you do not want to use Terraform, you can follow our alternative documentation to complete the infrastructure components process manually.

Step 2: Create the required infrastructure in your GCP cloud

Before creating GCP infrastructure, you'll need to decide:

The authentication method: You can use Google Cloud Workload Identity Federation with AWS or a service account—see the top-level tabs below.
The creation method: You can use Terraform to create the infrastructure, or create it manually in the GCP console—see the sub-tabs within each top-level tab below.

Workload Identity Federation authentication is in open beta starting with Panther version 1.112, and is available to all customers. Please share any bug reports and feature requests with your Panther support team.

If you'd like Panther to authenticate using a Google Cloud service account, follow the instructions in one of the tabs below.

To create GCP infrastructure using Terraform (authenticating with a service account):

On the Infrastructure & Credentials page, click the Service Account tab.
Click Terraform Template to download the Terraform template.
- You can also find the Terraform template at this GitHub link.
Fill out the fields in the panther.tfvars file with your configuration.
- Set authentication_method to "service_account".
Initialize a working directory containing Terraform configuration files and run terraform init.
Copy the corresponding Terraform Command provided and run it in your CLI.
Generate a JSON key file by copying the gcloud Command provided, replacing the value for your service account email address, and running it in your CLI.
- You can find the service account email in the output of the Terraform Command.

To create the GCP infrastructure components manually (authenticating with a service account):

Create a topic for the data.
- You can create a topic using the gcloud CLI tool with the following command format: gcloud pubsub topics create $TOPIC_ID
Create a subscription to be used with the topic you created.
This subscription should not be used by any other service or source.
- You can create a subscription using the gcloud CLI tool with the following command format: gcloud pubsub subscriptions create $SUBSCRIPTION_ID --topic $TOPIC_ID --topic-project $PROJECT_ID
Enable the IAM API.
Create a new Google Cloud service account. To create the account using the gcloud CLI tool, use the following command format:
```
gcloud iam service-accounts create SA-NAME \
    --description="DESCRIPTION" \
    --display-name="DISPLAY_NAME"
```
- Make sure to take note of the account email address, as Panther will use this to access the infrastructure created for this GCS integration.
Assign the required IAM roles to the account.
- The following permissions are required for the project where the Pub/Sub subscription and topic lives:
  Permissions required
  Role
  Scope
  pubsub.subscriptions.consume
  roles/pubsub.subscriber
  subscription-name
  pubsub.subscriptions.get
  roles/pubsub.viewer
  subscription-name
  monitoring.timeSeries.list
  roles/monitoring.viewer
  project
  - The monitoring.timeSeries.list permission is optional, but is recommended for improved autoscaling.
  - Note: You can set conditions or IAM policies on permissions for specific resources. This can be done either in the IAM page of the service account (as seen in the example screenshot below) or in the specific resource's page.
  - Note: You can create the permissions using the gcloud CLI tool:
    gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_EMAIL" --role="roles/pubsub.subscriber"
    gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_EMAIL" --role="roles/pubsub.viewer"
    gcloud projects add-iam-policy-binding $PROJECT_ID --member="serviceAccount:$SERVICE_ACCOUNT_EMAIL" --role="roles/monitoring.viewer"
Generate a JSON key file for the service account, which will be used in Panther to authenticate to the GCP infrastructure.
- To create a JSON key file using the gcloud CLI tool, run the following command format: gcloud iam service-accounts keys create $KEYFILE_PATH --iam-account=$SERVICE_ACCOUNT_EMAIL
- Alternatively, you can run the above command in GCP's terminal instead of locally.
  1. Click the 3 dots icon menu in the top right, then click Download.
  2. Click the folder icon for Browse.
  3. Navigate to the key file and select it, then click Download.

If you'd like Panther to authenticate using Google Cloud Workload Identity Federation, follow the instructions in one of the tabs below.

To create the GCP infrastructure components using Terraform (authenticating with Workload Identity Federation):

On the Infrastructure & Credentials page, click the Workload Identity Federation tab.
Click Terraform Template to download the Terraform template.
- You can also find the Terraform template at this GitHub link.
Fill out the fields in the panther.tfvars file with your configuration.
- Set authentication_method to "workload_identity_federation".
- Provide values for panther_workload_identity_pool_id, panther_workload_identity_pool_provider_id, and panther_aws_account_id.
Initialize a working directory containing Terraform configuration files and run terraform init.
Copy the corresponding Terraform Command provided and run it in your CLI.
Generate a credential configuration file for the pool by copying the gcloud Command provided, replacing the value for the project number, pool ID, and provider ID, and running it in your CLI.
- You can find the project number, the pool ID and the provider ID in the output of the Terraform Command.

To create the GCP infrastructure components manually (authenticating with Workload Identity Federation):

Create a topic for the data.
- You can create a topic using the gcloud CLI tool with the following command format: gcloud pubsub topics create $TOPIC_ID
Create a subscription to be used with the topic you created.
This subscription should not be used by any other service or source.
- You can create a subscription using the gcloud CLI tool with the following command format: gcloud pubsub subscriptions create $SUBSCRIPTION_ID --topic $TOPIC_ID --topic-project $PROJECT_ID
Enable the IAM API.
Configure Workload Identity Federation with AWS by following the Configure Workload Identity Federation with AWS or Azure documentation.
1. As you are defining an attribute mapping(s) and condition, take note of the following examples:
  - Example attribute mappings:
    Google
    AWS
    google.subject
    assertion.arn.extract('arn:aws:sts::{account_id}:')+":"+assertion.arn.extract('assumed-role/{role_and_session}').extract('/{session}')
    attribute.account
    assertion.account
    The value of the google.subject attribute cannot exceed 127 characters. You may use Common Expression Language (CEL) expressions to transform or combine attributes from the token issued by AWS. The expression suggested in the table above takes this limit into account, and is an attempt at transforming the ARN into a value that uniquely identifies Panther entities. For more information on the AWS attributes, see "Example 2 - Called by user created with AssumeRole" on this AWS documentation page.
  - Example attribute condition: attribute.account=="<PANTHER_AWS_ACCOUNT_ID>"
2. When you are adding a provider to your identity pool, select AWS.
Assign the required IAM roles to the account.
- The following permissions are required for the project where the Pub/Sub subscription and topic lives:
  Permissions required
  Role
  Scope
  pubsub.subscriptions.consume
  roles/pubsub.subscriber
  subscription-name
  pubsub.subscriptions.get
  roles/pubsub.viewer
  subscription-name
  monitoring.timeSeries.list
  roles/monitoring.viewer
  project
  - The monitoring.timeSeries.list permission is optional, but is recommended for improved autoscaling.
  - Note: You can set conditions or IAM policies on permissions for specific resources. This can be done either in the IAM section in GCP (as seen in the example screenshot below) or in the specific resource's page.
  - Note: You can create the permissions using the gcloud CLI tool, where the $PRINCIPAL_ID may be something like: principalSet://iam.googleapis.com/projects/<THE_ACTUAL_GOOGLE_PROJECT_NUMBER>/locations/global/workloadIdentityPools/<THE_ACTUAL_POOL_ID>/attribute.account/<THE_ACTUAL_PANTHER_AWS_ACCOUNT_ID>
    gcloud projects add-iam-policy-binding $PROJECT_ID --member="$PRINCIPAL_ID" --role="roles/pubsub.subscriber"
    gcloud projects add-iam-policy-binding $PROJECT_ID --member="$PRINCIPAL_ID" --role="roles/pubsub.viewer"
    gcloud projects add-iam-policy-binding $PROJECT_ID --member="$PRINCIPAL_ID" --role="roles/monitoring.viewer"
Download the credential configuration file, which will be used in Panther to authenticate to the GCP infrastructure.
- To generate a credential configuration file using the gcloud CLI tool, use the following command format: gcloud iam workload-identity-pools create-cred-config projects/$PROJECT_NUMBER/locations/global/workloadIdentityPools/$POOL_ID/providers/$PROVIDER_ID --aws --output-file=config.json

Step 3: Finish the source setup in Panther

If you are using a Google Cloud service account to authenticate:

Under Provide pulling configuration & JSON Keyfile, upload your JSON key file.
Enter your Pub/Sub Subscription ID, found in the Subscriptions section of your Google Cloud account.
Click Setup. You will be directed to a success screen:
- You can optionally enable one or more Detection Packs.
- If you have not done so already, click Attach or Infer Schemas to attach one or more schemas to the source.
- The Trigger an alert when no events are processed setting defaults to YES. We recommend leaving this enabled, as you will be alerted if data stops flowing from the log source after a certain period of time. The timeframe is configurable, with a default of 24 hours.

Viewing ingested logs

After your log source is configured, you can search ingested data using Search or Data Explorer.

PreviousCloud Storage (GCS) Source NextAzure Sources

Last updated 3 months ago

Was this helpful?