@sw-tsdk/common 0.1.1-next.23

package/LICENSE

@@ -0,0 +1,8 @@
+The ISC License (ISC)
+
+Copyright © SWIMLANE 2021
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+{"mode":"full","isActive":false}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './schemas';
+export * from './types';
+export * from './utils';
+export * from './versioning';

package/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./schemas"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./utils"), exports);
+tslib_1.__exportStar(require("./versioning"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,kDAAuB;AACvB,kDAAuB;AACvB,uDAA4B"}

package/lib/schemas/asset.d.ts

@@ -0,0 +1,13 @@
+import type { Family } from './family';
+export declare type Asset = {
+    actionType?: string;
+    base64Image: string;
+    description: string;
+    family: Family;
+    inputParameters: {
+        [key: string]: any;
+    };
+    name: string;
+    testScriptFile?: string;
+    version: string;
+};

package/lib/schemas/asset.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=asset.js.map

package/lib/schemas/asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../src/schemas/asset.ts"],"names":[],"mappings":""}

package/lib/schemas/available-output-type.d.ts

@@ -0,0 +1,7 @@
+export declare enum AvailableOutputType {
+    Email = "email",
+    InsertUpdateRecord = "insertUpdateRecord",
+    ReferentialTask = "referentialTask",
+    SaveToFile = "saveToFile",
+    SetFieldValue = "setFieldValue"
+}

package/lib/schemas/available-output-type.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AvailableOutputType = void 0;
+var AvailableOutputType;
+(function (AvailableOutputType) {
+    AvailableOutputType["Email"] = "email";
+    AvailableOutputType["InsertUpdateRecord"] = "insertUpdateRecord";
+    AvailableOutputType["ReferentialTask"] = "referentialTask";
+    AvailableOutputType["SaveToFile"] = "saveToFile";
+    AvailableOutputType["SetFieldValue"] = "setFieldValue";
+})(AvailableOutputType = exports.AvailableOutputType || (exports.AvailableOutputType = {}));
+//# sourceMappingURL=available-output-type.js.map

package/lib/schemas/available-output-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"available-output-type.js","sourceRoot":"","sources":["../../src/schemas/available-output-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC3B,sCAAe,CAAA;IACf,gEAAyC,CAAA;IACzC,0DAAmC,CAAA;IACnC,gDAAyB,CAAA;IACzB,sDAA+B,CAAA;AACnC,CAAC,EANW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAM9B"}

package/lib/schemas/family.d.ts

@@ -0,0 +1,14 @@
+export declare enum Family {
+    Communication = "Communication",
+    DevOpsApplicationSecurity = "DevOps & Application Security",
+    EndpointSecurityManagement = "Endpoint Security & Management",
+    GovernanceRiskManagement = "Governance & Risk Management",
+    IdentityAccessManagement = "Identity & Access Management",
+    Infrastructure = "Infrastructure",
+    Investigation = "Investigation",
+    Miscellaneous = "Miscellaneous",
+    NetworkSecurityManagement = "Network Security & Management",
+    SIEMLogManagement = "SIEM & Log Management",
+    TicketManagement = "Ticket Management",
+    VulnerabilityPatchManagement = "Vulnerability & Patch Management"
+}

package/lib/schemas/family.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Family = void 0;
+var Family;
+(function (Family) {
+    Family["Communication"] = "Communication";
+    Family["DevOpsApplicationSecurity"] = "DevOps & Application Security";
+    Family["EndpointSecurityManagement"] = "Endpoint Security & Management";
+    Family["GovernanceRiskManagement"] = "Governance & Risk Management";
+    Family["IdentityAccessManagement"] = "Identity & Access Management";
+    Family["Infrastructure"] = "Infrastructure";
+    Family["Investigation"] = "Investigation";
+    Family["Miscellaneous"] = "Miscellaneous";
+    Family["NetworkSecurityManagement"] = "Network Security & Management";
+    Family["SIEMLogManagement"] = "SIEM & Log Management";
+    Family["TicketManagement"] = "Ticket Management";
+    Family["VulnerabilityPatchManagement"] = "Vulnerability & Patch Management";
+})(Family = exports.Family || (exports.Family = {}));
+//# sourceMappingURL=family.js.map

package/lib/schemas/family.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"family.js","sourceRoot":"","sources":["../../src/schemas/family.ts"],"names":[],"mappings":";;;AAAA,IAAY,MAaX;AAbD,WAAY,MAAM;IACd,yCAA+B,CAAA;IAC/B,qEAA2D,CAAA;IAC3D,uEAA6D,CAAA;IAC7D,mEAAyD,CAAA;IACzD,mEAAyD,CAAA;IACzD,2CAAiC,CAAA;IACjC,yCAA+B,CAAA;IAC/B,yCAA+B,CAAA;IAC/B,qEAA2D,CAAA;IAC3D,qDAA2C,CAAA;IAC3C,gDAAsC,CAAA;IACtC,2EAAiE,CAAA;AACrE,CAAC,EAbW,MAAM,GAAN,cAAM,KAAN,cAAM,QAajB"}

package/lib/schemas/index.d.ts

@@ -0,0 +1,7 @@
+export * from './asset';
+export * from './available-output-type';
+export * from './family';
+export * from './integration';
+export * from './os-support';
+export * from './package';
+export * from './python-version';

package/lib/schemas/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./asset"), exports);
+tslib_1.__exportStar(require("./available-output-type"), exports);
+tslib_1.__exportStar(require("./family"), exports);
+tslib_1.__exportStar(require("./integration"), exports);
+tslib_1.__exportStar(require("./os-support"), exports);
+tslib_1.__exportStar(require("./package"), exports);
+tslib_1.__exportStar(require("./python-version"), exports);
+//# sourceMappingURL=index.js.map

package/lib/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":";;;AAAA,kDAAuB;AACvB,kEAAuC;AACvC,mDAAwB;AACxB,wDAA6B;AAC7B,uDAA4B;AAC5B,oDAAyB;AACzB,2DAAgC"}

package/lib/schemas/integration.d.ts

@@ -0,0 +1,39 @@
+import type { AvailableOutputType } from './available-output-type';
+import type { Family } from './family';
+export declare type Integration = {
+    actionType: string;
+    assetDependencyType?: string;
+    assetDependencyVersion?: string;
+    availableOutputTypes: AvailableOutputType[] | boolean | number | {
+        [key: string]: any;
+    } | null | string;
+    availableOutputVariables: {
+        [key: string]: OutputDescriptor;
+    } | null;
+    base64Image: string;
+    description: string;
+    family: Family;
+    inputParameters: {
+        [key: string]: InputDescriptor;
+    } | null;
+    name: string;
+    readonly: boolean;
+    scriptFile: string;
+    version: string;
+    turbine?: Record<string, any>;
+};
+export declare type ParameterValue = {
+    value: string | number | Array<string | number> | boolean | JSON;
+};
+export declare type InputDescriptor = {
+    name: string;
+    description?: string;
+    example?: string;
+    type: string | number;
+    required?: string | boolean;
+};
+export declare type OutputDescriptor = {
+    name: string;
+    type: string | number;
+};
+export declare const capsWords: string[];

package/lib/schemas/integration.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capsWords = void 0;
+// Common Acronyms
+exports.capsWords = [
+    'ip',
+    'dns',
+    'cc',
+    'sha256',
+    'md5',
+    'sha1',
+    'url',
+    'ai',
+    'tlp',
+    'ioc',
+    'id',
+    'uuid',
+    'mac',
+    'sdn',
+    'vt',
+    'ts',
+    'cve',
+    'cwe',
+    'cvss',
+    'wa',
+    'os',
+    'av',
+    'pe',
+    'dll',
+    'iso',
+    'pcap',
+    'pid',
+    'pdf',
+    'html',
+    'det',
+    'tld',
+    'zip',
+    'mime',
+    'stix',
+    'asdn',
+    'asn',
+    'jpg',
+    'ad',
+    'dtg',
+    'uri',
+    'vlan',
+    'dhcp',
+    'json',
+];
+//# sourceMappingURL=integration.js.map

package/lib/schemas/integration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.js","sourceRoot":"","sources":["../../src/schemas/integration.ts"],"names":[],"mappings":";;;AAyCA,kBAAkB;AACL,QAAA,SAAS,GAAG;IACvB,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,QAAQ;IACR,KAAK;IACL,MAAM;IACN,KAAK;IACL,IAAI;IACJ,KAAK;IACL,KAAK;IACL,IAAI;IACJ,MAAM;IACN,KAAK;IACL,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,KAAK;IACL,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,IAAI;IACJ,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAA"}

package/lib/schemas/os-support.d.ts

@@ -0,0 +1,4 @@
+export declare type OSSupport = {
+    linux?: boolean;
+    windows?: boolean;
+};

package/lib/schemas/os-support.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=os-support.js.map

package/lib/schemas/os-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"os-support.js","sourceRoot":"","sources":["../../src/schemas/os-support.ts"],"names":[],"mappings":""}

package/lib/schemas/package.d.ts

@@ -0,0 +1,26 @@
+import type { OSSupport } from './os-support';
+import type { PythonVersion } from './python-version';
+export declare type Package = {
+    author: string;
+    author_email: string;
+    description: string;
+    entry_points?: {
+        [key: string]: any;
+    };
+    install_requires?: string[];
+    isEmailBundle?: boolean;
+    name: string;
+    os_support?: OSSupport;
+    package_data?: {
+        [key: string]: any;
+    };
+    packages?: string[];
+    product: string;
+    python_version?: PythonVersion;
+    scripts?: any[];
+    supported_swimlane_version?: string;
+    url?: string;
+    vendor: string;
+    version: string;
+    version_hash?: null;
+};

package/lib/schemas/package.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=package.js.map

package/lib/schemas/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/schemas/package.ts"],"names":[],"mappings":""}

package/lib/schemas/python-version.d.ts

@@ -0,0 +1,4 @@
+export declare enum PythonVersion {
+    The27 = "2.7",
+    The36 = "3.6"
+}

package/lib/schemas/python-version.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PythonVersion = void 0;
+var PythonVersion;
+(function (PythonVersion) {
+    PythonVersion["The27"] = "2.7";
+    PythonVersion["The36"] = "3.6";
+})(PythonVersion = exports.PythonVersion || (exports.PythonVersion = {}));
+//# sourceMappingURL=python-version.js.map

package/lib/schemas/python-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"python-version.js","sourceRoot":"","sources":["../../src/schemas/python-version.ts"],"names":[],"mappings":";;;AAAA,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,8BAAa,CAAA;AACjB,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

package/lib/templates/CHANGELOG.md.t

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project are documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.0 - {{{timestamp}}}
+ * Initial Release

package/lib/templates/INTERNAL_CHANGELOG.md.t

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project are documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.0 - {{{timestamp}}}
+ * Initial Release

package/lib/templates/README.md.t

@@ -0,0 +1,40 @@
+# {{{title}}}
+
+A brief description goes here. Be sure to provide an overview of what the plugin does. Include description of the
+product being integrated, plus use cases/value prop of the Swimlane integration.
+
+## Prerequisites
+
+Prerequisites, everything outside of the plugin itself. This should include info on how to
+configure the device (API Key, Perms, ect)
+
+## Capabilities
+
+This plugin provides the following capabilities:
+
+* Capabilities
+* Go
+* Here
+* e.g. Manage Firewall Policies instead of listing each individual tasks
+
+### Limitations
+
+Include information about known limitations here, including supported or minimum versions, especially
+known unsupported versions.
+
+## Asset Setup
+
+The content here should discuss asset setup in a conversational manner. Be sure to include any known login
+ and test connection errors.
+
+## Tasks Setup
+Special task setup as needed depending on plugin, exclude if empty.
+
+Known available allowed input options from enum type selection
+
+## Notes
+
+* Any other notes not fitting other sections go here.
+* Any reference URLs to external docs or other resources
+
+This plugin was last tested against product version: !*CHANGEME*!.

package/lib/templates/asset.json.t

@@ -0,0 +1,132 @@
+{
+    "name": "{{{name}}}",
+    "type": "{{{type}}}",
+    "version": "1.0.0",
+    "description": "{{{description}}}",
+    "family": "{{{family}}}",
+    "inputParameters":
+    {
+        "username":
+        {
+            "name": "Username",
+            "description": "Account Username",
+            "required": true,
+            "type": 1
+        },
+        "password":
+        {
+            "name": "Password",
+            "description": "Account Password",
+            "required": true,
+            "type": 4
+        },
+        "http_proxy":
+        {
+            "name": "HTTP Proxy",
+            "description": "Optional HTTP/HTTPS proxy",
+            "example": "http://user:password@10.10.1.10:3128",
+            "type": 1
+        },
+        "verify_ssl":
+        {
+            "name": "Verify SSL",
+            "description": "Enable SSL certificate verification. Ignored for non-SSL connection",
+            "type": 7,
+            "default": true
+        },
+        "host":
+        {
+            "name": "Host",
+            "description": "Server Host Address",
+            "example": "http://192.168.1.1",
+            "required": true,
+            "type": 1
+        },
+        "ip_address":
+        {
+            "name": "IP Address",
+            "description": "Server IP Address",
+            "example": "192.168.1.1",
+            "required": true,
+            "type": 1
+        },
+        "port":
+        {
+            "name": "Port",
+            "description": "Server Port",
+            "example": "8080",
+            "required": true,
+            "type": 1
+        },
+        "api_key":
+        {
+            "name": "API Key",
+            "description": "API Key",
+            "required": true,
+            "type": 4
+        },
+        "access_key":
+        {
+            "name": "Access Key",
+            "description": "Access Key",
+            "required": true,
+            "type": 4
+        },
+        "token":
+        {
+            "name": "Token",
+            "description": "Token",
+            "required": true,
+            "type": 4
+        },
+        "access_token":
+        {
+            "name": "Access Token",
+            "description": "Access Token",
+            "required": true,
+            "type": 4
+        },
+        "email":
+        {
+            "name": "Email",
+            "description": "Account Email",
+            "example": "john.smith@company.com",
+            "required": true,
+            "type": 1
+        },
+        "url":
+        {
+            "name": "URL",
+            "description": "URL",
+            "example": "http://example.com",
+            "required": true,
+            "type": 1
+        },
+        "domain":
+        {
+            "name": "Domain",
+            "description": "Domain",
+            "example": "example.com",
+            "required": true,
+            "type": 1
+        },
+        "user_agent":
+        {
+            "name": "User Agent",
+            "description": "User Agent",
+            "example": "SwimlaneIntegration",
+            "required": true,
+            "type": 1
+        },
+        "verbose_errors":
+        {
+            "name": "Verbose Errors",
+            "description": "HTTP errors will contain more detail about the request and response if selected.",
+            "type": 7,
+            "default": false
+        }
+    },
+    "testScript": "",
+    "testScriptFile": "test_connection.py",
+    "base64Image": "{{{logo}}}"
+}

package/lib/templates/assetConfig.json.t

@@ -0,0 +1,3 @@
+{
+  "bitwardenName": "{{{name}}}"
+}

package/lib/templates/config.json.t

@@ -0,0 +1,9 @@
+{
+    "auth_endpoints": [false],
+    "HEADER_WHITELIST_ADDITIONS": [],
+    "mock_requests": true,
+    "validate_headers": true,
+    "validate_kwargs": true,
+    "allow_missing_outputs": false,
+    "validate_output_types": true
+}

package/lib/templates/conftest.py.t

@@ -0,0 +1 @@
+from swimlane_integration_testing.conftest import *

package/lib/templates/data_asset.json.t

@@ -0,0 +1,4 @@
+{
+  "host": "",
+  "verify_ssl": false
+}

package/lib/templates/dist_requirements.txt.t

@@ -0,0 +1,3 @@
+{{#each requirements}}
+{{this}}
+{{/each}}

package/lib/templates/example.py.t

@@ -0,0 +1,13 @@
+from {{bundleModuleName}} import {{baseClassName}}
+
+
+class SwMain({{baseClassName}}):
+    {{#if rest}}
+    method = "GET"
+    endpoint = ""
+    {{/if}}
+    def __init__(self, context):
+        super().__init__(context)
+
+    def execute(self):
+        pass

package/lib/templates/import.json.t

@@ -0,0 +1,23 @@
+{
+  "name": "{{{name}}}",
+  "description": "{{{description}}}",
+  "version": "{{{version}}}",
+  "family": "{{{family}}}",
+  "actionType": "{{{actionType}}}",
+  "assetDependencyType": "{{{assetDependencyType}}}",
+  "assetDependencyVersion": "{{{assetDependencyVersion}}}",
+  "inputParameters": {},
+  "availableOutputTypes": [
+    "email",
+    "insertUpdateRecord",
+    "referentialTask",
+    "saveToFile",
+    "setFieldValue"
+  ],
+  "availableOutputVariables": {},
+  "pythonDependencies": null,
+  "readonly": true,
+  "script": "",
+  "scriptFile": "{{{scriptFile}}}",
+  "base64Image": "{{{logo}}}"
+}

package/lib/templates/init.py.t

@@ -0,0 +1,17 @@
+{{#if rest}}
+from basic_rest_endpoint import BasicRestEndpoint, asset_parser
+
+class {{{baseClassName}}}(BasicRestEndpoint):
+
+    method = "GET"
+    endpoint = ""
+
+    def __init__(self, context):
+        super().__init__(**asset_parser(context.asset))
+
+        self.configure_status_actions(verbose_errors=context.asset['verbose_errors'])
+{{else}}
+class {{{baseClassName}}}(object):
+    def __init__(self, context):
+        pass
+{{/if}}

package/lib/templates/package.json.t

@@ -0,0 +1,22 @@
+{
+  "version_hash": null,
+  "author_email": "info@swimlane.com",
+  "version": "1.0.0",
+  "description": "{{{description}}}",
+  "scripts": [],
+  "author": "{{{author}}}",
+  "vendor": "{{{vendor}}}",
+  "product": "{{{product}}}",
+  "url": "{{{url}}}",
+  "install_requires": [],
+  "packages": [
+    {{#each packages}}
+      "{{this}}"{{#unless @last}},{{/unless}}
+    {{/each}}
+  ],
+  "name": "{{{name}}}",
+  "supported_swimlane_version": "{{{supportedSwimlaneVersion}}}",
+  "python_version": "3.6",
+  "python_runtime": "3.6",
+  "private": false
+}

package/lib/templates/pre-commit-config.yaml.t

@@ -0,0 +1,41 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-json
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: requirements-txt-fixer
+    -   id: trailing-whitespace
+    # Remove unused python imports
+-   repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+    -   id: autoflake
+        args: [--in-place, --remove-all-unused-imports]
+        # why we exclude these files? See below.
+        #
+        # setup.py -> if formatted the integration validation fails
+        # conftest.py -> has intentional unsused imports
+        # test_default.py -> has intentional unsused imports
+        #
+        # This is the same reason why we exclude this
+        # files on hooks bellow.
+        exclude: "setup.py|conftest.py|test_default.py"
+    # Sort python imports
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+    -   id: isort
+        # never remove --profile black
+        # if you do that darker and isort will enter
+        # in conflict and you'll enter in a infinity import
+        # error because black will revert what isort fixed.
+        args: ["--profile", "black"]
+        exclude: "setup.py|conftest.py|test_default.py"
+    # black but powered with diff
+-   repo: https://github.com/akaihola/darker
+    rev: 1.5.0
+    hooks:
+    -   id: darker
+        exclude: "setup.py"