Skip to content

Commit a3d92bb

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 4aa1cbf commit a3d92bb

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ The Idnomic PKI Gateway plugin extends the capabilities of Idnomic PKI (formerly
4040
* Download all certificates issued by the Idnomic CA
4141
* Support for incremental and full synchronization
4242
* Filter certificates by issuance date
43+
* Filter certificates by Issuer DN for multi-CA environments
4344
* **Certificate Enrollment**:
4445
* Support certificate enrollment with new key pairs
4546
* Dynamic template (profile) discovery from the CA
@@ -197,6 +198,7 @@ The plugin supports the following standard CRL revocation reasons:
197198
| **ClientCertLocation** | Full file path to the client certificate PFX file on the Gateway server | Yes | `C:\Certificates\gateway-client.pfx` |
198199
| **ClientCertPassword** | Password for the client certificate PFX file | Yes | `SecureP@ssw0rd` |
199200
| **Enabled** | Whether the CA connection is enabled | No (default: true) | `true` or `false` |
201+
| **IssuerDnFilter** | Optional filter to restrict certificate synchronization to a specific issuing CA. Only certificates whose Issuer DN contains this value (case-insensitive substring match) will be synchronized. Can also be specified as a suffix on the endpoint URL using `\|\|issuerdnfilter=<value>` syntax. | No | `CN=Server CA` |
200202
201203
### Template (Product) Configuration
202204
@@ -216,6 +218,7 @@ The plugin supports the following standard CRL revocation reasons:
216218
217219
- Each defined Certificate Authority in the AnyCA Gateway REST can support one Idnomic CA endpoint
218220
- 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
221+
- When multiple issuing CAs are hosted on a single Idnomic instance, define a separate Logical CA for each and use the **IssuerDnFilter** parameter to scope certificate synchronization to the correct issuing CA. Each Logical CA should point to the same EndpointAddress but with a different IssuerDnFilter value containing a unique substring of the respective CA's Issuer DN (e.g., `CN=Server CA` vs `CN=User CA`)
219222
- Each CA configuration will manifest in Command as a separate CA entry
220223
- The plugin uses SOAP-based communication exclusively; ensure the RA connector endpoint is properly configured for SOAP access
221224
- Client certificate authentication is mandatory and cannot be disabled
@@ -267,6 +270,9 @@ The plugin supports the following standard CRL revocation reasons:
267270
- Confirm the client certificate has permissions to call `search_for_certificates`
268271
- Verify network connectivity and timeout settings
269272
- For large certificate databases, consider adjusting synchronization schedules
273+
- If certificates from the wrong issuing CA appear under a Logical CA, verify the **IssuerDnFilter** value is a unique substring that only matches the intended CA's Issuer DN
274+
- If no certificates sync when a filter is configured, enable Trace logging and check the `filtered out by IssuerDnFilter` messages to verify the filter value matches the certificate Issuer DN
275+
- The IssuerDnFilter set via the dedicated configuration field takes precedence over the `||issuerdnfilter=` endpoint URL suffix
270276
271277
## Test Cases
272278
@@ -486,6 +492,38 @@ The plugin supports the following standard CRL revocation reasons:
486492
487493
---
488494
495+
### Test Case 9: Issuer DN Filter - Multi-CA Sync Scoping
496+
497+
**Objective**: Verify that the IssuerDnFilter parameter correctly restricts certificate synchronization to a specific issuing CA when multiple CAs are hosted on the same Idnomic instance.
498+
499+
**Prerequisites**:
500+
- Idnomic instance has at least two issuing CAs (e.g., `CN=Server CA, O=Keyfactor, C=FR` and `CN=User CA, O=Keyfactor, C=FR`)
501+
- Certificates have been issued under each CA
502+
- Two Logical CAs are configured in the AnyCA Gateway, both pointing to the same EndpointAddress but with different IssuerDnFilter values
503+
504+
**Test Steps**:
505+
1. Configure Logical CA "IDnomic-ServerCA" with `IssuerDnFilter=CN=Server CA`
506+
2. Configure Logical CA "IDnomic-UserCA" with `IssuerDnFilter=CN=User CA`
507+
3. Trigger a full synchronization on "IDnomic-ServerCA"
508+
4. Trigger a full synchronization on "IDnomic-UserCA"
509+
5. Verify certificate inventory in Keyfactor Command for each Logical CA
510+
511+
**Expected Results**:
512+
- "IDnomic-ServerCA" contains only certificates issued by `CN=Server CA`
513+
- "IDnomic-UserCA" contains only certificates issued by `CN=User CA`
514+
- No certificates appear under the wrong Logical CA
515+
- Synchronization completes without errors
516+
517+
**Verification**:
518+
- Review Gateway logs for `Issuer DN filter resolved to:` messages confirming filter activation
519+
- At Trace level, confirm per-certificate `passed IssuerDnFilter` and `filtered out by IssuerDnFilter` log entries
520+
- Spot-check certificates in Command to verify Issuer DN matches the configured filter
521+
- Test with IssuerDnFilter left blank to confirm all certificates sync (legacy behavior)
522+
- Test case-insensitivity by using a differently-cased filter value (e.g., `cn=server ca`)
523+
- Test the `||issuerdnfilter=` endpoint URL suffix syntax as an alternative to the dedicated field
524+
525+
---
526+
489527
490528
## License
491529

0 commit comments

Comments
 (0)