About the connector
A McAfee Web Gateway connects your network to the web and filters the traffic that goes out from your network and comes into your network.
This document provides information about the McAfee Web Gateway connector, which facilitates automated interactions, with McAfee Web Gateway using FortiSOAR™ playbooks. Add the McAfee Web Gateway connector as a step in FortiSOAR™ playbooks and perform automated operations, such as automatically creating an empty list in McAfee Web Gateway, adding a list entry into a list in McAfee Web Gateway, and retrieving lists from McAfee Web Gateway.
Version information
Connector Version: 1.0.0
FortiSOAR™ Version Tested on: 5.1.0-098
Authored By: Fortinet
Certified: Yes
Installing the connector
From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:
yum install cyops-connector-mcafee-web-gateway
Prerequisites to configuring the connector
- You must have the Hostname or IP address of McAfee Web Gateway to which you will connect and perform automated operations and credentials (username-password pair) to access that McAfee Web Gateway.
- To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.
Configuring the connector
For the procedure to configure a connector, click here
Configuration parameters
In FortiSOAR™, on the Connectors page, click the McAfee Web Gateway connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter |
Description |
| Protocol |
Protocol that is enabled to connect the McAfee Web Gateway to which you will connect and perform automated operations. You can choose between Http or Https. |
| Hostname/IP Address |
Hostname or IP address of the McAfee Web Gateway to which you will connect and perform automated operations. |
| Port |
Port Number used to connect to the McAfee Web Gateway to which you will connect and perform automated operations. |
| Username |
Username that is used to access the McAfee Web Gateway to which you will connect and perform automated operations. |
| Password |
Password that is used to access the McAfee Web Gateway to which you will connect and perform automated operations. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified or not. |
Actions supported by the connector
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from CyOPsTM release 4.10.0 and onwards:
| Function |
Description |
Annotation and Category |
| Create Empty List |
Creates an empty list in McAfee Web Gateway based on the list name and type you have specified. |
create_empty_list
Investigation |
| Get Lists |
Retrieves all lists or specific lists from McAfee Web Gateway based on the input parameters you have specified. |
get_lists
Investigation |
| Get List Details |
Retrieves details of a specific list from McAfee Web Gateway based on the list name you have specified. |
get_list_details
Investigation |
| Get All List Entries |
Retrieves all the list entries for a specific list from McAfee Web Gateway based on the list name you have specified. |
get_all_list_entries
Investigation |
| Get Details of List Entry |
Retrieves details of a specific list entry from McAfee Web Gateway based on the list name and entry name you have specified. |
get_details_of_list_entry
Investigation |
| Insert List Entry in Simple List |
Inserts a list entry in a specific list in McAfee Web Gateway based on the list type, list name, entry value and other input parameters you have specified. |
insert_list_entry
Investigation |
| Delete List |
Deletes a specific list from McAfee Web Gateway based on the list name you have specified. |
delete_list
Investigation |
| Delete List Entry |
Deletes a specific list entry from a specific list in McAfee Web Gateway based on the list name and entry number you have specified. |
delete_list_entry
Investigation |
| Get Rule Sets |
Retrieves all rule sets from McAfee Web Gateway. |
get_rules_sets
Investigation |
| Get Rule Set Details |
Retrieves details for a specific rule set from McAfee Web Gateway based on the rule ID you have specified. |
get_rule_set_details
Investigation |
operation: Create Empty List
Input parameters
| Parameter |
Description |
| List Name |
Name of the list that you want to create in McAfee Web Gateway. |
| List Type |
Type of the list that you want to create in McAfee Web Gateway. You can create lists of type Application Name, Category, IP, etc. |
Output
The output contains the following populated JSON schema:
{
"entry": {
"id": "",
"title": "",
"type": "",
"listype": "",
"link": {
"@href": "",
"@rel": ""
},
"content": {
"list": {
"@version": "",
"@mwg-version": "",
"@name": "",
"@id": "",
"@typeId": "",
"@classifier": "",
"@systemList": "",
"@structuralList": "",
"@defaultRights": "",
"@description": "",
"@content": ""
}
}
}
}
operation: Get Lists
Input parameters
Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned.
| Parameter |
Description |
| List Filters |
Filter based on which you want to extract lists from McAfee Web Gateway. You can choose between Get Lists By Name or Get Lists By Type.
- If you select Get Lists By Name, then you must specify the name of the list in the List Name field, based on which you want to retrieve lists from McAfee Web Gateway.
- If you select Get Lists By Type, then you must specify the select the type of list from the List Type field, based on which you want to retrieve lists from McAfee Web Gateway.
|
| Page Size |
Maximum number of results, per page, that this operation should return. |
| Page Number |
Page Number from which you want to extract lists from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"feed": {
"id": "",
"title": "",
"link": [
{
"@href": "",
"@rel": ""
}
],
"entry": [
{
"id": "",
"title": "",
"listType": "",
"link": {
"@href": "",
"@rel": ""
}
}
]
}
}
operation: Get List Details
Input parameters
| Parameter |
Description |
| List Name |
Name of the list whose details you want to retrieve from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"entry": {
"title": "",
"listType": "",
"type": "",
"id": "",
"content": {
"list": {
"description": "",
"@id": "",
"@structuralList": "",
"@classifier": "",
"@name": "",
"@mwg-version": "",
"@systemList": "",
"content": {
"listEntry": [
{
"description": "",
"entry": ""
}
]
},
"@typeId": "",
"@version": "",
"@defaultRights": ""
}
},
"link": {
"@href": "",
"@rel": ""
}
}
}
operation: Get All List Entries
Input parameters
| Parameter |
Description |
| List Name |
Name of the list whose list entries you want to retrieve from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"feed": {
"id": "",
"title": "",
"entry": [
{
"id": "",
"title": "",
"link": {
"@href": "",
"@rel": ""
}
}
],
"link": [
{
"@href": "",
"@rel": ""
}
]
}
}
operation: Get Details of List Entry
Input parameters
| Parameter |
Description |
| List Name |
Name of the list whose list entry details you want to retrieve from McAfee Web Gateway. |
| Entry Number |
Number of the list entry whose details you want to retrieve from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"entry": {
"content": {
"listEntry": {
"description": "",
"entry": ""
}
},
"id": "",
"title": "",
"link": {
"@href": "",
"@rel": ""
}
}
}
operation: Insert List Entry in Simple List
Input parameters
| Parameter |
Description |
| List Type |
Type of list in which you want to insert a list entry List Type in McAfee Web Gateway.
You can choose from the following options: Application Name, Category, String, Wildcard Expression, Number, Hex, IP, IP Range, Dimension, or Media Type. |
| List Name |
Name of the list in which you want to insert a list entry List Type in McAfee Web Gateway. |
| Entry to be Inserted |
Entry that you want to insert in the specified list in McAfee Web Gateway. |
| Entry Description |
(Optional) Description of the entry that you want to insert in the specified list in McAfee Web Gateway. |
| Entry Number |
(Optional) Number of where you want to insert in the specified list in McAfee Web Gateway.
Note: If you do not specify any value in this parameter, then the specified entry will be inserted at the "0th" location. |
Output
The output contains the following populated JSON schema:
{
"entry": {
"content": {
"listEntry": {
"description": "",
"entry": ""
}
},
"id": "",
"title": "",
"link": {
"@href": "",
"@rel": ""
}
}
}
operation: Delete List
Input parameters
| Parameter |
Description |
| List Name |
Name of the list you want to delete from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"deleted": {
"entry": {
"title": "",
"listType": "",
"type": "",
"id": "",
"content": {
"list": {
"description": "",
"@id": "",
"@structuralList": "",
"@classifier": "",
"@name": "",
"@mwg-version": "",
"@systemList": "",
"content": "",
"@typeId": "",
"@version": "",
"@defaultRights": ""
}
},
"link": {
"@href": "",
"@rel": ""
}
}
}
}
operation: Delete List Entry
Input parameters
| Parameter |
Description |
| List Name |
Name of the list from which you want to delete the list entry in McAfee Web Gateway. |
| Entry Number |
Number of the entry in the specified list that you want to delete from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"deleted": {
"entry": {
"content": {
"listEntry": {
"description": "",
"entry": ""
}
},
"id": "",
"title": "",
"link": {
"@href": "",
"@rel": ""
}
}
}
}
operation: Get Rule Sets
Input parameters
None.
Output
The output contains the following populated JSON schema:
{
"feed": {
"id": "",
"title": "",
"entry": [
{
"enabled": "",
"title": "",
"noOfChild": "",
"id": "",
"position": "",
"link": {
"@href": "",
"@rel": ""
}
}
],
"link": [
{
"@href": "",
"@rel": ""
}
]
}
}
operation: Get Rule Set Details
Input parameters
| Parameter |
Description |
| Rule ID |
ID of the rule set whose details you want to retrieve from McAfee Web Gateway. |
Output
The output contains the following populated JSON schema:
{
"libraryContent": {
"libraryObject": {
"name": "",
"description": "",
"version": ""
},
"ruleGroup": {
"description": "",
"@id": "",
"@cycleEmbeddedObject": "",
"@cloudSynced": "",
"rules": "",
"acElements": "",
"@cycleRequest": "",
"@enabled": "",
"@name": "",
"@cycleResponse": "",
"ruleGroups": {
"ruleGroup": [
{
"description": "",
"@id": "",
"@cycleEmbeddedObject": "",
"@cloudSynced": "",
"rules": {
"rule": [
{
"description": "",
"@id": "",
"actionContainer": {
"@actionId": ""
},
"@name": "",
"condition": {
"@always": "",
"expressions": {
"conditionExpression": {
"@closingBracketCount": "",
"@openingBracketCount": "",
"parameter": {
"@valueTyp": "",
"@typeId": "",
"value": {
"listValue": {
"@id": ""
}
},
"@listTypeId": ""
},
"@operatorId": "",
"propertyInstance": {
"@propertyId": "",
"@useMostRecentConfiguration": ""
}
}
}
},
"immediateActionContainers": "",
"@enabled": ""
}
]
},
"acElements": "",
"@cycleRequest": "",
"@enabled": "",
"@name": "",
"@cycleResponse": "",
"wizard": {},
"ruleGroups": "",
"condition": {
"@always": "false",
"expressions": {
"conditionExpression": []
}
},
"@defaultRights": ""
}
]
},
"condition": {},
"@defaultRights": ""
},
"lists": {
"entry": [
{
"string": "",
"list": {
"description": "",
"@id": "",
"@structuralList": "",
"@classifier": "",
"@name": "",
"@mwg-version": "",
"@systemList": "",
"content": "",
"@typeId": "",
"@version": "",
"@defaultRights": ""
}
}
]
},
"configurations": {
"configuration": [
{
"description": "",
"@mwg-version": "",
"configurationProperties": {
"configurationProperty": [
{
"@value": "",
"@key": "",
"@type": "",
"@encrypted": ""
}
]
},
"@name": "",
"@templateId": "",
"@id": "",
"@targetId": "",
"acElements": "",
"@defaultRights": "",
"@version": ""
}
]
}
}
}
Included playbooks
The Sample - Mcafee Web Gateway - 1.0.0 playbook collection comes bundled with the McAfee Web Gateway connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the McAfee Web Gateway connector.
- Create Empty List
- Get Lists
- Get List Details
- Get List Entry
- Get Details of List Entry
- Insert List Entry in Simple List
- Delete List
- Delete List Entry
- Get Rule Sets
- Get Rule Set Details
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
