Microsoft Office 365 Reporting Mail Add-on for Splunk

This add-on collects Message Trace data from Microsoft Office 365 including the following:

• Sender
• Recipient
• Subject
• To IP Address
• From IP Address
• Size
• Date Received

About

• Version: 1.2.4
• Vendor Products: Microsoft Office 365 Reporting Message Trace Report
• Splunk platform versions: 6.5 and later
• Platforms: Platform independent
• Visible: Yes, this add-on contains configuration

Prerequisites

• Office 365 Subscription

Minimum Permissions Needed in Office 365

The Microsoft API used by the add-on only supports Basic Authentication (username and password). Creating a new role for the user account with the following permissions is recommended:

• Message Tracking
• View-Only Audit Logs
• View-Only Configuration
• View-Only Recipients

Installing

Where to install this add-on

Unless otherwise noted, all supported add-ons can be safely installed to all tiers of a distributed Splunk platform deployment. See Where to install Splunk add-ons in Splunk Add-ons for more information.

This table provides a reference for installing this specific add-on to a distributed deployment of Splunk Enterprise.

Configuration

Ensure the prerequisites are met above.

1. Access Splunk Web on the node of your Splunk platform installation that collects data for this add-on.
2. Launch the add-on, then click the Configuration menu item > Account > Add
3. Enter the username and password to use for the add-on. Refer to the minimum permissions needed for the account above.
4. Select the Inputs menu item > Create New Input
5. Give the input a name.
6. Enter an interval (how often this input collects data).
7. Select an index.
8. Select an input mode.
   • Continuously Monitor will poll for new data based on the interval
   • Index Once requires a start date and end date and will only index the data in the given date range.
9. Select the account.
10. Specify the Query window size (minutes). When Continuously Monitor is selected, each time this input runs a start date is calculated for the Office 365 API query. The end date for the Office 365 API query will be the calculated start date plus the number of minutes specified by this parameter. For example, if the calculated start date is 2018-01-01T00:00:00 (midnight on January 1, 2018), the end date for the query will be 2018-01-01T00:01:00 (one hour after midnight) if the query window size is 60 minutes.
11. Specify the Delay throttle (minutes). Microsoft may delay trace events up to 24 hours and events are not guaranteed to be sequential during this delay ( reference ). This parameter specifies how close to "now" the end date for a query may be (where "now" is the time that the input runs). Continuing from the example above, if "now" is 2018-01-01T00:02:00 (two minutes after midnight) and the delay throttle is 60 minutes, the input will exit because the end date for the query is only 1 minute away from "now". Each time the input runs, the input will exit and do nothing until the end date is at least 60 minutes away from "now".
12. Select a Start date/time to specify how far back to go when initially collecting data. This parameter is optional when Continuously Monitor is selected, but the parameter is required when Index Once is selected.
13. Specify an End date/time if Index Once is selected.

Query Window Logic Diagram

Enabling Basic Authentication for a Single User in Your Environment

The Microsoft API used by the add-on only supports Basic Authentication (username and password). When an update is released for this API to support modern authentication, this add-on will be updated to use modern authentication.

In the meantime, it is possible to enable basic authentication for a single user in your environment. This can be done through the Azure portal using PowerShell.

Connect to Exchange Online
From the Azure portal, start a cloud shell (PowerShell)

$Credential = Get-Credential
$ExchangeSession = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri "https://outlook.office365.com/powershell-liveid" -Credential $credential -Authentication "Basic" -AllowRedirection
Import-PSSession $ExchangeSession

Create/set the policy

New-AuthenticationPolicy -Name "Allow Basic Auth for Reporting Web Service"
Set-AuthenticationPolicy -Identity "Allow Basic Auth for Reporting Web Service" -AllowBasicAuthReportingWebServices:$true

Check the policy settings

Get-AuthenticationPolicy -Identity "Allow Basic Auth for Reporting Web Service" | fl AllowBasicAuth*

(You should see AllowBasicAuthReportingWebServices : True in the list returned)

Next, grant a specific user the created policy (the username is LegacyUser in this case):

Set-User -Identity LegacyUser -AuthenticationPolicy "Allow Basic Auth for Reporting Web Service"

Finally, check if all went well:

Get-User -Identity LegacyUser | fl auth*

You should see something like this:

AuthenticationPolicy : Allow Basic Auth for Reporting Web Service
Name         : LegacyUser

CIM Compliance

Version 4.8.0

• Email model

Release Notes

Version 1.2.0

• Moved the username and password fields to the configuration tab in compliance with Splunk cloud.
• Added support for Splunk 8

Version 1.1.0

• Added controls for query window size and delay throttle
• Added "Index Once" functionality
• Added proxy support
• Moved authentication parameters to the input to support multiple environments
• Changed the default query start date from 7 to 29 days in the past due to O365 API changes
• Bug fix for recursively gathering message traces

Version 1.0.0

• Initial release

Privacy

Use of this add-on is permitted subject to your obligations, including data privacy obligations, under your agreement with Splunk and Splunk's Privacy Policy.

Contributors

• Jason Conger
• Luke Netto
• Adam Balogh
• Tetsuya Uemura
• Lindon Morris

Third-party software attributions

See README.md file in the package.