pan-scm-cli 0.1.2__tar.gz → 0.2.0__tar.gz

pan_scm_cli-0.2.0/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 [2024] [Calvin Remsburg]
+
+   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.

pan_scm_cli-0.2.0/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.3
+Name: pan-scm-cli
+Version: 0.2.0
+Summary: Network Engineer-friendly CLI for Palo Alto Networks Security Content Management
+Author: Calvin Remsburg
+Author-email: dev@cdot.io
+Requires-Python: >=3.10,<3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: dynaconf (>=3.2.10,<4.0.0)
+Requires-Dist: pan-scm-sdk (==0.3.22)
+Requires-Dist: pydantic (>=2.7.1,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: typer[all] (>=0.11.0,<0.12.0)
+Description-Content-Type: text/markdown
+
+# Strata Cloud Manager CLI
+
+![Banner Image](https://raw.githubusercontent.com/cdot65/pan-scm-cli/main/docs/images/logo.svg)
+[![Build Status](https://github.com/cdot65/pan-scm-cli/actions/workflows/code-quality.yml/badge.svg)](https://github.com/cdot65/pan-scm-cli/actions/workflows/code-quality.yml)
+[![PyPI version](https://badge.fury.io/py/pan-scm-cli.svg)](https://badge.fury.io/py/pan-scm-cli)
+[![Python versions](https://img.shields.io/pypi/pyversions/pan-scm-cli.svg)](https://pypi.org/project/pan-scm-cli/)
+[![License](https://img.shields.io/github/license/cdot65/pan-scm-cli.svg)](https://github.com/cdot65/pan-scm-cli/blob/main/LICENSE)
+
+Command-line interface for Palo Alto Networks Strata Cloud Manager.
+
+> **NOTE**: Please refer to the [GitHub Pages documentation site](https://cdot65.github.io/pan-scm-cli/) for all
+> examples
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Authentication](#authentication)
+    - [Command Structure](#command-structure)
+    - [Example Commands](#example-commands)
+- [Development](#development)
+    - [Setup](#setup)
+    - [Code Quality](#code-quality)
+    - [Pre-commit Hooks](#pre-commit-hooks)
+- [Contributing](#contributing)
+- [License](#license)
+- [Support](#support)
+
+## Features
+
+- **Consistent Command Structure**: Intuitive command pattern that follows standard CLI conventions.
+- **Comprehensive Object Management**: Create, read, update, and delete configuration objects like addresses, address groups, security zones, and security rules.
+- **Bulk Operations**: Load and manage objects in bulk using YAML files.
+- **Mock Mode**: Test commands without making actual API calls to validate configurations.
+- **Authentication Management**: Multiple authentication methods including environment variables and configuration files.
+- **Extensive Documentation**: Comprehensive examples for all supported operations.
+
+## Installation
+
+**Requirements**:
+
+- Python 3.10 or higher
+
+Install the package via pip:
+
+```bash
+pip install pan-scm-cli
+```
+
+## Usage
+
+### Authentication
+
+Configure authentication using one of the following methods:
+
+#### Environment Variables
+
+```bash
+# Linux/macOS
+export SCM_CLIENT_ID="your_client_id"
+export SCM_CLIENT_SECRET="your_client_secret"
+export SCM_TSG_ID="your_tenant_service_group_id"
+
+# Windows PowerShell
+$env:SCM_CLIENT_ID = "your_client_id"
+$env:SCM_CLIENT_SECRET = "your_client_secret"
+$env:SCM_TSG_ID = "your_tenant_service_group_id"
+```
+
+#### Configuration File
+
+Create a config file at `~/.scm-cli/config.yaml`:
+
+```yaml
+client_id: "your_client_id"
+client_secret: "your_client_secret"
+tsg_id: "your_tenant_service_group_id"
+```
+
+### Command Structure
+
+The CLI follows a consistent command pattern:
+
+```
+scm-cli <action> <object-type> <object> [options]
+```
+
+Where:
+- `<action>`: `set`, `delete`, or `load`
+- `<object-type>`: `objects`, `network`, `security`, or `deployment`
+- `<object>`: Specific object type (e.g., `address`, `address-group`, `security-zone`)
+
+### Example Commands
+
+#### Managing Address Objects
+
+```bash
+# Create a new address object
+scm-cli set objects address --folder Shared --name web-server --ip-netmask 192.168.1.100/32 --description "Web server in DMZ"
+
+# List all address objects in a folder
+scm-cli set objects address --list --folder Shared
+
+# Delete an address object
+scm-cli delete objects address --folder Shared --name web-server
+```
+
+#### Managing Address Groups
+
+```bash
+# Create a static address group
+scm-cli set objects address-group --folder Shared --name web-servers --type static --members "web-server-1,web-server-2"
+
+# Create a dynamic address group
+scm-cli set objects address-group --folder Shared --name dynamic-endpoints --type dynamic --filter "'endpoint' and 'corporate'"
+
+# Delete an address group
+scm-cli delete objects address-group --folder Shared --name web-servers
+```
+
+#### Managing Security Zones
+
+```bash
+# Create a security zone
+scm-cli set network security-zone --folder Shared --name DMZ --mode layer3 --enable-user-id true
+
+# List all security zones
+scm-cli set network security-zone --list --folder Shared
+```
+
+#### Managing Security Rules
+
+```bash
+# Create a security rule
+scm-cli set security rule --folder Shared --name "Allow-Web" \
+  --source-zones "Trust" --destination-zones "DMZ" \
+  --source-addresses "any" --destination-addresses "web-servers" \
+  --applications "web-browsing,ssl" --services "application-default" \
+  --action allow --log-end true
+
+# List all security rules
+scm-cli set security rule --list --folder Shared
+```
+
+#### Bulk Operations
+
+Create a YAML file with multiple objects:
+
+```yaml
+# addresses.yaml
+addresses:
+  - name: web-server-1
+    description: "Web server 1"
+    ip_netmask: 192.168.1.100/32
+    tags:
+      - web
+      - production
+
+  - name: web-server-2
+    description: "Web server 2"
+    ip_netmask: 192.168.1.101/32
+    tags:
+      - web
+      - production
+```
+
+Load the objects:
+
+```bash
+scm-cli load objects address --folder Shared --file addresses.yaml
+```
+
+## Development
+
+### Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/cdot65/pan-scm-cli.git
+   cd pan-scm-cli
+   ```
+
+2. Install dependencies and pre-commit hooks:
+   ```bash
+   make setup
+   ```
+
+   Alternatively, you can install manually:
+   ```bash
+   poetry install
+   poetry run pre-commit install
+   ```
+
+### Code Quality
+
+This project uses [ruff](https://github.com/astral-sh/ruff) for linting and formatting:
+
+```bash
+# Run linting checks
+make lint
+
+# Format code
+make format
+
+# Auto-fix linting issues when possible
+make fix
+```
+
+### Pre-commit Hooks
+
+We use pre-commit hooks to ensure code quality before committing:
+
+```bash
+# Run pre-commit hooks on all files
+make pre-commit-all
+```
+
+The following checks run automatically before each commit:
+- ruff linting and formatting
+- Trailing whitespace removal
+- End-of-file fixer
+- YAML/JSON syntax checking
+- Large file detection
+- Python syntax validation
+- Merge conflict detection
+- Private key detection
+
+## Contributing
+
+We welcome contributions! To contribute:
+
+1. Fork the repository.
+2. Create a new feature branch (`git checkout -b feature/your-feature`).
+3. Make your changes, ensuring all linting and tests pass.
+4. Commit your changes (`git commit -m 'Add new feature'`).
+5. Push to your branch (`git push origin feature/your-feature`).
+6. Open a Pull Request.
+
+Ensure your code adheres to the project's coding standards and includes tests where appropriate.
+
+## License
+
+This project is licensed under the Apache 2.0 License. See the [LICENSE](./LICENSE) file for details.
+
+## Support
+
+For support and questions, please refer to the [SUPPORT.md](./SUPPORT.md) file in this repository.
+
+---
+
+*Detailed documentation is available on our [GitHub Pages documentation site](https://cdot65.github.io/pan-scm-cli/).*
+