Release v1.0.0 (#9)

* Update generated docs

* v1.0.0 (#2)

Initial release

---------

Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io>

Author: spbsoluble

.github/workflows/keyfactor-bootstrap-workflow.yml

@@ -11,17 +11,9 @@ on:
 
 jobs:
   call-starter-workflow:
-    uses: keyfactor/actions/.github/workflows/starter.yml@v4
-    with:
-      command_token_url: ${{ vars.COMMAND_TOKEN_URL }}
-      command_hostname: ${{ vars.COMMAND_HOSTNAME }}
-      command_base_api_path: ${{ vars.COMMAND_API_PATH }}
+    uses: keyfactor/actions/.github/workflows/starter.yml@v5
     secrets:
       token: ${{ secrets.V2BUILDTOKEN }}
       gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }}
       gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }}
       scan_token: ${{ secrets.SAST_TOKEN }}
-      entra_username: ${{ secrets.DOCTOOL_ENTRA_USERNAME }}
-      entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }}
-      command_client_id: ${{ secrets.COMMAND_CLIENT_ID }}
-      command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }}

.gitignore

@@ -33,3 +33,7 @@ terraform/terraform.tfvars
 
 # macOS
 .DS_Store
+
+# Analysis / scratch — never commit
+analysis/
+

CERTInext.IntegrationTests/AlgorithmMatrixTests.cs

@@ -0,0 +1,181 @@
+// Copyright 2024 Keyfactor
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// At http://www.apache.org/licenses/LICENSE-2.0
+
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using FluentAssertions;
+using Keyfactor.AnyGateway.Extensions;
+using Org.BouncyCastle.Crypto.Parameters;
+using Org.BouncyCastle.Pkcs;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Keyfactor.Extensions.CAPlugin.CERTInext.IntegrationTests
+{
+    /// <summary>
+    /// Key-algorithm coverage matrix: RSA 2048/3072/4096/6144/8192, ECDSA P-256/P-384/P-521,
+    /// Ed25519, and Ed448 (see <see cref="KeyAlgorithms"/>).
+    ///
+    /// Motivation: every other test in the suite hardcoded an RSA-2048 CSR, so only RSA-2048
+    /// certificates were ever exercised end-to-end (and that is all that showed up in Command).
+    /// The plugin takes the CSR as enrollment input and submits it verbatim, so the key
+    /// algorithm is entirely determined by the CSR.
+    ///
+    /// This file is the offline / submission-only layer (no DCV, no issuance):
+    ///   1. <see cref="Csr_RoundTripsKeyAlgorithm"/> — deterministic, no API, always runs. Proves we
+    ///      emit a structurally valid, self-consistent PKCS#10 CSR for each algorithm (the public key
+    ///      type/size round-trips and the request signature verifies).
+    ///   2. <see cref="Enroll_AcceptsKeyAlgorithm"/> — opt-in (creates real sandbox orders). Proves
+    ///      whether CERTInext *accepts* each algorithm at order submission. A CA-side rejection is
+    ///      reported as an explicit Skip carrying the CA's own message.
+    ///
+    /// The end-to-end "does CERTInext actually issue this algorithm" matrix (DCV on, one real
+    /// scrup.org cert per type) lives in <c>DcvLifecycleTests.EnrollWithDcvOn_IssuesPerKeyAlgorithm</c>
+    /// and only exists on the DCV build.
+    /// </summary>
+    public class AlgorithmMatrixTests : IClassFixture<IntegrationTestFixture>
+    {
+        /// <summary>Set <c>CERTINEXT_ALGO_MATRIX=1</c> to run the live submission theory (creates real orders).</summary>
+        private const string OptInFlag = "CERTINEXT_ALGO_MATRIX";
+
+        private readonly IntegrationTestFixture _fixture;
+        private readonly ITestOutputHelper _output;
+
+        public AlgorithmMatrixTests(IntegrationTestFixture fixture, ITestOutputHelper output)
+        {
+            _fixture = fixture;
+            _output = output;
+        }
+
+        public static IEnumerable<object[]> KeyTypes => KeyAlgorithms.AsMemberData;
+
+        // ---------------------------------------------------------------------------
+        // Layer 1 — deterministic CSR-validity round-trip (no API, always runs)
+        // ---------------------------------------------------------------------------
+
+        /// <summary>
+        /// Generates a CSR for the given key type, re-parses it, and asserts the public key
+        /// algorithm/size round-trips and the request signature verifies. Fully offline.
+        ///
+        /// Note: RSA-6144 and RSA-8192 key generation is intentionally slow (seconds to tens of
+        /// seconds) — that cost is inherent to large RSA keygen, not the test.
+        /// </summary>
+        [Theory]
+        [MemberData(nameof(KeyTypes))]
+        public void Csr_RoundTripsKeyAlgorithm(string tag)
+        {
+            var spec = KeyAlgorithms.For(tag);
+
+            string pem = KeyAlgorithms.GenerateCsrPem($"algo-{KeyAlgorithms.Slug(tag)}.example.com", spec);
+
+            var request = new Pkcs10CertificationRequest(KeyAlgorithms.DerFromPem(pem));
+
+            request.Verify().Should().BeTrue($"the {tag} CSR must be self-signed with a verifiable signature");
+
+            var pub = request.GetPublicKey();
+
+            switch (spec.Kind)
+            {
+                case KeyKind.Rsa:
+                    pub.Should().BeOfType<RsaKeyParameters>();
+                    // BouncyCastle generates a modulus of exactly 'Strength' bits (top bit set).
+                    ((RsaKeyParameters)pub).Modulus.BitLength.Should().Be(spec.Strength,
+                        $"the RSA modulus must be {spec.Strength} bits");
+                    break;
+
+                case KeyKind.Ecdsa:
+                    pub.Should().BeOfType<ECPublicKeyParameters>();
+                    ((ECPublicKeyParameters)pub).Parameters.Curve.FieldSize.Should().Be(spec.Strength,
+                        $"the EC field size must be {spec.Strength} bits");
+                    break;
+
+                case KeyKind.Ed25519:
+                    pub.Should().BeOfType<Ed25519PublicKeyParameters>();
+                    break;
+
+                case KeyKind.Ed448:
+                    pub.Should().BeOfType<Ed448PublicKeyParameters>();
+                    break;
+            }
+
+            _output.WriteLine($"[OK] {tag}: CSR generated ({pem.Length} chars PEM), signature verified, public key type confirmed.");
+        }
+
+        // ---------------------------------------------------------------------------
+        // Layer 2 — live submission acceptance (opt-in; creates real sandbox orders)
+        // ---------------------------------------------------------------------------
+
+        /// <summary>
+        /// Submits a real order to CERTInext for each key type and asserts the order is accepted
+        /// (a CARequestID is returned). A CA-side rejection is reported as an explicit Skip carrying
+        /// the CA's own error message — so the suite documents which algorithms CERTInext accepts
+        /// rather than failing on a legitimate CA limitation.
+        ///
+        /// Opt-in: requires <c>CERTINEXT_ALGO_MATRIX=1</c> because each run creates a real (pending,
+        /// non-issued) DV order on the sandbox account. No DCV is performed, so the orders park at
+        /// EXTERNALVALIDATION and are not cleaned up here. "Accepted at submission" is weaker than
+        /// "will issue" — see <c>DcvLifecycleTests.EnrollWithDcvOn_IssuesPerKeyAlgorithm</c> for the
+        /// end-to-end issuance matrix.
+        /// </summary>
+        [SkippableTheory]
+        [MemberData(nameof(KeyTypes))]
+        public async Task Enroll_AcceptsKeyAlgorithm(string tag)
+        {
+            IntegrationSkip.IfNotConfigured(_fixture);
+            Skip.IfNot(
+                Environment.GetEnvironmentVariable(OptInFlag) == "1",
+                $"Set {OptInFlag}=1 to run the live algorithm-submission matrix (creates real sandbox orders).");
+
+            var spec = KeyAlgorithms.For(tag);
+            string cn = $"algo-{KeyAlgorithms.Slug(tag)}.example.com";
+            string csrPem = KeyAlgorithms.GenerateCsrPem(cn, spec);
+
+            var productInfo = new EnrollmentProductInfo
+            {
+                ProductID = _fixture.ProductCode,
+                ProductParameters = new Dictionary<string, string>
+                {
+                    [Constants.EnrollmentParam.ProfileId]      = _fixture.ProductCode,
+                    [Constants.EnrollmentParam.ProductCode]    = _fixture.ProductCode,
+                    [Constants.EnrollmentParam.RequesterName]  = _fixture.RequestorName,
+                    [Constants.EnrollmentParam.RequesterEmail] = _fixture.RequestorEmail,
+                }
+            };
+
+            var sanDict = new Dictionary<string, string[]> { ["DNS"] = new[] { cn } };
+
+            var plugin = new CERTInextCAPlugin(_fixture.Client, _fixture.Config);
+
+            EnrollmentResult enrollResult = null;
+            try
+            {
+                enrollResult = await plugin.Enroll(
+                    csrPem,
+                    $"CN={cn}",
+                    sanDict,
+                    productInfo,
+                    RequestFormat.PKCS10,
+                    EnrollmentType.New);
+            }
+            catch (Exception ex)
+            {
+                // Per agreed scope: a CA-side rejection becomes an explicit Skip carrying the CA's
+                // message (classified so an unsupported algorithm isn't confused with a credit/
+                // account limitation), so the matrix documents real CERTInext support honestly.
+                string reason = KeyAlgorithms.ClassifyRejection(ex.Message);
+                _output.WriteLine($"[SKIP] {tag}: {reason} — {ex.Message}");
+                Skip.If(true, $"CERTInext did not accept a {tag} order: {reason}. CA message: {ex.Message}");
+            }
+
+            enrollResult.Should().NotBeNull($"{tag}: Enroll must return a non-null result when accepted");
+            if (enrollResult == null) return; // satisfies nullable analysis; assertion above already failed
+
+            enrollResult.CARequestID.Should().NotBeNullOrWhiteSpace(
+                $"{tag}: a CARequestID must be returned when CERTInext accepts the order");
+
+            _output.WriteLine($"[OK] {tag}: CERTInext accepted the order. CARequestID={enrollResult.CARequestID}");
+        }
+    }
+}

CERTInext.IntegrationTests/CERTInext.IntegrationTests.csproj

@@ -6,12 +6,26 @@
     <LangVersion>12.0</LangVersion>
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
+    <!-- Mirror the main project's DcvSupport flag. Default false → DCV test files are excluded
+         (matches the GA no-DCV build); -p:DcvSupport=true compiles them in with SUPPORTS_DCV. -->
+    <DcvSupport Condition="'$(DcvSupport)' == ''">false</DcvSupport>
+    <DefineConstants Condition="'$(DcvSupport)' == 'true'">$(DefineConstants);SUPPORTS_DCV</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\CERTInext\CERTInext.csproj" />
   </ItemGroup>
 
+  <!-- DCV integration tests + the DNS validator implementations use the v3.3-only
+       IDomainValidator / IDomainValidatorFactory and the factory constructor. On the
+       IAnyCAPlugin 3.2.0 (no-DCV) build those don't exist, so exclude these files unless
+       SUPPORTS_DCV is defined. See issue 0003. -->
+  <ItemGroup Condition="!$(DefineConstants.Contains('SUPPORTS_DCV'))">
+    <Compile Remove="DcvLifecycleTests.cs" />
+    <Compile Remove="CloudflareDomainValidator.cs" />
+    <Compile Remove="StubDomainValidator.cs" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
     <PackageReference Include="xunit" Version="2.9.0" />
@@ -21,6 +35,7 @@
     </PackageReference>
     <PackageReference Include="FluentAssertions" Version="6.12.0" />
     <PackageReference Include="Xunit.SkippableFact" Version="1.4.13" />
+    <PackageReference Include="BouncyCastle.Cryptography" Version="2.6.2" />
     <!-- Suppress TFM support build warnings for transitive dependencies -->
     <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
     <PackageReference Include="System.IO.Pipelines" Version="8.0.0" />

CERTInext.IntegrationTests/CloudflareDomainValidator.cs

@@ -0,0 +1,129 @@
+// Copyright 2024 Keyfactor
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// At http://www.apache.org/licenses/LICENSE-2.0
+
+using System;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Net.Http.Json;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Threading;
+using System.Threading.Tasks;
+using Keyfactor.AnyGateway.Extensions;
+
+namespace Keyfactor.Extensions.CAPlugin.CERTInext.IntegrationTests
+{
+    /// <summary>
+    /// <see cref="IDomainValidator"/> that publishes and removes DNS TXT records via
+    /// the Cloudflare v4 API.  Intended for integration tests against a real domain.
+    ///
+    /// Credentials are read from the <see cref="IntegrationTestFixture"/>:
+    /// <c>CERTINEXT_CF_API_TOKEN</c> and <c>CERTINEXT_CF_ZONE_ID</c>.
+    /// </summary>
+    internal sealed class CloudflareDomainValidator : IDomainValidator
+    {
+        private const string CfApiBase = "https://api.cloudflare.com/client/v4";
+
+        private readonly string _apiToken;
+        private readonly string _zoneId;
+        private readonly HttpClient _http;
+
+        // Maps staging hostname → Cloudflare record ID so CleanupValidation can delete it
+        private readonly ConcurrentDictionary<string, string> _stagedRecordIds = new();
+
+        public CloudflareDomainValidator(string apiToken, string zoneId)
+        {
+            _apiToken = apiToken ?? throw new ArgumentNullException(nameof(apiToken));
+            _zoneId   = zoneId   ?? throw new ArgumentNullException(nameof(zoneId));
+
+            _http = new HttpClient();
+            _http.DefaultRequestHeaders.Authorization =
+                new AuthenticationHeaderValue("Bearer", _apiToken);
+        }
+
+        public void Initialize(IDomainValidatorConfigProvider configProvider) { }
+
+        public async Task<DomainValidationResult> StageValidation(string key, string value, CancellationToken cancellationToken)
+        {
+            var payload = new
+            {
+                type    = "TXT",
+                name    = key,
+                content = value,
+                ttl     = 60
+            };
+
+            var response = await _http.PostAsJsonAsync(
+                $"{CfApiBase}/zones/{_zoneId}/dns_records",
+                payload,
+                cancellationToken);
+
+            string body = await response.Content.ReadAsStringAsync(cancellationToken);
+
+            if (!response.IsSuccessStatusCode)
+                return new DomainValidationResult
+                {
+                    Success      = false,
+                    ErrorMessage = $"Cloudflare API error {(int)response.StatusCode}: {body}"
+                };
+
+            using var doc  = JsonDocument.Parse(body);
+            bool success   = doc.RootElement.GetProperty("success").GetBoolean();
+            string recordId = success
+                ? doc.RootElement.GetProperty("result").GetProperty("id").GetString()
+                : null;
+
+            if (!success || string.IsNullOrEmpty(recordId))
+                return new DomainValidationResult
+                {
+                    Success      = false,
+                    ErrorMessage = $"Cloudflare record creation failed: {body}"
+                };
+
+            _stagedRecordIds[key] = recordId;
+
+            return new DomainValidationResult { Success = true };
+        }
+
+        public async Task<DomainValidationResult> CleanupValidation(string key, CancellationToken cancellationToken)
+        {
+            if (!_stagedRecordIds.TryRemove(key, out string recordId))
+                return new DomainValidationResult { Success = true }; // nothing to clean up
+
+            var response = await _http.DeleteAsync(
+                $"{CfApiBase}/zones/{_zoneId}/dns_records/{recordId}",
+                cancellationToken);
+
+            if (!response.IsSuccessStatusCode)
+            {
+                string body = await response.Content.ReadAsStringAsync(cancellationToken);
+                return new DomainValidationResult
+                {
+                    Success      = false,
+                    ErrorMessage = $"Cloudflare delete error {(int)response.StatusCode}: {body}"
+                };
+            }
+
+            return new DomainValidationResult { Success = true };
+        }
+
+        public Task ValidateConfiguration(Dictionary<string, object> configuration) => Task.CompletedTask;
+        public Dictionary<string, Keyfactor.AnyGateway.Extensions.PropertyConfigInfo> GetDomainValidatorAnnotations() => new();
+        public string GetValidationType() => "dns-01";
+    }
+
+    internal sealed class CloudflareDomainValidatorFactory : IDomainValidatorFactory
+    {
+        private readonly IDomainValidator _validator;
+
+        public CloudflareDomainValidatorFactory(string apiToken, string zoneId)
+        {
+            _validator = new CloudflareDomainValidator(apiToken, zoneId);
+        }
+
+        public IDomainValidator ResolveDomainValidator(string domain, string validationType) => _validator;
+    }
+}