xsoar-cli 0.0.3__py3-none-any.whl

xsoar_cli/utilities.py

@@ -0,0 +1,94 @@
+import json
+from functools import update_wrapper
+from pathlib import Path
+from typing import Callable
+
+import click
+from xsoar_client.xsoar_client import Client
+
+
+def get_config_file_template_contents() -> dict:
+    return {
+        "default_environment": "dev",
+        "default_new_case_type": "",
+        "custom_pack_authors": ["SOMEONE"],
+        "server_config": {
+            "dev": {
+                "base_url": "https://xsoar.example.com",
+                "api_token": "YOUR API TOKEN HERE",
+                "artifacts_location": "S3",
+                "s3_bucket_name": "xsoar-cicd",
+                "verify_ssl": "/path/to/your/CA_bundle.pem",
+                "server_version": 6,
+            },
+            "prod": {
+                "base_url": "https://xsoar.example.com",
+                "api_token": "YOUR API TOKEN HERE",
+                "artifacts_location": "S3",
+                "s3_bucket_name": "xsoar-cicd-prod",
+                "verify_ssl": False,
+                "server_version": 6,
+            },
+        },
+    }
+
+
+def validate_environments(*args, **kwargs) -> bool:  # noqa: ANN002, ANN003
+    return all(env in kwargs["ctx"].obj["server_envs"] for env in args)
+
+
+def get_config_file_path() -> Path:
+    homedir = Path.home()
+    config_file_path = homedir / ".config/xsoar-cli"
+    config_file_name = "config.json"
+    return Path(config_file_path / config_file_name)
+
+
+def get_config_file_contents(filepath: Path):  # noqa: ANN201
+    return json.load(filepath.open("r"))
+
+
+def load_config(f: Callable) -> Callable:
+    """
+    This function is only to be used as a decorator for various xsoar-cli subcommands. Loads and parses the config file if
+    exists, or prompts the user to create one otherwise.
+    If an illegal environment is provided by the user, i.e by invoking "xsoar-cli command --environment illegal subcommand",
+    then prints out helpful error message and returns non-zero exit value.
+    """
+
+    @click.pass_context
+    def wrapper(ctx: click.Context, *args, **kwargs) -> Callable:  # noqa: ANN002, ANN003
+        config_file_path = get_config_file_path()
+        if not config_file_path.is_file():
+            click.echo(
+                'Config file not found. Please create a template config file using "xsoar-cli config create" and replace placeholder values before retrying.',
+            )
+            ctx.exit(1)
+        config = get_config_file_contents(config_file_path)
+        parse_config(config, ctx)
+        if "environment" in ctx.params and ctx.params["environment"] not in ctx.obj["server_envs"]:
+            click.echo(f"Invalid environment: {ctx.params['environment']}")
+            click.echo(f"Available environments as defined in config file are: {list(ctx.obj['server_envs'])}")
+            ctx.exit(1)
+        return ctx.invoke(f, *args, **kwargs)
+
+    return update_wrapper(wrapper, f)
+
+
+def parse_config(config: dict, ctx: click.Context) -> None:
+    # Set the two XSOAR client objects in Click Context for use in later functions
+    ctx.obj = {}
+    ctx.obj["default_environment"] = config["default_environment"]
+    ctx.obj["custom_pack_authors"] = config["custom_pack_authors"]
+    ctx.obj["server_envs"] = {}
+    for key in config["server_config"]:
+        ctx.obj["server_envs"][key] = Client(
+            api_token=config["server_config"][key]["api_token"],
+            server_url=config["server_config"][key]["base_url"],
+            verify_ssl=config["server_config"][key]["verify_ssl"],
+            custom_pack_authors=config["custom_pack_authors"],
+            xsiam_auth_id=config["server_config"][key].get("xsiam_auth_id", ""),
+            server_version=config["server_config"][key]["server_version"],
+            artifacts_location=config["server_config"][key]["artifacts_location"],
+            s3_bucket_name=config["server_config"][key]["s3_bucket_name"],
+        )

xsoar_cli-0.0.3.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: xsoar-cli
+Version: 0.0.3
+Project-URL: Documentation, https://github.com/tlium/xsoar-cli#readme
+Project-URL: Issues, https://github.com/tliumb/xsoar-cli/issues
+Project-URL: Source, https://github.com/tlium/xsoar-cli
+Author-email: Torbjørn Lium <torben@lium.org>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: click==8.1.8
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: xsoar-client>=1.0.0
+Requires-Dist: xsoar-dependency-graph>=0.0.3
+Description-Content-Type: text/markdown
+
+# xsoar-cli
+-----
+This tool is made to help provide a smoother workflow for developers, but also for power users to get useful information out of XSOAR from
+the terminal. Merge requests are very welcome and appreciated!
+
+*IMPORTANT NOTE* This CLI tools is made to be run from the root of a content repository. Some commands depends on files located in your
+content repository or expects a certain directory structure to be available from your currently working directory.
+
+## Installation
+```
+pip install xsoar-cli
+```
+## Upgrading
+```
+pip install --upgrade xsoar-cli
+```
+
+
+## Configuration
+The xsoar-cli config file is located in `~/.config/xsoar-cli/config.json`. To create a configuration file from template, please run
+```
+xsoar-cli config create
+```
+Open up the newly created configuration file and add values that correspond with your environment.
+*IMPORTANT NOTE*: the configuration key `"custom_pack_authors": ["SOMEONE"]` is needed in order for `xsoar-cli` to be able to
+determine which content packs are your own custom content packs and which are supplied from Palo Alto upstream. Use whateve values you may have set in
+pack_metadata.json in the content packs in your content repository.
+
+## Usage
+```
+xsoar-cli <command> <sub-command> <args>
+```
+For information about available commands, run `xsoar-cli` without arguments.
+
+For more information on a specific command execute `xsoar-cli <command> --help.`
+
+### Commands
+1. [case](src/xsoar_cli/case/README.md)
+2. [config](src/xsoar_cli/config/README.md)
+3. [manifest](src/xsoar_cli/manifest/README.md)
+4. [pack](src/xsoar_cli/pack/README.md)
+5. [playbook](src/xsoar_cli/playbook/README.md)
+6. [plugins](src/xsoar_cli/plugins/README.md)
+
+## Plugin System
+
+xsoar-cli supports a plugin system that allows you to extend the CLI with custom commands. Plugins are Python files that you place in `~/.local/xsoar-cli/plugins/` and they're automatically discovered and loaded.
+
+### Quick Start with Plugins
+
+1. **Create an example plugin**:
+   ```bash
+   xsoar-cli plugins create-example
+   ```
+
+2. **List available plugins**:
+   ```bash
+   xsoar-cli plugins list
+   ```
+
+3. **Test the example plugin**:
+   ```bash
+   xsoar-cli example hello --name "World"
+   ```
+
+### Plugin Management Commands
+
+- `xsoar-cli plugins list` - List all plugins
+- `xsoar-cli plugins info <plugin>` - Show plugin information
+- `xsoar-cli plugins validate` - Validate all plugins
+- `xsoar-cli plugins reload <plugin>` - Reload a specific plugin
+- `xsoar-cli plugins create-example` - Create an example plugin
+- `xsoar-cli plugins open` - Open the plugins directory
+
+### Creating Your Own Plugins
+
+Create a Python file in `~/.local/xsoar-cli/plugins/` that inherits from `XSOARPlugin`:
+
+```python
+import click
+from xsoar_cli.plugins import XSOARPlugin
+
+class MyPlugin(XSOARPlugin):
+    @property
+    def name(self) -> str:
+        return "myplugin"
+
+    @property
+    def version(self) -> str:
+        return "1.0.0"
+
+    def get_command(self) -> click.Command:
+        @click.command(help="My custom command")
+        def mycommand():
+            click.echo("Hello from my plugin!")
+        return mycommand
+```
+
+For detailed documentation, see [Plugin System Documentation](src/xsoar_cli/plugins/README.md).
+
+## License
+
+`xsoar-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

xsoar_cli-0.0.3.dist-info/RECORD

@@ -0,0 +1,31 @@
+xsoar_cli/__about__.py,sha256=PoiGgrfyfU1ozayN6GC8FLvwV9BYI1Jnh0eokMjDDyI,127
+xsoar_cli/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+xsoar_cli/cli.py,sha256=iAlSeZe2iR6ciTVrJYLt-CDZk7b5I-hzHFXbYoXhupA,1342
+xsoar_cli/utilities.py,sha256=_gfgwBV5p1_QwNl6qw1fluO6kP7jGW_oItAEJnaR3rA,3860
+xsoar_cli/case/README.md,sha256=MTfgVeW3qJXRPNFo8CkZvulm2vwbN8sgiW86V-qXRFw,1342
+xsoar_cli/case/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xsoar_cli/case/commands.py,sha256=q1rHb8UQ0NvN6kLh6NRWla5s6qG35PV0xhIOIR325Eg,3233
+xsoar_cli/config/README.md,sha256=pcO858PDL9c0qtwj3_a6B8q2CGvcka3dwclVnwi2vlA,516
+xsoar_cli/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xsoar_cli/config/commands.py,sha256=SJqIBUBq4tHmnXusycXuIOkmHhyc-vKvQwFMjIHh3Cc,3884
+xsoar_cli/graph/README.md,sha256=kyWIGs2Sd-OdqAaCWJjyvGpAhXhFcuqQwVqFBgzgWzk,861
+xsoar_cli/graph/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xsoar_cli/graph/commands.py,sha256=LKOpUu8r6KThJ5HdyjZlhpwLKRgMcEu7btBOQXwDkMs,1069
+xsoar_cli/manifest/README.md,sha256=Ha84Ozlj7KwSj9FsK42sSZVYoWllmPKsjtkB-53Anpg,913
+xsoar_cli/manifest/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xsoar_cli/manifest/commands.py,sha256=jShmi0s7GOSXJt9DQbEoFSu4ZsC0Givv1vJj7qfwI2g,8697
+xsoar_cli/pack/README.md,sha256=CA7jAEphHxK0gh58rLRKL-u3wx29QgNAXojd_tGBXnY,46
+xsoar_cli/pack/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xsoar_cli/pack/commands.py,sha256=bLbKCC_TROqqysEfmk6G9qqKJuXkt0nqwUHoP_LauD8,1899
+xsoar_cli/playbook/README.md,sha256=8y_YhvZtLP7KzYG83jiVBF-wBAEh8UTJcgmTOTynmbc,977
+xsoar_cli/playbook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xsoar_cli/playbook/commands.py,sha256=mFmXJ3D8plvrUC9ylMlkrAa2T1yhydByEBhrBVbaZec,2729
+xsoar_cli/plugins/README.md,sha256=qQ_shzxcJcJKHuWfuN_cTVhtaew4BEGBEjn9wxaZG5c,11314
+xsoar_cli/plugins/__init__.py,sha256=81IZsMbZsqrLdB6TjA9t6s3yS8FkuihliBFX4xZUpTo,1753
+xsoar_cli/plugins/commands.py,sha256=HC0sWu149uQG9Ztag4t2CNPKXTM4WJbEdLSvFMEjw80,10660
+xsoar_cli/plugins/manager.py,sha256=7RPk3lAYDifGMLOU-hFOqyPxTVk8ibBVzBqH7R8wy4g,13012
+xsoar_cli-0.0.3.dist-info/METADATA,sha256=OC2qqM6pvUZgS0cx_5sbqvFA2IxIh0e3tVky0_5SLXA,4375
+xsoar_cli-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xsoar_cli-0.0.3.dist-info/entry_points.txt,sha256=s6Klu4QRekXsmZaBxMyFlE4Q-4_jIA9uijk4qIYUPvE,48
+xsoar_cli-0.0.3.dist-info/licenses/LICENSE.txt,sha256=l6xnqWKshqwwTXt6ayO6MX8Uvygq0YnkUuFTNnR3ba4,1097
+xsoar_cli-0.0.3.dist-info/RECORD,,

xsoar_cli-0.0.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

xsoar_cli-0.0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xsoar-cli = xsoar_cli.cli:cli

xsoar_cli-0.0.3.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025-present Torbjørn Lium <torben@lium.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.