diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..76301ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +1.0.0 +* Initial Release + +1.1.0 +* Added support for renew/reissue +* Made CARequestID more consistent for pending/external validation certs +* Allow for the specifying of custom lifetimes for certs, and comparing the provided value to the allowed values \ No newline at end of file diff --git a/README.md b/README.md index 717daa7..1848c6d 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,13 @@ The Nameshield AnyCA Gateway REST plugin extends the capabilities of Nameshield The Nameshield AnyCA Gateway REST plugin is compatible with the Keyfactor AnyCA Gateway REST 24.2.0 and later. ## Support -The Nameshield AnyCA Gateway REST plugin is supported by Keyfactor for Keyfactor customers. If you have a support issue, please open a support ticket via the Keyfactor Support Portal at https://support.keyfactor.com. +The Nameshield AnyCA Gateway REST plugin is open source and community supported, meaning that there is **no SLA** applicable. > 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. ## Requirements -TODO Requirements is a required section + ## Installation @@ -59,15 +59,16 @@ TODO Requirements is a required section 2. On the server hosting the AnyCA Gateway REST, download and unzip the latest [Nameshield AnyCA Gateway REST plugin](https://github.com/Keyfactor/nameshield-caplugin/releases/latest) from GitHub. -3. Copy the unzipped directory (usually called `net6.0`) to the Extensions directory: +3. Copy the unzipped directory (usually called `net8.0` or `net10.0`) to the Extensions directory: ```shell Depending on your AnyCA Gateway REST version, copy the unzipped directory to one of the following locations: - Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net6.0\Extensions + Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net8.0\Extensions + Program Files\Keyfactor\AnyCA Gateway\AnyGatewayREST\net10.0\Extensions ``` - > The directory containing the Nameshield AnyCA Gateway REST plugin DLLs (`net6.0`) can be named anything, as long as it is unique within the `Extensions` directory. + > The directory containing the Nameshield AnyCA Gateway REST plugin DLLs (`net8.0` or `net10.0`) can be named anything, as long as it is unique within the `Extensions` directory. 4. Restart the AnyCA Gateway REST service. @@ -97,6 +98,7 @@ TODO Requirements is a required section * **OrganizationId** - If you know your organization's ID in nameshield, you can supply that here and that will be used as the organization regardless of what values exist in the request or the Organization field * **Organization** - If OrganizationId is empty, and an organization name is provided here, the Nameshield gateway will use that name to do organization lookups when enrolling. If neither OrganizationId nor Organization is supplied, the gateway will use whatever is in the O= field of the request subject. + * **Lifetime** - REQUIRED:The lifetime of the certificate to be issued. This should be a string in the format recognized by Nameshield (e.g. 1 year, etc.) ## License diff --git a/docsource/configuration.md b/docsource/configuration.md index df8c274..bce9751 100644 --- a/docsource/configuration.md +++ b/docsource/configuration.md @@ -17,5 +17,5 @@ When defining templates, use the product names as the ProductID (e.g. Digicert S ## Requirements -TODO Requirements is a required section + diff --git a/integration-manifest.json b/integration-manifest.json index ce0bde7..704cda3 100644 --- a/integration-manifest.json +++ b/integration-manifest.json @@ -34,6 +34,10 @@ { "name": "Organization", "description": "If OrganizationId is empty, and an organization name is provided here, the Nameshield gateway will use that name to do organization lookups when enrolling. If neither OrganizationId nor Organization is supplied, the gateway will use whatever is in the O= field of the request subject." + }, + { + "name": "Lifetime", + "description": "REQUIRED:The lifetime of the certificate to be issued. This should be a string in the format recognized by Nameshield (e.g. 1 year, etc.)" } ] } diff --git a/nameshield-caplugin/API/RequestCertificate.cs b/nameshield-caplugin/API/RequestCertificate.cs index 3825962..fc23e82 100644 --- a/nameshield-caplugin/API/RequestCertificate.cs +++ b/nameshield-caplugin/API/RequestCertificate.cs @@ -28,6 +28,8 @@ public CertificateRequest() data.relationships.product.data = new RelationshipData(); data.relationships.organization = new CertRequestRel(); data.relationships.organization.data = new RelationshipData(); + data.relationships.certificate = new CertRequestRel(); + data.relationships.certificate.data = new RelationshipData(); } public string GetOrderData() @@ -81,6 +83,9 @@ public class CertificateRequestRelationships [JsonPropertyName("organization")] [JsonProperty("organization")] public CertRequestRel organization { get; set; } + [JsonPropertyName("certificate")] + [JsonProperty("certificate")] + public CertRequestRel certificate { get; set; } } public class CertRequestRel diff --git a/nameshield-caplugin/Constants.cs b/nameshield-caplugin/Constants.cs index 0df6a51..3d8db08 100644 --- a/nameshield-caplugin/Constants.cs +++ b/nameshield-caplugin/Constants.cs @@ -20,6 +20,7 @@ public class Template { public const string ORGANIZATION_ID = "OrganizationId"; public const string ORGANIZATION = "Organization"; + public const string LIFETIME = "Lifetime"; } } } diff --git a/nameshield-caplugin/Models/Certificate.cs b/nameshield-caplugin/Models/Certificate.cs index fe8b22b..7564225 100644 --- a/nameshield-caplugin/Models/Certificate.cs +++ b/nameshield-caplugin/Models/Certificate.cs @@ -44,6 +44,9 @@ public class Certificate [JsonPropertyName("attributes")] [JsonProperty("attributes")] public CertificateAttributes Attributes { get; set; } + [JsonPropertyName("relationships")] + [JsonProperty("relationships")] + public CertificateRelationships Relationships { get; set; } } public class CertificateAttributes @@ -60,4 +63,18 @@ public class CertificateAttributes [JsonProperty("pem")] public string Pem { get; set; } } + + public class CertificateRelationships + { + [JsonPropertyName("current-order")] + [JsonProperty("current-order")] + public CertOrderRelationship Order { get; set; } + } + + public class CertOrderRelationship + { + [JsonPropertyName("data")] + [JsonProperty("data")] + public RelationshipData Data { get; set; } + } } diff --git a/nameshield-caplugin/Models/Order.cs b/nameshield-caplugin/Models/Order.cs index aff4d17..88d816d 100644 --- a/nameshield-caplugin/Models/Order.cs +++ b/nameshield-caplugin/Models/Order.cs @@ -36,6 +36,9 @@ public class OrderAttributes [JsonPropertyName("status")] [JsonProperty("status")] public string Status { get; set; } + [JsonPropertyName("can_renew_at")] + [JsonProperty("can_renew_at")] + public string CanRenewAt { get; set; } } public class OrderRelationships diff --git a/nameshield-caplugin/NameshieldCAPlugin.cs b/nameshield-caplugin/NameshieldCAPlugin.cs index cd7714b..2a17fac 100644 --- a/nameshield-caplugin/NameshieldCAPlugin.cs +++ b/nameshield-caplugin/NameshieldCAPlugin.cs @@ -1,6 +1,7 @@ using Keyfactor.AnyGateway.Extensions; using Keyfactor.Extensions.CAPlugin.Nameshield.API; using Keyfactor.Extensions.CAPlugin.Nameshield.Client; +using Keyfactor.Extensions.CAPlugin.Nameshield.Models; using Keyfactor.Logging; using Keyfactor.PKI.Enums.EJBCA; @@ -36,7 +37,7 @@ public void Initialize(IAnyCAPluginConfigProvider configProvider, ICertificateDa _config = JsonConvert.DeserializeObject(rawConfig); } - public async Task Enroll(string csr, string subject, Dictionary san, EnrollmentProductInfo productInfo, RequestFormat requestFormat, EnrollmentType enrollmnentType) + public async Task Enroll(string csr, string subject, Dictionary san, EnrollmentProductInfo productInfo, RequestFormat requestFormat, EnrollmentType enrollmentType) { _logger.MethodEntry(LogLevel.Debug); NameshieldClient client = NameshieldClient.InitializeClient(_config); @@ -93,17 +94,51 @@ public async Task Enroll(string csr, string subject, Dictionar { throw new Exception($"No organization provided in attributes or subject that matches an organization in the Nameshield account"); } + var lifetime = productInfo.ProductParameters[Constants.Config.Template.LIFETIME]; CertificateRequest request = new CertificateRequest(); request.data.type = "order"; - request.data.attributes.action = "create"; + request.data.attributes.csr = csr; - request.data.attributes.duration = "1 year"; + request.data.attributes.duration = lifetime; request.data.relationships.product.data.type = "product"; request.data.relationships.product.data.id = productId; request.data.relationships.organization.data.type = "organization"; request.data.relationships.organization.data.id = orgId; + string orderAction = "create"; + // Determine if we should do a renew or a reissue + if (enrollmentType == EnrollmentType.RenewOrReissue) + { + string priorCertSnString = productInfo.ProductParameters["PriorCertSN"]; + var priorCertReqID = await _certificateDataReader.GetRequestIDBySerialNumber(priorCertSnString); + if (string.IsNullOrEmpty(priorCertReqID)) + { + throw new Exception($"Cannot find prior certificate with serial number {priorCertSnString}."); + } + + string orderId = priorCertReqID.Split('-')[0]; + + var orderResponse = Task.Run(async () => await client.GetOrderDetails(orderId)).Result; + if (orderResponse.Order.Attributes.CanRenewAt != null) + { + DateTime canRenewDT = DateTime.Parse(orderResponse.Order.Attributes.CanRenewAt); + if (canRenewDT < DateTime.UtcNow) + { + orderAction = "renew"; + } + else + { + orderAction = "reissue"; + } + } + + request.data.relationships.certificate.data.type = "certificate"; + request.data.relationships.certificate.data.id = priorCertReqID.Split('-')[1]; + } + + request.data.attributes.action = orderAction; + var response = Task.Run(async () => await client.RequestCertificate(request)).Result; var status = response.Order.Attributes.Status; @@ -128,15 +163,17 @@ public async Task Enroll(string csr, string subject, Dictionar _logger.LogTrace($"Cert request submitted successfully but not delivered, will be picked up by a fugure sync once it is issued."); return new EnrollmentResult { - CARequestID = response.Order.Id, + CARequestID = response.Order.Relationships.Certificate.Data.id, Status = (int)EndEntityStatus.EXTERNALVALIDATION, StatusMessage = "Certificate is pending issuance and will be picked up by a future sync." }; } _logger.LogTrace($"Certificate enrolled successfully"); - var cert = GetSingleRecord(response.Order.Relationships.Certificate.Data.id).Result; - + //Use placeholder for the serial number part of the req ID, which will be retrieved by GetSingleRecord. + var reqId = $"{response.Order.Relationships.Certificate.Data.id}-XXXXXXXX"; + var cert = GetSingleRecord(reqId).Result; + return new EnrollmentResult { CARequestID = cert.CARequestID, @@ -191,15 +228,21 @@ public List GetProductIds() public async Task GetSingleRecord(string caRequestID) { NameshieldClient client = NameshieldClient.InitializeClient(_config); + var idParts = caRequestID.Split('-').ToList(); + if (idParts.Count == 1) + { + _logger.LogWarning($"Order {caRequestID} is still awaiting delivery."); + throw new Exception($"Unable to retrieve certificate for order {caRequestID} as it is still awaiting delivery. The certificate will be picked up by a future sync once it is issued."); + } + string certId = idParts[0]; + var cert = Task.Run(async () => await client.GetCertificate(certId)).Result; + var certProduct = Task.Run(async () => await client.GetCertificateProduct(certId)).Result; - var cert = Task.Run(async () => await client.GetCertificate(caRequestID)).Result; - var certProduct = Task.Run(async () => await client.GetCertificateProduct(caRequestID)).Result; - - int status = ConvertToKeyfactorStatus(cert.Certificate.Attributes.Status, caRequestID); + int status = ConvertToKeyfactorStatus(cert.Certificate.Attributes.Status, certId); return new AnyCAPluginCertificate() { - CARequestID = caRequestID, + CARequestID = $"{cert.Certificate.Id}-{cert.Certificate.Attributes.Serial}", ProductID = certProduct.CertificateProduct.Attributes.Name, Status = status, Certificate = cert.Certificate.Attributes.Pem, @@ -224,6 +267,13 @@ public Dictionary GetTemplateParameterAnnotations() Hidden = false, DefaultValue = "", Type = "String" + }, + [Constants.Config.Template.LIFETIME] = new PropertyConfigInfo() + { + Comments = "REQUIRED:The lifetime of the certificate to be issued. This should be a string in the format recognized by Nameshield (e.g. 1 year, etc.)", + Hidden = false, + DefaultValue = "1 year", + Type = "String" } }; } @@ -271,11 +321,24 @@ public async Task Synchronize(BlockingCollection blockin foreach (var cert in certs.Certificates) { + var certObj = Task.Run(async () => await client.GetCertificate(cert.Id)).Result; var certProduct = Task.Run(async () => await client.GetCertificateProduct(cert.Id)).Result; int status = ConvertToKeyfactorStatus(cert.Attributes.Status, cert.Id); + if (status == (int)EndEntityStatus.EXTERNALVALIDATION) + { + _logger.LogInformation($"Cert request with cert ID {cert.Id} is still waiting for issuance."); + continue; + } + if (string.IsNullOrEmpty(cert.Attributes.Pem)) + { + _logger.LogInformation($"Cert request with cert ID {cert.Id} has no PEM data. Skipping..."); + continue; + } + var newCert = new AnyCAPluginCertificate() { - CARequestID = cert.Id, + CARequestID = $"{cert.Id}-{cert.Attributes.Serial}", + OldCARequestID = $"{cert.Id}", ProductID = certProduct.CertificateProduct.Attributes.Name, Status = status, Certificate = cert.Attributes.Pem, @@ -310,20 +373,39 @@ public async Task ValidateProductInfo(EnrollmentProductInfo productInfo, Diction var productList = Task.Run(async () => await localClient.ListProducts()).Result; - bool foundProduct = false; + Product foundProduct = null; foreach (var product in productList.Products) { if (string.Equals(product.Attributes.Name, productInfo.ProductID, StringComparison.OrdinalIgnoreCase)) { - foundProduct = true; + foundProduct = product; break; } } - if (!foundProduct) + if (foundProduct == null) { throw new Exception($"Product ID {productInfo.ProductID} was not found in the list of valid products."); } + string lifetime = productInfo.ProductParameters[Constants.Config.Template.LIFETIME]; + if (string.IsNullOrEmpty(lifetime)) + { + throw new Exception($"Product ID {productInfo.ProductID} is missing a required lifetime value"); + } + + bool allowedDuration = false; + foreach (var duration in foundProduct.Attributes.Durations) + { + if (string.Equals(duration, lifetime, StringComparison.OrdinalIgnoreCase)) + { + allowedDuration = true; + break; + } + } + if (!allowedDuration) + { + throw new Exception($"Product ID {productInfo.ProductID} has an invalid lifetime value {lifetime}. Valid values for this product are: {string.Join(',', foundProduct.Attributes.Durations)}"); + } } private static string ValidateConfigurationKey(Dictionary connectionInfo, string key) @@ -336,7 +418,7 @@ private static string ValidateConfigurationKey(Dictionary connec return string.Empty; } - private static int ConvertToKeyfactorStatus(string status, string sslId) + private static int ConvertToKeyfactorStatus(string status, string certId) { switch (status.ToUpper()) { @@ -353,7 +435,7 @@ private static int ConvertToKeyfactorStatus(string status, string sslId) return (int)EndEntityStatus.REVOKED; default: - throw new Exception($"Request ID {sslId} has unknown status {status}"); + throw new Exception($"Request ID {certId} has unknown status {status}"); } } diff --git a/nameshield-caplugin/nameshield-caplugin.csproj b/nameshield-caplugin/nameshield-caplugin.csproj index 054f6a7..6bf5f52 100644 --- a/nameshield-caplugin/nameshield-caplugin.csproj +++ b/nameshield-caplugin/nameshield-caplugin.csproj @@ -1,7 +1,7 @@  - net6.0 + net8.0;net10.0 Keyfactor.Extensions.CAPlugin.Nameshield enable disable @@ -17,7 +17,7 @@ - +