Skip to main content
Sumo Logic

Symantec Web Security Service Source

The Symantec Web Security Service Source provides a secure endpoint to receive WSS Access logs from the Symantec WSS API. It securely stores the required authentication, scheduling, and state tracking information.

  • See the Access Log Format for reference.
  • Logs are ingested in batches of 1,000.
  • Logs are polled every five minutes.

Prerequisite

You need to configure a WSS agent on the machine you want to collect data from. The WSS agent will collect your access data and the Symantec Web Security Service Source will receive that data using the Symantec WSS API. To configure and install the agent, follow the instructions in the links below:

States

A Symantec Web Security Service Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A Symantec Web Security Service Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with Symantec.
  5. Collecting: The Source is actively collecting data from Symantec.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection.

C2C error icon on collection page.png

Hover your mouse over the status icon to view a tooltip with a count of the detected errors and warnings.

hover c2c error.png

You can click on the status icon to open a Health Events panel with details on each detected issue.

Authentication

You need to have a Symantec Web Security Service username and password. To create a User API Key that serves as the username and password in the Sync API syntax follow these steps:

  1. Navigate to Account Configuration > API Credentials.
  2. Click Add API Credentials.
  3. WSS displays the Add API Credential dialog, which contains the random characters Username and Password.
    Symantec generate api creds.png
    1. Copy the Username and Password keys into a text file.
    2. Select the API Expiry you'd like to set.
      • Time-based—You define the date and time when this token expires.
      • Never expires.
    3. For the Access option, select Reporting Access Logs.
  4. Click Save.

See Symantec Security Software documentation for further details on generating API credentials.

Create a Symantec Web Security Service Source

When you create a Symantec Web Security Service Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Symantec Web Security Service Source:

  1. In the Sumo Logic web app, select Manage Data > Collection > Collection
  1. On the Collectors page, click Add Source next to a Hosted Collector.
  1. Select Symantec Web Security Service.
    symantec source icon.png
  1. Enter a Name to display for the Source in the Sumo web application. The description is optional.
    Symantec WSS Source.png
  1. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  2. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor Symantec
_siemProduct Web Security Service
_siemFormat JSON
_siemEventID proxy-messages
  1. (Optional) Fields. Click the +Add link to add custom log metadata Fields.
    • Define the fields you want to associate, each field needs a name (key) and value. 
      • green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
  2. Enable Structured Logs. This is recommended. By default, access logs are in plain text and only provide the data for each field to save space. For example:

    32031 2021-04-30 09:25:51 "DP6-GINMU12_proxysg4" 7678 0.0.0.0 Suppressed Suppressed - OBSERVED "Technology/Internet" - 200 TCP_TUNNELED TUNNEL - tcp 180.87.4.149 443 / - - - 192.168.6.87 675 1506 - - - - 0 "client" client_connector - - 180.87.4.149 "Hong Kong" - - - - - none - - - - none - Suppressed ICAP_NOT_SCANNED - ICAP_NOT_SCANNED - 180.87.4.149 - - "Suppressed" - - wss-agent architecture=x86_64%20name=Windows%2010%20Pro%20version=10.0.19042 7.2.1.14589 Suppressed Suppressed - - - - - - - - - 2001:0DB8:3b84:4dd1:26d6:8df0:41e7:3ec7 4cf1e10bcebda191-000000001cbc70aa-00000000608bcd17


    You have the option to have Sumo Logic structure your access logs in JSON that includes the field names with each value. For example:

    {'x-bluecoat-request-tenant-id': '32031', 'date': '2021-04-30', 'time': '09:57:25', 'x-bluecoat-appliance-name': 'DP6-GINMU12_proxysg4', 'time-taken': '3264', 'c-ip': '0.0.0.0', 'cs-userdn': 'Suppressed', 'cs-auth-groups': 'Suppressed', 'sc-filter-result': 'OBSERVED', 'cs-categories': 'Web Ads/Analytics', 'sc-status': '0', 's-action': 'TUNNELED', 'cs-method': 'unknown', 'cs-uri-scheme': 'ssl', 'cs-host': 'stats.g.doubleclick.net', 'cs-uri-port': '443', 'cs-uri-path': '/', 's-ip': '192.168.6.87', 'sc-bytes': '1510', 'cs-bytes': '1028', 'x-bluecoat-location-id': '0', 'x-bluecoat-location-name': 'client', 'x-bluecoat-access-type': 'client_connector', 'r-ip': '172.217.194.156', 'r-supplier-country': 'United States', 'x-rs-connection-negotiated-cipher': 'none', 'x-cs-connection-negotiated-cipher': 'none', 'x-cs-certificate-subject': 'Suppressed', 'cs-icap-status': 'ICAP_NOT_SCANNED', 'rs-icap-status': 'ICAP_NOT_SCANNED', 's-supplier-ip': '172.217.194.154', 'x-cs-client-ip-country': 'Suppressed', 'x-client-agent-type': 'wss-agent', 'x-client-os': 'architecture=x86_64%20name=Windows%2010%20Pro%20version=10.0.19042', 'x-client-agent-sw': '7.2.1.14589', 'x-client-device-id': 'Suppressed', 'x-client-device-name': 'Suppressed', 'x-random-ipv6': '2001:0DB8:3b84:4dd1:26d6:8df0:41e7:3ec7', 'x-bluecoat-transaction-uuid\n': '4cf1e10bcebda191-000000001ccb21b9-00000000608bd482'}

  3. API Username and Password. Provide the Symantec Web Security Service user credentials you want to use to authenticate collection requests. This was copied during the Authentication steps above.

  4. When you are finished configuring the Source click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. FirstPartyGenericError

JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

Parameter Type Required? Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Use {"type":"Symantec Web Security Service"} for a Symantec Web Security Service Source. not modifiable
sourceType String Yes Use Universal for a Symantec Web Security Service Source. not modifiable

The following table shows the config parameters for a Symantec Web Security Service Source.

Parameter Type Required Default Description Access
name String Yes   Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No null Type a description of the Source. modifiable
category String No null Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No   JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable
apiUsername String Yes   Provide the username you want to use to authenticate collection requests. modifiable
apiPassword String Yes   Provide the password for the username that you want to use to authenticate collection requests. modifiable
structuredLogs Boolean No false By default, access logs are in plain text and only provide the data for each field to save space. You have the option to have Sumo Logic structure your access logs in JSON that includes the field names with each value. modifiable

Symantec Web Security Service Source JSON example:

{
  "api.version":"v1",
  "source":{
    "schemaRef":{
      "type":"Symantec Web Security Service"
    },
    "config":{
      "name":"Symantec WSS",
      "apiUsername":"********",
      "fields":{
        "_siemForward":false
      },
      "category":"c2c/sym",
      "structuredLogs":true,
      "apiPassword":"********"
    },
    "state":{
      "state":"Collecting"
    },
    "sourceType":"Universal"
  }
}