Collect logs for Netskope

Collection overview

Sumo Logic provides a collector agent which pulls logs from Netskope with API calls. You can configure the list of events and alerts to be collected, but by default all events and alerts are collected.

The events and alerts are forwarded to the Sumo Logic HTTP endpoint in JSON format. The configuration from a yaml file, which is stored in the home directory, is used. By default the collection starts from last 7 days, but this setting is configurable.

The Netskope App has the following components:

• Application Usage: Insights into application usage; specifically by devices, users, users and traffic patterns.
• Security Alerts: Visibility into Netskope security alerts and violations and the ability to identify effects of a breach.  

Step 1: Adding a Hosted Collector and HTTP Source

This section demonstrates how to add a hosted Sumo Logic collector and HTTP Logs and Metrics source, to collect events for Netskope

Step 2: Getting a token from the Netskope Portal

Netskope REST APIs use an auth token to make authorized calls to the API. This section demonstrates how to obtain a token from the Netskope user interface (UI).

To obtain a Netskope auth token, do the following:

1. Login to Netskope as the Tenant Admin.
2. Go to the API portion of the Netskope, Settings > Tools > Rest API.
3. Copy the existing token to your clipboard, or you can generate a new token and copy that token.

Step 3: Configuring a Sumo Logic Netskope collector

This section provides walkthrough instructions that demonstrate how to configure a Sumo Logic Netskope collector.

To create a Sumo Logic Netskope collector, do the following:

1. Login to a Linux machine.
2. Install the collector using the following command. 

pip install sumologic-netskope-collector

3. Download the netskope.yaml configuration file and place in the home directory.  
4. Edit the netskope.yaml file in the following way:
   1. Replace <SUMO HTTP SOURCE ENDPOINT> with the Sumo Logic HTTPS Source endpoint you created in Step 1.
   2. Replace <Netskope API Token> with the Netskope API token you created in Step 2.
   3. Replace <Netskope Domain> with your Netskope domain name.
      
      Example of an edited netskope.yaml file: 

Netskope:
 TOKEN: "ExampleTokenGxrtwdshciB7gHR7efDQbZPW"
 NETSKOPE_EVENT_ENDPOINT: https://example.goskope.com/api/v1/events
 NETSKOPE_ALERT_ENDPOINT: https://example.goskope.com/api/v1/alerts

SumoLogic:
 SUMO_ENDPOINT: "https://collectors.sumologic.com/receiver/v1/http/ZaVnC4dhaxxExampleEndpointxxx===" 

5. Create a cron job  to run the collector every 5 minutes, (use the crontab -e option) and add the following line:

*/5 * * * *  /usr/bin/python -m sumonetskopecollector.netskope > /dev/null 2>&1

Updating the Sumo Logic Netskope collector

Sumo Logic periodically makes changes to the collector. To make sure your collector is up-to-date, perform the following tasks on each machine running the collector: 

• Check the latest version of the Netskope collector on this page: https://pypi.org/project/sumologic-netskope-collector/#history
• Check the version of the collector you have installed by running the following command:  pip show sumologic-netskope-collector
• If you are not running the latest collector, do the following:

1. Disable your cron job.
2. Stop all existing collector processes.
3. Run the following command to upgrade your collector: pip install sumologic-netskope-collector --upgrade
4. Enable the cron job.

Advanced Configuration

The following table explains the configuration file parameters and their usage.

Sample log message

{
           "dstip": "74.125.239.150",
           "dst_location": "Mountain View",
           "app": "Google Gmail",
           "_insertion_epoch_timestamp": 1547391690,
           "site": "Google Gmail",
           "src_location": "Pomerol",
           "organization_unit": "",
           "object_type": "Mail",
           "id": 3764,
           "app_session_id": 4252577042,
           "category": "Webmail",
           "dst_region": "California",
           "userkey": "Tanja.Barton@kkrlogistics.com",
           "dst_country": "US",
           "src_zipcode": "33500",
           "ur_normalized": "tanja.barton@kkrlogistics.com",
           "type": "nspolicy",
           "object": "Welcome Novak Dimitrov",
           "srcip": "77.194.46.1",
           "dst_latitude": 37.405991,
           "timestamp": 1547400222,
           "src_region": "Gironde",
           "dst_longitude": -122.078514,
           "alert": "no",
           "to_user": "ns-india@microsoft.com, hrglobal@microsoft.com",
           "user": "Tanja.Barton@kkrlogistics.com",
           "from_user": "bloomberg@bloomberg.com",
           "device": "Windows PC",
           "org": "kkrlogistics.com",
           "src_country": "FR",
           "traffic_type": "CloudApp",
           "dst_zipcode": "N/A",
           "count": 2,
           "src_latitude": 44.9333,
           "url": "https://mail.google.com/",
           "page_id": 2641483218,
           "sv": "unknown",
           "ccl": "excellent",
           "cci": 92,
           "activity": "Send",
           "userip": "127.0.0.1",
           "src_longitude": -0.2,
           "_id": "5df996d5b66a9ea963e812ce",
           "os": "Windows 8",
           "browser": "Internet Explorer",
           "appcategory": "Webmail"
       }
   ]
}

Query sample

The following query sample was is from the Total Sessions panel of the Application Overview Dashboard.

_sourceCategory="netskope_events" "no" "nspolicy"
| json "_id", "alert", "type", "srcip", "dstip", "appcategory", "app", "os", "user", "device", 
"acked", "site", "timestamp", "ccl", "activity", "browser", "object", "object_type", "from_user", 
"to_user", "app_session_id" as alert_id, is_alert, type, src_ip, dest_ip, appcategory, app, os, 
user, device, acked, site, timestamp, ccl, activity, browser, object, object_type, from_user, 
to_user, app_session_id  nodrop
| where is_alert="no" and type="nspolicy"
| count by app_session_id
| count