Skip to content

Commit 4d0bb4a

Browse files
Update configuration.md
1 parent e1bbee6 commit 4d0bb4a

1 file changed

Lines changed: 60 additions & 1 deletion

File tree

docsource/configuration.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,66 @@ The plugin supports the following standard CRL revocation reasons:
123123

124124
## Gateway Registration
125125

126-
TODO Gateway Registration is a required section
126+
### CA Connection Configuration
127+
128+
When registering the Idnomic CA in the AnyCA Gateway, you'll need to provide the following configuration parameters:
129+
130+
| Parameter | Description | Required | Example |
131+
|-----------|-------------|----------|---------|
132+
| **EndpointAddress** | Full URL to the Idnomic RA connector SOAP endpoint | Yes | `https://idnomic.example.com:8443/RA/connector.cgi` |
133+
| **ClientCertLocation** | Full file path to the client certificate PFX file on the Gateway server | Yes | `C:\Certificates\gateway-client.pfx` |
134+
| **ClientCertPassword** | Password for the client certificate PFX file | Yes | `SecureP@ssw0rd` |
135+
| **Enabled** | Whether the CA connection is enabled | No (default: true) | `true` or `false` |
136+
137+
### Template (Product) Configuration
138+
139+
Each certificate template discovered from Idnomic requires configuration when used for enrollment:
140+
141+
| Parameter | Description | Required | Example |
142+
|-----------|-------------|----------|---------|
143+
| **Zone** | The Idnomic PKI zone where certificates will be issued | Yes | `Production` |
144+
145+
**Important Notes**:
146+
- Template names (Product IDs) are automatically discovered from Idnomic using the `list_profiles` operation
147+
- The Zone parameter must exactly match a zone configured in your Idnomic PKI system
148+
- Zone names are case-sensitive
149+
- Each template can be configured with a different zone if needed
150+
151+
### Configuration Example
152+
153+
**CA Configuration in AnyCA Gateway**:
154+
```json
155+
{
156+
"EndpointAddress": "https://idnomic-pki.example.com:8443/RA/connector.cgi",
157+
"ClientCertLocation": "C:\\Program Files\\Keyfactor\\AnyGateway\\Certificates\\gateway-client.pfx",
158+
"ClientCertPassword": "MySecurePassword123!",
159+
"Enabled": true
160+
}
161+
```
162+
163+
**Template Configuration** (for each profile):
164+
```json
165+
{
166+
"Zone": "Production"
167+
}
168+
```
169+
170+
### Gateway Registration Notes
171+
172+
- Each defined Certificate Authority in the AnyCA Gateway REST can support one Idnomic CA endpoint
173+
- If you have multiple Idnomic PKI instances or need to issue from different zones with different permissions, you must define multiple Certificate Authorities in the AnyCA Gateway
174+
- Each CA configuration will manifest in Command as a separate CA entry
175+
- The plugin uses SOAP-based communication exclusively; ensure the RA connector endpoint is properly configured for SOAP access
176+
- Client certificate authentication is mandatory and cannot be disabled
177+
- The "Enabled" flag allows you to temporarily disable a CA connection without removing the configuration
178+
179+
### Security Considerations
180+
181+
1. **Certificate Storage**: Store client certificates in a secure location with restricted file system permissions
182+
2. **Password Management**: Use strong passwords for client certificate PFX files and consider using a secrets management system
183+
3. **Network Security**: Ensure TLS/SSL is properly configured for the RA connector endpoint
184+
4. **Least Privilege**: Request client certificates with minimal required permissions in the Idnomic PKI system
185+
5. **Audit Logging**: Enable comprehensive logging in both the Gateway and Idnomic PKI for security monitoring
127186

128187
## Certificate Template Creation Step
129188

0 commit comments

Comments
 (0)