Bitwarden Source

The Bitwarden source collects event logs from their API. Many fields in the event log contain unique IDs, making it difficult to interpret the logs without contextual names. To enhance readability, this integration queries the group, member, and policy API endpoints before each poll cycle, ensuring up-to-date lookup information for event log IDs. The event log is then enriched with additional fields, such as group names, member names, member emails, and policy types.

Data collected

API Endpoint	Data
/public/events	Ingests the events logs into Sumo Logic
/public/groups	Gets the group names so we can include it in the event log data. The integration does not ingest logs directly from this endpoint.
/public/members	Gets the member names and email addresses so we can include it in the event log data. The integration does not ingest logs directly from this endpoint.
/public/policies	Gets the policy type so we can include it in the event log data. The integration does not ingest logs directly from this endpoint.

Setup

Vendor configuration

Prerequisites

To collect event logs from the Bitwarden API, you must have a Bitwarden Enterprise account. The integration uses OAuth 2.0 Client Credentials. Follow the authentication instructions in the authentication section of the public API page.

info

If you are using a Self-Hosted installation, you must also provide your OAuth Token URL. For more details, see Bitwarden's documentation.

Source configuration

When you create a Bitwarden Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure the Bitwarden Source:

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
   New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
2. On the Collectors page, click Add Source next to a Hosted Collector.
3. Search for and select Bitwarden icon.
4. Enter a Name to display for the Source in the Sumo Logic web application. The description is optional.
5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
6. (Optional) Fields. Click the +Add Field link to define the fields you want to associate. Each field needs a name (key) and value.
   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
7. In Bitwarden API Server Base URL, enter the API Base URL for your Bitwarden installation.
8. (Optional) In Self Hosted API Base URL, enter the API Base URL for your Self-Hosted Bitwarden installation. This field is only available if you select Self-Hosted for the server base URL.
9. (Optional) In OAuth 2.0 Token Url, enter the OAuth 2.0 Token URL for your Self-Hosted Bitwarden installation. This field is only available if you select Self-Hosted for the server base URL.
10. In OAuth 2.0 Client ID, enter your Bitwarden OAuth 2.0 Client ID.
11. In OAuth 2.0 Client Secret, enter your Bitwarden OAuth 2.0 Client Secret.
12. (Optional) The Polling Interval is set for 15 minutes default, you can adjust it based on your needs.
13. When you are finished configuring the Source, click Save.

JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See How to Use JSON to Configure Sources for details. 

Parameter	Type	Value	Required	Description
schemaRef	JSON Object	{"type":"Bitwarden"}	Yes	Define the specific schema type.
sourceType	String	"Universal"	Yes	Type of source.
config	JSON Object	Configuration object	Yes	Source type specific values.

Configuration Object

Parameter	Type	Required	Default	Description	Example
name	String	Yes	null	Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source.	"Bitwarden C2C"
description	String	No	null	Type a description of the source.	"My Bitwarden event log collection"
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	"bitwarden/eventlogs"
fields	JSON Object	No	null	JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	{"_siemForward": false, "fieldA": "valueA"}
api_base_url	String	Yes	https://api.bitwarden.com or ``https://api.bitwarden.eu` or self-hosted	The API Base URL for your Bitwarden installation. Use self-hosted here if you have a self-hosted Bitwarden installation.
api_self_base_url	String	Potentially	https://your.domain.com/api	Your self-hosted Bitwarden base URL.
api_self_oauth_token_url	String	Potentially	https://your.domain.com/identity/connect/token	Your self-hosted BitWarden OAuth token URL.
api_client_id	String	Yes	null	The Bitwarden OAuth 2.0 Client ID to use to authenticate requests.
api_client_secret	String	Yes	null	The Bitwarden OAuth 2.0 Client Secret to use to authenticate requests.
polling_interval	String	No	15m	This sets how often the Source checks for data. The polling interval value should be at 5 minutes.

JSON example

{
    "api.version":"v1",
    "source":{
      "config":{
        "name": "Bitwarden Source",
        "base_url": "https://api.bitwarden.com",
        "client_id": "********",
        "client_secret": "********",
        "polling_interval": "15m"
      },
      "schemaRef":{
        "type":"Bitwarden"
      },
      "sourceType":"Universal"
    }
  }

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "bitwarden_source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Bitwarden"
  }
  config = jsonencode({
      "name":"Bitwarden Source",
      "base_url":"https://api.bitwarden.com",
      "client_id":"********",
      "client_secret":"********",        
      "polling_interval":"15m",
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example