|
| 1 | +<h1 align="center" style="border-bottom: none"> |
| 2 | + Idnomic PKI Gateway AnyCA Gateway REST Plugin |
| 3 | +</h1> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <!-- Badges --> |
| 7 | +<img src="https://img.shields.io/badge/integration_status-pilot-3D1973?style=flat-square" alt="Integration Status: pilot" /> |
| 8 | +<a href="https://github.com/Keyfactor/idnomic-caplugin/releases"><img src="https://img.shields.io/github/v/release/Keyfactor/idnomic-caplugin?style=flat-square" alt="Release" /></a> |
| 9 | +<img src="https://img.shields.io/github/issues/Keyfactor/idnomic-caplugin?style=flat-square" alt="Issues" /> |
| 10 | +<img src="https://img.shields.io/github/downloads/Keyfactor/idnomic-caplugin/total?style=flat-square&label=downloads&color=28B905" alt="GitHub Downloads (all assets, all releases)" /> |
| 11 | +</p> |
| 12 | + |
| 13 | +<p align="center"> |
| 14 | + <!-- TOC --> |
| 15 | + <a href="#support"> |
| 16 | + <b>Support</b> |
| 17 | + </a> |
| 18 | + · |
| 19 | + <a href="#requirements"> |
| 20 | + <b>Requirements</b> |
| 21 | + </a> |
| 22 | + · |
| 23 | + <a href="#installation"> |
| 24 | + <b>Installation</b> |
| 25 | + </a> |
| 26 | + · |
| 27 | + <a href="#license"> |
| 28 | + <b>License</b> |
| 29 | + </a> |
| 30 | + · |
| 31 | + <a href="https://github.com/orgs/Keyfactor/repositories?q=anycagateway"> |
| 32 | + <b>Related Integrations</b> |
| 33 | + </a> |
| 34 | +</p> |
| 35 | + |
| 36 | + |
| 37 | +The Idnomic PKI Gateway plugin extends the capabilities of Idnomic PKI (formerly OpenTrust PKI) to Keyfactor Command via the Keyfactor AnyCA Gateway. This plugin leverages the Idnomic SOAP-based connectors to provide comprehensive certificate lifecycle management. The plugin represents a fully featured AnyCA Plugin with the following capabilities: |
| 38 | + |
| 39 | +* **CA Sync**: |
| 40 | + * Download all certificates issued by the Idnomic CA |
| 41 | + * Support for incremental and full synchronization |
| 42 | + * Filter certificates by issuance date |
| 43 | +* **Certificate Enrollment**: |
| 44 | + * Support certificate enrollment with new key pairs |
| 45 | + * Dynamic template (profile) discovery from the CA |
| 46 | + * Zone-based certificate issuance |
| 47 | + * Support for PKCS#10 CSR format |
| 48 | +* **Certificate Revocation**: |
| 49 | + * Request revocation of previously issued certificates |
| 50 | + * Support for standard CRL revocation reasons |
| 51 | + |
| 52 | +## Compatibility |
| 53 | + |
| 54 | +The Idnomic PKI Gateway AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 24.2.0 and later. |
| 55 | + |
| 56 | +## Support |
| 57 | +The Idnomic PKI Gateway AnyCA Gateway REST plugin 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. |
| 58 | + |
| 59 | +> 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. |
| 60 | +
|
| 61 | +## Requirements |
| 62 | + |
| 63 | +TODO Requirements is a required section |
| 64 | + |
| 65 | +## Installation |
| 66 | + |
| 67 | +1. Install the AnyCA Gateway REST per the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/InstallIntroduction.htm). |
| 68 | + |
| 69 | +2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Idnomic PKI Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/idnomic-caplugin/releases/latest) from GitHub. |
| 70 | + |
| 71 | +3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory: |
| 72 | + |
| 73 | + |
| 74 | + ```shell |
| 75 | + Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations: |
| 76 | + Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions |
| 77 | + Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions |
| 78 | + ``` |
| 79 | + |
| 80 | + > The directory containing the Idnomic PKI 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. |
| 81 | + |
| 82 | +4. Restart the AnyCA Gateway REST service. |
| 83 | + |
| 84 | +5. Navigate to the AnyCA Gateway REST portal and verify that the Gateway recognizes the Idnomic PKI Gateway plugin by hovering over the ⓘ symbol to the right of the Gateway on the top left of the portal. |
| 85 | + |
| 86 | +## Configuration |
| 87 | + |
| 88 | +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: |
| 89 | + |
| 90 | + * **Gateway Registration** |
| 91 | + |
| 92 | + TODO Gateway Registration is a required section |
| 93 | + |
| 94 | + * **CA Connection** |
| 95 | + |
| 96 | + Populate using the configuration fields collected in the [requirements](#requirements) section. |
| 97 | + |
| 98 | + * **EndpointAddress** - The SOAP endpoint address for the Idnomic RA service. For example, 'https://idnomic-server.com/ra-service'. |
| 99 | + * **ClientCertLocation** - The file path to the client certificate used for mutual TLS authentication with the Idnomic service. |
| 100 | + * **ClientCertPassword** - The password for the client certificate. |
| 101 | + * **Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available. |
| 102 | + |
| 103 | +2. TODO Certificate Template Creation Step is a required section |
| 104 | + |
| 105 | +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. |
| 106 | + |
| 107 | + |
| 108 | + |
| 109 | +## License |
| 110 | + |
| 111 | +Apache License 2.0, see [LICENSE](LICENSE). |
| 112 | + |
| 113 | +## Related Integrations |
| 114 | + |
| 115 | +See all [Keyfactor Any CA Gateways (REST)](https://github.com/orgs/Keyfactor/repositories?q=anycagateway). |
0 commit comments