Class PdfDigitalSignatureTimestampSettings

Class PdfDigitalSignatureTimestampSettings

Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (26.2.0)

Contains settings of the digital signature timestamp.

To learn more, visit the Work with Digital Signatures documentation article.

public class PdfDigitalSignatureTimestampSettings

Inheritance

object ← PdfDigitalSignatureTimestampSettings

Inherited Members

object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

Constructors

PdfDigitalSignatureTimestampSettings()

Initializes an instance of this class.

public PdfDigitalSignatureTimestampSettings()

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

PdfDigitalSignatureTimestampSettings(string, string, string)

Initializes an instance of this class.

public PdfDigitalSignatureTimestampSettings(string serverUrl, string userName, string password)

Parameters

serverUrl string

Timestamp server URL.

userName string

Timestamp server user name.

password string

Timestamp server password.

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

PdfDigitalSignatureTimestampSettings(string, string, string, TimeSpan)

Initializes an instance of this class.

public PdfDigitalSignatureTimestampSettings(string serverUrl, string userName, string password, TimeSpan timeout)

Parameters

serverUrl string

Timestamp server URL.

userName string

Timestamp server user name.

password string

Timestamp server password.

timeout TimeSpan

Time-out value for accessing timestamp server.

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

Properties

Password

Timestamp server password.

public string Password { get; set; }

Property Value

string

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

Remarks

The default value is null.

ServerUrl

Timestamp server URL.

public string ServerUrl { get; set; }

Property Value

string

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

Remarks

The default value is null. If null, then the digital signature will not be time-stamped.

Timeout

Time-out value for accessing timestamp server.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

Remarks

The default value is 100 seconds.

UserName

Timestamp server user name.

public string UserName { get; set; }

Property Value

string

Examples

Shows how to sign a saved PDF document digitally and timestamp it.

Document doc = new Document();
                                                                             DocumentBuilder builder = new DocumentBuilder(doc);
                                                                             builder.Writeln("Signed PDF contents.");

                                                                             // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
                                                                             // to modify how that method converts the document to .PDF.
                                                                             PdfSaveOptions options = new PdfSaveOptions();

                                                                             // Create a digital signature and assign it to our SaveOptions object to sign the document when we save it to PDF.
                                                                             CertificateHolder certificateHolder = CertificateHolder.Create(MyDir + "morzal.pfx", "aw");
                                                                             options.DigitalSignatureDetails = new PdfDigitalSignatureDetails(certificateHolder, "Test Signing", "Aspose Office", DateTime.Now);

                                                                             // Create a timestamp authority-verified timestamp.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword");

                                                                             // The default lifespan of the timestamp is 100 seconds.
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(100.0d));

                                                                             // We can set our timeout period via the constructor.
                                                                             options.DigitalSignatureDetails.TimestampSettings =
                                                                                 new PdfDigitalSignatureTimestampSettings("https://freetsa.org/tsr", "JohnDoe", "MyPassword", TimeSpan.FromMinutes(30));

                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Timeout.TotalSeconds, Is.EqualTo(1800.0d));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.ServerUrl, Is.EqualTo("https://freetsa.org/tsr"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.UserName, Is.EqualTo("JohnDoe"));
                                                                             Assert.That(options.DigitalSignatureDetails.TimestampSettings.Password, Is.EqualTo("MyPassword"));

                                                                             // The "Save" method will apply our signature to the output document at this time.
                                                                             doc.Save(ArtifactsDir + "PdfSaveOptions.PdfDigitalSignatureTimestamp.pdf", options);

Remarks

The default value is null.

 English