Configuring Webroot Connectors

This connector allows Stellar Cyber to ingest logs from Webroot and add the records to the data lake.

Stellar Cyber connectors with the Collect function (collectors) may skip collecting some data when the ingestion volume is large, which potentially can lead to data loss. This can happen when the processing capacity of the collector is exceeded.

Connector Overview: Webroot

Capabilities

  • Collect: Yes

  • Respond: No

  • Native Alerts Mapped: No

  • Runs on: DP

  • Interval: Configurable

Collected Data

Content Type

Index

Locating Records

Blocked Urls

Blocked Traffic

Endpoints

Phishing

Threat History

Traffic Summary

Syslog

msg_class:

webroot_blocked_urls

webroot_blocked_traffic

webroot_endpoints

webroot_phishing

webroot_threat_history

webroot_traffic_summary

msg_origin.source:

webroot

msg_origin.vendor

webroot

msg_origin.category:

endpoint

Domain

https://unityapi.webrootcloudav.com

Response Actions

N/A

Third Party Native Alert Integration Details

N/A

Required Credentials

  • Client ID, Client Secret, Username, Password, Parent Keycode (GSM key)

               Let us know if you find the above overview useful.

Adding a Webroot Connector

To add a Webroot connector:

  1. Obtain Webroot credentials
  2. Add the connector in Stellar Cyber
  3. Test the connector
  4. Verify ingestion

Obtaining Webroot Credentials

Use the following steps as a guide to obtain the credentials required to allow Stellar Cyber to retrieve data with the Webroot API.

  1. Access the Webroot Identity Portal (Management Console) as the username and password you will use to configure the Stellar Cyber connector. Make note of the login information for later use.

    The password should not include non-ASCII special characters.

  2. From the left navigation pane, select Settings.

  3. When the Settings page displays, select the Unity API Access sub-tab.

  4. Click the button to Create New Client Credential.

  5. In the dialog that displays, specify a Name and Description for the credential, then click Next.

  6. On the next screen, enable the option to use the event notification API, specifying Other use ... for the Purpose. Then click Next.

  7. On the final screen, click Save.

  8. The console displays a dialog with both the Client ID and the Client Secret. Make note of both of these values. The Client Secret cannot be retrieved later, although it can be regenerated.

  9.  The final information you need is the Parent Keycode, which you will enter as the GSM Key later. Click the sub-tab for Account Information and record the value for that field.

  10. Review your list of information before proceeding. You should now have:

    • Username

    • Password

    • Client ID

    • Client Secret

    • Parent Keycode (GSM key)

Adding the Connector in Stellar Cyber

With the access information handy, you can add a Webroot connector in Stellar Cyber:

  1. Log in to Stellar Cyber.

  2. Click System | Integration | Connectors. The Connector Overview appears.

  3. Click Create. The General tab of the Add Connector screen appears. The information on this tab cannot be changed after you add the connector.

    The asterisk (*) indicates a required field.

  4. Choose Endpoint Security from the Category drop-down.

  5. Choose Webroot from the Type drop-down.

  6. For this connector, the supported Function is Collect, which is enabled already.

  7. Enter a Name.

    Notes:
    • This field does not accept multibyte characters.
    • It is recommended that you follow a naming convention such as tenantname-connectortype.
  8. Choose a Tenant Name. This identifies which tenant is allowed to use the connector.

  9. Choose the device on which to run the connector.

    • Certain connectors can be run on either a Sensor or a Data Processor. The available devices are displayed in the Run On menu. If you want to associate your collector with a sensor, you must have configured that sensor prior to configuring the connector or you will not be able to select it during initial configuration. If you select Data Processor, you will need to associate the connector with a Data Analyzer profile as a separate step. That step is not required for a sensor, which is configured with only one possible profile.

    • If the device you're connecting to is on premises, we recommend you run on the local sensor. If you're connecting to a cloud service, we recommend you run on the DP.

  10. (Optional) When the Function is Collect, you can apply Log Filters. For information, see Managing Log Filters.

  11. Click Next. The Configuration tab appears.

    The asterisk (*) indicates a required field.

  12. Enter the following information you noted from the previous section:

    • Enter the Client ID.

    • Enter the Client Secret.

    • Enter the Username and Password.

    • Enter the GSM Key (Parent Keycode).

  13. Choose the Interval (min). This is how often the logs are collected.

  14. Chose the Content Type. The following are available:

    • Blocked Urls

    • Blocked Traffic

    • Endpoints

    • Phishing

    • Threat History

    • Traffic Summary

  15. Click Next. The final confirmation tab appears.

  16. Click Submit.

    To pull data, a connector must be added to a Data Analyzer profile if it is running on the Data Processor.

  17. If you are adding rather than editing a connector with the Collect function enabled and you specified for it to run on a Data Processor, a dialog box now prompts you to add the connector to the default Data Analyzer profile. Click Cancel to leave it out of the default profile or click OK to add it to the default profile.

    • This prompt only occurs during the initial create connector process when Collect is enabled.

    • Certain connectors can be run on either a Sensor or a Data Processor, and some are best run on one versus the other. In any case, when the connector is run on a Data Processor, that connector must be included in a Data Analyzer profile. If you leave it out of the default profile, you must add it to another profile. You need the Administrator Root scope to add the connector to the Data Analyzer profile. If you do not have privileges to configure Data Analyzer profiles, a dialog displays recommending you ask your administrator to add it for you.

    • The first time you add a Collect connector to a profile, it pulls data immediately and then not again until the scheduled interval has elapsed. If the connector configuration dialog did not offer an option to set a specific interval, it is run every five minutes. Exceptions to this default interval are the Proofpoint on Demand (pulls data every 1 hour) and Azure Event Hub (continuously pulls data) connectors. The intervals for each connector are listed in the Connector Types & Functions topic.

    The Connector Overview appears.

The new connector is immediately active.

Testing the Connector

When you add (or edit) a connector, we recommend that you run a test to validate the connectivity parameters you entered. (The test validates only the authentication / connectivity; it does not validate data flow).

  1. Click System | Integrations | Connectors. The Connector Overview appears.

  2. Locate the connector that you added, or modified, or that you want to test.

  3. Click Test at the right side of that row. The test runs immediately.

    Note that you may run only one test at a time.

Stellar Cyber conducts a basic connectivity test for the connector and reports a success or failure result. A successful test indicates that you entered all of the connector information correctly.

To aid troubleshooting your connector, the dialog remains open until you explicitly close it by using the X button. If the test fails, you can select the  button from the same row to review and correct issues.

The connector status is updated every five (5) minutes. A successful test clears the connector status, but if issues persist, the status reverts to failed after a minute.

Repeat the test as needed.

ClosedDisplay sample messages...

Success !

Failure with summary of issue:

Show More example detail:

If the test fails, the common HTTP status error codes are as follows:

HTTP Error Code HTTP Standard Error Name Explanation Recommendation
400 Bad Request This error occurs when there is an error in the connector configuration.

Did you configure the connector correctly?

401 Unauthorized

This error occurs when an authentication credential is invalid or when a user does not have sufficient privileges to access a specific API.

Did you enter your credentials correctly?

Are your credentials expired?

Are your credentials entitled or licensed for that specific resource?

403 Forbidden This error occurs when the permission or scope is not correct in a valid credential.

Did you enter your credentials correctly?

Do you have the required role or permissions for that credential?

404 Not Found This error occurs when a URL path does not resolve to an entity. Did you enter your API URL correctly?
429 Too Many Requests

This error occurs when the API server receives too much traffic or if a user’s license or entitlement quota is exceeded.

The server or user license/quota will eventually recover. The connector will periodically retry the query.

If this occurs unexpectedly or too often, work with your API provider to investigate the server limits, user licensing, or quotas.

For a full list of codes, refer to HTTP response status codes.

Resolving Error Messages for Webroot Connectors

In certain situations, the initial Test for a Webroot connector may report success but then subsequently display an error message in the Messages column of the System | Connectors page. Use the following information to resolve common error messages for Webroot connectors:

  • WSAT is not enabled for this site

    "{"statusCode":400,"requestId":"c60683f4-09a7-48c2-ae48-c8df21e8bb90","error":"wsat_not_enabled","error_description":"WSAT is not enabled for this site.","AdditionalInformation":{}}"

    This error message appears when the Security Awareness Training feature in Webroot is either not enabled or its subscription has expired. Try the following in Webroot:

    • Make sure that WSAT is enabled in Security Awareness Training | Settings | Enable Security Awareness Training.

    • Make sure the Security Awareness subscription has not expired.

  • DNSP is not enabled for this site

    {"statusCode":400,"requestId":"0e12a84d-1123-4c87-937b-a6469ee52b3c","error":"dnsp_not_enabled","error_description":"DNSP is not enabled for this site.","AdditionalInformation":{}}

    This error message appears when the DNS Protection feature in Webroot is either not enabled or its subscription has expired. Try the following in Webroot:

    • Make sure that the DNS Protection subscription in Webroot is not expired.

    • Make sure that the DNS Protection feature is set to On in Webroot.

Verifying Ingestion

To verify ingestion:

  1. Click Investigate | Threat Hunting. The Interflow Search tab appears.
  2. Change the Indices to Syslog. The table immediately updates to show ingested Interflow records.