Admin ConsoleReporting

Splunk SIEM

Splunk Enterprise is a security information and event management (SIEM) platform that can be used with Bitwarden organizations. Organizations can monitor event activity with the Bitwarden app on their Splunk Enterprise dashboard.

note

The Bitwarden Splunk integration is currently supported for Splunk Enterprise on-premises.

Setup

Create a Splunk account

Installing the Bitwarden app on Splunk Enterprise requires an account with Splunk Base.

Install Splunk

Once you have a Splunk Base account, the next step is to install Splunk Enterprise. Follow the Splunk documentation to complete an install of the self-hosted Enterprise software. 

note

The Bitwarden app is currently supported on Splunk Enterprise's Linux x64 architecture.

Create an index

Before connecting your Bitwarden organization to Splunk Enterprise, create an index that will maintain Bitwarden data.

1. Open the Settings menu located on the top navigation bar and select Indexes.

2. Once you are on the indexes screen, select New Index.

3. A window will appear for you to create a new index for your Bitwarden app.

Splunk index
Splunk index

4. In the Index Name field, enter bitwarden_events.

note

The only required field for the index creation is Index Name. The remaining fields can be adjusted as needed.

5. When you are finished, select Save.

Install the Splunk Enterprise Bitwarden app

After your Bitwarden index has been created, navigate to the Splunk Enterprise dashboard.

1. Select the cog icon next to Apps.

Splunk apps dashboard
Splunk apps dashboard

2. Select Browse more apps located at the top-right on the screen.

Splunk browse all apps
Splunk browse all apps

3. Search Bitwarden Event Logs in the app catalogue. Select Install for the Bitwarden Event Logs - Linux x64 app.

Bitwarden event logs app
Bitwarden event logs app


3. In order to complete the installation, you will need to enter your Splunk Base account. Your Splunk Base account may not be the same credentials used to log into your self-hosted Splunk Enterprise instance.

Login and install Bitwarden app on Splunk
Login and install Bitwarden app on Splunk

4. After you have entered your information, select Agree and Install.

note

You may need to restart Splunk following the Bitwarden app install.

Connect your Bitwarden organization

Once the Bitwarden Event Logs app has been installed in your Splunk Enterprise instance, you can connect your Bitwarden organization using your Bitwarden API key.

1. Go to the dashboard home and select the Bitwarden Event Logs app.

Bitwarden on Splunk dashboard
Bitwarden on Splunk dashboard

2. Next select Setup from the top navigation menu. This is where you will add your Bitwarden organization's information.

Setup Bitwarden menu
Setup Bitwarden menu

3. Keep this screen open, on another tab, access your Bitwarden web vault. Open your organization and navigate to Settings, Organization info, and View API key. You will be asked to re-enter your master password in order to access your API key information.

Organization api info
Organization api info

2. Copy and paste the client_id and client_secret values into their respective locations on the Splunk setup page.

Complete the additional fields as follows:

Field

Value

Index

Select the index that was created previously in the guide: bitwarden_events.

Server URL

For self-hosted Bitwarden users, input your self-hosted URL. Be sure that the URL does not include any trailing forward slashes at the end of the URL "/".

For cloud-hosted organizations, use the URL https://bitwarden.com.

warning

Your organization API key enables full access to your organization. Keep your API key private. If you believe your API key has been compromised, select Settings > Organization info > Rotate API key button on this screen. Active implementations of your current API key will need to be reconfigured with the new key before use.


3. Select Submit.

4. Once you have completed the setup, restart Splunk Enterprise. To do this, head to Settings Server controls Restart Splunk. 

Start monitoring data with a search macro

To start reviewing data, you can set up a search macro. A Splunk search macro is a reusable search query that can be applied to your dashboard.

1. To add a search macro go to Settings on to top navigation bar. Then, select Advanced Search.

Create Splunk search macro
Create Splunk search macro

2. Next, select + Add new. Once you are on the create macro screen, complete the following fields:

Field

Definition

Destination app

The app that this macro will be applied. The Bitwarden destination app is bitwarden_event_logs.

Name

The name of the macro. The macro you are using takes arguments appended to the name of the macro. The macro name for Bitwarden is bitwarden_event_logs_index.

Definition

This field will contain the string that the search macro expands upon when it is referenced in searches. Included arguments will be enclosed in dollar signs, such as $arg$.

Input index=* for a broad search in the macro. The wildcard * is required in the search. More specific queries can be performed from the Search function following the macro setup.

Arguments

Input arguments in a comma-delimited string of argument names. Argument names may only contain alphanumeric, "_", and "-" characters.

This field is not required for creating the macro.

Validation Expression

Enter an eval or boolean expression that runs over macro arguments.

This field is not required for creating the macro.

Validation Error Message

Enter a message to display when the validation expression returns false.

This field is not required for creating the macro.

3. Once you have input all information into the macro forum, select Save.

Search macro permissions

Next, setup which user roles will have permission to use the macro:

1. View macros by selecting Settings Advanced Search Search macros.

Access Splunk macros
Access Splunk macros

2. Select Permissions on the macro you would like to edit.

Splunk macro permissions
Splunk macro permissions

3. Edit the following permissions:

Field

Description

Object should appear in

In order to use the macro in event searching, select This app only. The macro will not apply if Keep private is selected.

Permissions

Select the desired permissions for user roles with Read and Write access.

4. Once you have edited your desired permissions, select Save.

note

Only one search macro will be functional on the app at a given time.

Understanding the dashboards

The Dashboard will provide several options for monitoring and visualizing Bitwarden organizational data. The three primary categories of data monitoring include:

  • Bitwarden authentication events

  • Bitwarden vault item events

  • Bitwarden organization events

The data displayed on the dashboards will provide information and visualization for a broad variety of searches. More complex queries can be completed by selecting the Search tab at the top of the dashboard.

Timeframe

While searching from the Search page or Dashboards, searches can be designated to a specific timeframe.

Splunk timeframe search
Splunk timeframe search

The following timeframes are supported for Bitwarden event logs searches:

  • Month to date

  • Year to date

  • Previous week

  • Previous business week

  • Previous month

  • Previous year

  • Last 30 days

  • All time

Query parameters

Set up specific searches by including search queries. Spunk utilizes its search processing language (SPL) method for searching. See Splunk's documentation for additional details on searches.

Search structure:

Bash
search | commands1 arguments1 | commands2 arguments2 | ...

An example of a standard search result object:

Splunk search result object
Splunk search result object

The fields shown in the standard search object can be included in any specific search. This includes all of the following values:

Value

Example result

actingUserEmail

The email of the user performing the action.

actingUserId

Unique id of user performing action.

actingUserName

Name of the user performing an action.

date

Date of event displayed in YYYY-MM-DD TT:TT:TT format.

device

Numerical number to identify the device that the action was performed on.

hash

Splunk computed data hash. Learn more about Splunk's data integrity here.

ipAddress

The ip address that performed the event.

memberEmail

Email of the organization member that the action was directed towards.

memberId

Unique id of the organization member that the action was directed towards.

memberName

Name of organization member that action was directed towards.

type

The event type code that represents the organization event that occurred. See a complete list of event codes with descriptions here.

Search all:

Bash
sourcetype="bitwarden:events" type=*

Filter results by a specific field

In the following example, the search is looking for actingUserName with a * wildcard which will display all results with actingUserName.

Bash
sourcetype="bitwarden:events" actingUserName=*

The AND operator is implied in Splunk searches. The following query will search for results containing a specific type AND actingUserName.

Bash
sourcetype="bitwarden:events" type=1000 actingUserName="John Doe"

Include multiple commands by separating with |. The following will show results with the top value being ipAddress.

Bash
sourcetype="bitwarden:events" type=1115 actingUserName="John Doe" | top ipAddress

Additional resources

Set user roles

Manage users roles to allow individuals to perform specific tasks. To edit user roles:

1. Open the Settings menu on the top navigation bar.

2. Select Users from the bottom right corner of the menu.

3. From the users screen, locate the user that you wish to edit permissions for and select Edit.

Splunk edit user permissions
Splunk edit user permissions

From this screen, details for the user can be filled out. Permission such as admin, power, and can_delete can be individually assigned here as well.

Delete data

Delete Bitwarden search data by clearing the index with SSH access. Data may need to be cleared in instances such as changing the organization being monitored.

1. Access the Splunk directory and stop Splunk processes.

2. Clear the bitwarden_events index with -index flag.

3. Restart Splunk processes.

Make a suggestion to this page

Contact Our Support Team

For technical, billing, and product questions.

Name*
Bitwarden account email*
Verify account email*
Product*
Are you self-hosting?*
Subject*
Message...*

Cloud Status

Check status

© 2024 Bitwarden, Inc.TermsPrivacySitemap
This site is available in English.
Go to EnglishStay Here