diff --git a/.gitignore b/.gitignore index 43d9deb..50b55db 100644 --- a/.gitignore +++ b/.gitignore @@ -361,3 +361,6 @@ MigrationBackup/ # Fody - auto-generated XML schema FodyWeavers.xsd +/.claude +/issue.txt +/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 2395c25..f5e356a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +v.1.0.1 + +- Added support for the AWS Code Signing Template +- Fixed template passthrough to final certificate + v1.0 - Initial Release. diff --git a/README.md b/README.md index 6a2f36e..647e905 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- AWSPCA CA Gateway AnyCA Gateway REST Plugin + AWSPCA CAPlugin AnyCA Gateway REST Plugin

@@ -38,10 +38,10 @@ This integration allows for the Synchronization, Enrollment, and Revocation of c ## Compatibility -The AWSPCA CA Gateway AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 25.4.0 and later. +The AWSPCA CAPlugin AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 25.4.0 and later. ## Support -The AWSPCA CA Gateway AnyCA Gateway REST plugin is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com. +The AWSPCA CAPlugin AnyCA Gateway REST plugin is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket with your Keyfactor representative. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com. > To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab. @@ -53,7 +53,7 @@ This integration is tested and confirmed as working for Anygateway REST 24.4 and 1. Install the AnyCA Gateway REST per the [official Keyfactor documentation](https://software.keyfactor.com/Guides/AnyCAGatewayREST/Content/AnyCAGatewayREST/InstallIntroduction.htm). -2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [AWSPCA CA Gateway AnyCA Gateway REST plugin](https://github.com/Keyfactor/aws-pca-caplugin/releases/latest) from GitHub. +2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [AWSPCA CAPlugin AnyCA Gateway REST plugin](https://github.com/Keyfactor/aws-pca-caplugin/releases/latest) from GitHub. 3. Copy the unzipped directory (usually called `net6.0` or `net8.0`) to the Extensions directory: @@ -64,11 +64,11 @@ This integration is tested and confirmed as working for Anygateway REST 24.4 and Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions ``` - > The directory containing the AWSPCA 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. + > The directory containing the AWSPCA CAPlugin AnyCA Gateway REST plugin DLLs (`net6.0` or `net8.0`) can be named anything, as long as it is unique within the `Extensions` directory. 4. Restart the AnyCA Gateway REST service. -5. Navigate to the AnyCA Gateway REST portal and verify that the Gateway recognizes the AWSPCA CA Gateway plugin by hovering over the ⓘ symbol to the right of the Gateway on the top left of the portal. +5. Navigate to the AnyCA Gateway REST portal and verify that the Gateway recognizes the AWSPCA CAPlugin plugin by hovering over the ⓘ symbol to the right of the Gateway on the top left of the portal. ## Configuration @@ -100,11 +100,12 @@ This integration is tested and confirmed as working for Anygateway REST 24.4 and * **ExternalId** - Optional sts:ExternalId to supply on AssumeRole calls. * **Enabled** - Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available. -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 AWSPCA CA Gateway plugin supports the following product IDs: +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 AWSPCA CAPlugin plugin supports the following product IDs: * **EndEntity** * **EndEntityClientAuth** * **EndEntityServerAuth** + * **CodeSigning** 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. diff --git a/aws-pca-caplugin/AWSPCACAPlugin.cs b/aws-pca-caplugin/AWSPCACAPlugin.cs index 2201fc9..5de07a7 100644 --- a/aws-pca-caplugin/AWSPCACAPlugin.cs +++ b/aws-pca-caplugin/AWSPCACAPlugin.cs @@ -415,6 +415,30 @@ public async Task Enroll( switch (enrollmentType) { case EnrollmentType.New: + { + return await IssueAndFetchAsync( + csr, + productInfo.ProductID, + days, + signingAlgorithm, + "Certificate Issued") + .ConfigureAwait(false); + } + + case EnrollmentType.RenewOrReissue: + { + if (productInfo.ProductParameters == null || + !TryGetProductParam(productInfo.ProductParameters, "PriorCertSN", out var priorSn) || + string.IsNullOrWhiteSpace(priorSn)) + return new EnrollmentResult + { + Status = (int)EndEntityStatus.FAILED, + StatusMessage = + "Renew/Reissue requires ProductParameters['PriorCertSN'] (hex serial number)." + }; + + string priorRequestId; + try { return await IssueAndFetchAsync( csr, @@ -685,7 +709,7 @@ public Dictionary GetCAConnectorAnnotations() DefaultValue = "", Type = "String" }, - [Constants.Enabled] = new() + [Constants.Enabled] = new () { Comments = "Flag to Enable or Disable gateway functionality. Disabling is primarily used to allow creation of the CA prior to configuration information being available.", Hidden = false, diff --git a/aws-pca-caplugin/AWSPCACAPlugin.csproj b/aws-pca-caplugin/AWSPCACAPlugin.csproj index ae30f76..a53434c 100644 --- a/aws-pca-caplugin/AWSPCACAPlugin.csproj +++ b/aws-pca-caplugin/AWSPCACAPlugin.csproj @@ -3,7 +3,7 @@ true - net8.0 + net8.0;net10.0 Keyfactor.Extensions.CAPlugin.AWS true enable @@ -13,16 +13,11 @@ - + - - - - - + @@ -31,13 +26,17 @@ + - - - - - + + + + + + + - + + \ No newline at end of file diff --git a/aws-pca-caplugin/Client/ACMPCAClient.cs b/aws-pca-caplugin/Client/ACMPCAClient.cs index 008ddb6..8f350d6 100644 --- a/aws-pca-caplugin/Client/ACMPCAClient.cs +++ b/aws-pca-caplugin/Client/ACMPCAClient.cs @@ -39,6 +39,7 @@ public sealed class AwsPcaClient : IAwsPcaClient private const string ENHANCED_KEY_USAGE_OID = "2.5.29.37"; private const string SERVER_AUTH_OID = "1.3.6.1.5.5.7.3.1"; private const string CLIENT_AUTH_OID = "1.3.6.1.5.5.7.3.2"; + private const string CODE_SIGNING_OID = "1.3.6.1.5.5.7.3.3"; private readonly SemaphoreSlim _caInfoLock = new(1, 1); private readonly AWSCredentials AwsCredentials; @@ -60,7 +61,6 @@ public AwsPcaClient(IAnyCAPluginConfigProvider configProvider) throw new ArgumentNullException(nameof(configProvider), "Config provider and CAConnectionData are required."); - var enabled = bool.Parse(GetRequiredString(configProvider, "Enabled")); if (!enabled) { @@ -145,12 +145,29 @@ public async Task SubmitIssueCertificateAsync( if (signingAlgoRes.Error != null) return new IssueCertificateResponse { RegistrationError = signingAlgoRes.Error }; + // Map the requested ProductId to its AWS PCA template ARN. Without this, + // PCA falls back to EndEntityCertificate/V1 and every cert gets the default + // Server+Client Auth EKU combination regardless of the selected product. + if (string.IsNullOrWhiteSpace(request.ProductId) || + !Constants.TemplateARNs.TryGetValue(request.ProductId, out var templateArn)) + return new IssueCertificateResponse + { + RegistrationError = new RegistrationError + { + Description = string.IsNullOrWhiteSpace(request.ProductId) + ? "ProductId is required to resolve the AWS PCA template ARN." + : $"Unsupported ProductId '{request.ProductId}'. Supported: {string.Join(", ", Constants.TemplateARNs.Keys)}", + ErrorCode = "InvalidRequest" + } + }; + var signingAlgorithm = signingAlgoRes.Value!; var issueReq = new Amazon.ACMPCA.Model.IssueCertificateRequest { CertificateAuthorityArn = CaArn, Csr = new MemoryStream(Encoding.ASCII.GetBytes(csrBytes)), SigningAlgorithm = signingAlgorithm, + TemplateArn = templateArn, IdempotencyToken = request.IdempotencyToken ?? Guid.NewGuid().ToString("N"), Validity = new Validity { @@ -554,14 +571,14 @@ private static string Wrap64(string b64) ///

/// Infers one of the supported template type keys: - /// EndEntity, EndEntityClientAuth, EndEntityServerAuth. + /// EndEntity, EndEntityClientAuth, EndEntityServerAuth, CodeSigning. /// Returns "Unknown" if certificate parsing/inspection fails. /// public static string InferTemplateTypeKey(X509Certificate2 cert) { try { - bool server = false, client = false; + bool server = false, client = false, codeSigning = false; // Find EKU extension (do not rely on indexer throwing) var eku = cert.Extensions @@ -574,8 +591,11 @@ public static string InferTemplateTypeKey(X509Certificate2 cert) server = true; else if (string.Equals(usage.Value, CLIENT_AUTH_OID, StringComparison.Ordinal)) client = true; + else if (string.Equals(usage.Value, CODE_SIGNING_OID, StringComparison.Ordinal)) + codeSigning = true; // Map to your known keys + if (codeSigning && !server && !client) return "CodeSigning"; if (server && !client) return "EndEntityServerAuth"; if (client && !server) return "EndEntityClientAuth"; diff --git a/aws-pca-caplugin/Constants.cs b/aws-pca-caplugin/Constants.cs index 69b76f3..b0f0ac0 100644 --- a/aws-pca-caplugin/Constants.cs +++ b/aws-pca-caplugin/Constants.cs @@ -22,6 +22,10 @@ public static class Constants { "EndEntityServerAuth", "arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1" + }, + { + "CodeSigning", + "arn:aws:acm-pca:::template/CodeSigningCertificate/V1" } }; diff --git a/integration-manifest.json b/integration-manifest.json index 515032c..ee8c3d8 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -95,7 +95,8 @@ "product_ids": [ "EndEntity", "EndEntityClientAuth", - "EndEntityServerAuth" + "EndEntityServerAuth", + "CodeSigning" ] } }