PdfTimestamper Class

Namespace:
GemBox.Pdf.Security
Assembly:
GemBox.Pdf.dll

Represents a timestamper that gets the TimeStampToken as specified in RFC 3161 as updated by RFC 5816.

The value of the messageImprint field within the TimeStampToken shall be a hash of either:

  • the bytes of the signature field within SignerInfo for the CMS-based Content if the generated timestamp token is included as a unsigned attribute of that SignerInfo (signature timestamp).
  • the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the Content value) if the generated timestamp token is included as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update (document timestamp).
public class PdfTimestamper
Public Class PdfTimestamper
Inheritance:
System.Object
PdfTimestamper

Constructors

PdfTimestamper(String)

Initializes a new instance of the PdfTimestamper class with the specified address of a Timestamp Authority (TSA) that generates the timestamp token.

public PdfTimestamper(string address)
Public Sub New(address As String)
Parameters
address
System.String

The address of a Timestamp Authority (TSA) that generates the timestamp token.

Exceptions
System.ArgumentNullException

address is null.

Properties

Address

Gets the address of a Timestamp Authority (TSA) that generates the timestamp token.

public string Address { get; }
Public ReadOnly Property Address As String
Property Value
System.String

The address of a Timestamp Authority (TSA) that generates the timestamp token.

ApplicationName

(Optional; PDF 1.5) The name of the software module used to create the timestamp. When used as an entry in the data dictionary of the Filter attribute (Table 2.1), the value is the name of the signature handler. The value is normally equal to the value of the Filter attribute in the signature dictionary.

Default value: Title.

public string ApplicationName { get; set; }
Public Property ApplicationName As String
Property Value
System.String

The name of the software module used to create the timestamp.

See Also

ApplicationVersion

(Optional; PDF 1.6) A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7).

Default value: Version.

public string ApplicationVersion { get; set; }
Public Property ApplicationVersion As String
Property Value
System.String

A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary.

See Also

ClientId

Gets or sets the client digital ID used in a Transport Layer Security protocol if Timestamp Authority (TSA) requires it to identify the TimeStampToken request client.

Default value: null.

public PdfDigitalId ClientId { get; set; }
Public Property ClientId As PdfDigitalId
Property Value
PdfDigitalId

The client digital ID used in a Transport Layer Security protocol if Timestamp Authority (TSA) requires it to identify the TimeStampToken request client.

HashAlgorithm

Gets or sets the hash algorithm that hashes either:

  • the bytes of the signature field within SignerInfo for the CMS-based Content if the generated timestamp token is included as an unsigned attribute of that SignerInfo (signature timestamp).
  • the bytes of the document indicated by the ByteRange and the ByteRange shall specify the complete PDF file contents (excepting the Content value) if the generated timestamp token is included as a content of a signature dictionary (whose Type entry has a value of DocTimeStamp) that is a value of a signature field added as an incremental update (document timestamp).

Default value: SHA512.

public PdfHashAlgorithm HashAlgorithm { get; set; }
Public Property HashAlgorithm As PdfHashAlgorithm
Property Value
PdfHashAlgorithm

The hash algorithm.

Password

Gets or sets the password used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request.

Default value: null.

public string Password { get; set; }
Public Property Password As String
Property Value
System.String

The password used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request.

Proxy

Gets or sets the proxy used by the PdfTimestamper.

Default value: null

public IWebProxy Proxy { get; set; }
Public Property Proxy As IWebProxy
Property Value
System.Net.IWebProxy

The proxy used by the PdfTimestamper.

Username

Gets or sets the user name used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request.

Default value: null.

public string Username { get; set; }
Public Property Username As String
Property Value
System.String

The user name used in an HTTP Authorization header if Timestamp Authority (TSA) requires authentication information for the TimeStampToken request.

Examples

See Also