11# Introduction
2- This AnyGateway plug-in enables issuance, revocation, and synchronization of certificates from < Company > < Product > offering.
2+ This AnyGateway plug-in enables issuance, revocation, and synchronization of certificates from DigiCert's CertCentral offering.
33# Prerequisites
44
55## Certificate Chain
@@ -10,121 +10,19 @@ In order to enroll for certificates the Keyfactor Command server must trust the
1010# Install
1111* Download latest successful build from [ GitHub Releases] ( ../../releases/latest )
1212
13- * Copy <GatewayDLL >.dll to the Program Files\Keyfactor\Keyfactor AnyGateway directory
14-
15- * Update the CAProxyServer.config file
16- * Update the CAConnection section to point at the DigiCertCAProxy class
17- ``` xml
18- <alias alias =" CAConnector" type =" Keyfactor.Extensions.AnyGateway.Company.Product.GatewayNameCAConnector, DLLName" />
19- ```
20-
21- # Configuration
22- The following sections will breakdown the required configurations for the AnyGatewayConfig.json file that will be imported to configure the AnyGateway.
23-
24- ## Templates
25- The Template section will map the CA's products to an AD template.
26- * ``` ProductID ```
27- This is the ID of the <Product > product to map to the specified template.
28-
29- ``` json
30- "Templates" : {
31- "WebServer" : {
32- "ProductID" : " <productID>" ,
33- "Parameters" : {
34- }
35- }
13+ * Copy DigiCertCAGateway.dll and DigiCertCAGateway.deps.json to the Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions directory
14+
15+ * Update the manifest.json file located in Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions\Connectors
16+ * If the manifest.json file or the Connectors folder do not exist, create them.
17+ ``` json
18+ {
19+ "extensions" : {
20+ "Keyfactor.AnyGateway.Extensions.ICAConnector" : {
21+ "DigiCertCAConnector" : {
22+ "assemblypath" : " ../DigiCertCAGateway.dll" ,
23+ "TypeFullName" : " Keyfactor.Extensions.CAGateway.DigiCert.CertCentralCAConnector"
24+ }
25+ }
26+ }
3627}
37- ```
38-
39- ## Security
40- The security section does not change specifically for the <Product > CA Gateway. Refer to the AnyGateway Documentation for more detail.
41- ``` json
42- /*Grant permissions on the CA to users or groups in the local domain.
43- READ: Enumerate and read contents of certificates.
44- ENROLL: Request certificates from the CA.
45- OFFICER: Perform certificate functions such as issuance and revocation. This is equivalent to "Issue and Manage" permission on the Microsoft CA.
46- ADMINISTRATOR: Configure/reconfigure the gateway.
47- Valid permission settings are "Allow", "None", and "Deny".*/
48- "Security" : {
49- "Keyfactor\\ Administrator" : {
50- "READ" : " Allow" ,
51- "ENROLL" : " Allow" ,
52- "OFFICER" : " Allow" ,
53- "ADMINISTRATOR" : " Allow"
54- },
55- "Keyfactor\\ gateway_test" : {
56- "READ" : " Allow" ,
57- "ENROLL" : " Allow" ,
58- "OFFICER" : " Allow" ,
59- "ADMINISTRATOR" : " Allow"
60- },
61- "Keyfactor\\ SVC_TimerService" : {
62- "READ" : " Allow" ,
63- "ENROLL" : " Allow" ,
64- "OFFICER" : " Allow" ,
65- "ADMINISTRATOR" : " None"
66- },
67- "Keyfactor\\ SVC_AppPool" : {
68- "READ" : " Allow" ,
69- "ENROLL" : " Allow" ,
70- "OFFICER" : " Allow" ,
71- "ADMINISTRATOR" : " Allow"
72- }
73- }
74- ```
75- ## CerificateManagers
76- The Certificate Managers section is optional.
77- If configured, all users or groups granted OFFICER permissions under the Security section
78- must be configured for at least one Template and one Requester.
79- Uses "<All >" to specify all templates. Uses "Everyone" to specify all requesters.
80- Valid permission values are "Allow" and "Deny".
81- ``` json
82- "CertificateManagers" :{
83- "DOMAIN\\ Username" :{
84- "Templates" :{
85- "MyTemplateShortName" :{
86- "Requesters" :{
87- "Everyone" :" Allow" ,
88- "DOMAIN\\ Groupname" :" Deny"
89- }
90- },
91- "<All>" :{
92- "Requesters" :{
93- "Everyone" :" Allow"
94- }
95- }
96- }
97- }
98- }
99- ```
100- ## CAConnection
101- The CA Connection section will determine the API endpoint and configuration data used to connect to the <Product > API.
102-
103-
104- ``` json
105- "CAConnection" : {
106-
107- },
108- ```
109- ## GatewayRegistration
110- There are no specific Changes for the GatewayRegistration section. Refer to the AnyGateway Documentation for more detail.
111- ``` json
112- "GatewayRegistration" : {
113- "LogicalName" : " CASandbox" ,
114- "GatewayCertificate" : {
115- "StoreName" : " CA" ,
116- "StoreLocation" : " LocalMachine" ,
117- "Thumbprint" : " 0123456789abcdef"
118- }
119- }
120- ```
121-
122- ## ServiceSettings
123- There are no specific Changes for the ServiceSettings section. Refer to the AnyGateway Documentation for more detail.
124- ``` json
125- "ServiceSettings" : {
126- "ViewIdleMinutes" : 8 ,
127- "FullScanPeriodHours" : 24 ,
128- "PartialScanPeriodMinutes" : 240
129- }
130- ```
28+ ```
0 commit comments