You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-12Lines changed: 9 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,8 +54,6 @@ The Aruba Clearpass Gateway AnyCA Gateway REST plugin is supported by Keyfacto
54
54
55
55
## Requirements
56
56
57
-
---
58
-
59
57
### ClearPass Onboard: Setting Up an API Client
60
58
61
59
#### Step 1: Access ClearPass Admin Console
@@ -81,7 +79,9 @@ The Aruba Clearpass Gateway AnyCA Gateway REST plugin is supported by Keyfacto
81
79
- Select **ClearPass REST API - Client will be used for API calls to ClearPass** from the **Operating Mode** dropdown.
82
80
83
81
-**Operator Profile**:
82
+
84
83
- Select **Super Administrator** from the **Operator Profile** dropdown.
84
+
85
85
- This profile will provide the API client with the necessary permissions to interact with ClearPass.
86
86
87
87
-**Grant Type**:
@@ -94,7 +94,6 @@ The Aruba Clearpass Gateway AnyCA Gateway REST plugin is supported by Keyfacto
94
94
-**Note:** The client secret is used in the OAuth2 `client_secret` parameter and will be encrypted once stored, so be sure to copy it securely.
95
95
96
96
#### Step 4: Set Token Lifetimes
97
-
98
97
-**Access Token Lifetime**:
99
98
- Enter `8` in the **Access Token Lifetime** field.
100
99
- Select **hours** from the dropdown. This means the access token will be valid for 8 hours.
@@ -166,13 +165,16 @@ At the time of writing, there was no API call available to get a list of Certifi
166
165
167
166
2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Aruba Clearpass Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/aruba-clearpass-caplugin/releases/latest) from GitHub.
168
167
169
-
3. Copy the unzipped directory (usually called `net6.0`) to the Extensions directory:
168
+
3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory:
169
+
170
170
171
171
```shell
172
+
Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations:
172
173
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions
174
+
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions
173
175
```
174
176
175
-
> The directory containing the Aruba Clearpass Gateway AnyCA Gateway REST plugin DLLs (`net6.0`) can be named anything, as long as it is unique within the `Extensions` directory.
177
+
> The directory containing the Aruba Clearpass 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.
176
178
177
179
4. Restart the AnyCA Gateway REST service.
178
180
@@ -184,7 +186,7 @@ At the time of writing, there was no API call available to get a list of Certifi
184
186
185
187
***Gateway Registration**
186
188
187
-
TODO Gateway Registration is a required section
189
+
Each defined Certificate Authority in the AnyCA Gateway REST can support one issuing certificate authority. Since Aruba ClearPass Onboard has multiple available Certificate Authorities, if you require certificate enrollment from multiple Aruba ClearPass Certificate Authorities, you must define multiple Certificate Authorities in the AnyCA Gateway REST. This will manifest in Command as one Aruba ClearPass CA per defined Certificate Authority.
188
190
189
191
***CA Connection**
190
192
@@ -194,6 +196,7 @@ At the time of writing, there was no API call available to get a list of Certifi
194
196
***BaseUrl** - Base Url for ClearPass API such as https://url:8443
195
197
***ClearPassApiClient** - ClearPass API Client Name
196
198
***ClearPassCaId** - ClearPass Ca Id. Example would be 2. In ClearPass Onboard UI, click edit on the Ca and look at the id in the Url.
199
+
***Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available.
197
200
198
201
2. Define [Certificate Profiles](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCP-Gateway.htm) and [Certificate Templates](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/AddCA-Gateway.htm) for the Certificate Authority as required. One Certificate Profile must be defined per Certificate Template. It's recommended that each Certificate Profile be named after the Product ID. The Aruba Clearpass Gateway plugin supports the following product IDs:
199
202
@@ -205,12 +208,6 @@ At the time of writing, there was no API call available to get a list of Certifi
205
208
206
209
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.
207
210
208
-
4. In Keyfactor Command (v12.3+), for each imported Certificate Template, follow the [official documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Configuring%20Template%20Options.htm) to define enrollment fields for each of the following parameters:
209
-
210
-
* **NumberOfDaysValid** - OPTIONAL: The number of days of validity to use when requesting certs. If not provided, default is 365.
Copy file name to clipboardExpand all lines: integration-manifest.json
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,10 @@
27
27
{
28
28
"name": "ClearPassCaId",
29
29
"description": "ClearPass Ca Id. Example would be 2. In ClearPass Onboard UI, click edit on the Ca and look at the id in the Url."
30
+
},
31
+
{
32
+
"name": "Enabled",
33
+
"description": "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available."
0 commit comments