DigitalSignatureFieldGenerateContentsWithEmbeddedTimestamp Method |
[Missing <summary> documentation for "M:pdftron.PDF.DigitalSignatureField.GenerateContentsWithEmbeddedTimestamp(pdftron.PDF.TimestampingConfiguration,pdftron.PDF.VerificationOptions)"]
Namespace:
pdftron.PDF
Assembly:
pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax public TimestampingResult GenerateContentsWithEmbeddedTimestamp(
TimestampingConfiguration in_timestamping_config,
VerificationOptions in_timestamp_response_verification_options
)
Public Function GenerateContentsWithEmbeddedTimestamp (
in_timestamping_config As TimestampingConfiguration,
in_timestamp_response_verification_options As VerificationOptions
) As TimestampingResult
public:
virtual TimestampingResult^ GenerateContentsWithEmbeddedTimestamp(
[InAttribute] TimestampingConfiguration^ in_timestamping_config,
[InAttribute] VerificationOptions^ in_timestamp_response_verification_options
) sealed
function GenerateContentsWithEmbeddedTimestamp(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 an exception being thrown.
The usability of a combination of a TimestampingConfiguration and VerificationOptions
can be checked ahead of time to prevent exceptions by calling TestConfiguration on
TimestampingConfiguration and 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 embedded timestamp 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 main signature digest correctly and 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).
Return Value
Type:
TimestampingResultThe result of the timestamp request, including the final document signature as DER-encoded CMS with a timestamp embedded
Remarks This function does not insert the final CMS-type document signature into the document.
You must retrieve it from the result using GetData and then pass that to PDFDoc SaveCustomSignature.
See Also