PoDoFo::PdfSigningContext Class Reference

A context that can be used to customize the signing process. More...

#include <PdfSigningContext.h>

Public Member Functions
std::unique_ptr< PdfMemDocument >	Restore (std::shared_ptr< StreamDevice > device)
	Restore a dumped signing context from an input stream device.
PdfSignerId	AddSigner (const PdfSignature &signature, std::shared_ptr< PdfSigner > signer)
	Configure a signer on the specific signature field.
void	Sign (PdfMemDocument &doc, StreamDevice &device, PdfSaveOptions options=PdfSaveOptions::None)
	Start a blocking event-driven signing procedure.
void	StartSigning (PdfMemDocument &doc, std::shared_ptr< StreamDevice > device, PdfSigningResults &results, PdfSaveOptions saveOptions=PdfSaveOptions::None)
	Start a deferred (aka "async") signing procedure.
void	FinishSigning (const PdfSigningResults &processedResults)
	Finish a deferred (aka "async") signing procedure.
void	DumpInPlace ()
	Dump the signing context so it can be resumed later.
std::shared_ptr< PdfSigner >	GetSignerEntry (const PdfReference &signatureRef)
	Get the fist signer entry from the context for the given input signature.
std::shared_ptr< PdfSigner >	GetSignerEntry (const std::string_view &fullName, PdfReference &signatureRef)
	Get the fist signer entry from the context for the given input signature.
bool	IsEmpty () const

Friends
PODOFO_API void	SignDocument (PdfMemDocument &doc, StreamDevice &device, PdfSigner &signer, PdfSignature &signature, PdfSaveOptions saveOptions)
	Sign the document on the given signature field.

Detailed Description

A context that can be used to customize the signing process.

It also enables the deferred (aka "async") signing, which is a mean to separately process the intermediate results of signing (normally a hash to sign) that doesn't require a streamlined event based processing. It can be issued by starting the process with StartSigning() and finishing it with FinishSigning()

Member Function Documentation

DumpInPlace()

void PdfSigningContext::DumpInPlace

(

)

Dump the signing context so it can be resumed later.

Remarks

Can be used only after starting a deferred (aka "async") signing operation. This will effectively disable further operations on this context

FinishSigning()

void PdfSigningContext::FinishSigning

(

const PdfSigningResults &

processedResults

)

Finish a deferred (aka "async") signing procedure.

Parameters

processedResults

results that will be used to finalize the signatures

StartSigning()

void PdfSigningContext::StartSigning	(	PdfMemDocument &	doc,
		std::shared_ptr< StreamDevice >	device,
		PdfSigningResults &	results,
		PdfSaveOptions	saveOptions = PdfSaveOptions::None
	)

Start a deferred (aka "async") signing procedure.

Parameters

results

instance where intermediate results will be stored

Friends And Related Symbol Documentation

SignDocument

PODOFO_API void SignDocument ( PdfMemDocument &  doc, StreamDevice &  device, PdfSigner &  signer, PdfSignature &  signature, PdfSaveOptions  saveOptions  )

friend

Sign the document on the given signature field.

Parameters

doc	the document to be signed
device	the input/output device where the document will be saved
signer	the signer implementation that will compute the signature
signature	the signature field where the signature will be applied
options	document saving options

---

The documentation for this class was generated from the following files:

• src/podofo/main/PdfSigningContext.h
• src/podofo/main/PdfSigningContext.cpp