Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLS BWAN 1.0.0 - Initial release #262

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions netskope_bwan_cls/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 1.0.0
## Added
- Initial release.
1 change: 1 addition & 0 deletions netskope_bwan_cls/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Netskope Borderless WAN CLS plugin."""
Binary file added netskope_bwan_cls/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
199 changes: 199 additions & 0 deletions netskope_bwan_cls/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
"""
BSD 3-Clause License

Copyright (c) 2021, Netskope OSS
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CLS Netskope Borderless plugin.
"""

import traceback
from typing import List

from netskope.integrations.cls.plugin_base import (
PluginBase,
ValidationResult,
PushResult,
)

from .utils.constants import (
MODULE_NAME,
PLUGIN_NAME,
PLUGIN_VERSION,
EVENT_TYPES,
)

# from netskope.common.utils import DBConnector, AlertsHelper
from netskope.common.utils.alerts_helper import AlertsHelper

# from netskope.common.utils.plugin_provider_helper import PluginProviderHelper

helper = AlertsHelper()

# connector = DBConnector()
# alerts_helper = AlertsHelper()
# plugin_provider_helper = PluginProviderHelper()


class NetskopeBWANCLSPlugin(PluginBase):
"""The Netskope Borderless WAN CLS plugin implementation class."""

def __init__(
self,
name,
configuration,
storage,
last_run_at,
logger,
use_proxy=False,
ssl_validation=True,
source=None,
mappings=None,
):
"""Initialize."""
super().__init__(
name,
configuration,
storage,
last_run_at,
logger,
use_proxy,
ssl_validation,
source=source,
mappings=mappings,
)
self.plugin_name, self.plugin_version = self._get_plugin_info()
self.log_prefix = f"{MODULE_NAME} {self.plugin_name}"
if name:
self.log_prefix = f"{self.log_prefix} [{name}]"

def _get_plugin_info(self) -> tuple:
"""Get plugin name and version from manifest.

Returns:
tuple: Tuple of plugin's name and version fetched from manifest.
"""
try:
manifest_json = NetskopeBWANCLSPlugin.metadata
plugin_name = manifest_json.get("name", PLUGIN_NAME)
plugin_version = manifest_json.get("version", PLUGIN_VERSION)
return (plugin_name, plugin_version)
except Exception as exp:
self.logger.error(
message=(
"{} {}: Error occurred while"
" getting plugin details. Error: {}".format(
MODULE_NAME, PLUGIN_NAME, exp
)
),
details=traceback.format_exc(),
)
return (PLUGIN_NAME, PLUGIN_VERSION)

def push(self, transformed_data, data_type, subtype) -> PushResult:
"""Push the transformed_data to the 3rd party platform."""
pass

def transform(self, raw_data, data_type, subtype) -> List:
"""Transform the raw Netskope JSON data into target platform \
supported data formats."""
pass

def get_types_to_pull(self, data_type):
"""Get the types of data to pull.

Returns:
List of sub types to pull
"""
types = []
if data_type == "events":
types = self.configuration.get("events_types", [])

return types if types else EVENT_TYPES
else:
return types

def validate(
self, configuration: dict, tenant_name=None
) -> ValidationResult:
"""Validate the configuration parameters dict."""

event_types = configuration.get("events_types", [])
if event_types and (not isinstance(event_types, list) or not (
all(
indicator_type in EVENT_TYPES
for indicator_type in event_types
)
)):
error_msg = (
"Invalid Event Types provided in the "
"configuration parameters. Please select the "
"Event Types from the available options."
)
self.logger.error(
f"{self.log_prefix}: Validation error occurred. Error: "
f"{error_msg}",
)
return ValidationResult(success=False, message=error_msg)

hours = configuration.get("hours", 0)
if hours is None:
err_msg = (
"Initial Range in hours is a required "
"configuration parameters."
)
self.logger.error(f"{self.log_prefix}: {err_msg}")
return ValidationResult(
success=False,
message=err_msg,
)
elif not isinstance(hours, int):
err_msg = (
"Invalid Initial Range in hours provided in "
"the configuration parameters."
)
self.logger.error(f"{self.log_prefix}: {err_msg}")
return ValidationResult(
success=False,
message=err_msg,
)
elif hours < 0 or hours > 8760:
err_msg = (
"Invalid Initial Range in hours provided in the configuration "
"parameters. The value should be in range 0 to 8760."
)
self.logger.error(f"{self.log_prefix}: {err_msg}")
return ValidationResult(
success=False,
message=err_msg,
)

if not tenant_name:
tenant_name = helper.get_tenant_cls(self.name).name

return ValidationResult(success=True, message="Validation successful.")
71 changes: 71 additions & 0 deletions netskope_bwan_cls/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"name": "Netskope Borderless WAN",
"id": "netskope_bwan_cls",
"netskope": true,
"version": "1.0.0",
"module": "CLS",
"minimum_version": "5.1.0",
"minimum_provider_version": "1.0.0",
"provider_id": "netskope_bwan_tenant",
"patch_supported": true,
"types": [
"events"
],
"mapping": "",
"description": "This plugin is used to fetch Events (Audit, Authentication, Client, Gateway, System) from the Monitor > Events page of Netskope Borderless WAN Tenant. The Plugin fetches the data in JSON format.",
"supported_subtypes": {
"events": [
"audit",
"authentication",
"client",
"gateway",
"system"
]
},
"configuration": [
{
"label": "Event Types",
"key": "events_types",
"mandatory": false,
"description": "Selected types of events will be fetched. If kept empty, all event types will be fetched.",
"type": "multichoice",
"choices": [
{
"key": "Audit",
"value": "audit"
},
{
"key": "Authentication",
"value": "authentication"
},
{
"key": "Client",
"value": "client"
},
{
"key": "Gateway",
"value": "gateway"
},
{
"key": "System",
"value": "system"
}
],
"default": [
"audit",
"authentication",
"client",
"gateway",
"system"
]
},
{
"label": "Initial Range (in hours)",
"key": "hours",
"type": "number",
"mandatory": true,
"default": 1,
"description": "Number of hours to pull the event data for the initial run."
}
]
}
44 changes: 44 additions & 0 deletions netskope_bwan_cls/utils/constants.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
"""
BSD 3-Clause License

Copyright (c) 2021, Netskope OSS
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CLS Borderless WAN plugin constants.
"""

MODULE_NAME = "CLS"
PLUGIN_NAME = "Netskope Borderless WAN"
PLUGIN_VERSION = "1.0.0"
EVENT_TYPES = [
"audit",
"authentication",
"client",
"gateway",
"system"
]