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 Event Logs app on their Splunk dashboard.

Installing the Bitwarden app on Splunk requires a Splunk Enterprise account. Bitwarden event monitoring is available on:

• Splunk Enterprise

For on-premise Splunk users, the next step is to install Splunk Enterprise. Follow the Splunk documentation to complete an install of the Splunk Enterprise software. 

Before connecting your Bitwarden organization to your Splunk Dashboard, 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. A window will appear for you to create a new index for your Bitwarden app.
   

   • Splunk Cloud
   • Splunk Enterprise

   

   

3. 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.

4. When you are finished, select Save.

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

1. Open the Apps drop down menu and select Find More Apps.
   

   

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

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

   

4. In order to complete the installation, you will need to enter your Splunk account. Your Splunk account may not be the same credentials used to access your Splunk portal.
   

   

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

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:

   

2. Next, on the App configuration page, select Continue to app setup page. This is where you will add your Bitwarden organization's information.

   

3. Keep this screen open, on another tab, log in to the Bitwarden web app and open the Admin Console using the product switcher ():

   

4. Navigate to your organization's Settings → Organization info screen and select the View API key button. You will be asked to re-enter your master password in order to access your API key information.

   

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

Complete the following additional fields as well:

Once done, select Submit.

The bitwarden_event_logs_index search macro will be created following the initial Bitwarden Event Logs install. To access the macro and adjust settings:

1. Open the Settings on to top navigation bar. Then, select Advanced Search.

2. Select Search Macros to open the list of search macros.

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

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

2. Select Permissions on bitwarden_events_logs_index. Edit the following permissions and select Save once complete:
   

   • Splunk Cloud
   • Splunk Enterprise

   

   

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.

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

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:

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

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

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.

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. For example:
   

   Bash
   splunk clean eventdata -index bitwaren_events

3. Restart Splunk processes.

• Splunk Enterprise users, the app will log to: /opt/splunk/var/log/splunk/bitwarden_event_logs.log

If you are experiencing any errors, or the Bitwarden app is not functioning correctly, users can check the log file for errors or see Spunk's documentation.