DigitalSignatureFieldTimestampOnNextSave Method |
Must be called to prepare a secure PDF-embedded timestamp signature (RFC 3161
DocTimeStamp) for signing, which is done afterwards by calling Save on the
document with an e_incremental flag.Throws if document is locked by other
signatures, if signature is already signed, or if another signature has already
been prepared for signing on the next save(because only one signing operation
can be done per incremental save).Default document permission level is
NOTE: A failure in timestamp response verification will result in document Save
throwing an exception.It is recommended to use TimestampingConfiguration.TestConfiguration
with the VerificationOptions ahead of time to avoid this. ///
Namespace:
pdftron.PDF
Assembly:
pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax public void TimestampOnNextSave(
TimestampingConfiguration in_timestamping_config,
VerificationOptions in_timestamp_response_verification_options
)
Public Sub TimestampOnNextSave (
in_timestamping_config As TimestampingConfiguration,
in_timestamp_response_verification_options As VerificationOptions
)
public:
virtual void TimestampOnNextSave(
[InAttribute] TimestampingConfiguration^ in_timestamping_config,
[InAttribute] VerificationOptions^ in_timestamp_response_verification_options
) sealed
function TimestampOnNextSave(in_timestamping_config, in_timestamp_response_verification_options);
Parameters
- in_timestamping_config
- Type: pdftron.PDFTimestampingConfiguration
Configuration options to store for timestamping.
These will include various items related to contacting a timestamping authority.
Incorrect configuration will result in document Save throwing an exception.
The usability of a combination of a TimestampingConfigurationand VerificationOptions
can be checked ahead of time to prevent exceptions by calling TestConfiguration on
TimestampingConfigurationand passing VerificationOptions.
- in_timestamp_response_verification_options
- Type: pdftron.PDFVerificationOptions
Options for the timestamp
response verification step(which is required by RFC 3161 to be done as part of
timestamping).These response verification options should include the root certificate
of the timestamp authority, so that the trust status of the timestamp signature
can be verified.The options that should be passed are the same ones that one expects
the timestamp to be verifiable with in the future(once it is embedded in the document),
except the response verification requires online revocation information whereas
the later verification may not (depending on whether LTV offline verification
information for the timestamp signature gets embedded into the document by that
time).The timestamp response verification step makes sure that(a) the
timestamp response has a success status, which is the only time that this is
verified in the entire workflow, which prevents embedding an unsuccessful
response; (b)that it digests the document correctlyand is otherwise generally
verifiable; and (c)that the nonce is correct(which is the only time that this
is verifiable in the entire workflow) to prevent replay attacks(if it was not
requested in the TimestampingConfiguration that the nonce mechanism should be
disabled).
See Also