ExternalSignature

ExternalSignature

Overview

ExternalSignature is a class in Aspose.PDF FOSS for .NET. Inherits from: Signature.

A detached PKCS#7 signature configuration built around an already-loaded platform certificate — typically from the OS certificate store, a smartcard or an HSM — rather than a PFX file.

This class provides 11 methods for working with ExternalSignature objects in .NET programs. Available methods include: ExternalSignature, GetSignatureAlgorithmInfo, Signature, Verify. All public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package. Properties: Authority, AvoidEstimatingSignatureLength, ByteRange, Certificate, ContactInfo, CustomAppearance, and 9 more.

Properties

NameTypeAccessDescription
CertificateSystem.Security.Cryptography.X509Certificates.X509Certificate2ReadThe certificate this instance was constructed with.
AuthoritystringRead/WriteGets or sets the authority.
ContactInfostringRead/WriteGets or sets the contact info.
LocationstringRead/WriteGets or sets the location.
ReasonstringRead/WriteGets or sets the reason.
DateDateTimeRead/WriteGets or sets the date.
ByteRangeint[]ReadThe signature’s /ByteRange entry.
TimestampSettingsAspose.Pdf.TimestampSettingsRead/WriteRFC 3161 TSA settings; honoured by the signer when set.
OcspSettingsAspose.Pdf.OcspSettingsRead/WriteOCSP / revocation-check settings; honoured by the signer when set.
CustomAppearanceSignatureCustomAppearance?Read/WriteVisual-appearance knobs honoured by SignWithAppearance when the signature is signed via a visible-rect overload.
CustomSignHashSignHash?Read/WriteOptional external-signer callback.
UseLtvboolRead/WriteGets or sets the use ltv.
AvoidEstimatingSignatureLengthboolRead/WriteWhen true, the signer skips the byte-range estimation pass and uses DefaultSignatureLength directly when reserving space for the PKCS#7 /Contents hex string.
DefaultSignatureLengthintRead/WriteNumber of bytes reserved for the PKCS#7 /Contents hex string.
ShowPropertiesboolRead/WriteWhen true, the visible signature appearance includes the signer’s Reason/Location/ContactInfo as text.

Methods

SignatureDescription
ExternalSignature(certificate: System.Security.Cryptography.X509Certificates.X509Certificate2)Calls ExternalSignature(certificate) on this ExternalSignature instance.
ExternalSignature(certificate: System.Security.Cryptography.X509Certificates.X509Certificate2, detached: bool)detached selects the handler, exactly as the PKCS7 / PKCS7Detached pair does: true emits an adbe.pkcs7.detached envelope over a SHA-256 digest, false the adbe.pkcs7.sha1 handler over a SHA-1 digest.
ExternalSignature(certificate: System.Security.Cryptography.X509Certificates.X509Certificate2, digestHashAlgorithm: DigestHashAlgorithm)Calls ExternalSignature(certificate, digestHashAlgorithm) on this ExternalSignature instance.
ExternalSignature(base64Certificate: string, detached: bool)Construct from a base64-encoded public certificate (no private key) for deferred/external signing via CustomSignHash.
Signature()Calls Signature on this ExternalSignature instance.
Signature(pfx: string, password: string)Calls Signature(pfx, password) on this ExternalSignature instance.
Signature(pfx: Stream, password: string)Calls Signature(pfx, password) on this ExternalSignature instance.
Verify()Verify the loaded signature’s PKCS#7 against the original PDF bytes — returns true when the signature decodes and validates.
Verify(options: Security.ValidationOptions, validationResult: Security.ValidationResult)Verify with explicit options + a result DTO.
Verify(publicKeyCertificate: System.Security.Cryptography.X509Certificates.X509Certificate2, options: Security.ValidationOptions, validationResult: Security.ValidationResult)Public-key-pinned verify.
GetSignatureAlgorithmInfo()Parse the PKCS#7 envelope (when loaded from an existing signature) to report the signing-algorithm / digest-algorithm / cryptographic-standard triple.