Mimecast

Get Threat Intel Feed

Description

This feed can be used to return identified malware threats at a customer or regional grid level.

Note: This is tied to the Threat Intel feature in the Administration Console, which is currenlty available as an opt-in early release. Contact your Customer Success Manager or regional Customer Success Desk to have this feature enabled for an account prior to expecting returned data.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Services | Tracking | Read permission.

URI

To use this endpont you send a POST request to:

  • /api/ttp/threat-intel/get-feed

Request Headers

The following request headers must be included in your request:

Field Description
Authorization Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id

A randomly generated GUID, for example,

8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id The Application ID provided with your Registered API Application.
x-mc-date

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

{
     "data": [
      {
       "end": "Date String", 
       "fileType": "String", 
       "compress": "Boolean", 
       "start": "Date String", 
       "token": "String", 
       "feedType": "String"
      }
     ]
    }
data
Field Type Required Description
start Date String Optional Start Date in the ISO 8601 date time format (e.g. 2011-12-03T10:15:30). Default is 7 days before current date.
end Date String Optional End Date in the ISO 8601 date time format (e.g. 2011-12-03T10:15:30). Default is current date.
compress Boolean Optional Compress multiple feed files. Default is false.
fileType String Optional File type of respective feed - csv or stix. Default is csv.
feedType String Optional The scope of data to return, either for the account, or for the regions grid. Can be one of "malware_customer" or "malware_grid"
token String Optional Secure ID of the threat feed file that was previously downloaded. The Secure ID is included in every response.

Response

The response will be a data stream, and the format will vary depending on the feedType and fileType provided in the request.

For Customer CSV, the output will be:

key|FileMimeType|FileName|FileSize|MD5|Observations|RecipientAddress|Route|SHA1|SHA256|SenderAddress|SenderDomain|SendingIP|Timestamp
0|text/plain|fileName.ext|68|44d88612fea8a8f36de82e1278abb02f|1|recipient@domain1.tld|In|3395856ce81f2b7382dee72602f798b642f14140|275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f|sender@domain2.tld|domain2.tld|1.2.3.4|2015-02-04T17:20:35.485

For Grid CSV, the output will be:

key|FileMimeType|FileName|FileSize|MD5|Observations|Route|SHA1|SHA256|SendingIP|Timestamp
0|text/plain|fileName.ext|68|44d88612fea8a8f36de82e1278abb02f|1|In|3395856ce81f2b7382dee72602f798b642f14140|275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f|1.2.3.4|2015-02-04T17:20:35.485

For Customer and Grid STIX, the output will be:

{
    "type": "bundle",
    "id": "bundle--bf8be578-3953-4b80-ae84-312d149b91e8",
    "spec_version": "2.0",
    "objects": [
        {
            "type": "malware",
            "id": "malware--94b21aa9-a512-4a09-ae8a-83a24f77567f",
            "created": "2015-07-02T09:14:59.163Z",
            "modified": "2015-07-02T09:14:59.163Z",
            "name": "fileName.ext",
            "labels": [
                "virus"
            ]
        },
        {
            "type": "indicator",
            "id": "indicator--69f4511a-75c8-440f-890d-ff91ba5f300a",
            "created": "2015-07-02T09:14:59.163Z",
            "modified": "2015-07-02T09:14:59.163Z",
            "labels": [
                "malicious-activity"
            ],
            "pattern": "[file:hashes.'SHA-256' = '275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f']",
            "valid_from": "2015-07-02T09:14:59.163Z"
        },
        {
            "type": "relationship",
            "id": "relationship--4bca1b52-de50-4d91-982b-50c7256c2680",
            "created": "2015-07-02T09:14:59.163Z",
            "modified": "2015-07-02T09:14:59.163Z",
            "relationship_type": "indicates",
            "source_ref": "indicator--69f4511a-75c8-440f-890d-ff91ba5f300a",
            "target_ref": "malware--94b21aa9-a512-4a09-ae8a-83a24f77567f"
        },
    ]
}

Sample Code

Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the Global Base URL's page to find the correct base URL to use for your account.

POST {base_url}/api/ttp/threat-intel/get-feed
    Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
    x-mc-date: {dateTime}
    x-mc-req-id: {unique id}
    x-mc-app-id: {applicationId}
    Content-Type: application/json
    Accept: application/json
    
    
    {
      "data":[
        {s
            "start": "Date String",
            "end": "Date String",
            "compress": "Boolean",
            "fileType": "String",
            "feedType": "String",
            "token": "String"
        }
      ]
    }
    
import base64
    import hashlib
    import hmac
    import uuid
    import datetime
    import requests
    
    # Setup required variables
    base_url = "https://xx-api.mimecast.com"
    uri = "/api/ttp/threat-intel/get-feed"
    url = base_url + uri
    access_key = "YOUR ACCESS KEY"
    secret_key = "YOUR SECRET KEY"
    app_id = "YOUR APPLICATION ID"
    app_key = "YOUR APPLICATION KEY"
    
    # Generate request header values
    request_id = str(uuid.uuid4())
    hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"
    
    # Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
    hmac_sha1 = hmac.new(secret_key.decode("base64"), ':'.join([hdr_date, request_id, uri, app_key]),
                      digestmod=hashlib.sha1).digest()
    
    # Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
    sig = base64.encodestring(hmac_sha1).rstrip()
    
    # Create request headers
    headers = {
        'Authorization': 'MC ' + access_key + ':' + sig,
        'x-mc-app-id': app_id,
        'x-mc-date': hdr_date,
        'x-mc-req-id': request_id,
        'Content-Type': 'application/json'
    }
    
    payload = {
            'data': [
                {
                    "start": "Date String",
                    "end": "Date String",
                    "compress": "Boolean",
                    "fileType": "String",
                    "feedType": "String",
                    "token": "String"
                }
            ]
        }
    
    r = requests.post(url=url, headers=headers, data=str(payload))
    
    print r.text
static void Main(string[] args)
            {
                //Setup required variables
                string baseUrl = "https://xx-api.mimecast.com";
                string uri = "/api/ttp/threat-intel/get-feed";
                string accessKey = "YOUR ACCESS KEY";
                string secretKey = "YOUR SECRET KEY";
                string appId = "YOUR APPLICATION ID";
                string appKey = "YOUR APPLICATION KEY";
    
                //Generate request header values
                string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
                string requestId = System.Guid.NewGuid().ToString();
    
                //Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
                System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));
    
                //Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
                byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));
    
                //Build the signature to be included in the Authorization header in your request
                string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);
    
                //Build Request
                System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
                request.Method = "POST";
                request.ContentType = "application/json";
    
                //Add Headers
                request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
                request.Headers.Add("x-mc-date", hdrDate);
                request.Headers.Add("x-mc-req-id", requestId);
                request.Headers.Add("x-mc-app-id", appId);
    
                //Add request body
                //Create and write data to stream
                string postData = @"{
                        ""data"": [
                            {
                                ""start"": ""Date String"",
                                ""end"": ""Date String"",
                                ""compress"": ""Boolean"",
                                ""fileType"": ""String"",
                                ""feedType"": ""String"",
                                ""token"": ""String""
                            }
                        ]
                    }";
    
                byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);
    
                System.IO.Stream stream = request.GetRequestStream();
                stream.Write(payload, 0, payload.Length);
                stream.Close();
    
                //Send Request
                System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();
    
                //Output response to console
                System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
                string responseBody = "";
                string temp = null;
                while ((temp = reader.ReadLine()) != null)
                {
                    responseBody += temp;
                };
                System.Console.WriteLine(responseBody);
                System.Console.ReadLine();
            }
#Setup required variables
    $baseUrl = "https://xx-api.mimecast.com"
    $uri = "/api/ttp/threat-intel/get-feed"
    $url = $baseUrl + $uri
    $accessKey = "YOUR ACCESS KEY"
    $secretKey = "YOUR SECRET KEY"
    $appId = "YOUR APPLICATION ID"
    $appKey = "YOUR APPLICATION KEY"
    
    #Generate request header values
    $hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
    $requestId = [guid]::NewGuid().guid
    
    #Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
    $sha = New-Object System.Security.Cryptography.HMACSHA1
    $sha.key = [Convert]::FromBase64String($secretKey)
    $sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
    $sig = [Convert]::ToBase64String($sig)
    
    #Create Headers
    $headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
                    "x-mc-date" = $hdrDate;
                    "x-mc-app-id" = $appId;
                    "x-mc-req-id" = $requestId;
                    "Content-Type" = "application/json"}
    
    #Create post body
    $postBody = "{
                        ""data"": [
                            {
                                ""start"": ""Date String"",
                                ""end"": ""Date String"",
                                ""compress"": ""Boolean"",
                                ""fileType"": ""String"",
                                ""feedType"": ""String"",
                                ""token"": ""String""
                            }
                        ]
                    }"
    
    #Send Request
    $response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url
    
    #Print the response
    $response
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {
    
            //set up variables for request
            String baseUrl = "https://xx-api.mimecast.com";
            String uri = "/api/ttp/threat-intel/get-feed";
            String url = "https://" + baseUrl + uri;
            String accessKey = "YOUR ACCESS KEY";
            String secretKey = "YOUR SECRET KEY";
            String appId = "YOUR APPLICATION ID";
            String appKey = "YOUR APPLICATION KEY";
    
            //create URL object
            java.net.URL obj = new java.net.URL(url);
    
            // set guid for x-mc-req-id header
            String guid = java.util.UUID.randomUUID().toString();
    
            // set date for x-mc-date header
            java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
            sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
            String date = sdf.format(new java.util.Date());
    
            //create signature for the Authorization header
            String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
            String hmacSHA1 = "HmacSHA1";
            javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
            javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
            mac.init(signingKey);
            String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));
    
            // create request object
            javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();
    
            //set request type to POST
            con.setRequestMethod("POST");
            con.setDoOutput(true);
    
            //add reuqest headers
            con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
            con.setRequestProperty("x-mc-req-id", guid);
            con.setRequestProperty("x-mc-app-id", appId);
            con.setRequestProperty("x-mc-date", date);
            con.setRequestProperty("Content-Type", "application/json");
            con.setRequestProperty("Accept", "application/json");
    
            //Add post body to the request
            String postBody = "{\n" +
            " \"data\": [\n" +
            "     {\n" +
            "            \"start\": \"Date String\","\n" +
            "            \"end\": \"Date String\","\n" +
            "            \"compress\": \"Boolean\","\n" +
            "            \"fileType\": \"String\","\n" +
            "            \"feedType\": \"String\","\n" +
            "            \"token\": \"String\""\n" +
            "     }\n" +
            " ]\n" +
            "}";
            java.io.OutputStream os = con.getOutputStream();
            os.write(postBody.getBytes("UTF-8"));
            os.close();
    
            //process response
            java.io.BufferedReader in = new java.io.BufferedReader(
                    new java.io.InputStreamReader(con.getInputStream()));
            String inputLine;
            StringBuffer response = new StringBuffer();
    
            while ((inputLine = in.readLine()) != null) {
                response.append(inputLine);
            }
            in.close();
    
            //return result
            java.lang.System.out.println(response.toString());
        }