-
Notifications
You must be signed in to change notification settings - Fork 0
Merge 1.0.1 to main #5
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| ### 1.0.0 | ||
| * initial release | ||
| ## 1.0.0 | ||
| * Initial release | ||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,111 @@ | ||||||||
| <h1 align="center" style="border-bottom: none"> | ||||||||
| Nexus Certificate Manager Gateway AnyCA Gateway REST Plugin | ||||||||
|
||||||||
| </h1> | ||||||||
|
|
||||||||
| <p align="center"> | ||||||||
| <!-- Badges --> | ||||||||
| <img src="https://img.shields.io/badge/integration_status-prototype-3D1973?style=flat-square" alt="Integration Status: prototype" /> | ||||||||
| <a href="https://github.com/Keyfactor/nexus-certificate-manager-caplugin/releases"><img src="https://img.shields.io/github/v/release/Keyfactor/nexus-certificate-manager-caplugin?style=flat-square" alt="Release" /></a> | ||||||||
| <img src="https://img.shields.io/github/issues/Keyfactor/nexus-certificate-manager-caplugin?style=flat-square" alt="Issues" /> | ||||||||
| <img src="https://img.shields.io/github/downloads/Keyfactor/nexus-certificate-manager-caplugin/total?style=flat-square&label=downloads&color=28B905" alt="GitHub Downloads (all assets, all releases)" /> | ||||||||
| </p> | ||||||||
|
|
||||||||
| <p align="center"> | ||||||||
| <!-- TOC --> | ||||||||
| <a href="#support"> | ||||||||
| <b>Support</b> | ||||||||
| </a> | ||||||||
| · | ||||||||
| <a href="#requirements"> | ||||||||
| <b>Requirements</b> | ||||||||
| </a> | ||||||||
| · | ||||||||
| <a href="#installation"> | ||||||||
| <b>Installation</b> | ||||||||
| </a> | ||||||||
| · | ||||||||
| <a href="#license"> | ||||||||
| <b>License</b> | ||||||||
| </a> | ||||||||
| · | ||||||||
| <a href="https://github.com/orgs/Keyfactor/repositories?q=anycagateway"> | ||||||||
| <b>Related Integrations</b> | ||||||||
| </a> | ||||||||
| </p> | ||||||||
|
|
||||||||
|
|
||||||||
| The Nexus Certificate Manager AnyCA REST plugin connects Nexus Certificate Manager to Keyfactor Command via the AnyCA Gateway REST. It supports the following capabilities: | ||||||||
| * Certificate Synchronization | ||||||||
| * Certificate Enrollment | ||||||||
| * Certificate Revocation | ||||||||
|
|
||||||||
| ## Compatibility | ||||||||
|
|
||||||||
| The Nexus Certificate Manager Gateway AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 25.2.0 and later. | ||||||||
|
|
||||||||
| ## Support | ||||||||
| The Nexus Certificate Manager Gateway AnyCA Gateway REST plugin is open source and there is **no SLA**. Keyfactor will address issues as resources become available. Keyfactor customers may request escalation by opening up a support ticket through their Keyfactor representative. | ||||||||
|
|
||||||||
| > 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 | ||||||||
|
|
||||||||
| - The host URL for the instance of Nexus Certificate Manager | ||||||||
| - A certificate in the pfx format to use for authentication into Nexus Certificate Manager, located on the Gateway Host | ||||||||
| - The passphrase for the pfx certificate | ||||||||
|
|
||||||||
| ## Installation | ||||||||
|
|
||||||||
| 1. Install the AnyCA Gateway REST per the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/InstallIntroduction.htm). | ||||||||
|
|
||||||||
| 2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Nexus Certificate Manager Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/nexus-certificate-manager-caplugin/releases/latest) from GitHub. | ||||||||
|
|
||||||||
| 3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory: | ||||||||
|
|
||||||||
|
|
||||||||
| ```shell | ||||||||
| Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations: | ||||||||
| Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions | ||||||||
| Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions | ||||||||
| ``` | ||||||||
|
Comment on lines
+66
to
+70
|
||||||||
|
|
||||||||
| > The directory containing the Nexus Certificate Manager Gateway AnyCA Gateway REST plugin DLLs (`net6.0` or `net8.0`) can be named anything, as long as it is unique within the `Extensions` directory. | ||||||||
|
|
||||||||
| 4. Restart the AnyCA Gateway REST service. | ||||||||
|
|
||||||||
| 5. Navigate to the AnyCA Gateway REST portal and verify that the Gateway recognizes the Nexus Certificate Manager Gateway plugin by hovering over the ⓘ symbol to the right of the Gateway on the top left of the portal. | ||||||||
|
Comment on lines
+44
to
+76
|
||||||||
|
|
||||||||
| ## Configuration | ||||||||
|
|
||||||||
| 1. Follow the [official AnyCA Gateway REST documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCA-Gateway.htm) to define a new Certificate Authority, and use the notes below to configure the **Gateway Registration** and **CA Connection** tabs: | ||||||||
|
|
||||||||
| * **Gateway Registration** | ||||||||
|
|
||||||||
| To enroll certificates, the Keyfactor Command server must trust the CA chain. Identify the Root and/or Subordinate CA used by Nexus Certificate Manager, then download and import the certificate chain into the Command Server certificate store. | ||||||||
|
|
||||||||
| * **CA Connection** | ||||||||
|
|
||||||||
| Populate using the configuration fields collected in the [requirements](#requirements) section. | ||||||||
|
|
||||||||
| * **Host** - The path to the Nexus CM server, including port | ||||||||
| * **AuthCertificatePath** - The path to the PFX certificate for authenticating into Nexus CM | ||||||||
| * **AuthCertPassword** - The password for the authentication certificate | ||||||||
| * **Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available. | ||||||||
|
|
||||||||
| 2. For this AnyCA Gateway, there is a single product type named "NexusCM". | ||||||||
|
|
||||||||
| 3. Follow the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCA-Keyfactor.htm) to add each defined Certificate Authority to Keyfactor Command and import the newly defined Certificate Templates. | ||||||||
|
|
||||||||
|
|
||||||||
| ## CA Connection | ||||||||
|
|
||||||||
| The certificate used by the gateway to authenticate into Nexus Certificate Manager must be copied to a location on the Gateway Host accessible by the gateway service. | ||||||||
|
|
||||||||
|
|
||||||||
|
Comment on lines
+100
to
+104
|
||||||||
| ## CA Connection | |
| The certificate used by the gateway to authenticate into Nexus Certificate Manager must be copied to a location on the Gateway Host accessible by the gateway service. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,39 @@ | ||
| { | ||
| "$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json", | ||
| "integration_type": "anyca-plugin", | ||
| "name": "Nexus Certificate Maanager AnyCA REST Gateway Plugin", | ||
| "status": "prototype", | ||
| "support_level": "kf-community", | ||
| "link_github": false, | ||
| "update_catalog": false, | ||
| "description": "Nexus Certificate Manager plugin for the AnyCA REST Gateway framework", | ||
| "gateway_framework": "25.2.0", | ||
| "release_dir": "nexus-certificate-manager-caplugin/bin/Release", | ||
| "release_project": "nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.csproj", | ||
| "about": { | ||
| "carest": { | ||
| "product_ids": [ "NexusCM" ], | ||
| "ca_plugin_config": [ | ||
| { | ||
| "name": "Host", | ||
| "description": "The URI of the instance of the Nexus Certificate Manager API, including port. example: https://127.0.0.1:8444" | ||
| }, | ||
| { | ||
| "name": "AuthCertificatePath", | ||
| "description": "The path on the AnyCA Gateway host where the PFX certificate that will be used for authentication can be found. example: 'C:\\Program Files\\Keyfactor\\Keyfactor AnyCA Gateway\\AnyGatewayREST\\net8.0\\my_auth_cert.pfx'" | ||
| }, | ||
| { | ||
| "name": "AuthCertPassword", | ||
| "description": "The password for the PFX certificate located on the AnyCA Gateway Host that will be used for authentication into Nexus Certificate Manager" | ||
| }, | ||
| { | ||
| "name": "Enabled", | ||
| "description": "Flag to enable or disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available." | ||
| "$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json", | ||
| "integration_type": "anyca-plugin", | ||
| "name": "Nexus Certificate Manager AnyCA REST Gateway Plugin", | ||
| "status": "prototype", | ||
| "support_level": "kf-community", | ||
| "link_github": false, | ||
| "update_catalog": false, | ||
| "description": "Nexus Certificate Manager plugin for the AnyCA REST Gateway framework", | ||
| "gateway_framework": "25.2.0", | ||
| "release_dir": "nexus-certificate-manager-caplugin/bin/Release", | ||
| "release_project": "nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.csproj", | ||
| "about": { | ||
| "carest": { | ||
| "product_ids": [ | ||
| "NexusCM" | ||
| ], | ||
| "ca_plugin_config": [ | ||
| { | ||
| "name": "Host", | ||
| "description": "The path to the Nexus CM server, including port" | ||
| }, | ||
| { | ||
| "name": "AuthCertificatePath", | ||
| "description": "The path to the PFX certificate for authenticating into Nexus CM" | ||
| }, | ||
| { | ||
| "name": "AuthCertPassword", | ||
| "description": "The password for the authentication certificate" | ||
| }, | ||
| { | ||
| "name": "Enabled", | ||
| "description": "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available." | ||
| } | ||
| ], | ||
| "enrollment_config": [] | ||
| } | ||
| ], | ||
| "enrollment_config": [] | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR title and description indicate this is a merge of release "1.0.1" to main, but the CHANGELOG.md only has an entry for version 1.0.0 with no new entry added for 1.0.1. If this is indeed a 1.0.1 release, a corresponding changelog entry should be added documenting what changed between 1.0.0 and 1.0.1.