Introduced a cryptographic infrastructure for PDF signing and validation using PKCS#11-based hardware security modules (HSMs) or software tokens. Key changes include: - Added `PdfDigitalSignatureService` for signing PDFs, multi-signature support, and signature validation. - Implemented `Pkcs11ExternalSigner` and `Pkcs11PdfSigningRsa` for PKCS#11-based signing with DevExpress PDF infrastructure. - Added utilities like `Pkcs11SessionRunner`, `Pkcs11InteropBootstrap`, and `Pkcs11ToolBridge` for session management, library initialization, and fallback mechanisms. - Introduced `Pkcs11Options` for managing PKCS#11 configurations. - Updated project dependencies to include `DevExpress.Document.Processor`, `System.Security.Cryptography.Pkcs`, and `Pkcs11Interop`. - Enhanced error handling and fallback support for PKCS#11 operations. These changes enable robust and extensible PDF signing capabilities with detailed signature metadata extraction and validation.
354 lines
14 KiB
C#
354 lines
14 KiB
C#
using EnvelopeGenerator.Application.Common.Configurations;
|
|
using EnvelopeGenerator.Application.Common.Dto;
|
|
using EnvelopeGenerator.Application.Common.Enums;
|
|
using EnvelopeGenerator.Application.Common.Interfaces.Services;
|
|
using DevExpress.Office.DigitalSignatures;
|
|
using DevExpress.Pdf;
|
|
using Microsoft.Extensions.Options;
|
|
using System.Formats.Asn1;
|
|
using System.Security.Cryptography.Pkcs;
|
|
using System.Security.Cryptography;
|
|
using System.Security.Cryptography.X509Certificates;
|
|
using System.Text;
|
|
|
|
namespace EnvelopeGenerator.Infrastructure.Crypt.Services;
|
|
|
|
public sealed class PdfDigitalSignatureService(IOptions<Pkcs11Options> options) : IPdfDigitalSignatureService
|
|
{
|
|
public Task<byte[]> SignPdfAsync(byte[] pdfBytes, PdfSignOptionsDto? optionsModel = null, CancellationToken cancellationToken = default)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(pdfBytes);
|
|
var pkcs11Options = options.Value;
|
|
var request = optionsModel ?? new PdfSignOptionsDto();
|
|
var fallbackSigningTime = pkcs11Options.UseUtcSigningTime ? DateTimeOffset.UtcNow : DateTimeOffset.Now;
|
|
|
|
using var inputPdf = new MemoryStream(pdfBytes);
|
|
using var signer = new PdfDocumentSigner(inputPdf);
|
|
|
|
var digestCalculator = new DigestCalculator(HashAlgorithmType.SHA256);
|
|
var signerInfo = new ExternalSignerInfo(PdfSignatureType.Pkcs7, 32768, digestCalculator);
|
|
var signatureFieldInfo = new PdfSignatureFieldInfo(1)
|
|
{
|
|
Name = $"Sig_{DateTimeOffset.UtcNow:yyyyMMddHHmmss}"
|
|
};
|
|
|
|
var builder = new PdfDeferredSignatureBuilder(signerInfo, signatureFieldInfo)
|
|
{
|
|
Name = request.Name ?? pkcs11Options.CertificateLabel,
|
|
Reason = request.Reason ?? pkcs11Options.DefaultReason,
|
|
Location = request.Location,
|
|
ContactInfo = request.ContactInfo,
|
|
SigningTime = request.SigningTime ?? fallbackSigningTime,
|
|
ApplicationName = request.ApplicationName ?? pkcs11Options.DefaultApplicationName,
|
|
CertificationLevel = ToDevExpressCertificationLevel(request.CertificationLevel)
|
|
?? ToDevExpressCertificationLevel(pkcs11Options.DefaultCertificationLevel)
|
|
?? PdfCertificationLevel.NoCertification
|
|
};
|
|
|
|
var deferredSigner = signer.SignDeferred(builder);
|
|
var externalSigner = new Pkcs11ExternalSigner(pkcs11Options);
|
|
byte[] signature = externalSigner.BuildSignature(deferredSigner.HashValue, digestCalculator.AlgorithmOid);
|
|
|
|
using var outputPdf = new MemoryStream();
|
|
deferredSigner.Sign(outputPdf, signature);
|
|
return Task.FromResult(outputPdf.ToArray());
|
|
}
|
|
|
|
public async Task<byte[]> SignPdfAsync(byte[] pdfBytes, IReadOnlyList<PdfSignOptionsDto> optionsList, CancellationToken cancellationToken = default)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(pdfBytes);
|
|
ArgumentNullException.ThrowIfNull(optionsList);
|
|
|
|
if (optionsList.Count == 0)
|
|
return pdfBytes;
|
|
|
|
var currentPdf = pdfBytes;
|
|
|
|
foreach (var signOptions in optionsList)
|
|
{
|
|
cancellationToken.ThrowIfCancellationRequested();
|
|
currentPdf = await SignPdfAsync(currentPdf, signOptions, cancellationToken);
|
|
}
|
|
|
|
return currentPdf;
|
|
}
|
|
|
|
public Task<PdfSignatureCheckResultDto> CheckPdfSignatureAsync(byte[] pdfBytes, CancellationToken cancellationToken = default)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(pdfBytes);
|
|
|
|
using var inputPdf = new MemoryStream(pdfBytes);
|
|
using var signer = new PdfDocumentSigner(inputPdf);
|
|
var signatures = signer.GetSignatureInfo();
|
|
|
|
if (signatures is null || signatures.Count == 0)
|
|
{
|
|
return Task.FromResult(new PdfSignatureCheckResultDto(
|
|
Signed: false,
|
|
Signatures: []));
|
|
}
|
|
|
|
var items = new List<PdfSignatureCheckItemDto>(signatures.Count);
|
|
|
|
foreach (var signature in signatures)
|
|
{
|
|
try
|
|
{
|
|
var pkcs7 = signer.GetPdfPkcs7Signature(signature.FieldName);
|
|
bool valid = pkcs7.VerifySignature();
|
|
bool coversWholeDocument = true;
|
|
var certificate = pkcs7.GetSignatureCertificate();
|
|
var now = DateTimeOffset.UtcNow;
|
|
var serialNumber = ToColonSerial(certificate?.SerialNumber);
|
|
DateTimeOffset? validFrom = certificate is null ? null : new DateTimeOffset(certificate.NotBefore).ToUniversalTime();
|
|
DateTimeOffset? validTo = certificate is null ? null : new DateTimeOffset(certificate.NotAfter).ToUniversalTime();
|
|
var issuedTo = ParsePrincipal(certificate?.Subject);
|
|
var issuedBy = ParsePrincipal(certificate?.Issuer);
|
|
var certificateInfo = BuildCertificateInfo(certificate, now);
|
|
var digestAlgorithm = InferDigestAlgorithm(certificate);
|
|
var signatureAlgorithm = InferSignatureAlgorithm(certificate);
|
|
var signerDisplayName = issuedTo.CommonName ?? signature.SignerName;
|
|
var messageDigestHex = TryExtractMessageDigestHex(signature.Contents);
|
|
|
|
items.Add(new PdfSignatureCheckItemDto(
|
|
CoversWholeDoc: coversWholeDocument,
|
|
Reason: signature.Reason,
|
|
Location: signature.Location,
|
|
DeclaredName: signature.SignerName,
|
|
ContactInfo: signature.ContactInfo,
|
|
DigestAlgorithm: digestAlgorithm,
|
|
SignatureAlgorithm: signatureAlgorithm,
|
|
SignerName: signerDisplayName,
|
|
Issuer: issuedBy.Full,
|
|
SerialNumber: serialNumber,
|
|
ValidFrom: validFrom,
|
|
ValidTo: validTo,
|
|
ExpiryCheckedAgainst: "now",
|
|
Certificates: [certificateInfo],
|
|
Unchanged: valid,
|
|
FieldName: signature.FieldName,
|
|
IsCryptographicallyValid: valid,
|
|
SigningTime: signature.SigningTime?.ToUniversalTime().ToString("O"),
|
|
Filter: signature.Filter,
|
|
SubFilter: signature.SubFilter,
|
|
ApplicationName: null,
|
|
MessageDigestHex: messageDigestHex,
|
|
Error: null));
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
items.Add(new PdfSignatureCheckItemDto(
|
|
CoversWholeDoc: false,
|
|
Reason: signature.Reason,
|
|
Location: signature.Location,
|
|
DeclaredName: signature.SignerName,
|
|
ContactInfo: signature.ContactInfo,
|
|
DigestAlgorithm: null,
|
|
SignatureAlgorithm: null,
|
|
SignerName: signature.SignerName,
|
|
Issuer: null,
|
|
SerialNumber: null,
|
|
ValidFrom: null,
|
|
ValidTo: null,
|
|
ExpiryCheckedAgainst: "now",
|
|
Certificates: [],
|
|
Unchanged: false,
|
|
FieldName: signature.FieldName,
|
|
IsCryptographicallyValid: false,
|
|
SigningTime: signature.SigningTime?.ToUniversalTime().ToString("O"),
|
|
Filter: signature.Filter,
|
|
SubFilter: signature.SubFilter,
|
|
ApplicationName: null,
|
|
MessageDigestHex: null,
|
|
Error: ex.Message));
|
|
}
|
|
}
|
|
|
|
return Task.FromResult(new PdfSignatureCheckResultDto(
|
|
Signed: true,
|
|
Signatures: items));
|
|
}
|
|
|
|
private static PdfSignatureCertificateInfoDto BuildCertificateInfo(X509Certificate2? certificate, DateTimeOffset now)
|
|
{
|
|
if (certificate is null)
|
|
{
|
|
return new PdfSignatureCertificateInfoDto(
|
|
IssuedTo: new PdfSignaturePrincipalDto(null, null, null, null),
|
|
IssuedBy: new PdfSignaturePrincipalDto(null, null, null, null),
|
|
SerialNumber: null,
|
|
ValidFrom: null,
|
|
ValidTo: null,
|
|
SelfSigned: false,
|
|
Expired: false,
|
|
NotYetValid: false,
|
|
IsSigner: true,
|
|
Version: null,
|
|
KeyAlgorithm: null,
|
|
SignatureAlgorithm: null,
|
|
Pem: null,
|
|
KeySizeBits: null);
|
|
}
|
|
|
|
var issuedTo = ParsePrincipal(certificate.Subject);
|
|
var issuedBy = ParsePrincipal(certificate.Issuer);
|
|
var validFrom = new DateTimeOffset(certificate.NotBefore).ToUniversalTime();
|
|
var validTo = new DateTimeOffset(certificate.NotAfter).ToUniversalTime();
|
|
|
|
return new PdfSignatureCertificateInfoDto(
|
|
IssuedTo: issuedTo,
|
|
IssuedBy: issuedBy,
|
|
SerialNumber: ToColonSerial(certificate.SerialNumber),
|
|
ValidFrom: validFrom,
|
|
ValidTo: validTo,
|
|
SelfSigned: string.Equals(certificate.Subject, certificate.Issuer, StringComparison.OrdinalIgnoreCase),
|
|
Expired: validTo < now,
|
|
NotYetValid: validFrom > now,
|
|
IsSigner: true,
|
|
Version: certificate.Version,
|
|
KeyAlgorithm: certificate.PublicKey.Oid?.FriendlyName ?? certificate.PublicKey.Oid?.Value,
|
|
SignatureAlgorithm: certificate.SignatureAlgorithm.FriendlyName ?? certificate.SignatureAlgorithm.Value,
|
|
Pem: ToPem(certificate.RawData),
|
|
KeySizeBits: TryGetKeySize(certificate));
|
|
}
|
|
|
|
private static int? TryGetKeySize(X509Certificate2 certificate)
|
|
{
|
|
try
|
|
{
|
|
return certificate.PublicKey.Key.KeySize;
|
|
}
|
|
catch
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
private static string? InferDigestAlgorithm(X509Certificate2? certificate)
|
|
{
|
|
if (certificate?.SignatureAlgorithm is null)
|
|
return null;
|
|
|
|
var source = (certificate.SignatureAlgorithm.FriendlyName ?? certificate.SignatureAlgorithm.Value ?? string.Empty).ToUpperInvariant();
|
|
if (source.Contains("SHA512", StringComparison.Ordinal)) return "SHA-512";
|
|
if (source.Contains("SHA384", StringComparison.Ordinal)) return "SHA-384";
|
|
if (source.Contains("SHA256", StringComparison.Ordinal)) return "SHA-256";
|
|
if (source.Contains("SHA1", StringComparison.Ordinal)) return "SHA-1";
|
|
return certificate.SignatureAlgorithm.FriendlyName ?? certificate.SignatureAlgorithm.Value;
|
|
}
|
|
|
|
private static string? InferSignatureAlgorithm(X509Certificate2? certificate)
|
|
{
|
|
var oidName = certificate?.PublicKey.Oid?.FriendlyName?.ToUpperInvariant();
|
|
if (oidName is not null && oidName.Contains("RSA", StringComparison.Ordinal))
|
|
return "RSA";
|
|
if (oidName is not null && oidName.Contains("ECDSA", StringComparison.Ordinal))
|
|
return "ECDSA";
|
|
return certificate?.PublicKey.Oid?.FriendlyName ?? certificate?.PublicKey.Oid?.Value;
|
|
}
|
|
|
|
private static PdfSignaturePrincipalDto ParsePrincipal(string? dn)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(dn))
|
|
return new PdfSignaturePrincipalDto(null, null, null, dn);
|
|
|
|
string? commonName = null;
|
|
string? organization = null;
|
|
string? country = null;
|
|
|
|
foreach (var part in dn.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries))
|
|
{
|
|
var equalsIndex = part.IndexOf('=');
|
|
if (equalsIndex <= 0 || equalsIndex >= part.Length - 1)
|
|
continue;
|
|
|
|
var key = part[..equalsIndex].Trim();
|
|
var value = part[(equalsIndex + 1)..].Trim();
|
|
|
|
if (key.Equals("CN", StringComparison.OrdinalIgnoreCase)) commonName = value;
|
|
else if (key.Equals("O", StringComparison.OrdinalIgnoreCase)) organization = value;
|
|
else if (key.Equals("C", StringComparison.OrdinalIgnoreCase)) country = value;
|
|
}
|
|
|
|
return new PdfSignaturePrincipalDto(commonName, organization, country, dn);
|
|
}
|
|
|
|
private static PdfCertificationLevel? ToDevExpressCertificationLevel(PdfSignatureCertificationLevel? value)
|
|
{
|
|
return value is null ? null : (PdfCertificationLevel)(int)value.Value;
|
|
}
|
|
|
|
private static string? ToColonSerial(string? raw)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(raw))
|
|
return null;
|
|
|
|
var normalized = raw.Replace(":", string.Empty, StringComparison.Ordinal).Trim();
|
|
if (normalized.Length % 2 != 0)
|
|
return normalized;
|
|
|
|
return string.Join(':', Enumerable.Range(0, normalized.Length / 2).Select(i => normalized.Substring(i * 2, 2).ToUpperInvariant()));
|
|
}
|
|
|
|
private static string ToPem(byte[] der)
|
|
{
|
|
var base64 = Convert.ToBase64String(der, Base64FormattingOptions.InsertLineBreaks);
|
|
var sb = new StringBuilder();
|
|
sb.AppendLine("-----BEGIN CERTIFICATE-----");
|
|
sb.AppendLine(base64);
|
|
sb.Append("-----END CERTIFICATE-----");
|
|
return sb.ToString();
|
|
}
|
|
|
|
private static string? TryExtractMessageDigestHex(byte[]? signatureContents)
|
|
{
|
|
if (signatureContents is null || signatureContents.Length == 0)
|
|
return null;
|
|
|
|
try
|
|
{
|
|
var cms = new SignedCms();
|
|
cms.Decode(signatureContents);
|
|
|
|
var signerInfo = cms.SignerInfos.Count > 0 ? cms.SignerInfos[0] : null;
|
|
if (signerInfo is null)
|
|
return null;
|
|
|
|
foreach (CryptographicAttributeObject attr in signerInfo.SignedAttributes)
|
|
{
|
|
if (!string.Equals(attr.Oid?.Value, "1.2.840.113549.1.9.4", StringComparison.Ordinal))
|
|
continue;
|
|
|
|
foreach (var value in attr.Values)
|
|
{
|
|
var octets = TryReadOctetString(value.RawData);
|
|
if (octets is not null && octets.Length > 0)
|
|
return Convert.ToHexString(octets);
|
|
}
|
|
}
|
|
}
|
|
catch
|
|
{
|
|
return null;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private static byte[]? TryReadOctetString(byte[] rawData)
|
|
{
|
|
try
|
|
{
|
|
var reader = new AsnReader(rawData, AsnEncodingRules.BER);
|
|
var octets = reader.ReadOctetString();
|
|
if (reader.HasData)
|
|
return null;
|
|
return octets;
|
|
}
|
|
catch
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
}
|