Skip to content

Commit 8f8f0d3

Browse files
doebrowskdgaleyKeyfactormkachkfiddlermikey
authored
Merge 1.1.0 to main
* Add custom field support * changelog * support cname return from enrollment * Update generated docs * feat: release 1.1.1 * Update generated docs * Fix for issues with * Test * Added template parameter configuration via REST gateway. Fixed bug with email used for verification. Changed docs and enrollment field/template parameter names. See changelog. * Update generated docs * Fixed broken logging. * Incremental sync support added using csc date filter so sync timing can run faster that default full sync periods * Update generated docs * Fixes for Incremental Sync * Update CHANGELOG.md --------- Co-authored-by: Mikey Henderson <4452096+fiddlermikey@users.noreply.github.com> Co-authored-by: Sean <1661003+spbsoluble@users.noreply.github.com> Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io> Co-authored-by: Brian Hill <bhill@keyfactor.com> Co-authored-by: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com> --------- Co-authored-by: David Galey <dgaley@keyfactor.com> Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io> Co-authored-by: Mark Kachkaev <37276742+mkachk@users.noreply.github.com> Co-authored-by: Mikey Henderson <4452096+fiddlermikey@users.noreply.github.com> Co-authored-by: Sean <1661003+spbsoluble@users.noreply.github.com> Co-authored-by: Brian Hill <bhill@keyfactor.com> Co-authored-by: Brian Hill <76450501+bhillkeyfactor@users.noreply.github.com>
1 parent ce4df18 commit 8f8f0d3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+743
-196
lines changed

CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1+
v.1.1.1
2+
- Added Incremental Sync that goes back X Number of days
3+
- Fixed issue with parsing certain certificates that were in zip format
4+
- Fixed Missing Default Values for Template Enrollment Parameters
5+
- Fixed Issue Template Configuration Params Missing and Certificate Profile Mapping Not Present
6+
7+
v.1.0.2
8+
- Warning: enrollment field/template parameter with the name "CN DCV Email (admin@boingy.com)" has been renamed to "CN DCV Email" to make it compatible with the REST gateway. "Aplicant Pgone (+nn.nnnnnnnn)" has also been renamed to "Applicant Phone".
9+
- Updated dependencies.
10+
- Added support for default values via enrollment parameters configured in the AnyGateway REST certificate template.
11+
- Fixed issue with non-ASCII characters breaking the gateway.
12+
113
v1.0.1
214
- Fixed issue with SANs not being read correctly.
315

416
v1.0
5-
- Initial Release.
17+
18+
- Initial Release.

README.md

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,16 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
5555

5656
2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [CSCGlobal CA Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/cscglobal-caplugin/releases/latest) from GitHub.
5757

58-
3. Copy the unzipped directory (usually called `net6.0`) to the Extensions directory:
58+
3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory:
59+
5960

6061
```shell
62+
Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations:
6163
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions
64+
Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions
6265
```
6366

64-
> The directory containing the CSCGlobal CA Gateway AnyCA Gateway REST plugin DLLs (`net6.0`) can be named anything, as long as it is unique within the `Extensions` directory.
67+
> The directory containing the CSCGlobal CA 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.
6568

6669
4. Restart the AnyCA Gateway REST service.
6770

@@ -84,11 +87,13 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
8487
* **BearerToken** - CSCGlobal Bearer Token
8588
* **DefaultPageSize** - Default page size for use with the API. Default is 100
8689
* **TemplateSync** - Enable template sync.
90+
* **SyncFilterDays** - Number of days from today to filter certificates by expiration date during incremental sync.
8791

8892
2. PLEASE NOTE, AT THIS TIME THE RAPID_SSL TEMPLATE IS NOT SUPPORTED BY THE CSC API AND WILL NOT WORK WITH THIS INTEGRATION
8993

9094
The following certificate templates are supported. Please set up the key sizes accordingly in the Certificate Profile menu of Anygateway REST, then enter the remaining details
91-
and the Enrollment Fields for each Template accordingly using the Certificate Templates section in Command:
95+
and the Enrollment Fields for each Template accordingly using the Certificate Templates section in Command. If you would like to set up default values for enrollment parameters, you can do so the in the Certificate Template Menu of Anygateway REST.
96+
If a field value is specified as both an Enrollment Field in Command and in the Certificate Template Menu in the REST Gateway, the value in the Enrollment Field will take precedence.
9297

9398
CONFIG ELEMENT | DESCRIPTION
9499
----------------------------|------------------
@@ -109,12 +114,12 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
109114
Applicant First Name | String | N/A
110115
Applicant Last Name | String | N/A
111116
Applicant Email Address | String | N/A
112-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
117+
Applicant Phone | String | N/A
113118
Domain Control Validation Method | Multiple Choice | EMAIL
114119
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
115120
Business Unit | Multiple Choice | Get From CSC Differs For Clients
116121
Notification Email(s) Comma Separated | String | N/A
117-
CN DCV Email (admin@yourdomain.com) | String | N/A
122+
CN DCV Email | String | N/A
118123

119124
**CSC TrustedSecure EV Certificate - Details Tab**
120125

@@ -137,12 +142,12 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
137142
Applicant First Name | String | N/A
138143
Applicant Last Name | String | N/A
139144
Applicant Email Address | String | N/A
140-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
145+
Applicant Phone | String | N/A
141146
Domain Control Validation Method | Multiple Choice | EMAIL
142147
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
143148
Business Unit | Multiple Choice | Get From CSC Differs For Clients
144149
Notification Email(s) Comma Separated | String | N/A
145-
CN DCV Email (admin@yourdomain.com) | String | N/A
150+
CN DCV Email | String | N/A
146151
Organization Country | String | N/A
147152

148153
**CSC TrustedSecure UC Certificate - Details Tab**
@@ -166,13 +171,13 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
166171
Applicant First Name | String | N/A
167172
Applicant Last Name | String | N/A
168173
Applicant Email Address | String | N/A
169-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
174+
Applicant Phone | String | N/A
170175
Domain Control Validation Method | Multiple Choice | EMAIL
171176
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
172177
Business Unit | Multiple Choice | Get From CSC Differs For Clients
173178
Notification Email(s) Comma Separated | String | N/A
174-
CN DCV Email (admin@yourdomain.com) | String | N/A
175-
Addtl Sans Comma Separated DVC Emails | String | N/A
179+
CN DCV Email | String | N/A
180+
Addtl Sans Comma Separated DCV Emails | String | N/A
176181

177182

178183
**CSC TrustedSecure Premium Wildcard Certificate - Details Tab**
@@ -196,12 +201,12 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
196201
Applicant First Name | String | N/A
197202
Applicant Last Name | String | N/A
198203
Applicant Email Address | String | N/A
199-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
204+
Applicant Phone | String | N/A
200205
Domain Control Validation Method | Multiple Choice | EMAIL
201206
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
202207
Business Unit | Multiple Choice | Get From CSC Differs For Clients
203208
Notification Email(s) Comma Separated | String | N/A
204-
CN DCV Email (admin@yourdomain.com) | String | N/A
209+
CN DCV Email | String | N/A
205210

206211
**CSC TrustedSecure Domain Validated SSL - Details Tab**
207212

@@ -224,12 +229,12 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
224229
Applicant First Name | String | N/A
225230
Applicant Last Name | String | N/A
226231
Applicant Email Address | String | N/A
227-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
232+
Applicant Phone | String | N/A
228233
Domain Control Validation Method | Multiple Choice | EMAIL
229234
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
230235
Business Unit | Multiple Choice | Get From CSC Differs For Clients
231236
Notification Email(s) Comma Separated | String | N/A
232-
CN DCV Email (admin@yourdomain.com) | String | N/A
237+
CN DCV Email | String | N/A
233238

234239
**CSC TrustedSecure Domain Validated Wildcard SSL - Details Tab**
235240

@@ -252,12 +257,12 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
252257
Applicant First Name | String | N/A
253258
Applicant Last Name | String | N/A
254259
Applicant Email Address | String | N/A
255-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
260+
Applicant Phone | String | N/A
256261
Domain Control Validation Method | Multiple Choice | EMAIL
257262
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
258263
Business Unit | Multiple Choice | Get From CSC Differs For Clients
259264
Notification Email(s) Comma Separated | String | N/A
260-
CN DCV Email (admin@yourdomain.com) | String | N/A
265+
CN DCV Email | String | N/A
261266

262267
**CSC TrustedSecure Domain Validated UC Certificate - Details Tab**
263268

@@ -280,16 +285,31 @@ This integration is tested and confirmed as working for Anygateway REST 24.2 and
280285
Applicant First Name | String | N/A
281286
Applicant Last Name | String | N/A
282287
Applicant Email Address | String | N/A
283-
Applicant Phone (+nn.nnnnnnnn) | String | N/A
288+
Applicant Phone | String | N/A
284289
Domain Control Validation Method | Multiple Choice | EMAIL
285290
Organization Contact | Multiple Choice | Get From CSC Differs For Clients
286291
Business Unit | Multiple Choice | Get From CSC Differs For Clients
287292
Notification Email(s) Comma Separated | String | N/A
288-
CN DCV Email (admin@yourdomain.com) | String | N/A
289-
Addtl Sans Comma Separated DVC Emails | String | N/A
293+
CN DCV Email | String | N/A
294+
Addtl Sans Comma Separated DCV Emails | String | N/A
290295

291296
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.
292297

298+
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:
299+
300+
* **Term** - OPTIONAL: Certificate term (e.g. 12 or 24 months)
301+
* **Applicant First Name** - OPTIONAL: Applicant First Name
302+
* **Applicant Last Name** - OPTIONAL: Applicant Last Name
303+
* **Applicant Email Address** - OPTIONAL: Applicant Email Address
304+
* **Applicant Phone** - OPTIONAL: Applicant Phone (+nn.nnnnnnnn)
305+
* **Domain Control Validation Method** - OPTIONAL: Domain Control Validation Method (e.g. EMAIL)
306+
* **Organization Contact** - OPTIONAL: Organization Contact (selected from CSC configuration)
307+
* **Business Unit** - OPTIONAL: Business Unit (selected from CSC configuration)
308+
* **Notification Email(s) Comma Separated** - OPTIONAL: Notification Email(s), comma separated
309+
* **CN DCV Email** - OPTIONAL: CN DCV Email (e.g. admin@yourdomain.com)
310+
* **Organization Country** - OPTIONAL: Organization Country
311+
* **Addtl Sans Comma Separated DCV Emails** - OPTIONAL: Additional SANs DCV Emails, comma separated
312+
293313

294314

295315
## License

cscglobal-caplugin.sln

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio Version 17
4-
VisualStudioVersion = 17.11.35327.3
3+
# Visual Studio Version 18
4+
VisualStudioVersion = 18.0.11217.181 d18.0
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSCGlobalCAPlugin", "cscglobal-caplugin\CSCGlobalCAPlugin.csproj", "{01DDFD6F-275D-46E7-B522-E0C965D1BF9C}"
77
EndProject
8+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{8EC462FD-D22E-90A8-E5CE-7E832BA40C5D}"
9+
ProjectSection(SolutionItems) = preProject
10+
CHANGELOG.md = CHANGELOG.md
11+
docsource\configuration.md = docsource\configuration.md
12+
integration-manifest.json = integration-manifest.json
13+
EndProjectSection
14+
EndProject
815
Global
916
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1017
Debug|Any CPU = Debug|Any CPU

cscglobal-caplugin/CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
v1.1.0
2+
- Support for custom fields in enrollment
3+
- Support for returning CNAME tokens from enrollment call
4+
5+
v1.0.1
6+
- Fixed issue with SANs not being read correctly.
7+
8+
v1.0
9+
- Initial Release.

0 commit comments

Comments
 (0)