diff --git a/.github/workflows/keyfactor-bootstrap-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml similarity index 80% rename from .github/workflows/keyfactor-bootstrap-workflow.yml rename to .github/workflows/keyfactor-starter-workflow.yml index 6d8de53..a4649f2 100644 --- a/.github/workflows/keyfactor-bootstrap-workflow.yml +++ b/.github/workflows/keyfactor-starter-workflow.yml @@ -11,9 +11,10 @@ on: jobs: call-starter-workflow: - uses: keyfactor/actions/.github/workflows/starter.yml@v2 + uses: keyfactor/actions/.github/workflows/starter.yml@3.1.2 secrets: token: ${{ secrets.V2BUILDTOKEN}} APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}} gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} + scan_token: ${{ secrets.SAST_TOKEN }} diff --git a/PaloAlto/PaloAlto.csproj b/PaloAlto/PaloAlto.csproj index af55d40..7ae2040 100644 --- a/PaloAlto/PaloAlto.csproj +++ b/PaloAlto/PaloAlto.csproj @@ -1,9 +1,10 @@ - netcoreapp3.1 - Keyfactor.Extensions.Orchestrator.PaloAlto + true + net6.0;net8.0 true + disable @@ -11,10 +12,10 @@ false - - - - + + + + @@ -27,7 +28,7 @@ - + diff --git a/PaloAltoTestConsole/PaloAltoTestConsole.csproj b/PaloAltoTestConsole/PaloAltoTestConsole.csproj index 6a3f5fe..dc3077e 100644 --- a/PaloAltoTestConsole/PaloAltoTestConsole.csproj +++ b/PaloAltoTestConsole/PaloAltoTestConsole.csproj @@ -2,7 +2,10 @@ Exe - netcoreapp3.1 + true + net6.0;net8.0 + true + disable diff --git a/README.md b/README.md index 3e0e88c..40d94f8 100644 --- a/README.md +++ b/README.md @@ -1,160 +1,216 @@ +

+ Palo Alto Universal Orchestrator Extension +

+ +

+ +Integration Status: production +Release +Issues +GitHub Downloads (all assets, all releases) +

-# Palo Alto Orchestrator +

+ + + Support + + · + + Installation + + · + + License + + · + + Related Integrations + +

-The Palo Alto Orchestrator remotely manages certificates on either the Palo Alto PA-VM Firewall Device or the Panorama. If using Panorama, it will push changes to all the devices from Panorama. It supports adding certificates with or without private keys. Palo Alto does not support incremental certificate inventory. If you have large numbers of certificates in your environment it is recommended to limit the frequency of inventory jobs to 30 minutes or more. +## Overview -#### Integration status: Production - Ready for use in production environments. +TODO Overview is a required section -## About the Keyfactor Universal Orchestrator Extension -This repository contains a Universal Orchestrator Extension which is a plugin to the Keyfactor Universal Orchestrator. Within the Keyfactor Platform, Orchestrators are used to manage “certificate stores” — collections of certificates and roots of trust that are found within and used by various applications. -The Universal Orchestrator is part of the Keyfactor software distribution and is available via the Keyfactor customer portal. For general instructions on installing Extensions, see the “Keyfactor Command Orchestrator Installation and Configuration Guide” section of the Keyfactor documentation. For configuration details of this specific Extension see below in this readme. +### PaloAlto +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info -The Universal Orchestrator is the successor to the Windows Orchestrator. This Orchestrator Extension plugin only works with the Universal Orchestrator and does not work with the Windows Orchestrator. -## Support for Palo Alto Orchestrator +TODO Overview is a required section -Palo Alto Orchestrator is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com +## Compatibility -###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab. +This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later. ---- +## Support +The Palo Alto Universal Orchestrator extension is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com. + +> To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab. +## Requirements & Prerequisites ---- +Before installing the Palo Alto Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command. +### PaloAlto Requirements +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info -## Keyfactor Version Supported -The minimum version of the Keyfactor Universal Orchestrator Framework needed to run this version of the extension is 10.1 -## Platform Specific Notes +TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info -The Keyfactor Universal Orchestrator may be installed on either Windows or Linux based platforms. The certificate operations supported by a capability may vary based what platform the capability is installed on. The table below indicates what capabilities are supported based on which platform the encompassing Universal Orchestrator is running. -| Operation | Win | Linux | -|-----|-----|------| -|Supports Management Add|✓ | | -|Supports Management Remove|✓ | | -|Supports Create Store| | | -|Supports Discovery| | | -|Supports Reenrollment| | | -|Supports Inventory|✓ | | -## PAM Integration -This orchestrator extension has the ability to connect to a variety of supported PAM providers to allow for the retrieval of various client hosted secrets right from the orchestrator server itself. This eliminates the need to set up the PAM integration on Keyfactor Command which may be in an environment that the client does not want to have access to their PAM provider. +## Create the PaloAlto Certificate Store Type -The secrets that this orchestrator extension supports for use with a PAM Provider are: +To use the Palo Alto Universal Orchestrator extension, you **must** create the PaloAlto Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance. -|Name|Description| -|----|-----------| -|ServerPassword|Key obtained from Palo Alto API to authenticate the server hosting the store| +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info -It is not necessary to use a PAM Provider for all of the secrets available above. If a PAM Provider should not be used, simply enter in the actual value to be used, as normal. -If a PAM Provider will be used for one of the fields above, start by referencing the [Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam). The GitHub repo for the PAM Provider to be used contains important information such as the format of the `json` needed. What follows is an example but does not reflect the `json` values for all PAM Providers as they have different "instance" and "initialization" parameter names and values. +* **Create PaloAlto using kfutil**: -
General PAM Provider Configuration -

+ ```shell + # PaloAlto + kfutil store-types create PaloAlto + ``` +* **Create PaloAlto manually in the Command UI**: +

Create PaloAlto manually in the Command UI + Create a store type called `PaloAlto` with the attributes in the tables below: -### Example PAM Provider Setup + #### Basic Tab + | Attribute | Value | Description | + | --------- | ----- | ----- | + | Name | PaloAlto | Display name for the store type (may be customized) | + | Short Name | PaloAlto | Short display name for the store type | + | Capability | PaloAlto | Store type name orchestrator will register with. Check the box to allow entry of value | + | Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add | + | Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove | + | Supports Discovery | 🔲 Unchecked | Indicates that the Store Type supports Discovery | + | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | + | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | + | Needs Server | ✅ Checked | Determines if a target server name is required when creating store | + | Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint | + | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell | + | Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. | + | Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. | -To use a PAM Provider to resolve a field, in this example the __Server Password__ will be resolved by the `Hashicorp-Vault` provider, first install the PAM Provider extension from the [Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) on the Universal Orchestrator. + The Basic tab should look like this: -Next, complete configuration of the PAM Provider on the UO by editing the `manifest.json` of the __PAM Provider__ (e.g. located at extensions/Hashicorp-Vault/manifest.json). The "initialization" parameters need to be entered here: + ![PaloAlto Basic Tab](docsource/images/PaloAlto-basic-store-type-dialog.png) -~~~ json - "Keyfactor:PAMProviders:Hashicorp-Vault:InitializationInfo": { - "Host": "http://127.0.0.1:8200", - "Path": "v1/secret/data", - "Token": "xxxxxx" - } -~~~ + #### Advanced Tab + | Attribute | Value | Description | + | --------- | ----- | ----- | + | Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. | + | Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | + | PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) | -After these values are entered, the Orchestrator needs to be restarted to pick up the configuration. Now the PAM Provider can be used on other Orchestrator Extensions. + The Advanced tab should look like this: -### Use the PAM Provider -With the PAM Provider configured as an extenion on the UO, a `json` object can be passed instead of an actual value to resolve the field with a PAM Provider. Consult the [Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) for the specific format of the `json` object. + ![PaloAlto Advanced Tab](docsource/images/PaloAlto-advanced-store-type-dialog.png) -To have the __Server Password__ field resolved by the `Hashicorp-Vault` provider, the corresponding `json` object from the `Hashicorp-Vault` extension needs to be copied and filed in with the correct information: + #### Custom Fields Tab + Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type: -~~~ json -{"Secret":"my-kv-secret","Key":"myServerPassword"} -~~~ + | Name | Display Name | Description | Type | Default Value/Options | Required | + | ---- | ------------ | ---- | --------------------- | -------- | ----------- | + | ServerUsername | Server Username | Palo Alto or Panorama Api User. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | Secret | | 🔲 Unchecked | + | ServerPassword | Server Password | Palo Alto or Panorama Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration). | Secret | | 🔲 Unchecked | + | ServerUseSsl | Use SSL | Should be true, http is not supported. | Bool | true | ✅ Checked | + | DeviceGroup | Device Group | Device Group on Panorama that changes will be pushed to. | String | | 🔲 Unchecked | + | InventoryTrustedCerts | Inventory Trusted Certs | If false, will not inventory default trusted certs, saves time. | Bool | false | ✅ Checked | + | TemplateStack | Template Stack | Template stack used for device push of certificates via Template. | String | | 🔲 Unchecked | -This text would be entered in as the value for the __Server Password__, instead of entering in the actual password. The Orchestrator will attempt to use the PAM Provider to retrieve the __Server Password__. If PAM should not be used, just directly enter in the value for the field. -

-
+ The Custom Fields tab should look like this: + ![PaloAlto Custom Fields Tab](docsource/images/PaloAlto-custom-fields-store-type-dialog.png) ---- +
+## Installation -## Release 2.2 Update on Entry Params -**Important Note** Entry params are no longer used. This version of the extension will only update certs on existing bindings and not add a cert to a new binding location. This was done to simplify the process since there are so many binding locations and reference issues. +1. **Download the latest Palo Alto Universal Orchestrator extension from GitHub.** -**Important Note** Please review the new path considerations in the store section. It explains how the paths work for Panorama and the Firewalls. 'locahost.localdomain' will always be that constant value. + Navigate to the [Palo Alto Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/paloalto-firewall-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive. + | Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `paloalto-firewall-orchestrator` .NET version to download | + | --------- | ----------- | ----------- | ----------- | + | Older than `11.0.0` | | | `net6.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` | + | `11.6` _and_ newer | `net8.0` | | `net8.0` | -## CERT STORE SETUP AND GENERAL PERMISSIONS -
- Cert Store Type Configuration - -In Keyfactor Command create a new Certificate Store Type similar to the one below: - -#### STORE TYPE CONFIGURATION -SETTING TAB | CONFIG ELEMENT | DESCRIPTION -------|-----------|------------------ -Basic |Name |Descriptive name for the Store Type. PaloAlto can be used. -Basic |Short Name |The short name that identifies the registered functionality of the orchestrator. Must be PaloAlto -Basic |Custom Capability|You can leave this unchecked and use the default. -Basic |Job Types |Inventory, Add, and Remove are the supported job types. -Basic |Needs Server |Must be checked -Basic |Blueprint Allowed |Unchecked -Basic |Requires Store Password |Determines if a store password is required when configuring an individual store. This must be unchecked. -Basic |Supports Entry Password |Determined if an individual entry within a store can have a password. This must be unchecked. -Advanced |Store Path Type| Determines how the user will enter the store path when setting up the cert store. Freeform -Advanced |Supports Custom Alias |Determines if an individual entry within a store can have a custom Alias. This must be Required -Advanced |Private Key Handling |Determines how the orchestrator deals with private keys. Optional -Advanced |PFX Password Style |Determines password style for the PFX Password. Default - -#### CUSTOM FIELDS FOR STORE TYPE -NAME | DISPLAY NAME | TYPE | DEFAULT VALUE | DEPENDS ON | REQUIRED |DESCRIPTION ---------------|-----------------|-------|--------------|-------------|---------|-------------- -ServerUsername|Server Username |Secret | |Unchecked |No |Palo Alto Api User Name -ServerPassword|Server Password |Secret | |Unchecked |No |Palo Alto Api Password -ServerUseSsl |Use SSL |Bool |True |Unchecked |Yes |Requires SSL Connection -DeviceGroup |Device Group |String | |Unchecked |No |Device Group on Panorama that changes will be pushed to. -InventoryTrustedCerts|Inventory Trusted Certs|Bool |False|Unchecked |No |If false, will not inventory default trusted certs, saves time. -TemplateStack |Template Stack |String | |Unchecked |No |Template stack used for device push of certificates via Template. - -#### ENTRY PARAMETERS FOR STORE TYPE -The entry parameters for this version have been eliminated. It will not longer support new bindings but will just update existing bindings when the certificate is replaced. + Unzip the archive containing extension assemblies to a known location. -
+ > **Note** If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for `net6.0`. + +2. **Locate the Universal Orchestrator extensions directory.** + + * **Default on Windows** - `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions` + * **Default on Linux** - `/opt/keyfactor/orchestrator/extensions` + +3. **Create a new directory for the Palo Alto Universal Orchestrator extension inside the extensions directory.** + + Create a new directory called `paloalto-firewall-orchestrator`. + > The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory. + +4. **Copy the contents of the downloaded and unzipped assemblies from __step 2__ to the `paloalto-firewall-orchestrator` directory.** + +5. **Restart the Universal Orchestrator service.** + + Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm). + + +6. **(optional) PAM Integration** + + The Palo Alto Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider. + + To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension, and follow the associated instructions to install it on the Universal Orchestrator (remote). + + +> The above installation steps can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions). + + + +## Defining Certificate Stores + + +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +TODO Certificate Store Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + + +> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). + +## Discovering Certificate Stores with the Discovery Job + +### PaloAlto Discovery Job +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + +TODO Discovery Job Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + + + +## Release 2.2 Update on Entry Params +**Important Note** Entry params are no longer used. This version of the extension will only update certs on existing bindings and not add a cert to a new binding location. This was done to simplify the process since there are so many binding locations and reference issues. + +**Important Note** Please review the new path considerations in the section below. It explains how the paths work for Panorama and the Firewalls. `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. + +## STORE PATH DETAILS AND API SECURITY CONSIDERATIONS
-PaloAlto Certificate Store -In Keyfactor Command, navigate to Certificate Stores from the Locations Menu. Click the Add button to create a new Certificate Store using the settings defined below. - -#### STORE CONFIGURATION -CONFIG ELEMENT |DESCRIPTION -----------------|--------------- -Category |The type of certificate store to be configured. Select category based on the display name configured above "PaloAlto". -Container |This is a logical grouping of like stores. This configuration is optional and does not impact the functionality of the store. -Client Machine |The hostname of the Panorama or Firewall. Sample is "palourl.cloudapp.azure.com". -Store Path | See Store Path Explanation Section Below -Orchestrator |This is the orchestrator server registered with the appropriate capabilities to manage this certificate store type. -Inventory Schedule |The interval that the system will use to report on what certificates are currently in the store. -Use SSL |This should be checked. -User |ApiUser Setup for either Panorama or the Firewall Device -Password |Api Password Setup for the user above +Store Path Permutations ### Store Path Explanation **Important Note** The store path permutations are show below @@ -170,13 +226,12 @@ This indicates that the path is within the configuration section of the firewall This section specifies that the path is within the shared settings. Shared settings are common configurations that can be used across multiple virtual systems (vsys) or contexts within the firewall. _________________________________ - - - #### FIREWALL VIRTUAL SYSTEM PATH _________________________________ **Path Example**: /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1'] +**Note** `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. + **/config**: This indicates that the path is within the configuration section of the firewall device. It contains all the configuration settings and parameters for the device. @@ -184,7 +239,7 @@ This indicates that the path is within the configuration section of the firewall This part specifies that the configuration relates to devices. In the context of a single firewall, this generally refers to the firewall itself. **/entry[@name='localhost.localdomain']**: -The entry tag with the attribute @name='localhost.localdomain' identifies a specific device by its name. In this case, it refers to the device named "localhost.localdomain," which is a default or placeholder name for the firewall device. +Note `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. The entry tag with the attribute @name='localhost.localdomain' identifies a specific device by its name. In this case, it refers to the device named "localhost.localdomain," which is a default or placeholder name for the firewall device. **/vsys**: This section specifies that the path is within the virtual systems (vsys) section. Virtual systems allow multiple virtualized instances of firewall configurations within a single physical firewall. @@ -193,13 +248,12 @@ This section specifies that the path is within the virtual systems (vsys) sectio The entry tag with the attribute @name='vsys1' identifies a specific virtual system by its name. In this case, it refers to a virtual system named "vsys1." _________________________________ - - - #### PANORAMA SHARED TEMPLATE PATH _________________________________ **Path Example**: /config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared +**Note** `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. + **/config**: This section indicates that the path is within the configuration section of the Panorama device. It contains all the configuration settings and parameters for the device. @@ -207,7 +261,7 @@ This section indicates that the path is within the configuration section of the This part specifies that the configuration relates to devices managed by Panorama. Panorama can manage multiple devices, such as firewalls. **/entry[@name='localhost.localdomain']**: -The entry tag with the attribute @name='localhost.localdomain' identifies a specific device by its name. In this case, it refers to the device named "localhost.localdomain," which is a default or placeholder name for the device. +Note `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. The entry tag with the attribute @name='localhost.localdomain' identifies a specific device by its name. In this case, it refers to the device named "localhost.localdomain," which is a default or placeholder name for the device. **/template**: This section indicates that the path is within the templates section. Templates in Panorama are used to define configuration settings that can be applied to multiple devices. @@ -219,9 +273,6 @@ The entry tag with the attribute @name='CertificatesTemplate' identifies a speci This part of the path indicates that the configuration settings within this template are shared settings. Shared settings are common configurations that can be used across multiple devices or contexts within the Panorama management system. _________________________________ - - - #### PANORAMA VIRTUAL SYSTEM PATH __________________________________ **Path Example**: /config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2'] @@ -254,9 +305,6 @@ This section specifies that the path is within the virtual systems (vsys) sectio The entry tag with the attribute @name='vsys2' identifies a specific virtual system by its name. In this case, it refers to a virtual system named "vsys2." __________________________________ - - - #### PANORAMA LEVEL __________________________________ **Path Example**: /config/panorama @@ -325,6 +373,11 @@ TC30|Panorama Level Replace bound Cert|/config/panorama|**Alias**:
PanoramaNo TC31|Firewall previous version cert store settings|/config/shared|**Alias**:
www.extraparams.com
**Overwrite**:
false|Cert is still installed because it ignores extra params|True|![](images/TC31.gif)
-When creating cert store type manually, that store property names and entry parameter names are case sensitive +## License + +Apache License 2.0, see [LICENSE](LICENSE). + +## Related Integrations +See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). \ No newline at end of file diff --git a/docsource/content.md b/docsource/content.md new file mode 100644 index 0000000..3e564fb --- /dev/null +++ b/docsource/content.md @@ -0,0 +1,182 @@ +## Overview + +The Palo Alto Orchestrator Extension is an integration that can replace and inventory certificates on either a Panoroama instance or Firewall Instance, depending on the configuration. The certificate store types that can be managed in the current version are: + +* PaloAlto - See Test Cases For Specific Use Cases that are supported. + +## Requirements + +## Release 2.2 Update on Entry Params +**Important Note** Entry params are no longer used. This version of the extension will only update certs on existing bindings and not add a cert to a new binding location. This was done to simplify the process since there are so many binding locations and reference issues. + +**Important Note** Please review the new path considerations in the section below. It explains how the paths work for Panorama and the Firewalls. `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. + +## STORE PATH DETAILS AND API SECURITY CONSIDERATIONS +
+Store Path Permutations + +### Store Path Explanation +**Important Note** The store path permutations are show below + +#### FIREWALL SHARED SYSTEM PATH +_________________________________ +**Path Example** /config/shared + +**/config**: +This indicates that the path is within the configuration section of the firewall device. It contains all the configuration settings and parameters for the device. + +**/shared**: +This section specifies that the path is within the shared settings. Shared settings are common configurations that can be used across multiple virtual systems (vsys) or contexts within the firewall. +_________________________________ + +#### FIREWALL VIRTUAL SYSTEM PATH +_________________________________ +**Path Example**: /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1'] + +**Note** `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. + +**/config**: +This indicates that the path is within the configuration section of the firewall device. It contains all the configuration settings and parameters for the device. + +**/devices**: +This part specifies that the configuration relates to devices. In the context of a single firewall, this generally refers to the firewall itself. + +**/entry[@name='localhost.localdomain']**: +Note `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. The entry tag with the attribute @name='localhost.localdomain' identifies a specific device by its name. In this case, it refers to the device named "localhost.localdomain," which is a default or placeholder name for the firewall device. + +**/vsys**: +This section specifies that the path is within the virtual systems (vsys) section. Virtual systems allow multiple virtualized instances of firewall configurations within a single physical firewall. + +**/entry[@name='vsys1']**: +The entry tag with the attribute @name='vsys1' identifies a specific virtual system by its name. In this case, it refers to a virtual system named "vsys1." +_________________________________ + +#### PANORAMA SHARED TEMPLATE PATH +_________________________________ +**Path Example**: /config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared + +**Note** `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. + +**/config**: +This section indicates that the path is within the configuration section of the Panorama device. It contains all the configuration settings and parameters for the device. + +**/devices**: +This part specifies that the configuration relates to devices managed by Panorama. Panorama can manage multiple devices, such as firewalls. + +**/entry[@name='localhost.localdomain']**: +Note `'locahost.localdomain'` will always be that `constant value` do not make that **anything else!**. The entry tag with the attribute @name='localhost.localdomain' identifies a specific device by its name. In this case, it refers to the device named "localhost.localdomain," which is a default or placeholder name for the device. + +**/template**: +This section indicates that the path is within the templates section. Templates in Panorama are used to define configuration settings that can be applied to multiple devices. + +**/entry[@name='CertificatesTemplate']**: +The entry tag with the attribute @name='CertificatesTemplate' identifies a specific template by its name. In this case, it refers to a template named "CertificatesTemplate." + +**/config/shared**: +This part of the path indicates that the configuration settings within this template are shared settings. Shared settings are common configurations that can be used across multiple devices or contexts within the Panorama management system. +_________________________________ + +#### PANORAMA VIRTUAL SYSTEM PATH +__________________________________ +**Path Example**: /config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2'] + +**/config**: +This indicates that the path is within the configuration section of the Panorama device. It contains all the configuration settings and parameters for the device. + +**/devices**: +This part specifies that the configuration relates to devices managed by Panorama. Panorama can manage multiple devices, such as firewalls. + +**/entry**: +This is a generic entry point under devices. However, since it does not have a @name attribute specified at this level, it applies to the broader device category. + +**/template**: +This section indicates that the path is within the templates section. Templates in Panorama are used to define configuration settings that can be applied to multiple devices. + +**/entry[@name='CertificatesTemplate']**: +The entry tag with the attribute @name='CertificatesTemplate' identifies a specific template by its name. In this case, it refers to a template named "CertificatesTemplate." + +**/config/devices**: +This part of the path specifies that the configuration settings within this template apply to devices. + +**/entry**: +This again specifies a generic entry point under devices in the context of the template. This would typically be further defined by specific device attributes, but here it leads to the virtual systems (vsys) section. + +**/vsys**: +This section specifies that the path is within the virtual systems (vsys) section. Virtual systems allow multiple virtualized instances of firewall configurations within a single physical firewall. + +**/entry[@name='vsys2']**: +The entry tag with the attribute @name='vsys2' identifies a specific virtual system by its name. In this case, it refers to a virtual system named "vsys2." +__________________________________ + +#### PANORAMA LEVEL +__________________________________ +**Path Example**: /config/panorama + +**/config**: +This indicates that the path is within the configuration section of the Panorama device. It contains all the configuration settings and parameters for the device. + +**/panorama**: +This section specifies that the path is within the Panorama-specific configuration settings. This part of the configuration contains settings that are specific to the Panorama management system itself, rather than the devices it manages. +__________________________________ + +
+ +
+API User Setup Permissions in Panorama or Firewall Required + +Tab | Security Items +--------------|-------------------------- +Xml Api |Report,Log,Configuration,Operational Requests,Commit,Export,Import +Rest Api |Objects/Devices,Panorama/Scheduled Config Push,Panorama/Templates,Panorama/Template Stacks,Panorama/Device Groups,System/Configuration,Plugins/Plugins +*** + +
+ +## Test Cases +
+Firewall, Panorama Template and Panorama Level + +Case Number|Case Name|Store Path|Enrollment Params|Expected Results|Passed|Screenshots +-------|----------|------------------|--------------------|----------------------------|----|-------- +TC1|Firewall Enroll No Bindings|/config/shared|**Alias**:
www.certandchain.com
**Overwrite**:
false|Cert and Chain Installed on Firewall|True|![](images/TC1.gif) +TC1a|Firewall Enroll Template Stack|/config/shared|**Alias**:
www.tc1a.com
**Overwrite**:
false|Error Stating Template Stacks Not Used for Firewall|True|![](images/TC1a.gif) +TC2|Firewall Replace No Bindings|/config/shared|**Alias**:
www.certandchain.com
**Overwrite**:
true|Cert and Chain Installed on Firewall|True|![](images/TC2.gif) +TC3|Firewall Remove Bound Certificate|/config/shared|**Alias**:
0.13757535891685202
**Overwrite**:
false|Cert will **not** be removed because bound|True|![](images/TC3.gif) +TC4|Firewall Enroll Bindings|/config/shared|**Alias**:0.13757535891685202
**Overwrite**:
false|Will not replace cert since Overwrite=false|True|![](images/TC4.gif) +TC5|Firewall Replace Bound Certificate|/config/shared|**Alias**:0.13757535891685202
**Overwrite**:
true|Will replace cert bindings get automatically updated since Overwrite=true|True|![](images/TC5.gif) +TC6|Firewall Inventory|/config/shared|N/A|Inventory will finish and certs from shared location inventoried.|True|![](images/TC6.gif) +TC6a|Firewall Inventory No Trusted Certs|/config/shared|N/A|Inventory will finish no Trusted Certs and certs from shared location inventoried.|True|![](images/TC6.gif) +TC7|Firewall Inventory With Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']|N/A|Will Inventory all certificates from vsys1 on firewall|True|![](images/TC7.gif) +TC8|Firewall Enroll cert and chain to Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']|**Alias**:
www.ejbcacertandchain.com|Cert is installed along with chain.|True|![](images/TC8.gif) +TC9|Firewall Remove unbound cert from Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']|N/A|Will remove cert from test case 8 from Firewall Virtual System|True|![](images/TC9.gif) +TC10|Firewall Remove bound cert from Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']|**Alias**:
0.8168##|Cert will not be removed because it is bound.|True|![](images/TC10.gif) +TC11|Firewall Replace without Overwrite on Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']|**Alias**:
0.8168##
**Overwrite**:
true|User is warned Overwrite needs checked.|True|![](images/TC11.gif) +TC12|Firewall Renew cert on Shared and Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1'] and /config/shared|**Alias**:
www.renewtester.com|Cert renewed on vsys and shared locations|True|![](images/TC12.gif) +TC13|Firewall Replace bound cert on Virtual System|/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']|**Alias**:
0.8168##
**Overwrite**:
true|Cert will be replaced and binding updated on vsys.|True|![](images/TC13.gif) +TC14|Panorama Template Enroll Certificate|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
www.pantemptc1.com|Certificate is enrolled to shared location for template|True|![](images/TC14.gif) +TC14a|Panorama Invalid Template Stack|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
www.tc14a.com|Error Occurs with list of valid Template Stacks To Use|True|![](images/TC14a.gif) +TC15|Panorama Template Replace Certificate|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
www.pantemptc1.com
**Overwrite**:
true|Certificate is replaced in shared location for template|True|![](images/TC15.gif) +TC16|Panorama Template Remove unbound Certificate|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
www.pantemptc1.com|Certificate is removed from shared location for template|True|![](images/TC16.gif) +TC16a|Panorama Template Stack Push|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
www.tc16a.com|Certificate pushed to Template and Template Stack|True|![](images/TC16a.gif) +TC17|Panorama Template Replace bound Certificate|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
LongNameTest
**Overwrite**:
true|Certificate is replaced, binding updated in shared location for template|True|![](images/TC17.gif) +TC18|Panorama Template Remove bound Certificate|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|**Alias**:
LongNameTest|Certificate is not removed because it is bound|True|![](images/TC18.gif) +TC19|Panorama Template Shared Inventory|/config/devices/entry[@name='localhost.localdomain']/template/entry[@name='CertificatesTemplate']/config/shared|N/A|Certificates are inventoried from this location|True|![](images/TC19.gif) +TC20|Panorama Template Virtual System Inventory|/config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2']|N/A|Certificates are inventoried from this template vsys location|True|![](images/TC20.gif) +TC21|Panorama Template Virtual System Enroll Certificate|/config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2']|**Alias**:
www.vsys2enroll.com|Certificate is enrolled to vsys2 location for template|True|![](images/TC21.gif) +TC21a|Panorama Level Inventory No Trusted Certs|/config/panorama|N/A|Certificates are inventoried from this location No Trusted Certs|True|![](images/TC21a.gif) +TC22|Panorama Template Virtual System Replace unbound Certificate|/config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2']|**Alias**:
www.vsys2enroll.com|Certificate is replaced in vsys2 location for template|True|![](images/TC22.gif) +TC23|Panorama Template Virtual System Remove unbound Certificate|/config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2']|**Alias**:
www.vsys2enroll.com|Certificate is removed in vsys2 location for template|True|![](images/TC23.gif) +TC24|Panorama Template Virtual System Renew bound Certificate|/config/devices/entry/template/entry[@name='CertificatesTemplate']/config/devices/entry/vsys/entry[@name='vsys2']|**Alias**:
www.vsys2enroll.com|Certificate is renewed, binding updated in vsys2 location for template|True|![](images/TC24.gif) +TC25|Panorama Level Inventory|/config/panorama|N/A|Certificates are inventoried from this location|True|![](images/TC25.gif) +TC26|Panorama Level Enroll Cert and Chain|/config/panorama|**Alias**:
www.panlevelcertandchain.com|Panorama Level Install Cert and Chain|True|![](images/TC26.gif) +TC27|Panorama Level Enroll Cert overwrite warning|/config/panorama|**Alias**:
www.panlevelcertandchain.com
**Overwrite**:
false|Cert is not installed warned Overwrite is needed|True|![](images/TC27.gif) +TC28|Panorama Level Replace Cert|/config/panorama|**Alias**:
www.panlevelcertandchain.com
**Overwrite**:
true|Cert is replaced because Overwrite was used|True|![](images/TC28.gif) +TC29|Panorama Level Remove unbound Cert|/config/panorama|N/A|Cert is removed because not bound|True|![](images/TC28.gif) +TC30|Panorama Level Replace bound Cert|/config/panorama|**Alias**:
PanoramaNoPK
**Overwrite**:
true|Cert is replaced, binding updated|True|![](images/TC30.gif) +TC31|Firewall previous version cert store settings|/config/shared|**Alias**:
www.extraparams.com
**Overwrite**:
false|Cert is still installed because it ignores extra params|True|![](images/TC31.gif) +
+ +## Overview + +TODO Overview is a required section + diff --git a/docsource/paloalto.md b/docsource/paloalto.md new file mode 100644 index 0000000..d53d056 --- /dev/null +++ b/docsource/paloalto.md @@ -0,0 +1,20 @@ +## Overview + +TODO Overview is a required section + +## Requirements + +TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +## Discovery Job Configuration + +TODO Discovery Job Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +## Certificate Store Configuration + +TODO Certificate Store Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + +## Global Store Type Section + +TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info + diff --git a/integration-manifest.json b/integration-manifest.json index 37b11e2..2e7aeb9 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -6,14 +6,15 @@ "update_catalog": true, "link_github": true, "support_level": "kf-supported", - "release_dir": "PaloAlto/bin/Release/netcoreapp3.1", + "release_project": "PaloAlto/PaloAlto.csproj", + "release_dir": "PaloAlto/bin/Release", "description": "The Palo Alto Orchestrator remotely manages certificates on either the Palo Alto PA-VM Firewall Device or the Panorama. If using Panorama, it will push changes to all the devices from Panorama. It supports adding certificates with or without private keys. Palo Alto does not support incremental certificate inventory. If you have large numbers of certificates in your environment it is recommended to limit the frequency of inventory jobs to 30 minutes or more.", "about": { "orchestrator": { - "UOFramework": "10.1", - "keyfactor_platform_version": "9.10", + "UOFramework": "10.4", + "keyfactor_platform_version": "10.4", "pam_support": true, - "keyfactor_platform_version": "9.10", + "keyfactor_platform_version": "10.4", "win": { "supportsCreateStore": false, "supportsDiscovery": false, @@ -50,54 +51,68 @@ "Name": "ServerUsername", "DisplayName": "Server Username", "Type": "Secret", - "DependsOn": null, - "DefaultValue": null, - "Required": false + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": true, + "Description": "Palo Alto or Panorama Api User. (or valid PAM key if the username is stored in a KF Command configured PAM integration)." }, { "Name": "ServerPassword", "DisplayName": "Server Password", "Type": "Secret", - "DependsOn": null, - "DefaultValue": null, - "Required": false + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": true, + "Description": "Palo Alto or Panorama Api Password. (or valid PAM key if the username is stored in a KF Command configured PAM integration)." }, { "Name": "ServerUseSsl", "DisplayName": "Use SSL", "Type": "Bool", - "DependsOn": null, + "DependsOn": "", "DefaultValue": "true", - "Required": true + "Required": true, + "IsPAMEligible": false, + "Description": "Should be true, http is not supported." }, { "Name": "DeviceGroup", "DisplayName": "Device Group", "Type": "String", - "DependsOn": null, - "DefaultValue": null, - "Required": false + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": false, + "Description": "Device Group on Panorama that changes will be pushed to." }, { "Name": "InventoryTrustedCerts", "DisplayName": "Inventory Trusted Certs", "Type": "Bool", - "DependsOn": null, + "DependsOn": "", "DefaultValue": "false", - "Required": true + "Required": true, + "IsPAMEligible": false, + "Description": "If false, will not inventory default trusted certs, saves time." }, { "Name": "TemplateStack", "DisplayName": "Template Stack", "Type": "String", - "DependsOn": null, - "DefaultValue": null, - "Required": false + "DependsOn": "", + "DefaultValue": "", + "Required": false, + "IsPAMEligible": false, + "Description": "Template stack used for device push of certificates via Template." } ], "EntryParameters": [ ], + "ClientMachineDescription": "Either the Panorama or Palo Alto Firewall URI or IP address.", + "StorePathDescription": "The Store Path field should be reviewed in the store path explanation section. It varies depending on configuration.", "PasswordOptions": { "EntrySupported": false, "StoreRequired": false, diff --git a/readme-src/readme-pam-support.md b/readme-src/readme-pam-support.md deleted file mode 100644 index d684d56..0000000 --- a/readme-src/readme-pam-support.md +++ /dev/null @@ -1,4 +0,0 @@ -|Name|Description| -|----|-----------| -|ServerPassword|Key obtained from Palo Alto API to authenticate the server hosting the store| -