Skip to content

Commit 7c22709

Browse files
spbsolublespbsoluble
authored
Merge dc6ee81 into 7388276 
2 parents 7388276 + dc6ee81 commit 7c22709

5 files changed

Lines changed: 165 additions & 42 deletions

File tree

‎.github/workflows/keyfactor-bootstrap-workflow.yml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,19 @@ on:
1111

1212
jobs:
1313
call-starter-workflow:
14-
uses: keyfactor/actions/.github/workflows/starter.yml@v3
14+
uses: keyfactor/actions/.github/workflows/starter.yml@v4
15+
permissions:
16+
contents: write
17+
with:
18+
command_token_url: ${{ vars.COMMAND_TOKEN_URL }}
19+
command_hostname: ${{ vars.COMMAND_HOSTNAME }}
20+
command_base_api_path: ${{ vars.COMMAND_API_PATH }}
1521
secrets:
16-
token: ${{ secrets.V2BUILDTOKEN}}
17-
APPROVE_README_PUSH: ${{ secrets.APPROVE_README_PUSH}}
22+
token: ${{ secrets.V2BUILDTOKEN }}
1823
gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }}
1924
gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }}
25+
scan_token: ${{ secrets.SAST_TOKEN }}
26+
entra_username: ${{ secrets.DOCTOOL_ENTRA_USERNAME }}
27+
entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }}
28+
command_client_id: ${{ secrets.COMMAND_CLIENT_ID }}
29+
command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }}

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
### 1.0.0
2-
* initial release
1+
## 1.0.0
2+
* Initial release

‎README.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<h1 align="center" style="border-bottom: none">
2+
Nexus Certificate Maanager Gateway AnyCA Gateway REST Plugin
3+
</h1>
4+
5+
<p align="center">
6+
<!-- Badges -->
7+
<img src="https://img.shields.io/badge/integration_status-prototype-3D1973?style=flat-square" alt="Integration Status: prototype" />
8+
<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>
9+
<img src="https://img.shields.io/github/issues/Keyfactor/nexus-certificate-manager-caplugin?style=flat-square" alt="Issues" />
10+
<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)" />
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 Nexus Certificate Manager AnyCA REST plugin extends the capabilities of the Nexus Certificate Manager product to Keyfactor Command via the Keyfactor AnyCA Gateway REST. The plugin represents a fully featured AnyCA REST Plugin with the following capabilies:
38+
* Certificate Synchronization
39+
* Certificate Enrollment
40+
* Certificate Revocation
41+
42+
## Compatibility
43+
44+
The Nexus Certificate Maanager Gateway AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 25.2.0 and later.
45+
46+
## Support
47+
The Nexus Certificate Maanager 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.
48+
49+
> 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.
50+
51+
## Requirements
52+
53+
- The host URL for the instance of Nexus Certificate Manager
54+
- A certificate in the pfx format to use for authentication into Nexus Certificate Manager, located on the Gateway Host
55+
- The passphrase for the pfx certificate
56+
57+
## Installation
58+
59+
1. Install the AnyCA Gateway REST per the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/InstallIntroduction.htm).
60+
61+
2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Nexus Certificate Maanager Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/nexus-certificate-manager-caplugin/releases/latest) from GitHub.
62+
63+
3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory:
64+
65+
66+
```shell
67+
Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations:
68+
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions
69+
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions
70+
```
71+
72+
> The directory containing the Nexus Certificate Maanager 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.
73+
74+
4. Restart the AnyCA Gateway REST service.
75+
76+
5. Navigate to the AnyCA Gateway REST portal and verify that the Gateway recognizes the Nexus Certificate Maanager Gateway plugin by hovering over the ⓘ symbol to the right of the Gateway on the top left of the portal.
77+
78+
## Configuration
79+
80+
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:
81+
82+
* **Gateway Registration**
83+
84+
In order to enroll certificates the Keyfactor Command server must trust the CA chain. Once you identify your Root and/or Subordinate CA used by the Nexus Certificate Manager platform, make sure to download and import the certificate chain into the Command Server certificate store
85+
86+
* **CA Connection**
87+
88+
Populate using the configuration fields collected in the [requirements](#requirements) section.
89+
90+
* **Host** - The path to the Nexus CM server, including port
91+
* **AuthCertificatePath** - The path to the PFX certificate for authenticating into Nexus CM
92+
* **AuthCertPassword** - The password for the authentication certificate
93+
* **Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available.
94+
95+
2. For this AnyCA Gateway, there is a single product type named "NexusCM".
96+
97+
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.
98+
99+
100+
## CA Connection
101+
102+
The certificate used by the gateway for authenticating into the Nexus Certificate Manager will need to be copied to a location on the Gateway Host that is accessible by the gateway service. The Certificate Path
103+
104+
105+
## License
106+
107+
Apache License 2.0, see [LICENSE](LICENSE).
108+
109+
## Related Integrations
110+
111+
See all [Keyfactor Any CA Gateways (REST)](https://github.com/orgs/Keyfactor/repositories?q=anycagateway).

‎docsource/configuration.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Overview
22

3-
The Nexus Certificate Manager AnyCA REST plugin extends the capabilities of the Nexus Certificate Manager product to Keyfactor Command via the Keyfactor AnyCA Gateway REST. The plugin represents a fully featured AnyCA REST Plugin with the following capabilies:
3+
The Nexus Certificate Manager AnyCA REST plugin connects Nexus Certificate Manager to Keyfactor Command via the AnyCA Gateway REST. It supports the following capabilities:
44
* Certificate Synchronization
55
* Certificate Enrollment
66
* Certificate Revocation
@@ -13,11 +13,11 @@ The Nexus Certificate Manager AnyCA REST plugin extends the capabilities of the
1313

1414
## Gateway Registration
1515

16-
In order to enroll certificates the Keyfactor Command server must trust the CA chain. Once you identify your Root and/or Subordinate CA used by the Nexus Certificate Manager platform, make sure to download and import the certificate chain into the Command Server certificate store
16+
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.
1717

1818
## CA Connection
1919

20-
The certificate used by the gateway for authenticating into the Nexus Certificate Manager will need to be copied to a location on the Gateway Host that is accessible by the gateway service. The Certificate Path
20+
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.
2121

2222
## Certificate Template Creation Step
2323

‎integration-manifest.json‎

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,39 @@
11
{
2-
"$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json",
3-
"integration_type": "anyca-plugin",
4-
"name": "Nexus Certificate Maanager AnyCA REST Gateway Plugin",
5-
"status": "prototype",
6-
"support_level": "kf-community",
7-
"link_github": false,
8-
"update_catalog": false,
9-
"description": "Nexus Certificate Manager plugin for the AnyCA REST Gateway framework",
10-
"gateway_framework": "25.2.0",
11-
"release_dir": "nexus-certificate-manager-caplugin/bin/Release",
12-
"release_project": "nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.csproj",
13-
"about": {
14-
"carest": {
15-
"product_ids": [ "NexusCM" ],
16-
"ca_plugin_config": [
17-
{
18-
"name": "Host",
19-
"description": "The URI of the instance of the Nexus Certificate Manager API, including port. example: https://127.0.0.1:8444"
20-
},
21-
{
22-
"name": "AuthCertificatePath",
23-
"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'"
24-
},
25-
{
26-
"name": "AuthCertPassword",
27-
"description": "The password for the PFX certificate located on the AnyCA Gateway Host that will be used for authentication into Nexus Certificate Manager"
28-
},
29-
{
30-
"name": "Enabled",
31-
"description": "Flag to enable or disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available."
2+
"$schema": "https://keyfactor.github.io/v2/integration-manifest-schema.json",
3+
"integration_type": "anyca-plugin",
4+
"name": "Nexus Certificate Manager AnyCA REST Gateway Plugin",
5+
"status": "prototype",
6+
"support_level": "kf-community",
7+
"link_github": false,
8+
"update_catalog": false,
9+
"description": "Nexus Certificate Manager plugin for the AnyCA REST Gateway framework",
10+
"gateway_framework": "25.2.0",
11+
"release_dir": "nexus-certificate-manager-caplugin/bin/Release",
12+
"release_project": "nexus-certificate-manager-caplugin/NexusCertManagerCAPlugin.csproj",
13+
"about": {
14+
"carest": {
15+
"product_ids": [
16+
"NexusCM"
17+
],
18+
"ca_plugin_config": [
19+
{
20+
"name": "Host",
21+
"description": "The path to the Nexus CM server, including port"
22+
},
23+
{
24+
"name": "AuthCertificatePath",
25+
"description": "The path to the PFX certificate for authenticating into Nexus CM"
26+
},
27+
{
28+
"name": "AuthCertPassword",
29+
"description": "The password for the authentication certificate"
30+
},
31+
{
32+
"name": "Enabled",
33+
"description": "Enables or disables gateway functionality. Disable to create the CA before configuration information is available."
34+
}
35+
],
36+
"enrollment_config": []
3237
}
33-
],
34-
"enrollment_config": []
3538
}
36-
}
37-
}
39+
}

0 commit comments

Comments
 (0)