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

skeleton #11

Merged
merged 1 commit into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ Requires Python 3.7 or higher.
Install the package using pip:

```bash
pip install device-certificate-report
$ pip install device-certificate-report
---> 100%
Successfully installed device-certificate-report
```

## Usage
Expand All @@ -54,10 +56,10 @@ The `device-certificate-report` utility provides three subcommands:
Process a CSV file to generate the report.

```bash
device-certificate-report csv --csv-file <path_to_csv_file> --output-file <output_pdf>
$ device-certificate-report csv --csv-file <path_to_csv_file> --output-file <output_pdf>
```

> the `--csv-file` and `--output-file` flags are optional
* `--csv-file` and `--output-file` flags are optional*

**Examples:**

Expand All @@ -81,10 +83,10 @@ Report generated at device_certificate_report.pdf
Connect to a Panorama appliance and generate the report from connected firewalls.

```bash
device-certificate-report panorama --hostname <panorama_ip> --username <user> --password <password> --output-file <output_pdf>
$ device-certificate-report panorama --hostname <panorama_ip> --username <user> --password <password> --output-file <output_pdf>
```

> the `--hostname`, `--username`, `--password`, and `--output-file` flags are optional
* `--hostname`, `--username`, `--password`, and `--output-file` flags are optional*


**Examples:**
Expand Down Expand Up @@ -115,7 +117,7 @@ Report generated at panorama_report.pdf
Connect to a single Firewall appliance and generate the report.

```bash
device-certificate-report firewall --hostname <firewall_ip> --username <user> --password <password> --output-file <output_pdf>
$ device-certificate-report firewall --hostname <firewall_ip> --username <user> --password <password> --output-file <output_pdf>
```

**Examples:**
Expand Down
9 changes: 5 additions & 4 deletions docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Before you begin, make sure you have a GitHub account and are familiar with Git

<!-- termynal -->
```bash
git clone https://github.com/yourusername/device-certificate-report.git
$ git clone https://github.com/yourusername/device-certificate-report.git
cd device-certificate-report
```

</div>

3. **Create a Branch:** Create a new branch for your feature, fix, or improvement:
Expand All @@ -29,7 +30,7 @@ Before you begin, make sure you have a GitHub account and are familiar with Git

<!-- termynal -->
```bash
git checkout -b feature/YourFeatureName
$ git checkout -b feature/YourFeatureName
```

</div>
Expand All @@ -50,7 +51,7 @@ Before you begin, make sure you have a GitHub account and are familiar with Git

<!-- termynal -->
```bash
git commit -am "Add some AmazingFeature"
$ git commit -am "Add some AmazingFeature"
```

</div>
Expand All @@ -65,7 +66,7 @@ Before you begin, make sure you have a GitHub account and are familiar with Git

<!-- termynal -->
```bash
git push origin feature/YourFeatureName
$ git push origin feature/YourFeatureName
```

</div>
Expand Down
6 changes: 1 addition & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,12 @@ hide:

## Important Dates

- **November 18, 2024**: Deadline for User-ID and Terminal Server (TS) agent remediation.
- **November 11, 2025**: New enforcement date for Device Certificate for Cloud-Delivered Security Services (CDSS).

## Affected Products and Services

- Next-Generation Firewalls (NGFW)
- Panorama for NGFW management
- Cloud Delivered Security Services (CDSS), including WildFire/Advanced WildFire, DNS Security, and URL/Advanced URL Filtering
- User-ID using User-ID agents or Terminal Server agents
- WF-500 and WF-500-B appliances

## Workflow

Expand All @@ -78,7 +74,7 @@ hide:
<div class="termy">

<!-- termynal -->
```console
```bash
$ pip install device-certificate-report
$ device-certificate-report --help
Usage: device-certificate-report [OPTIONS] COMMAND [ARGS]...
Expand Down
16 changes: 8 additions & 8 deletions docs/user-guide/docker/execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Pull the `device-certificate-report` image from GitHub Packages:

<!-- termynal -->
```bash
docker pull ghcr.io/cdot65/device-certificate-report:latest
$ docker pull ghcr.io/cdot65/device-certificate-report:latest
```

</div>
Expand All @@ -25,7 +25,7 @@ To run the container with interactive prompts:

<!-- termynal -->
```bash
docker run -it --rm ghcr.io/cdot65/device-certificate-report:latest
$ docker run -it --rm ghcr.io/cdot65/device-certificate-report:latest
```

</div>
Expand All @@ -38,7 +38,7 @@ For Panorama-based report generation:

<!-- termynal -->
```bash
docker run -it --rm \
$ docker run -it --rm \
-v "$(pwd)/output:/app/output" \
ghcr.io/cdot65/device-certificate-report:latest \
panorama --hostname <panorama_ip> --username <username> --password <password>
Expand All @@ -52,7 +52,7 @@ For CSV-based report generation:

<!-- termynal -->
```bash
docker run -it --rm \
$ docker run -it --rm \
-v "$(pwd)/input:/app/input" \
-v "$(pwd)/output:/app/output" \
ghcr.io/cdot65/device-certificate-report:latest \
Expand All @@ -76,7 +76,7 @@ The `device-certificate-report` Docker container supports various arguments to c

<!-- termynal -->
```bash
docker run ... panorama [OPTIONS]
$ docker run ... panorama [OPTIONS]
```

</div>
Expand All @@ -93,7 +93,7 @@ Options:

<!-- termynal -->
```bash
docker run ... csv [OPTIONS]
$ docker run ... csv [OPTIONS]
```

</div>
Expand All @@ -117,7 +117,7 @@ Options:

<!-- termynal -->
```bash
docker run -it --rm \
$ docker run -it --rm \
-v "$(pwd)/output:/app/output" \
ghcr.io/cdot65/device-certificate-report:latest \
panorama --hostname 192.168.1.1 --username admin --password admin123
Expand All @@ -131,7 +131,7 @@ docker run -it --rm \

<!-- termynal -->
```bash
docker run -it --rm \
$ docker run -it --rm \
-v "$(pwd)/input:/app/input" \
-v "$(pwd)/output:/app/output" \
ghcr.io/cdot65/device-certificate-report:latest \
Expand Down
10 changes: 5 additions & 5 deletions docs/user-guide/docker/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `device-certificate-report` Docker image is hosted on GitHub Packages. Pull

<!-- termynal -->
```bash
docker pull ghcr.io/cdot65/device-certificate-report:latest
$ docker pull ghcr.io/cdot65/device-certificate-report:latest
```

</div>
Expand All @@ -33,8 +33,8 @@ As an alternative, if you would like to build the container yourself:

<!-- termynal -->
```bash
git clone https://github.com/cdot65/device-certificate-report.git
cd device-certificate-report
$ git clone https://github.com/cdot65/device-certificate-report.git
$ cd device-certificate-report
```

</div>
Expand All @@ -45,7 +45,7 @@ As an alternative, if you would like to build the container yourself:

<!-- termynal -->
```bash
cd docker
$ cd docker
```

</div>
Expand All @@ -56,7 +56,7 @@ As an alternative, if you would like to build the container yourself:

<!-- termynal -->
```bash
docker build -t device-certificate-report:custom .
$ docker build -t device-certificate-report:custom .
```

</div>
Expand Down
4 changes: 0 additions & 4 deletions docs/user-guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,14 @@ The `device-certificate-report` tool follows a straightforward workflow:

The tool helps administrators prepare for crucial deadlines related to PAN-OS device certificates:

- **November 18, 2024**: Deadline for User-ID and Terminal Server (TS) agent remediation.
- **November 11, 2025**: New enforcement date for Device Certificate for Cloud-Delivered Security Services (CDSS).

## Affected Products and Services

The `device-certificate-report` tool is relevant for the following Palo Alto Networks products and services:

- Next-Generation Firewalls (NGFW)
- Panorama for NGFW management
- Cloud Delivered Security Services (CDSS), including WildFire/Advanced WildFire, DNS Security, and URL/Advanced URL Filtering
- User-ID using User-ID agents or Terminal Server agents
- WF-500 and WF-500-B appliances

## Next Steps

Expand Down
16 changes: 8 additions & 8 deletions docs/user-guide/python/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Run the following command to create a new virtual environment named `cert_report
<div class="termy">

<!-- termynal -->
```console
python3 -m venv cert_report_env
```bash
$ python3 -m venv cert_report_env
```

</div>
Expand All @@ -40,8 +40,8 @@ This creates a new directory named `cert_report_env` with a copy of the Python i
<div class="termy">

<!-- termynal -->
```console
cert_report_env\Scripts\activate
```bash
$ cert_report_env\Scripts\activate
```

</div>
Expand All @@ -51,8 +51,8 @@ cert_report_env\Scripts\activate
<div class="termy">

<!-- termynal -->
```console
source cert_report_env/bin/activate
```bash
$ source cert_report_env/bin/activate
```

</div>
Expand All @@ -66,10 +66,10 @@ Within the activated environment, install the package using pip:
<div class="termy">

<!-- termynal -->
```console
```bash
$ pip install device-certificate-report

---> 100%
Successfully device-certificate-report
```

</div>
Expand Down
Loading