Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
Mimecast is a cloud-based, anti-spam, and archive filtering service for securing email accounts and communications for businesses.
Mimecast protects an enterprise’s email infrastructure from viruses, malware, phishing, and the rise of deep-fake attacks. It does this by deploying a layered cyber resilience solution that prevents email-borne infections and reduces data loss by archiving emails. This cloud-based cybersecurity solution also makes it possible to automate the recovery of archived and affected emails for continuous use.
The Mimecast approach to protecting email structures means it can predict or anticipate attacks in order to handle real-time threats. It also deals with data loss from ransomware attacks using data archiving, which eliminates the need to meet ransom demands, as well as struggle with downtime. Mimecast can also be deployed to tackle those annoyingly ‘spammy’ messages that keep cluttering inboxes.
For those who already use any of the popular email management brands such as Microsoft Office 365, Outlook, or Google’s Gsuite, Mimecast’s cloud-based nature makes it compatible with them. It can be deployed to tackle spam, ransomware, or other cybersecurity challenges.
The Devo Mimecast Collector uses the Mimecast API to extract all the relevant information an send it as events to Devo.
Data sources
Data source | Description | API endpoint | Devo table |
---|---|---|---|
Attachments |
|
| |
Audit |
|
| |
Dashboard |
|
| |
Impersonation |
|
| |
Messageholdlist |
|
| |
Messageholdsummary |
|
| |
Search |
|
| |
Siem |
|
| |
Siem (API v2) |
|
| |
Threatfeed |
|
| |
Url |
|
| |
View |
|
|
For more information on how the events are parsed, visit our page.
Vendor setup
Expand | ||
---|---|---|
| ||
OverviewMimecast API 2.0 uses OAuth 2.0 to authenticate with the new Mimecast API Gateway using a dedicated Application (created and configured by the customer). To register and configure an Application:
AuthenticationAfter this process, the two keys that the Mimecast Collector API 2.0 needs are created, the keys are:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||
OverviewFollowing steps are necessary for setup at the Mimecast side. Log in from https://www.mimecast.com/tech-connect/documentation/api-overview/api-concepts/ Accessing your API applications:
With your API applications displayed you can:
Further information may be found here: https://community.mimecast.com/s/article/Managing-API-Applications-505230018 Creating user API keys: Scroll to middle of: https://www.mimecast.com/tech-connect/documentation/api-overview/api-concepts/ for detailed instructions. AuthenticationThe Mimecast Collector needs four keys that the API uses, the four keys are:
Credentials
More details https://community.mimecast.com/s/article/Managing-API-Applications-505230018#Creating-an-API-user-Authentication-Profile .
More details https://community.mimecast.com/s/article/Managing-API-Applications-505230018#Creating-an-API-user-Authentication-Profile . |
Permissions (both API 1 and 2)
Each API call has a prerequisite section that tells you what permissions are needed for the call. Usually, a Basic Administrator role will suffice, which should allow you to use the same API keys generated for multiple API calls under the application.
Service | Permissions |
---|---|
SIEM Audit | Gateway | Tracking | Read |
Audit | Account | Logs | Read |
TTP attachment | Monitoring | Attachment Protection | Read |
TTP impersonation | Monitoring | Impersonation Protection | Read |
TTP URL | Monitoring | URL Protection | Read |
Archive search | Archive | Search Logs | Read |
Archive view | Archive | View Logs | Read |
TTP Thread intel | Services | Gateway | Tracking | Read |
Message Hold List | Account | Dashboard | Read |
Message Hold Summary | Account | Monitoring | Held Summary | Read |
Dashboard | Account | Dashboard | Read |
If you want to create a custom administrative role for this API service account user:
Navigate to Administration | Account | Roles.
Click New Role.
Enter a Role Name and Description.
In the Application Permissions section, select the boxes for each required role to be used by the service user account.
Click Save and Exit.
Locate the newly created role and click on the role name.
Click Add User to Role.
Click on the email address of the API service user account.
If you want to add the service account user to an existing role:
Navigate to Administration | Account | Roles.
Click on the administrator role the user will be added to.
Click Add User to Role.
Click on the email address of the API service user account.
More details https://community.mimecast.com/s/article/Managing-API-Applications-505230018#Creating-an-API-user-Authentication-Profile .
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Rw ui tabs macro | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
We use a piece of software called Collector Server to host and manage all our available collectors. To enable the collector for a customer:
Editing the JSON configuration
Please replace the placeholders with real world values following the description table below:
We recommend to leave parameters not in the list with their default values. Keep in mind that the Mimecast collector has two different inputs:
The collector can use both inputs or just one. Each input uses different endpoints and feeds different tables in Devo. Make sure to check the credentials given to determine the inputs and endpoints to use.
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running. StructureThe following directory structure should be created for being used when running the collector:
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in
Editing the config.yaml file
Replace the placeholders with your required values following the description table below:
Download the Docker imageThe collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
Use the following command to add the Docker image to the system:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace The Docker image can be deployed on the following services: DockerExecute the following command on the root directory
Docker ComposeThe following Docker Compose file can be used to execute the Docker container. It must be created in the
To run the container using docker-compose, execute the following command from the
|
API limits and duplicates
The Mimecast API has some call rate limits. When a limit is reached, the collector shows a 429 error. More details about MImecast limits can be found here and here
The Mimecast API sometimes sends duplicate events (it is not common). The collector tries to filter out the duplicates, but it is not possible to guarantee that all duplicates are deleted.
Change log
Release | Released on | Release type | Recommendations | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
| ||||||||||||
| |||||||||||||||
|
|
| |||||||||||||
| |||||||||||||||
|
|
| |||||||||||||
| |||||||||||||||
|
|
|
| ||||||||||||
|