diff --git a/.github/workflows/keyfactor-starter-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml
index 61ea7a0..7d01cfb 100644
--- a/.github/workflows/keyfactor-starter-workflow.yml
+++ b/.github/workflows/keyfactor-starter-workflow.yml
@@ -1,4 +1,4 @@
-name: Keyfactor Bootstrap Workflow
+name: Keyfactor Bootstrap Workflow
on:
workflow_dispatch:
@@ -11,10 +11,18 @@ on:
jobs:
call-starter-workflow:
- uses: keyfactor/actions/.github/workflows/starter.yml@3.1.2
+ uses: keyfactor/actions/.github/workflows/starter.yml@screenshots
+ with:
+ command_token_url: ${{ vars.DOCTOOL_COMMAND_TOKEN_URL }}
+ command_hostname: ${{ vars.DOCTOOL_COMMAND_HOSTNAME }}
+ command_base_api_path: ${{ vars.DOCTOOL_COMMAND_BASE_API_PATH }}
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 }}
+ entra_username: ${{ secrets.DOCTOOL_ENTRA_USERNAME }}
+ entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }}
+ command_client_id: ${{ secrets.DOCTOOL_COMMAND_CLIENT_ID }}
+ command_client_secret: ${{ secrets.DOCTOOL_COMMAND_CLIENT_SECRET }}
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9ae0bf7..f3c7f62 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,6 @@
+v1.1.1
+- Bug fix to prevent API key logging
+
v1.1.0
- Modified build to produce .net6 and .net8 compatible versions
- Updated README documentation to use doctool
diff --git a/Imperva/PAMUtilities.cs b/Imperva/PAMUtilities.cs
index 723bfe3..f68c401 100644
--- a/Imperva/PAMUtilities.cs
+++ b/Imperva/PAMUtilities.cs
@@ -7,7 +7,7 @@ internal class PAMUtilities
{
internal static string ResolvePAMField(IPAMSecretResolver resolver, ILogger logger, string name, string key)
{
- logger.LogDebug($"Attempting to resolve PAM eligible field {name} with key {key}");
+ logger.LogDebug($"Attempting to resolve PAM eligible field {name}");
return resolver.Resolve(key);
}
}
diff --git a/README.md b/README.md
index c0016c7..023dc36 100644
--- a/README.md
+++ b/README.md
@@ -40,8 +40,8 @@ The Imperva Orchestrator Extension allows for the management of SSL certificates
This integration is compatible with Keyfactor Universal Orchestrator version 10.1 and later.
## Support
-The Imperva 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.
-
+The Imperva Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or 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
@@ -52,82 +52,117 @@ Before installing the Imperva Universal Orchestrator extension, we recommend tha
The Imperva Orchestrator Extension requires the creation of an Imperva account id, API id, and API key. Please reference the [Imperva Documentation](https://docs.imperva.com/bundle/cloud-application-security/page/settings/api-keys.htm#:~:text=In%20the%20Cloud%20Security%20Console%20top%20menu%20bar%2C%20click%20Account,to%20create%20a%20new%20key) for more information on creating an API id and key for use with this integration.
-## Create the Imperva Certificate Store Type
+## Imperva Certificate Store Type
To use the Imperva Universal Orchestrator extension, you **must** create the Imperva Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
-* **Create Imperva using kfutil**:
- ```shell
- # Imperva
- kfutil store-types create Imperva
- ```
-* **Create Imperva manually in the Command UI**:
- Create Imperva manually in the Command UI
- Create a store type called `Imperva` with the attributes in the tables below:
- #### Basic Tab
- | Attribute | Value | Description |
- | --------- | ----- | ----- |
- | Name | Imperva | Display name for the store type (may be customized) |
- | Short Name | Imperva | Short display name for the store type |
- | Capability | Imperva | 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 | 🔲 Unchecked | 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 | ✅ Checked | 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. |
- The Basic tab should look like this:
+#### Supported Operations
+
+| Operation | Is Supported |
+|--------------|------------------------------------------------------------------------------------------------------------------------|
+| Add | ✅ Checked |
+| Remove | ✅ Checked |
+| Discovery | 🔲 Unchecked |
+| Reenrollment | 🔲 Unchecked |
+| Create | 🔲 Unchecked |
+
+#### Store Type Creation
+
+##### Using kfutil:
+`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
+For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)
+ Click to expand Imperva kfutil details
+
+ ##### Using online definition from GitHub:
+ This will reach out to GitHub and pull the latest store-type definition
+ ```shell
+ # Imperva
+ kfutil store-types create Imperva
+ ```
- 
+ ##### Offline creation using integration-manifest file:
+ If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo.
+ You would first download the [integration-manifest.json](./integration-manifest.json) and then run the following command
+ in your offline environment.
+ ```shell
+ kfutil store-types create --from-file integration-manifest.json
+ ```
+ Click to expand manual Imperva details
- 
+ Create a store type called `Imperva` with the attributes in the tables below:
- #### 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:
+ ##### Basic Tab
+ | Attribute | Value | Description |
+ | --------- | ----- | ----- |
+ | Name | Imperva | Display name for the store type (may be customized) |
+ | Short Name | Imperva | Short display name for the store type |
+ | Capability | Imperva | 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 | 🔲 Unchecked | 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 | ✅ Checked | 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. |
- | Name | Display Name | Description | Type | Default Value/Options | Required |
- | ---- | ------------ | ---- | --------------------- | -------- | ----------- |
+ The Basic tab should look like this:
- The Custom Fields tab should look like this:
+ 
- 
+ ##### 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 | Required | 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.) |
+ The Advanced tab should look like this:
+ 
- Click to expand details
+
+1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.**
+
+ Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_.
- Create Certificate Stores manually in the UI
+2. **Add a Certificate Store.**
- 1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.**
+ Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.
- Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_.
+ | Attribute | Description |
+ | --------- |---------------------------------------------------------|
+ | Category | Select "Imperva" or the customized certificate store name from the previous step. |
+ | Container | Optional container to associate certificate store with. |
+ | Client Machine | The URL that will be used as the base URL for Imperva endpoint calls. Should be https://my.imperva.com |
+ | Store Path | Your Imperva account id. Please refer to the [Imperva documentation](https://docs.imperva.com/howto/bd68301b) as to how to find your Imperva account id. |
+ | Store Password | Your Imperva API id and API key concatenated with a comma (,}. For example: 12345,12345678-1234-1234-1234-123456789ABC. Please refer to the [Imperva documentation](https://docs.imperva.com/bundle/cloud-application-security/page/settings/api-keys.htm#:~:text=In%20the%20Cloud%20Security%20Console%20top%20menu%20bar%2C%20click%20Account,to%20create%20a%20new%20key.) as to how to create an API id and key. |
+ | Orchestrator | Select an approved orchestrator capable of managing `Imperva` certificates. Specifically, one with the `Imperva` capability. |
- 2. **Add a Certificate Store.**
+Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
+#### Using kfutil CLI
- If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
- | Attribute | Description |
- | --------- | ----------- |
- | Store Password | Your Imperva API id and API key concatenated with a comma (,}. For example: 12345,12345678-1234-1234-1234-123456789ABC. Please refer to the [Imperva documentation](https://docs.imperva.com/bundle/cloud-application-security/page/settings/api-keys.htm#:~:text=In%20the%20Cloud%20Security%20Console%20top%20menu%20bar%2C%20click%20Account,to%20create%20a%20new%20key.) as to how to create an API id and key. |
+Click to expand details
- Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
+1. **Generate a CSV template for the Imperva certificate store**
- > Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
- Create Certificate Stores with kfutil
-
- 1. **Generate a CSV template for the Imperva certificate store**
+3. **Import the CSV file to create the certificate stores**
+
+ ```shell
+ kfutil stores import csv --store-type-name Imperva --file Imperva.csv
+ ```
- ```shell
- kfutil stores import generate-template --store-type-name Imperva --outpath Imperva.csv
- ```
- 2. **Populate the generated CSV file**
+Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
- Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
+If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
- If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
- | Attribute | Description |
- | --------- | ----------- |
- | Store Password | Your Imperva API id and API key concatenated with a comma (,}. For example: 12345,12345678-1234-1234-1234-123456789ABC. Please refer to the [Imperva documentation](https://docs.imperva.com/bundle/cloud-application-security/page/settings/api-keys.htm#:~:text=In%20the%20Cloud%20Security%20Console%20top%20menu%20bar%2C%20click%20Account,to%20create%20a%20new%20key.) as to how to create an API id and key. |
+ | Attribute | Description |
+ | --------- | ----------- |
+ | StorePassword | Your Imperva API id and API key concatenated with a comma (,}. For example: 12345,12345678-1234-1234-1234-123456789ABC. Please refer to the [Imperva documentation](https://docs.imperva.com/bundle/cloud-application-security/page/settings/api-keys.htm#:~:text=In%20the%20Cloud%20Security%20Console%20top%20menu%20bar%2C%20click%20Account,to%20create%20a%20new%20key.) as to how to create an API id and key. |
- > Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
-