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

[IN-152] Automox XSOAR Documentation #3

Merged
merged 10 commits into from
Mar 24, 2022

Conversation

ax-jmiller
Copy link
Owner

Contributing to Cortex XSOAR Content

Make sure to register your contribution by filling the contribution registration form

The Pull Request will be reviewed only after the contribution registration form is filled.

Status

  • In Progress
  • Ready
  • In Hold - (Reason for hold)

Related Issues

fixes: link to the issue

Description

A few sentences describing the overall goals of the pull request's commits.

Screenshots

Paste here any images that will help the reviewer

Minimum version of Cortex XSOAR

  • 6.0.0
  • 6.1.0
  • 6.2.0
  • 6.5.0

Does it break backward compatibility?

  • Yes
    • Further details:
  • No

Must have

  • Tests
  • Documentation

@ax-jmiller ax-jmiller marked this pull request as ready for review March 23, 2022 18:48
Copy link
Collaborator

@ax-tschmidtke ax-tschmidtke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

Packs/Automox/Integrations/Automox/Automox.py Show resolved Hide resolved
Packs/Automox/pack_metadata.json Outdated Show resolved Hide resolved
Packs/Automox/pack_metadata.json Show resolved Hide resolved
Packs/Automox/README.md Outdated Show resolved Hide resolved
Packs/Automox/README.md Show resolved Hide resolved
Packs/Automox/README.md Outdated Show resolved Hide resolved
@ax-jmiller ax-jmiller requested a review from ax-zyoutz March 24, 2022 18:08
Copy link
Collaborator

@ax-zyoutz ax-zyoutz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@ax-jmiller ax-jmiller merged commit 74fdf10 into master Mar 24, 2022
@ax-jmiller ax-jmiller deleted the IN-152-automox-xsoar-documentation branch March 24, 2022 18:35
ax-jmiller added a commit that referenced this pull request May 23, 2022
* Automox Content Pack for XSOAR (#1)

* IN-104 Implemented commands related to Administration and Vulnerability Sync use cases.

* [IN-149] Adding Vulnerability Upload Playbook (#2)

Added playbook to automate report uploads

* [IN-152] Automox XSOAR Documentation (#3)

Added documentation for Playbook, Integration, and Pack

* IN-166 Automox XSOAR Unit Tests (#4)

* Adding unit tests

* Reviewed checklist for XSOAR submission

* Cleaning up integration test files

* Fixed validation issues with playbook

* Updated README and Integration yaml to be consistent with args in Python. Fixed issues with fromversion and tests in Integration yaml.

* Playbook documentation updates regarding supported csv formats

* Present errors in a pleasant and readable way. Handled basic http fail codes

* Updated delete commands to update objects in the context with deleted key

* Removed test playbook from integration yaml

Co-authored-by: MLainer1 <[email protected]>

* Added Automox integration instrumentation

* Fixed docker image version and schema validation in integration yaml

Co-authored-by: MLainer1 <[email protected]>

Co-authored-by: Jack Miller <[email protected]>
Co-authored-by: MLainer1 <[email protected]>
ax-jmiller pushed a commit that referenced this pull request May 23, 2022
)

* Added new files:
- MSDE playbooks for isolation and unisolations
- new images of all playbooks
- README files

Modified:
- Common playbooks for isolation and unisolation

* .

* Update RN

* Changes on the PB for dealing with incorrect Device IDs

* Changes on the PB - adding support for Hostname and IP

* Updated RN

* Fixed Issue with Task #3 in the Unisolate (filters were incorrect).

* Additional fix - added else on task 26

* Applied PR comments

* Applied PR comments

* Applied PR comments

* Updated RN for MSDE pack

* Fixed issues with validation

* Changed "devices" --> "device"

* Added !endpoint instead the enrichment that was done through the native MSDE commands

* Fixed conflicts + Updated RN

* Fix Format issues

* Fix RN issues

* Fix dependencies

* Fix dependencies

* Updated RN

* Updated RN

* Merge from master + Resolve conflicts + Resolve comments

* Updated RN

* Update playbook-Isolate_Endpoint_-_Generic_V2.yml

Doc review complete for this file, updated descriptions.

* Update playbook-Isolate_Endpoint_-_Generic_V2_README.md

doc review complete for this file. Updated descriptions to align with the yaml file.

* Update playbook-Isolate_Endpoint_-_Generic_V2.yml

minor additional update

* Update playbook-Unisolate_Endpoint_-_Generic.yml

Doc review complete for this file, updated descriptions.

* Update playbook-Unisolate_Endpoint_-_Generic_README.md

Doc review complete for this file, aligned the descriptions with the yaml file.

* Update 2_2_0.md

Doc review complete for this file, minor formatting updates.

* Update playbook-Microsoft_Defender_For_Endpoint_-_Isolate_Endpoint.yml

Doc review complete for the playbook-Microsoft_Defender_For_Endpoint_-_Isolate_Endpoint.yml file. @ssokolovich please confirm the following:
- Lines 314, 368, 591, 645, 695 - the description for **Set Active Device** , **Set Non-valid Devices**, **Set Incorrect ID**, **Set Incorrect IP**, **Set Incorrect Hostname**  is "Set a value in context under the key you entered. If no value is entered, the script doesn't do anything.
        This automation runs using the default Limited User role, unless you explicitly change the permissions.
        For more information, see the section about permissions here:
        https://docs.paloaltonetworks.com/cortex/cortex-xsoar/6-2/cortex-xsoar-admin/playbooks/automations.html"
        
        This description is generic - should there be descriptions specific to these tasks?

- Line 500 - the description for **Check if there is any provided incorrect info** is "Check if there are any incorrect device IDs." - is this correct (incorrect info = incorrect device ID)?
- Line 903 - the description for **Was any data provided?** is "'Validate/Enrich inputs through !endpoint'" - this looks like a boolean task. Is it that if it returns yes, then the playbook returns the data?

* Update playbook-Microsoft_Defender_For_Endpoint_-_Unisolate_Endpoint.yml

Doc review complete for the playbook-Microsoft_Defender_For_Endpoint_-_Unisolate_Endpoint.yml file. @ssokolovich - please confirm the following:
- Lines 278, 333, 501, 551, 605 - the description for **Set Unisolate list**, **Set Inactive Device list**, **Set Incorrect IP**, **Set Incorrect Hostname**, **Set Incorrect ID** is generic, should it be more specific?
- Line 399 - the simple description for  **Print those that can't be unisolated as are not active** is "The following devices can't be isolated...." - shouldn't it be "The following devices can't be unisolated..."?
- Line 659 - the description for **Check if there is any provided incorrect info** is "Check if there are any incorrect device IDs." - is incorrect info = incorrect device ID?
- Line 904 - the description for **Was any data provided?** is "'Validate/Enrich inputs through !endpoint'" - is this description correct?

* Update 1_6_2.md

doc review complete for this file. Minor formatting update

* Update 1_6_3.md

doc review complete for this file, minor formatting update

* Update 1_6_2.md

additional minor update

* Update 1_7_0.md

doc review complete for this file, aligned descriptions with the yaml files.

* Update RN

* Update Yml description

* Update Yml description

Co-authored-by: julieschwartz18 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants