diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml new file mode 100644 index 0000000..131c639 --- /dev/null +++ b/.github/workflows/linting.yml @@ -0,0 +1,11 @@ +name: Linting +on: [push, pull_request] +jobs: + lint: + # Run per push for internal contributers. This isn't possible for forked pull requests, + # so we'll need to run on PR events for external contributers. + # String comparison below is case insensitive. + if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + runs-on: ubuntu-latest + steps: + - uses: 'phantomcyber/dev-cicd-tools/github-actions/lint@main' diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml new file mode 100644 index 0000000..712cc1b --- /dev/null +++ b/.github/workflows/semgrep.yml @@ -0,0 +1,28 @@ +name: Semgrep +on: + pull_request_target: + branches: + - next + - main + push: + branches: + - next + - main +jobs: + semgrep: + runs-on: ubuntu-latest + steps: + - if: github.event_name == 'push' + run: | + echo "REPOSITORY=${{ github.repository }}" >> $GITHUB_ENV + echo "REF=${{ github.REF }}" >> $GITHUB_ENV + - if: github.event_name == 'pull_request_target' + run: | + echo "REPOSITORY=${{ github.event.pull_request.head.repo.full_name }}" >> $GITHUB_ENV + echo "REF=${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV + - uses: 'phantomcyber/dev-cicd-tools/github-actions/semgrep@main' + with: + SEMGREP_DEPLOYMENT_ID: ${{ secrets.SEMGREP_DEPLOYMENT_ID }} + SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }} + REPOSITORY: ${{ github.repository }} + REF: ${{ github.ref }} diff --git a/.github/workflows/start-release.yml b/.github/workflows/start-release.yml new file mode 100644 index 0000000..7bbce79 --- /dev/null +++ b/.github/workflows/start-release.yml @@ -0,0 +1,13 @@ +name: Start Release +on: + workflow_dispatch: + push: + tags: + - '*-beta*' +jobs: + start-release: + runs-on: ubuntu-latest + steps: + - uses: 'phantomcyber/dev-cicd-tools/github-actions/start-release@main' + with: + GITHUB_TOKEN: ${{ secrets.SOAR_APPS_TOKEN }} diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index 38e1594..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,3 +0,0 @@ -include: - - project: 'phantom/appscript' - file: 'gitlab-ci/.gitlab-ci.yml' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..47da14c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,11 @@ +repos: +- repo: https://github.com/phantomcyber/dev-cicd-tools + rev: v1.10 + hooks: + - id: org-hook + - id: package-app-dependencies +- repo: https://github.com/Yelp/detect-secrets + rev: v1.1.0 + hooks: + - id: detect-secrets + args: ['--no-verify', '--exclude-files', '^misp.json$'] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b3cc507 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,2 @@ +# Contributing +For more information about contributing to Splunk SOAR Apps please take a look at our app [Contribution Guide](https://github.com/splunk-soar-connectors/.github/blob/main/.github/CONTRIBUTING.md)! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6af04d8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (c) 2017-2022 Splunk Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/Makefile b/Makefile deleted file mode 100644 index 7af3212..0000000 --- a/Makefile +++ /dev/null @@ -1,81 +0,0 @@ -# Makefile for Phantom apps CI -# created oct-2018 by michellel & jacobd at splunk -# -# Usage: -# make local - to bring up docker for local dev -# make - pipeline targets build / upload -# make secrets - list any required secret values -# -# Credentials can be passed as environment variables or docker secret files -# under /run/secrets - - -# Variables set by GitLab -WORKSPACE ?= $(shell grep WORKSPACE: docker-compose.yml | cut -d : -f 2) -CI_COMMIT_REF_NAME ?= $(shell git branch | grep "\*" | cut -d ' ' -f 2) - -# Git variables -GIT_SERVER ?= cd.splunkdev.com -RELEASE_GROUP ?= phantom -RELEASE_REPO ?= app_release -RELEASE_DIR := $(WORKSPACE)/$(RELEASE_REPO) - -# Docker variables -export IMAGE_TAG ?= $(shell grep ^image: .gitlab-ci.yml | cut -d : -f 3) - -# Variables sent to app_release for test/build/release scripts -export APP_DIR ?= $(shell pwd) -export APP_REPO_NAME ?= $(shell basename $(APP_DIR)) -export APP_BRANCH ?= $(CI_COMMIT_REF_NAME) -export TEST_BRANCH ?= master - -# Pipeline secrets -SECRETS = app_artf_token gitlab_api_token app_deploy_key -ifneq ($(wildcard /run/secrets/.),) - # Load secrets if specified in filesystem rather than variables - export GITLAB_API_TOKEN ?= $(shell cat /run/secrets/gitlab_api_token) - export APP_ARTF_TOKEN ?= $(shell cat /run/secrets/app_artf_token) - export APP_DEPLOY_KEY ?= $(shell cat /run/secrets/app_deploy_key) -endif - -APP_RELEASE_TARGETS = test upload build release -.PHONY: checkout local secrets list_secrets $(APP_RELEASE_TARGETS) - -checkout: $(RELEASE_DIR) -$(RELEASE_DIR): /tmp/ssh-agent - $(info Clone the $(RELEASE_REPO) repo into $(RELEASE_DIR)) - @git clone git@$(GIT_SERVER):$(RELEASE_GROUP)/$(RELEASE_REPO).git $(RELEASE_DIR) - $(info Checkout the test branch: $(TEST_BRANCH)) - @cd $(RELEASE_DIR) && git checkout $(TEST_BRANCH) - -$(APP_RELEASE_TARGETS): checkout - @cd $(RELEASE_DIR) && make $@ - -local: secrets - $(info Setting up local development instance) - $(info Make sure you have run:) - $(info docker login repo.splunk.com) - docker-compose up -d - $(info Working directory is mapped to $(DOCKER_WORK). To connect:) - $(info docker exec -it -w $(DOCKER_WORK) local_qa-local_1 bash) - -/tmp/ssh-agent: - $(info Starting ssh agent) - @mkdir -p -m 700 ~/.ssh - @ssh-keyscan -p 22 $(GIT_SERVER) >> ~/.ssh/known_hosts - @eval $(shell ssh-agent -s >$@) - @if [ -s /run/secrets/app_deploy_key ]; then \ - cp /run/secrets/app_deploy_key ~/.ssh/id_rsa && \ - source $@ && ssh-add ~/.ssh/id_rsa; \ - else \ - cp ~/.ssh/app_deploy_key ~/.ssh/id_rsa && \ - chmod 600 ~/.ssh/id_rsa && \ - cat $@ && \ - source $@ && ssh-add ~/.ssh/id_rsa; \ - fi - -SECRET_FILES = $(foreach I,$(SECRETS),~/.docker/secrets/$I) -secrets: list_secrets $(SECRET_FILES) -list_secrets: - $(info From .docker/secrets these files are loaded:) - $(info $(SECRETS)) diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..70532d8 --- /dev/null +++ b/NOTICE @@ -0,0 +1,40 @@ +Splunk SOAR MISP +Copyright (c) 2017-2022 Splunk Inc. + +Third-party Software Attributions: + +Library: Deprecated +Version: 1.2.12 +License: MIT +Copyright 2017 Laurent LAPORTE + +Library: beautifulsoup4 +Version: 4.9.1 +License: MIT +Copyright 2004-2017 Leonard Richardson +Copyright 2004-2019 Leonard Richardson +Copyright 2018 Isaac Muse + +Library: cachetools +Version: 4.2.2 +License: MIT +Copyright 2014-2021 Thomas Kemmer +Copyright 2014-2021 Thomas Kemmer + +Library: jsonschema +Version: 3.2.0 +License: MIT +Copyright 2013 Julian Berman + +Library: pymisp +Version: 2.4.138 +License: BSD 2 +Copyright 2013-2014 Alexandre Dulaunoy +Copyright 2013-2014 CIRCL +Copyright 2013-2014 Rapha +Copyright 2014 Koen Van Impe + +Library: requests +Version: 2.25.0 +License: Apache 2.0 +Kenneth Reitz diff --git a/README.md b/README.md new file mode 100644 index 0000000..830c901 --- /dev/null +++ b/README.md @@ -0,0 +1,475 @@ +[comment]: # "Auto-generated SOAR connector documentation" +# MISP + +Publisher: Splunk +Connector Version: 2\.1\.6 +Product Vendor: MISP +Product Name: MISP +Product Version Supported (regex): "\.\*" +Minimum Product Version: 5\.1\.0 + +Take action with Malware Information Sharing Platform + +[comment]: # "File: README.md" +[comment]: # "Copyright (c) 2017-2022 Splunk Inc." +[comment]: # "" +[comment]: # "Licensed under the Apache License, Version 2.0 (the 'License');" +[comment]: # "you may not use this file except in compliance with the License." +[comment]: # "You may obtain a copy of the License at" +[comment]: # "" +[comment]: # " http://www.apache.org/licenses/LICENSE-2.0" +[comment]: # "" +[comment]: # "Unless required by applicable law or agreed to in writing, software distributed under" +[comment]: # "the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND," +[comment]: # "either express or implied. See the License for the specific language governing permissions" +[comment]: # "and limitations under the License." +[comment]: # "" +## pymisp-2.4.138 + +This app uses the pymisp module, which is licensed under an open source license. A simplified 2-BSD +License, Copyright (c) 2017 Raphaël Vinot. + +## jsonschema-3.2.0 + +This app uses the jsonschema module, which is licensed under the MIT License, Copyright (c) 2013 +Julian Berman. + +## Deprecated-1.2.12 + +This app uses the Deprecated module, which is licensed under the MIT License, Copyright (c) 2017 +Laurent LAPORTE. + +## cachetools-4.2.2 + +This app uses the cachetools module, which is licensed under the MIT License, Copyright (c) +2014-2021 Thomas Kemmer. + +Misp will return integers which correspond to various values. Here is the complete list: + +For **distribution** : + +- 0: Your Org Only +- 1: This Community Only +- 2: Connected Communities +- 3: All Communities +- 4: Sharing Group +- 5: Inherit + + +For **threat level id** : + +- 1: High +- 2: Medium +- 3: Low +- 4: Undefined + + +For **analysis** : + +- 0: Initial +- 1: Ongoing +- 2: Completed + + +**Note:** + +- There is no validation provided in case of an incorrect value in the 'json' action parameter of + the **'create event'** and **'update event'** actions. Hence, the action will pass even if an + incorrect attribute value is passed in the 'json' action parameter and no attributes will be + added. + +- The value of the attribute passed in the 'json' action parameter of **'create event'** and + **'update event'** will be treated as a list if a list is specified. If a string is specified + then a list will be created by splitting the string by comma (,). For example: + + - json: {"email_body": \["body 1", "body 2"\], "ip-dst": "8.8.8.8, 12.4.6.34"} + + The value of the 'email_body' will be considered a list and the value of the 'ip-dst' will be + converted to a list having two elements(\["8.8.8.8", "12.4.6.34"\]). + +- In the **'run query'** action, tags containing a comma (,) in its value can be passed through + the 'other' action parameter. For example: + + - other: {"tags": \["tag1, tag11", "tag_2"\]} + + "tag1, tag11" will be considered a single tag. + + +### Configuration Variables +The below configuration variables are required for this Connector to operate. These variables are specified when configuring a MISP asset in SOAR. + +VARIABLE | REQUIRED | TYPE | DESCRIPTION +-------- | -------- | ---- | ----------- +**base\_url** | required | string | MISP instance URL \(http\://misp\_instance\.company\.com/\) +**verify\_server\_cert** | required | boolean | Verify server certificate +**api\_key** | required | password | API Key found under Event Actions\: Automation + +### Supported Actions +[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity +[create event](#action-create-event) - Create a new event in MISP +[update event](#action-update-event) - Add attributes / IOCs to an event in MISP +[run query](#action-run-query) - Run a query to find events or attributes +[get attributes](#action-get-attributes) - Get attributes for a specific event + +## action: 'test connectivity' +Validate the asset configuration for connectivity + +Type: **test** +Read only: **True** + +#### Action Parameters +No parameters are required for this action + +#### Action Output +No Output + +## action: 'create event' +Create a new event in MISP + +Type: **generic** +Read only: **False** + +This action first creates an event, then adds attributes to that event\. Parameters urls, domains, source\_ips, dest\_ips, source\_emails, dest\_emails accept comma\-separated values\. + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**distribution** | required | Distribution level for sharing | string | +**threat\_level\_id** | required | Threat level id | string | +**analysis** | required | Current stage of analysis for event | string | +**info** | required | Information / Description for Event | string | +**add\_attributes** | optional | Add attributes upon event creation | boolean | +**to\_ids** | optional | Set 'to\_IDS' flag=True in MISP | boolean | +**source\_ips** | optional | Source IPs to be added as attributes | string | `ip` +**dest\_ips** | optional | Destination IPs to be added as attributes | string | `ip` +**domains** | optional | Domains to be added as attributes | string | `domain` +**source\_emails** | optional | Source email addresses to be added as attributes | string | `email` +**dest\_emails** | optional | Destination email addresses to be added as attributes | string | `email` +**urls** | optional | URLs to be added as attributes | string | `url` +**json** | optional | JSON key value list of attributes | string | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.add\_attributes | boolean | +action\_result\.parameter\.analysis | string | +action\_result\.parameter\.dest\_emails | string | `email` +action\_result\.parameter\.dest\_ips | string | `ip` +action\_result\.parameter\.distribution | string | +action\_result\.parameter\.domains | string | `domain` +action\_result\.parameter\.info | string | +action\_result\.parameter\.json | string | +action\_result\.parameter\.source\_emails | string | `email` +action\_result\.parameter\.source\_ips | string | `ip` +action\_result\.parameter\.threat\_level\_id | string | +action\_result\.parameter\.to\_ids | boolean | +action\_result\.parameter\.urls | string | `url` +action\_result\.data\.\*\.Org\.id | string | +action\_result\.data\.\*\.Org\.local | boolean | +action\_result\.data\.\*\.Org\.name | string | +action\_result\.data\.\*\.Org\.uuid | string | +action\_result\.data\.\*\.Orgc\.id | string | +action\_result\.data\.\*\.Orgc\.local | boolean | +action\_result\.data\.\*\.Orgc\.name | string | +action\_result\.data\.\*\.Orgc\.uuid | string | +action\_result\.data\.\*\.analysis | string | +action\_result\.data\.\*\.attribute\_count | string | +action\_result\.data\.\*\.category | string | +action\_result\.data\.\*\.comment | string | +action\_result\.data\.\*\.date | string | +action\_result\.data\.\*\.deleted | boolean | +action\_result\.data\.\*\.disable\_correlation | boolean | +action\_result\.data\.\*\.distribution | string | +action\_result\.data\.\*\.event\_creator\_email | string | +action\_result\.data\.\*\.event\_id | string | `misp event id` +action\_result\.data\.\*\.extends\_uuid | string | +action\_result\.data\.\*\.id | string | +action\_result\.data\.\*\.info | string | +action\_result\.data\.\*\.locked | boolean | +action\_result\.data\.\*\.object\_id | string | +action\_result\.data\.\*\.org\_id | string | +action\_result\.data\.\*\.orgc\_id | string | +action\_result\.data\.\*\.proposal\_email\_lock | boolean | +action\_result\.data\.\*\.publish\_timestamp | numeric | +action\_result\.data\.\*\.published | boolean | +action\_result\.data\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.threat\_level\_id | string | +action\_result\.data\.\*\.timestamp | string | +action\_result\.data\.\*\.to\_ids | boolean | +action\_result\.data\.\*\.type | string | +action\_result\.data\.\*\.uuid | string | +action\_result\.data\.\*\.value | string | `url` `domain` `ip` `email` `hash` `md5` `sha256` `md1` +action\_result\.data\.0\.id | string | `misp event id` +action\_result\.summary\.errors | string | +action\_result\.summary\.message | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'update event' +Add attributes / IOCs to an event in MISP + +Type: **generic** +Read only: **False** + +Parameters urls, domains, source\_ips, dest\_ips, source\_emails, dest\_emails accept comma\-separated values\. + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**event\_id** | required | MISP event ID for adding attributes | numeric | `misp event id` +**to\_ids** | optional | Set 'to\_IDS' flag=True in MISP | boolean | +**source\_ips** | optional | Source IPs to be added as attributes | string | `ip` +**dest\_ips** | optional | Destination IPs to be added as attributes | string | `ip` +**domains** | optional | Domains to be added as attributes | string | `domain` +**source\_emails** | optional | Source email addresses to be added as attributes | string | `email` +**dest\_emails** | optional | Destination email addresses to be added as attributes | string | `email` +**urls** | optional | URLs to be added as attributes | string | `url` +**json** | optional | JSON key value list of attributes | string | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.dest\_emails | string | `email` +action\_result\.parameter\.dest\_ips | string | `ip` +action\_result\.parameter\.domains | string | `domain` +action\_result\.parameter\.event\_id | numeric | `misp event id` +action\_result\.parameter\.json | string | +action\_result\.parameter\.source\_emails | string | `email` +action\_result\.parameter\.source\_ips | string | `ip` +action\_result\.parameter\.to\_ids | boolean | +action\_result\.parameter\.urls | string | `url` +action\_result\.data\.\*\.category | string | +action\_result\.data\.\*\.comment | string | +action\_result\.data\.\*\.deleted | boolean | +action\_result\.data\.\*\.disable\_correlation | boolean | +action\_result\.data\.\*\.distribution | string | +action\_result\.data\.\*\.event\_id | string | `misp event id` +action\_result\.data\.\*\.id | string | `misp attribute id` +action\_result\.data\.\*\.object\_id | string | +action\_result\.data\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.timestamp | string | +action\_result\.data\.\*\.to\_ids | boolean | +action\_result\.data\.\*\.type | string | +action\_result\.data\.\*\.uuid | string | +action\_result\.data\.\*\.value | string | `url` `domain` `ip` `email` `hash` `md5` `sha256` `md1` +action\_result\.summary | string | +action\_result\.summary\.errors | string | +action\_result\.summary\.message | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'run query' +Run a query to find events or attributes + +Type: **investigate** +Read only: **True** + +By setting max\_results to 0, you can get every result\. It is recommended you do not do this, as MISP can return a lot of data\. The default is 10, and this will be the oldest 10 results\.

The other field expects a json string, which can have the key value pairs of any field which the search API supports\.

The MISP API doesn't support paging, but it is possible to work around this\. By giving max results as a negative number, n, it will take the last n results from the query\. From there, you can take the timestamp from the first object in the resulting list, then pass it in the other field like so\: \{"timestamp"\: <timestamp \+ 1>\}\. All the results will now be after that specified timestamp\.

Also note that when searching for events, events with no attributes will not be returned\. + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**controller** | required | Search for events or attributes | string | +**max\_results** | optional | Max results to return | numeric | +**event\_id** | optional | Comma seperated list of Event IDs | string | `misp event id` +**tags** | optional | Comma seperated list of tags | string | +**other** | optional | Other search parameters, as a JSON object | string | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.controller | string | +action\_result\.parameter\.event\_id | string | `misp event id` +action\_result\.parameter\.max\_results | numeric | +action\_result\.parameter\.other | string | +action\_result\.parameter\.tags | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.distribution | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.id | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.info | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.org\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.orgc\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.uuid | string | +action\_result\.data\.\*\.Attribute\.\*\.Object\.distribution | string | +action\_result\.data\.\*\.Attribute\.\*\.Object\.id | string | +action\_result\.data\.\*\.Attribute\.\*\.Object\.sharing\_group\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.category | string | +action\_result\.data\.\*\.Attribute\.\*\.comment | string | +action\_result\.data\.\*\.Attribute\.\*\.deleted | numeric | +action\_result\.data\.\*\.Attribute\.\*\.disable\_correlation | numeric | +action\_result\.data\.\*\.Attribute\.\*\.distribution | string | +action\_result\.data\.\*\.Attribute\.\*\.event\_id | string | `misp event id` +action\_result\.data\.\*\.Attribute\.\*\.first\_seen | string | +action\_result\.data\.\*\.Attribute\.\*\.id | string | `misp attribute id` +action\_result\.data\.\*\.Attribute\.\*\.last\_seen | string | +action\_result\.data\.\*\.Attribute\.\*\.object\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.object\_relation | string | +action\_result\.data\.\*\.Attribute\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.timestamp | string | +action\_result\.data\.\*\.Attribute\.\*\.to\_ids | boolean | +action\_result\.data\.\*\.Attribute\.\*\.type | string | +action\_result\.data\.\*\.Attribute\.\*\.uuid | string | +action\_result\.data\.\*\.Attribute\.\*\.value | string | `url` `domain` `ip` `email` `hash` `md5` `sha256` `md1` +action\_result\.data\.\*\.\*\.Event\.id | string | +action\_result\.data\.\*\.\*\.Event\.Org\.id | string | +action\_result\.data\.\*\.\*\.Event\.Org\.name | string | +action\_result\.data\.\*\.\*\.Event\.Org\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.Org\.local | numeric | +action\_result\.data\.\*\.\*\.Event\.Orgc\.id | string | +action\_result\.data\.\*\.\*\.Event\.Orgc\.name | string | +action\_result\.data\.\*\.\*\.Event\.Orgc\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.Orgc\.local | numeric | +action\_result\.data\.\*\.\*\.Event\.date | string | +action\_result\.data\.\*\.\*\.Event\.info | string | +action\_result\.data\.\*\.\*\.Event\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.locked | numeric | +action\_result\.data\.\*\.\*\.Event\.org\_id | string | +action\_result\.data\.\*\.\*\.Event\.orgc\_id | string | +action\_result\.data\.\*\.\*\.Event\.analysis | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.id | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.type | string | `url` +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.value | string | `url` `domain` `ip` `email` `hash` `md5` `sha256` `md1` +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.to\_ids | numeric | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.comment | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.deleted | numeric | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.category | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.event\_id | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.last\_seen | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.object\_id | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.timestamp | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.first\_seen | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.distribution | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.object\_relation | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.\*\.Event\.Attribute\.\*\.disable\_correlation | numeric | +action\_result\.data\.\*\.\*\.Event\.published | numeric | +action\_result\.data\.\*\.\*\.Event\.timestamp | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.id | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.Org\.id | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.Org\.name | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.Org\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.Orgc\.id | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.Orgc\.name | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.Orgc\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.date | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.info | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.org\_id | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.orgc\_id | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.analysis | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.published | numeric | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.timestamp | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.distribution | string | +action\_result\.data\.\*\.\*\.Event\.RelatedEvent\.\*\.Event\.threat\_level\_id | string | +action\_result\.data\.\*\.\*\.Event\.distribution | string | +action\_result\.data\.\*\.\*\.Event\.extends\_uuid | string | +action\_result\.data\.\*\.\*\.Event\.attribute\_count | string | +action\_result\.data\.\*\.\*\.Event\.threat\_level\_id | string | +action\_result\.data\.\*\.\*\.Event\.sharing\_group\_id | string | +action\_result\.data\.\*\.\*\.Event\.publish\_timestamp | string | +action\_result\.data\.\*\.\*\.Event\.disable\_correlation | numeric | +action\_result\.data\.\*\.\*\.Event\.event\_creator\_email | string | `email` +action\_result\.data\.\*\.\*\.Event\.proposal\_email\_lock | numeric | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.id | string | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.name | string | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.local | numeric | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.colour | string | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.user\_id | string | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.hide\_tag | numeric | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.is\_galaxy | numeric | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.exportable | numeric | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.numerical\_value | string | +action\_result\.data\.\*\.\*\.Event\.Tag\.\*\.is\_custom\_galaxy | numeric | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.name | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.comment | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.deleted | numeric | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.event\_id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.type | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.uuid | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.value | string | `url` `domain` `ip` `email` `hash` `md5` `sha256` `md1` +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.to\_ids | numeric | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.comment | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.deleted | numeric | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.category | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.event\_id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.last\_seen | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.object\_id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.timestamp | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.first\_seen | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.distribution | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.object\_relation | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.Attribute\.\*\.disable\_correlation | numeric | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.last\_seen | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.timestamp | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.first\_seen | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.description | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.distribution | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.meta\-category | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.template\_uuid | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.\*\.Event\.Object\.\*\.template\_version | string | +action\_result\.data\.\*\.attribute\_count | string | +action\_result\.summary | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | + +## action: 'get attributes' +Get attributes for a specific event + +Type: **investigate** +Read only: **True** + +download\_samples will only download files which are marked as a 'malware\-sample'\. + +#### Action Parameters +PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS +--------- | -------- | ----------- | ---- | -------- +**event\_id** | required | An Event ID | numeric | `misp event id` +**download\_samples** | optional | Download malware samples to vault | boolean | + +#### Action Output +DATA PATH | TYPE | CONTAINS +--------- | ---- | -------- +action\_result\.status | string | +action\_result\.parameter\.download\_samples | boolean | +action\_result\.parameter\.event\_id | numeric | `misp event id` +action\_result\.data\.\*\.Attribute\.\*\.Event\.distribution | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.id | string | `misp event id` +action\_result\.data\.\*\.Attribute\.\*\.Event\.info | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.org\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.orgc\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.Event\.uuid | string | +action\_result\.data\.\*\.Attribute\.\*\.Object\.distribution | string | +action\_result\.data\.\*\.Attribute\.\*\.Object\.id | string | +action\_result\.data\.\*\.Attribute\.\*\.Object\.sharing\_group\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.category | string | +action\_result\.data\.\*\.Attribute\.\*\.comment | string | +action\_result\.data\.\*\.Attribute\.\*\.deleted | boolean | +action\_result\.data\.\*\.Attribute\.\*\.disable\_correlation | boolean | +action\_result\.data\.\*\.Attribute\.\*\.distribution | string | +action\_result\.data\.\*\.Attribute\.\*\.event\_id | string | `misp event id` +action\_result\.data\.\*\.Attribute\.\*\.first\_seen | string | +action\_result\.data\.\*\.Attribute\.\*\.id | string | `misp attribute id` +action\_result\.data\.\*\.Attribute\.\*\.last\_seen | string | +action\_result\.data\.\*\.Attribute\.\*\.object\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.object\_relation | string | +action\_result\.data\.\*\.Attribute\.\*\.sharing\_group\_id | string | +action\_result\.data\.\*\.Attribute\.\*\.timestamp | string | +action\_result\.data\.\*\.Attribute\.\*\.to\_ids | boolean | +action\_result\.data\.\*\.Attribute\.\*\.type | string | +action\_result\.data\.\*\.Attribute\.\*\.uuid | string | +action\_result\.data\.\*\.Attribute\.\*\.value | string | `url` `domain` `ip` `email` `hash` `md5` `sha256` `md1` +action\_result\.summary | string | +action\_result\.message | string | +summary\.total\_objects | numeric | +summary\.total\_objects\_successful | numeric | \ No newline at end of file diff --git a/__init__.py b/__init__.py index 8cd278d..7a7c38d 100644 --- a/__init__.py +++ b/__init__.py @@ -1,9 +1,14 @@ -# -- # File: __init__.py # -# Copyright (c) 2017-2021 Splunk Inc. +# Copyright (c) 2017-2022 Splunk Inc. # -# SPLUNK CONFIDENTIAL - Use or disclosure of this material in whole or in part -# without a valid written license from Splunk Inc. is PROHIBITED. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at # -# -- +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, +# either express or implied. See the License for the specific language governing permissions +# and limitations under the License. diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 6150455..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,24 +0,0 @@ -version: "3.2" - -services: - app_tester: - image: repo.splunk.com/splunk/infra/phantom_apps_tester:${IMAGE_TAG:-latest} - environment: - BUILD_USER_ID: ${USER:-localbuild} - TEST_BRANCH: ${TEST_BRANCH:-master} - WORKSPACE: /builds/phantom-apps - volumes: - - .:/builds/phantom-apps/${APP_REPO_NAME} - command: sleep 28800 - secrets: - - app_artf_token - - app_deploy_key - - gitlab_api_token - -secrets: - app_artf_token: - file: ~/.docker/secrets/app_artf_token - app_deploy_key: - file: ~/.docker/secrets/app_deploy_key - gitlab_api_token: - file: ~/.docker/secrets/gitlab_api_token diff --git a/exclude_files.txt b/exclude_files.txt index 4c81ebc..e9cafef 100644 --- a/exclude_files.txt +++ b/exclude_files.txt @@ -2,4 +2,4 @@ docker-compose.yml Makefile .git* .gitlab-ci.yml -whitesource-results \ No newline at end of file +whitesource-results diff --git a/misp.json b/misp.json index 97b03f7..eadd1dd 100644 --- a/misp.json +++ b/misp.json @@ -5,14 +5,15 @@ "publisher": "Splunk", "package_name": "phantom_misp", "type": "threat intel", - "license": "Copyright (c) 2017-2021 Splunk Inc.", + "license": "Copyright (c) 2017-2022 Splunk Inc.", "main_module": "misp_connector.py", - "app_version": "2.1.5", - "utctime_updated": "2021-07-12T05:53:08.000000Z", + "app_version": "2.1.7", + "utctime_updated": "2022-02-03T21:33:46.000000Z", "product_vendor": "MISP", "product_name": "MISP", "product_version_regex": ".*", - "min_phantom_version": "4.9.39220", + "min_phantom_version": "5.1.0", + "fips_compliant": true, "python_version": "3", "latest_tested_versions": [ "On-prem, Version 2.4.140" @@ -22,20 +23,84 @@ "pip_dependencies": { "wheel": [ { - "module": "pymisp", - "input_file": "wheels/pymisp-2.4.138-py3-none-any.whl" + "module": "Deprecated", + "input_file": "wheels/shared/Deprecated-1.2.12-py2.py3-none-any.whl" }, { - "module": "jsonschema", - "input_file": "wheels/jsonschema-3.2.0-py2.py3-none-any.whl" + "module": "attrs", + "input_file": "wheels/shared/attrs-21.4.0-py2.py3-none-any.whl" }, { - "module": "deprecated", - "input_file": "wheels/Deprecated-1.2.12-py2.py3-none-any.whl" + "module": "beautifulsoup4", + "input_file": "wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl" }, { "module": "cachetools", - "input_file": "wheels/cachetools-4.2.2-py3-none-any.whl" + "input_file": "wheels/py3/cachetools-4.2.2-py3-none-any.whl" + }, + { + "module": "certifi", + "input_file": "wheels/shared/certifi-2021.10.8-py2.py3-none-any.whl" + }, + { + "module": "chardet", + "input_file": "wheels/shared/chardet-3.0.4-py2.py3-none-any.whl" + }, + { + "module": "idna", + "input_file": "wheels/shared/idna-2.10-py2.py3-none-any.whl" + }, + { + "module": "importlib_metadata", + "input_file": "wheels/py3/importlib_metadata-4.8.3-py3-none-any.whl" + }, + { + "module": "jsonschema", + "input_file": "wheels/shared/jsonschema-3.2.0-py2.py3-none-any.whl" + }, + { + "module": "pymisp", + "input_file": "wheels/py3/pymisp-2.4.138-py3-none-any.whl" + }, + { + "module": "pyrsistent", + "input_file": "wheels/py36/pyrsistent-0.18.0-cp36-cp36m-manylinux1_x86_64.manylinux_2_5_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl" + }, + { + "module": "python_dateutil", + "input_file": "wheels/shared/python_dateutil-2.8.2-py2.py3-none-any.whl" + }, + { + "module": "requests", + "input_file": "wheels/shared/requests-2.25.0-py2.py3-none-any.whl" + }, + { + "module": "setuptools", + "input_file": "wheels/py3/setuptools-59.6.0-py3-none-any.whl" + }, + { + "module": "six", + "input_file": "wheels/shared/six-1.16.0-py2.py3-none-any.whl" + }, + { + "module": "soupsieve", + "input_file": "wheels/py3/soupsieve-2.3.1-py3-none-any.whl" + }, + { + "module": "typing_extensions", + "input_file": "wheels/py3/typing_extensions-4.0.1-py3-none-any.whl" + }, + { + "module": "urllib3", + "input_file": "wheels/shared/urllib3-1.26.8-py2.py3-none-any.whl" + }, + { + "module": "wrapt", + "input_file": "wheels/py36/wrapt-1.13.3-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl" + }, + { + "module": "zipp", + "input_file": "wheels/py3/zipp-3.6.0-py3-none-any.whl" } ] }, @@ -2317,5 +2382,77 @@ ], "versions": "EQ(*)" } - ] + ], + "pip39_dependencies": { + "wheel": [ + { + "module": "Deprecated", + "input_file": "wheels/shared/Deprecated-1.2.12-py2.py3-none-any.whl" + }, + { + "module": "attrs", + "input_file": "wheels/shared/attrs-21.4.0-py2.py3-none-any.whl" + }, + { + "module": "beautifulsoup4", + "input_file": "wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl" + }, + { + "module": "cachetools", + "input_file": "wheels/py3/cachetools-4.2.2-py3-none-any.whl" + }, + { + "module": "certifi", + "input_file": "wheels/shared/certifi-2021.10.8-py2.py3-none-any.whl" + }, + { + "module": "chardet", + "input_file": "wheels/shared/chardet-3.0.4-py2.py3-none-any.whl" + }, + { + "module": "idna", + "input_file": "wheels/shared/idna-2.10-py2.py3-none-any.whl" + }, + { + "module": "jsonschema", + "input_file": "wheels/shared/jsonschema-3.2.0-py2.py3-none-any.whl" + }, + { + "module": "pymisp", + "input_file": "wheels/py3/pymisp-2.4.138-py3-none-any.whl" + }, + { + "module": "pyrsistent", + "input_file": "wheels/py39/pyrsistent-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl" + }, + { + "module": "python_dateutil", + "input_file": "wheels/shared/python_dateutil-2.8.2-py2.py3-none-any.whl" + }, + { + "module": "requests", + "input_file": "wheels/shared/requests-2.25.0-py2.py3-none-any.whl" + }, + { + "module": "setuptools", + "input_file": "wheels/py3/setuptools-60.7.0-py3-none-any.whl" + }, + { + "module": "six", + "input_file": "wheels/shared/six-1.16.0-py2.py3-none-any.whl" + }, + { + "module": "soupsieve", + "input_file": "wheels/py3/soupsieve-2.3.1-py3-none-any.whl" + }, + { + "module": "urllib3", + "input_file": "wheels/shared/urllib3-1.26.8-py2.py3-none-any.whl" + }, + { + "module": "wrapt", + "input_file": "wheels/py39/wrapt-1.13.3-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl" + } + ] + } } \ No newline at end of file diff --git a/misp_connector.py b/misp_connector.py index 346ee98..068724a 100644 --- a/misp_connector.py +++ b/misp_connector.py @@ -1,28 +1,35 @@ -# -- # File: misp_connector.py # -# Copyright (c) 2017-2021 Splunk Inc. +# Copyright (c) 2017-2022 Splunk Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, +# either express or implied. See the License for the specific language governing permissions +# and limitations under the License. # -# SPLUNK CONFIDENTIAL - Use or disclosure of this material in whole or in part -# without a valid written license from Splunk Inc. is PROHIBITED. # -# -- - # Phantom App imports +import ipaddress +import json + import phantom.app as phantom -from phantom.base_connector import BaseConnector +import phantom.rules as ph_rules +import phantom.utils as ph_utils +import requests +from bs4 import BeautifulSoup from phantom.action_result import ActionResult +from phantom.base_connector import BaseConnector from phantom.vault import Vault -import phantom.utils as ph_utils -import phantom.rules as ph_rules +from pymisp import MISPEvent, PyMISP # Imports local to this App from misp_consts import * -import json -import requests -from bs4 import BeautifulSoup -from pymisp import PyMISP, MISPEvent -import ipaddress # This patching is required because the PyMISP API sets the verify flag as a @@ -735,6 +742,7 @@ def handle_action(self, param): if __name__ == '__main__': import sys + import pudb # Breakpoint at runtime @@ -742,7 +750,7 @@ def handle_action(self, param): if len(sys.argv) < 2: print("No test json specified as input") - exit(0) + sys.exit(0) with open(sys.argv[1]) as f: in_json = f.read() @@ -753,4 +761,4 @@ def handle_action(self, param): ret_val = connector._handle_action(json.dumps(in_json), None) print(json.dumps(json.loads(ret_val), indent=4)) - exit(0) + sys.exit(0) diff --git a/misp_consts.py b/misp_consts.py index 5789c7f..f21388a 100644 --- a/misp_consts.py +++ b/misp_consts.py @@ -1,10 +1,17 @@ # File: misp_consts.py -# Copyright (c) 2017-2021 Splunk Inc. # -# SPLUNK CONFIDENTIAL - Use or disclosure of this material in whole or in part -# without a valid written license from Splunk Inc. is PROHIBITED. +# Copyright (c) 2017-2022 Splunk Inc. # - +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, +# either express or implied. See the License for the specific language governing permissions +# and limitations under the License. MISP_INVALID_INT_ERR = "Please provide a valid {msg} integer value in the {param}" MISP_INVALID_EVENT_ID = "'event_id' action parameter" MISP_INVALID_MAX_RESULT = "'max_result' action parameter" diff --git a/readme.html b/readme.html index b192626..d046b22 100644 --- a/readme.html +++ b/readme.html @@ -1,11 +1,16 @@ - @@ -86,4 +91,4 @@

cachetools-4.2.2

"tag1, tag11" will be considered a single tag.

- \ No newline at end of file + diff --git a/release_notes/1.0.12.md b/release_notes/1.0.12.md new file mode 100644 index 0000000..85b6b53 --- /dev/null +++ b/release_notes/1.0.12.md @@ -0,0 +1,6 @@ +**MISP Release Notes - Published by Splunk September 27, 2017** + + +**Version 1.0.12 - Released September 27, 2017** + +* Initial release diff --git a/release_notes/1.0.14.md b/release_notes/1.0.14.md new file mode 100644 index 0000000..f6cbc13 --- /dev/null +++ b/release_notes/1.0.14.md @@ -0,0 +1,6 @@ +**MISP Release Notes - Published by Splunk February 07, 2018** + + +**Version 1.0.14 - Released February 07, 2018** + +* App action views and Logo updates diff --git a/release_notes/1.0.19.md b/release_notes/1.0.19.md new file mode 100644 index 0000000..decb81b --- /dev/null +++ b/release_notes/1.0.19.md @@ -0,0 +1,6 @@ +**MISP Release Notes - Published by Splunk January 18, 2019** + + +**Version 1.0.19 - Released January 18, 2019** + +* Compatibility updates for next Phantom release diff --git a/release_notes/2.0.4.md b/release_notes/2.0.4.md new file mode 100644 index 0000000..d3e7275 --- /dev/null +++ b/release_notes/2.0.4.md @@ -0,0 +1,7 @@ +**MISP Release Notes - Published by Splunk February 05, 2021** + + +**Version 2.0.4 - Released February 05, 2021** + +* Compatibility changes for Python 3 support +* Fixed output view for the 'create event' action diff --git a/release_notes/2.1.5.md b/release_notes/2.1.5.md new file mode 100644 index 0000000..5f42eea --- /dev/null +++ b/release_notes/2.1.5.md @@ -0,0 +1,9 @@ +**MISP Release Notes - Published by Splunk July 12, 2021** + + +**Version 2.1.5 - Released July 12, 2021** + +* Bug fixes in 'run query' action for filter parameter [PAPP-10889] +* Handled extra commas in event\_id parameter of 'run query' action +* Bugfix in Create event and Update event action to pass attribute value having commas in JSON parameter +* Datapath contains improvements diff --git a/release_notes/2.1.7.md b/release_notes/2.1.7.md new file mode 100644 index 0000000..9319b29 --- /dev/null +++ b/release_notes/2.1.7.md @@ -0,0 +1,7 @@ +**MISP Release Notes - Published by Splunk February 03, 2022** + + +**Version 2.1.7 - Released February 03, 2022** + +* Added support for Python 3.9 +* Marked the app as FIPS Compliant [PAPP-21839] diff --git a/release_notes/release_notes.html b/release_notes/release_notes.html new file mode 100644 index 0000000..b85ae5f --- /dev/null +++ b/release_notes/release_notes.html @@ -0,0 +1,31 @@ +MISP Release Notes - Published by Splunk February 03, 2022 +

+Version 2.1.7 - Released February 03, 2022 + +Version 2.1.5 - Released July 12, 2021 + +Version 2.0.4 - Released February 05, 2021 + +Version 1.0.19 - Released January 18, 2019 + +Version 1.0.14 - Released February 07, 2018 + +Version 1.0.12 - Released September 27, 2017 + diff --git a/release_notes/unreleased.md b/release_notes/unreleased.md new file mode 100644 index 0000000..fbcb2fd --- /dev/null +++ b/release_notes/unreleased.md @@ -0,0 +1 @@ +**Unreleased** diff --git a/requirements.txt b/requirements.txt index 4a966b6..4c97589 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,6 @@ -pymisp==2.4.138 -jsonschema==3.2.0 -Deprecated==1.2.12 +beautifulsoup4==4.9.1 cachetools==4.2.2 +Deprecated==1.2.12 +jsonschema==3.2.0 +pymisp==2.4.138 +requests==2.25.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..127a08b --- /dev/null +++ b/tox.ini @@ -0,0 +1,7 @@ +[flake8] +max-line-length = 145 +max-complexity = 28 +ignore = F403,E128,E126,E111,E121,E127,E731,E201,E202,F405,E722,D,W292 + +[isort] +line_length = 145 diff --git a/wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl b/wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl new file mode 100644 index 0000000..080b2f8 Binary files /dev/null and b/wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl differ diff --git a/wheels/cachetools-4.2.2-py3-none-any.whl b/wheels/py3/cachetools-4.2.2-py3-none-any.whl similarity index 100% rename from wheels/cachetools-4.2.2-py3-none-any.whl rename to wheels/py3/cachetools-4.2.2-py3-none-any.whl diff --git a/wheels/py3/importlib_metadata-4.8.3-py3-none-any.whl b/wheels/py3/importlib_metadata-4.8.3-py3-none-any.whl new file mode 100644 index 0000000..42f9532 Binary files /dev/null and b/wheels/py3/importlib_metadata-4.8.3-py3-none-any.whl differ diff --git a/wheels/pymisp-2.4.138-py3-none-any.whl b/wheels/py3/pymisp-2.4.138-py3-none-any.whl similarity index 100% rename from wheels/pymisp-2.4.138-py3-none-any.whl rename to wheels/py3/pymisp-2.4.138-py3-none-any.whl diff --git a/wheels/py3/setuptools-59.6.0-py3-none-any.whl b/wheels/py3/setuptools-59.6.0-py3-none-any.whl new file mode 100644 index 0000000..08d7e94 Binary files /dev/null and b/wheels/py3/setuptools-59.6.0-py3-none-any.whl differ diff --git a/wheels/py3/setuptools-60.7.0-py3-none-any.whl b/wheels/py3/setuptools-60.7.0-py3-none-any.whl new file mode 100644 index 0000000..1344f6d Binary files /dev/null and b/wheels/py3/setuptools-60.7.0-py3-none-any.whl differ diff --git a/wheels/py3/soupsieve-2.3.1-py3-none-any.whl b/wheels/py3/soupsieve-2.3.1-py3-none-any.whl new file mode 100644 index 0000000..85d33de Binary files /dev/null and b/wheels/py3/soupsieve-2.3.1-py3-none-any.whl differ diff --git a/wheels/py3/typing_extensions-4.0.1-py3-none-any.whl b/wheels/py3/typing_extensions-4.0.1-py3-none-any.whl new file mode 100644 index 0000000..65500a1 Binary files /dev/null and b/wheels/py3/typing_extensions-4.0.1-py3-none-any.whl differ diff --git a/wheels/py3/zipp-3.6.0-py3-none-any.whl b/wheels/py3/zipp-3.6.0-py3-none-any.whl new file mode 100644 index 0000000..bc23f25 Binary files /dev/null and b/wheels/py3/zipp-3.6.0-py3-none-any.whl differ diff --git a/wheels/py36/pyrsistent-0.18.0-cp36-cp36m-manylinux1_x86_64.manylinux_2_5_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl b/wheels/py36/pyrsistent-0.18.0-cp36-cp36m-manylinux1_x86_64.manylinux_2_5_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl new file mode 100644 index 0000000..481938c Binary files /dev/null and b/wheels/py36/pyrsistent-0.18.0-cp36-cp36m-manylinux1_x86_64.manylinux_2_5_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl differ diff --git a/wheels/py36/wrapt-1.13.3-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl b/wheels/py36/wrapt-1.13.3-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl new file mode 100644 index 0000000..afc3e02 Binary files /dev/null and b/wheels/py36/wrapt-1.13.3-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl differ diff --git a/wheels/py39/pyrsistent-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl b/wheels/py39/pyrsistent-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl new file mode 100644 index 0000000..22e3f17 Binary files /dev/null and b/wheels/py39/pyrsistent-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl differ diff --git a/wheels/py39/wrapt-1.13.3-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl b/wheels/py39/wrapt-1.13.3-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl new file mode 100644 index 0000000..0dec361 Binary files /dev/null and b/wheels/py39/wrapt-1.13.3-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl differ diff --git a/wheels/Deprecated-1.2.12-py2.py3-none-any.whl b/wheels/shared/Deprecated-1.2.12-py2.py3-none-any.whl similarity index 100% rename from wheels/Deprecated-1.2.12-py2.py3-none-any.whl rename to wheels/shared/Deprecated-1.2.12-py2.py3-none-any.whl diff --git a/wheels/shared/attrs-21.4.0-py2.py3-none-any.whl b/wheels/shared/attrs-21.4.0-py2.py3-none-any.whl new file mode 100644 index 0000000..097aacc Binary files /dev/null and b/wheels/shared/attrs-21.4.0-py2.py3-none-any.whl differ diff --git a/wheels/shared/certifi-2021.10.8-py2.py3-none-any.whl b/wheels/shared/certifi-2021.10.8-py2.py3-none-any.whl new file mode 100644 index 0000000..fbcb86b Binary files /dev/null and b/wheels/shared/certifi-2021.10.8-py2.py3-none-any.whl differ diff --git a/wheels/shared/chardet-3.0.4-py2.py3-none-any.whl b/wheels/shared/chardet-3.0.4-py2.py3-none-any.whl new file mode 100644 index 0000000..d276977 Binary files /dev/null and b/wheels/shared/chardet-3.0.4-py2.py3-none-any.whl differ diff --git a/wheels/shared/idna-2.10-py2.py3-none-any.whl b/wheels/shared/idna-2.10-py2.py3-none-any.whl new file mode 100644 index 0000000..41225cb Binary files /dev/null and b/wheels/shared/idna-2.10-py2.py3-none-any.whl differ diff --git a/wheels/jsonschema-3.2.0-py2.py3-none-any.whl b/wheels/shared/jsonschema-3.2.0-py2.py3-none-any.whl similarity index 100% rename from wheels/jsonschema-3.2.0-py2.py3-none-any.whl rename to wheels/shared/jsonschema-3.2.0-py2.py3-none-any.whl diff --git a/wheels/shared/python_dateutil-2.8.2-py2.py3-none-any.whl b/wheels/shared/python_dateutil-2.8.2-py2.py3-none-any.whl new file mode 100644 index 0000000..8ffb923 Binary files /dev/null and b/wheels/shared/python_dateutil-2.8.2-py2.py3-none-any.whl differ diff --git a/wheels/shared/requests-2.25.0-py2.py3-none-any.whl b/wheels/shared/requests-2.25.0-py2.py3-none-any.whl new file mode 100644 index 0000000..c3f28e5 Binary files /dev/null and b/wheels/shared/requests-2.25.0-py2.py3-none-any.whl differ diff --git a/wheels/shared/six-1.16.0-py2.py3-none-any.whl b/wheels/shared/six-1.16.0-py2.py3-none-any.whl new file mode 100644 index 0000000..fd94265 Binary files /dev/null and b/wheels/shared/six-1.16.0-py2.py3-none-any.whl differ diff --git a/wheels/shared/urllib3-1.26.8-py2.py3-none-any.whl b/wheels/shared/urllib3-1.26.8-py2.py3-none-any.whl new file mode 100644 index 0000000..bad52ab Binary files /dev/null and b/wheels/shared/urllib3-1.26.8-py2.py3-none-any.whl differ