Class PdfSignature

A class that represents a PDF signing certificate (.PFX or .p12) format which can be used to digitally sign a PDF. This protecting it from alteration.

Inheritance

System.Object

PdfSignature

Namespace: IronPdf.Signing

Assembly: IronPdf.dll

Syntax

public class PdfSignature : Object

Constructors

PdfSignature(Byte[], String, String)

Initializes a new instance of the PdfSignature class.

Declaration

public PdfSignature(byte[] CertificateRawData, string Password, string TimeStampUrl = null)

Parameters

Type	Name	Description
System.Byte[]	CertificateRawData	The certificate as a binary data (byte array).
System.String	Password	The certificate's password.
System.String	TimeStampUrl	Url used for time-stamping the signature.

PdfSignature(X509Certificate2)

Initializes a new instance of the PdfSignature class. Not working in docker mode (Installation.UseIronPdfEngineDocker)

Declaration

public PdfSignature(X509Certificate2 ExportableNativeCertificate)

Parameters

Type	Name	Description
System.Security.Cryptography.X509Certificates.X509Certificate2	ExportableNativeCertificate	The exportable native certificate as a System.Security.Cryptography.X509Certificates.X509Certificate2.

PdfSignature(String, String, String)

Initializes a new instance of the PdfSignature class using a .pfx or .p12 digital signature file.

Declaration

public PdfSignature(string FilePathToCertificate, string Password, string TimeStampUrl = null)

Parameters

Type	Name	Description
System.String	FilePathToCertificate	The file path to certificate.
System.String	Password	The certificate's password.
System.String	TimeStampUrl	Url used for time-stamping the signature.

Fields

SignatureDate

The date and time of the digital signature. If left null, the signature will be timestamped at the millisecond that the PdfDocument is saved to Disk or Stream.

Declaration

public Nullable<DateTime> SignatureDate

Field Value

Type	Description
System.Nullable<System.DateTime>

SignatureImage

A visual image for the sign, often a PNG of a human signature or company stamp (optional).

This appends a visual signature in addition to cryptographic signing.

LoadSignatureImageFromFile(String, Int32, CropRectangle)LoadSignatureImageFromStream(Stream, Int32, CropRectangle)

Declaration

public PdfSignatureImage SignatureImage

Field Value

Type	Description
PdfSignatureImage

SigningContact

The contact person or email address for signing related inquiries (optional).

Declaration

public string SigningContact

Field Value

Type	Description
System.String

SigningLocation

The physical location the PDF was signed (optional).

Declaration

public string SigningLocation

Field Value

Type	Description
System.String

SigningReason

The reason the PDF was signed (optional).

Declaration

public string SigningReason

Field Value

Type	Description
System.String

TimeStampUrl

Url to be used when time-stamping the signature

Declaration

public string TimeStampUrl

Field Value

Type	Description
System.String

Methods

LoadSignatureImageFromFile(String, Int32, CropRectangle)

Loads a signature image from an image file. This appends a visual signature in addition to cryptographic signing.

Declaration

public void LoadSignatureImageFromFile(string FilePath, int PageIndex, CropRectangle Rectangle)

Parameters

Type	Name	Description
System.String	FilePath	Image path
System.Int32	PageIndex	Page index to display image
IronSoftware.Drawing.CropRectangle	Rectangle	Rectangle to display image

LoadSignatureImageFromStream(Stream, Int32, CropRectangle)

Loads a signature image from a stream. This appends visual signature in addition to cryptographic signing.

Declaration

public void LoadSignatureImageFromStream(Stream Stream, int PageIndex, CropRectangle Rectangle)

Parameters

Type	Name	Description
System.IO.Stream	Stream	The image file as a stream.
System.Int32	PageIndex	Page index to display image
IronSoftware.Drawing.CropRectangle	Rectangle	Rectangle to display image

SignPdfFile(String, Boolean, String, String)

Signs an existing PDF file.

Declaration

public bool SignPdfFile(string PdfFilePath, bool RemoveOldSignatures = false, string UserPassword = null, string OwnerPassword = null)

Parameters

Type	Name	Description
System.String	PdfFilePath	The PDF file path.
System.Boolean	RemoveOldSignatures	if set to true old digital signatures are removed to ensure signing validity.
System.String	UserPassword	Optional user password if the PDF document is encrypted.
System.String	OwnerPassword	Optional owner password if the PDF document is encrypted.

Returns

Type	Description
System.Boolean	true if successful.