Digital_Signatures.DigSig (Acrobat)

	Define
	DigSigHFT_NUMSELECTORS
	ESOBJ_SigInfo Private data name of ASCab entry in sigInfo ESObject
	ESOBJ_SigSeedValue The private data name of the ASCab entry in the seed value ESObject.
	kDSException Get the exception string. When this is returned, the exception text should be available from the called routine. If the exception text is NULL, it is considered to be an unknown error.
	kDSFalse A boolean return value.
	kDSOk Success.
	kDSParameterError Error in a parameter to the function call. There is no exception string.
	kDSTrue A boolean return value.
	PROP_DSSigPropChainExpiration The earliest expiration time for all certificates in the trusted chain
	PROP_DSSigProp_Date PDF Date format, time of signing
	PROP_DSSigProp_DisplayOnPageIcon only use the values enumerated below. Default is kDSDisplayOnPageIconAlways.
	PROP_DSSigProp_ErrText Error text, present only if there was error while validating, new in Acrobat 7
	PROP_DSSigProp_HashAlgo Hashing algorithm used to hash the document. Can be empty, new in Acrobat 8
	PROP_DSSigProp_IconState If you want to put this entry in your plugins' signature properties cab please make sure you use the DSSigPropIconState enum below for its values. This will ensure that DigSig use the appropriate icons (in sync with your plugins') to represent the signature's state. If you do not provide this value, DigSig will use validity icons according to what it thinks is the validity status of the signature.
	PROP_DSSigProp_IssuerCN Common name of issuer
	PROP_DSSigProp_LTVStatus Signature LTV status
	PROP_DSSigProp_LTVStatusText Text of the signature LTV status
	PROP_DSSigProp_Name Common name of signer
	PROP_DSSigPropNumberOfChains Total number of chains built for the signature validation
	PROP_DSSigPropNumberOfTrustedChains Number of trusted chains built for the signature validation
	PROP_DSSigProp_RevInfo
	PROP_DSSigProp_RevInfo_CRL
	PROP_DSSigProp_RevInfo_OCSP
	PROP_DSSigProp_SigValTextDetail Sig validity detail title line
	PROP_DSSigProp_SigValTextDetails ASCab array of ASText sig validity details
	PROP_DSSigProp_SigValTextSummary Summary signature validity text, to append to AVPanel sig title
	PROP_DSSigProp_SigValTextTooltip Signature validity text to show in tooltip
	PROP_DSSigProp_SigValue
	PROP_DSSigProp_SubjectOrg Organisation of signer
	PROP_DSSigProp_TrustedDate indicates whether the signing time was from a trusted time source or not. If the key is not present, its assumed it was from an untrusted (e.g. system) source, new in Acrobat 7
	PROP_DSSigProp_VerifyDate PDF Date format, time of verification, new in Acrobat 7
	SIGINFO_OBJ EScript SigInfo object name
	VALUE_APCab_TypeDSAPIcon

	Typedef
	DigSigBBox
	DigSigBBoxRec
	DigSigCosDocSigParams
	DigSigCosDocSigParamsRec
	DigSigDataBufferSigNewParams
	DigSigDataBufferSigNewParamsRec
	DigSigDataBufferSigValidateParams
	DigSigDataBufferSigValidateParamsRec
	DigSigDataParams
	DigSigDataParamsRec
	DigSigHandler
	DigSigHandlerRec
	DigSigNewSigDataParams
	DigSigNewSigDataParamsRec
	DigSigOffset
	DigSigOffset64
	DigSigOffset64Rec
	DigSigOffsetRec
	DSAPCreateLayeredStreamExParams
	DSAPCreateLayeredStreamExParamsRec
	DSAPTextEntry
	DSAPTextEntryRec
	DSAPXObjEntry
	DSAPXObjEntryRec
	DSComparePagesParams
	DSComparePagesParamsRec
	DSCompareWordsParams
	DSCompareWordsParamsRec
	DSNtfyParams
	DSNtfyParamsRec
	DSSigRefDictErrParams
	DSSigRefDictErrParamsRec
	DSSigRefDictParams
	DSSigRefDictParamsRec
	ESObject
	ESObjectRec ESObject is an EScript object that is supported as of Acrobat 5.0 by the escript plug-in. The EScript HFT has not been exposed to third party developers, thus you should use or assume NULL for ESObject parameters. Signature support for EScript is available only when using the PubSecHFT for public-key signatures.

	Enumeration
	`DSAPXObjectFromXObjectListFlags`
	`DSCosDocSigObjType` The type of CosDoc signature.
	`DSHandlerProperty` Boolean properties of a DigSigHandler, obtained with DSGetBoolPropertyProc() , that show whether the handler supports specific functionality.
	`DSLTVEnabled` Enumerate signature LTV-enabled state
	`DSMDPType` Modification, detection, and prevention (MDP) options.
	`DSNotificationType` A type of notification to register for.
	`DSNotifySigType` Notification types for the DSNotifySigProc().
	`DSPropertyType` Constants that specify what dialog box to show.
	`DSQuadding` Justification of XObjects.
	`DSSigEncode` Signature value encodings for public key signatures. It is a parameter to DigSigDataSigSign() and DigSigDataSigValidate().
	`DSSigPropDisplayOnPageIcon`
	`DSSigPropIconState`
	`DSSigRefErrCode` Error constants for signature reference dictionary procedures.
	`DSValidState` A validity state constant for a signature field, resulting from verification.
	`DSXObjType` A structure describing the appearance of a digital signature.

	Variable
	gDigSigHFT

	Structure
	_t_DigSigBBoxRec A signature annotation bounding box.
	_t_DigSigCosDocSigParamsRec Parameters passed in to DSCosDocSigSign() and DSCosDocSigValidate() procs. Certain parameters vary depending on what DSCosDocSigObjType objSigType is set to.
	_t_DigSigDataBufferSigNewParamsRec
	_t_DigSigDataBufferSigValidateParamsRec
	_t_DigSigDataParamsRec
	_t_DigSigHandlerRec A data structure containing callbacks that define a signature plug-in's behavior. Unused entries should be NULL.
	_t_DigSigNewSigDataParamsRec Parameters for DSNewSigDataWithParamsProc() .
	_t_DigSigOffset64Rec Acrobat 10 - 64-bit positioning
	_t_DigSigOffsetRec A structure that indicates the location of objects in a saved PDF document.
	_t_DSAPCreateLayeredStreamExParams
	_t_DSAPTextEntryRec A linked list of text items to be merged together.
	_t_DSAPXObjEntryRec Structure used in DigSigAPXObjectFromXObjList().
	_t_DSComparePagesParamsRec Parameters for page comparison.
	_t_DSCompareWordsParamsRec Parameters for page comparison.
	_t_DSNtfyParamsRec A structure passed to the callback when a digital signature event occurs for which an interest has been registered. The structure contains information about the event.
	_t_DSSigRefDictErrParamsRec A structure that contains information about exceptions that occurred in signature reference dictionary procedures.
	_t_DSSigRefDictParamsRec Parameters used by methods that create a signature reference dictionary. See Section 8.7, Digital Signatures, in the PDF Reference, for more information on signature reference dictionaries.

	Callback
	DigSigEnumProc A user-supplied callback that is passed in the call to DigSigEnumSignatures() . DigSig calls this once for each existing signature.
	DSCanValidateProc This function is called to query the handler to find out if it can validate this PDDoc signature field. The call determines if the general signature format is supported by the handler, or if the handler should be given the opportunity to validate this signature.
	DSClearSigProc
	DSCommitSign64Proc
	DSCommitSignProc A callback for DigSigHandler. It is called to put the signature into the document in memory or to cancel. It modifies the signature dictionary as needed. It may allocate storage for an array of signature objects.
	DSCosDocSigSignProc Signs a CosDoc (for example, when signing FDF). It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 6.0.
	DSCosDocSigValidateProc Validates a CosDoc signature. It returns a valid state in sigInfoCab.
	DSDataBufferSigSignFinishProc Finish the signing of a data buffer (for example, when signing XML data). It must be called to destroy the context, whenever signNew returns a context. It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 7.0.
	DSDataBufferSigSignNewProc Initiate the signing of a data buffer (for example, when signing XML data). It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 7.0.
	DSDataBufferSigValidateProc Validate a data buffer signature. It returns a valid state in sigInfoCab. It should populate the following entries in this cab: PROP_SigInfo_Status PROP_SigInfo_StatusText PROP_SigInfo_HandlerName It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 7.0.
	DSDefaultValueProc A callback for DigSigHandler. It is called when a new signature field is created. This method creates the default signature value dictionary and creates a default value (DV) entry in the signature field dictionary pointing to this dictionary.
	DSDocCloseProc A callback for DigSigHandler. It is called when a new document is closed.
	DSDocOpenProc A callback for DigSigHandler. It is called when a new document is opened.
	DSFinishSign64Proc
	DSFinishSignProc A callback for DigSigHandler. It is called to calculate the checksum and update the disk copy of document. It may use information from the offsetArray parameter.
	DSFreeSigDataProc A callback for DigSigHandler. It frees signature data.
	DSGetBoolPropertyProc Gets the boolean value of a DigSig handler property. It returns true for those properties that represent functionality your handler supports, false if it does not support the functionality. (Some properties are available directly from the DigSigHandler.)
	DSGetSigInfoProc Internal use. Add your engine-specific properties to the existing sigInfo ESObject. Any private data should be added to the ASCab that is set as private data in ESOBJ_SigInfo ASCab (see above). This should have been written to pass an ASCab instead of ESObject, but we missed this. handlerName is the name of the handler that is being asked to return the data (not necessarly the same as the value of the /Filter attribute in the sigDict). It is for Adobe use only, and subject to change. It can only be used by EScript-aware DigSig handlers (for example, PubSec).
	DSGetSigPropProc Called to obtain an ASCab containing values that the handler wants DigSig to use in the user interface. This is called only after the handler is called to validate the signature.
	DSGetSigSeedValueProc Internal use. Add your engine-specific properties to the existing seedValue ESObject. Any private data should be added to ESOBJ_SigSeedValue ASCab (see above). It is for Adobe use only, and subject to change. It can only be used by EScript-aware DigSig handlers (for example, PubSec). jsErrText will be NULL. The handler should set jsErrText to a new ASText object, which will then be destroyed by DigSig.
	DSGetStatusTextProc Returns a string describing the status of the signature. It must be PDDocEncoding or Unicode, where Unicode strings must start with 0xFE, 0xFF.
	DSGetValidStateProc A callback for DigSigHandler. It is called by the signature panel display to choose which of the double-checked pass, fail, unknown, or blank icons to show. It may call DigSigUpdatePanel() to update the signature panel.
	DSIsSignerProc Returns whether the current application user has the credential that was used to create the signature that was passed in.
	DSNewSigDataExProc Use DSNewSigDataWithParamsProc() instead of this call. Support for this call will continue for at least the short term.
	DSNewSigDataProc A callback for DigSigHandler. It is called to gather signature data or to cancel. It may display dialogs. It may use the default value (DV) field of the signature field if it is not CosNull.
	DSNewSigDataWithParamsProc A callback for DigSigHandler. It creates new signature data to be used by Commit and Finish, and is then destroyed by DSFreeSigDataProc() .
	DSNewSigEngineProc This call was used only in Acrobat 5.x when the EScript security object was implemented in DigSig. It returns the existing user interface engine object (ESObject) if uiEngine is true, otherwise it returns a new signature engine object (ESObject). handlerName is the name of the handler that is being asked to return the new engine. vData is reserved for future use and is currently not used. This call is no longer used.
	DSNotificationFailureProc A callback for the Notification Server. It is called when a digital signature event occurs for which you have registered an interest.
	DSNotificationProc A callback for the Notification Server. It is called when a digital signature event occurs for which you have registered an interest.
	DSNotifySigProc Sends a notification for this signature. The only current notification is kDSNotifySetUnknown, which will cause handlers to mark the validity for this signature as unknown. This is done if the document is dirtied or changed in a manner that would cause the current validity status to no longer be valid. This is not the same as the DSUnValidateProc(). The handler should update its cached validity values to the signature unknown state.
	DSPropertiesExProc A callback for DigSigHandler. It is called when a user selects a signature and asks for its properties. It brings up the properties dialog box for the signature.
	DSPropertiesProc A callback for DigSigHandler. It is called when a user selects a signature and asks for its properties. The handler should present its own dialog box that provides details concerning the signature and its validation state.
	DSSetSigSeedValueProc Internal use. Add your engine-specific properties to the existing seedValue ESObject. Any private data should be added to ESOBJ_SigSeedValue ASCab (see above). It is for Adobe use only, and subject to change. It can only be used by EScript-aware DigSig handlers (for example, PubSec). jsErrText will be NULL. The handler should set jsErrText to a new ASText object, which will then be destroyed by DigSig.
	DSSigDataGetErrorTextProc Returns an error string to describe failure during new, commit, or free steps. If it is not NULL, then a JavaScript general exception is thrown using this string.
	DSUnValidateSigProc A callback for DigSigHandler. It is called to change the appearance key (AP) back to the appearance that is used for the unvalidated state.
	DSValidateSigExProc Internal use. Validates a signature (performs an action). If sigEngine is not NULL then use this engine, otherwise use the user interface engine. handlerName is the name of the handler that is being asked to validate the signature (not necessarily the same as the value of the /Filter attribute in the sigDict). If bUI is true, show an alert after validating. Note that this alert may be suppressed depending on preference settings. It is for Adobe use only, and subject to change. Itan only be used by EScript aware DigSig handlers (for example, PubSec).
	DSValidateSigProc A callback for DigSigHandler. It is called to validate a signature. It recalculates any document digest desired, possibly using the DigSigFileGetEOF() , DigSigMD5ByteRange() , DigSigFileRead() , and DigSigFileSetPos() methods.
	VerifyRefCallbackProc Callback function used to verify all references used by the data signature. It is only called if the core signature is valid.

	Method
	void DigSigAddedSig(PDDoc pdDoc) Recalculates the number of signature fields and redraws the signature panel after any signature is added.
	void DigSigAddedSigEx(PDDoc pdDoc, CosObj cosField) Recalculates the number of signature fields and redraws the signature panel after a specified signature field is added.
	CosObj DigSigAPCreateCompositeTextXObj(const CosDoc cosDoc, const DSAPTextEntry inText, const ASFixedRect*const bbox, const CosObj sigField, const CosObj sigAnnot) Create a new XObject that consists of vertically stacked blocks of text, where each block is auto-sized to fit its own bounding box.
	CosObj DigSigAPCreateLayeredStream(const CosDoc cosDoc, const CosObj layer1XObject, ASFixedMatrixP layer1Matrix, const CosObj layer2XObject, ASFixedMatrixP layer2Matrix, const CosObj layer3XObject, ASFixedMatrixP layer3Matrix, const CosObj layerNXObject, ASFixedMatrixP layerNMatrix, ASInt16 layerNNum, AFPDWidgetBorder border, PDColorValue cBorder, PDColorValue cBackGnd, ASFixed width, ASFixed height, PDRotate pdr) Creates a stream that is composed of either four or five layers: Layer Description n0 Background, inherited from the form annotation background. n1 Middle, question mark or equivalent (uses the default if the layer 1 XObject is CosNull). n2 Main, text and appearance (must be provided). n3 Top, blank or X (uses the default if layer1XObject is CosNull). nN (Optional) Very top layer, used for text showing the validity state (none if CosNull).
	CosObj DigSigAPCreateLayeredStreamEx(const DSAPCreateLayeredStreamExParams params) Creates a signature-appearance layered stream, using a parameters structure.
	ASBool DigSigAPFileAcquire(const ASBool bResolveProblems, const ASBool bCreate) Acquires the DSAP file and opens it, if it has not already been acquired.
	ASBool DigSigAPFileCanDeleteNthEntry(const ASInt32 index) Tests whether a signature appearance entry at a specified index in the DSAP file can be edited or is read-only.
	ASBool DigSigAPFileCopyNthEntry(const ASInt32 index) Creates a copy of the specified entry in the default DSAP file and appends the copy to the end of the list of signature appearances in the file.
	ASBool DigSigAPFileEditNthEntry(const APPreview previewData, const ASInt32 index) Opens the user interface that allows the user to edit the specified signature appearance entry of the DSAP file.
	ASInt32 DigSigAPFileGetCount() Gets the number of configured signature appearance entries in the DSAP file,
	ASText DigSigAPFileGetNewNthName(const ASInt32 index) Gets a copy of the name of the specified signature appearance entry in the DSAP file. Use this when building a list of signatures for a user to choose from or edit.
	void DigSigAPFileRelease() Closes the digital signature appearance (DSAP) file.
	ASBool DigSigAPFileRemoveNthEntry(const ASInt32 index) Deletes the specified signature appearance entry from the DSAP file.
	void DigSigAPFileSave() Saves the DSAP file if it is dirty, leaving it open.
	CosObj DigSigAPXObjectFromLogo(const CosDoc cosDoc, const char* logoStr, const ASInt32 logoStrSize, const ASFixedRectconst logoBBox, const ASFixedRectconst bbox) Takes text for a stream logoStr with bounding box logoBBox and fits it precisely to bbox. It performs uniform x and y scaling, and x-y translation. It can raise an exception. This method might throw an exception, and should be wrapped in a DURING/HANDLER block.
	CosObj DigSigAPXObjectFromXObjList(CosDoc cosDoc, const ASFixedRect*const bbox, DSAPXObjEntry objEntry, TextAppearanceP ta, size_t taSize, AFPDWidgetBorder border, ASUns32 flags) Creates a new XObject from the list of DSAPXObjEntry objects. Each object in the list is either an existing stream or a string that will be laid out and reflowed into a new stream. The streams are then turned into XObjects. Controls allow you to adjust the vertical position of each stream within bbox. If bMerge is true, this method combines the new XObjects into one large XObject, and the sub XObjects are destroyed. Otherwise the method leaves the component XObjects intact and new XObjects are created but not destroyed for the text entries. Text streams use the text attributes of ta.
	CosObj DigSigAPXObjectFromXObjListObsolete(CosDoc cosDoc, const ASFixedRect*const bbox, DSAPXObjEntry objEntry, TextAppearanceP ta, AFPDWidgetBorder border, ASBool bMerge) Legacy procedure for backwards compatibility.
	void DigSigByteToHex(unsigned char* byteP, unsigned char* hexP, ASInt32 length) Converts a byte string to a PDF hex string.
	void DigSigClearSig(PDDoc pdDoc, CosObj sigField) Clears a signature field in a document. This removes the signature so that the document is unsigned.
	DSRetCode DigSigClearSigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj refDict) Clears the signature reference dictionary referred to by refDict and removes any reference to it from the document.
	void DigSigClick(PDAnnot pdAnnot, AVPageView avPV, ASInt16 nX, ASInt16 nY, ASInt16 nFlags, ASInt16 nClicks) The AcroForm plug-in calls this method when a user left-clicks inside a signature annotation.
	DSRetCode DigSigCommitSigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj* pOutRefDict) Adds a signature reference dictionary to the document and saves the document.
	ASBool DigSigComparePages(PDDoc docA, PDDoc docB, ASBool insertDiffs) Compares the pages of two documents, producing a third document of the differences.
	ASBool DigSigComparePagesEx(PDDoc docA, PDDoc docB, DSComparePagesParams params) Compares the pages of two documents, producing a third document of the differences.
	ASBool DigSigCompareWords(PDDoc docA, PDDoc docB, ASBool iUseFonts) Compares the words of two documents, producing a third document of the differences.
	void DigSigCompareWordsAndFontsRecent(PDDoc docA, PDDoc docB, ASBool iUseFonts) Compares the words of two documents, taking into account possible font changes, and produces a third document of the differences.
	ASBool DigSigCompareWordsEx(PDDoc docA, PDDoc docB, DSCompareWordsParams params) Compares the words of two documents, producing a third document of the differences.
	void DigSigCompareWordsRecent(PDDoc docA, PDDoc docB, ASBool iUseFonts) Compares the words of two documents, producing a third document of the differences.
	CosObj DigSigCreateStdXObj(const CosDoc cosDoc, const ASFixedRect*const pBBoxRec, DSXObjType dsXObjType) Returns a new XObject with the specified bounding box. Unlike the XObject returned by DigSigGetStdXObj(), DigSig does not attach the XObject returned by this function to the CosDoc.
	void DigSigDeletedSig(PDDoc pdDoc) Recalculates the number of signature fields and redraws the signature panel after any signature is deleted.
	void DigSigDeletedSigEx(PDDoc pdDoc, CosObj cosField) Recalculates the number of signature fields and redraws the signature panel after a specified signature is deleted.
	ASBool DigSigDocModifiedAfterSig(PDDoc doc, CosObj sigField) Tests whether a document has been modified since being signed with the specified signature.
	void DigSigDoProperties(AVDoc avDoc, CosObj sigField) Opens the DigSig's property dialog box.
	void DigSigDraw(PDAnnot pdAnnot, AVPageView avPV, ASBool bIsSelected) Causes the signature to be redrawn.
	void DigSigEnumSignatures(PDDoc pdDoc, DigSigEnumProc proc, void* clientData) Enumerates the signature fields (signed and unsigned) in the file.
	ASInt32 DigSigFileGetEOF(ASFile asFile) Gets the number of bytes in an ASFile. It serves as a wrapper for the ASFileGetEOF() method.
	ASFilePos64 DigSigFileGetEOF64(ASFile asFile) Procs below are provided in version 0x00020000 Gets the number of bytes in an ASFile. It serves as a wrapper for the ASFileGetEOF64() method.
	ASInt32 DigSigFileRead(ASFile asFile, char* p, ASInt32 count) Reads from an ASFile. This is a wrapper function for the ASFileRead() method.
	void DigSigFileSetPos(ASFile asFile, ASInt32 pos) Reopens an ASFile for reading and sets the file position.
	void DigSigFileSetPos64(ASFile asFile, ASFilePos64 pos) Reopens an ASFile for reading and sets the file position.
	DSRetCode DigSigFinishSigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj refDict, DSSigRefDictErrParams errParams) Computes the digest value and stores it in the reference dictionary. It should be called after DigSigCommitSigRefDict().
	CosObj DigSigGetDocAuthorSignature(PDDoc doc) Gets the author signature for a document, as a Cos object.
	DSMDPType DigSigGetDocMDPSetting(PDDoc pdDoc) Gets the Modification Detection and Prevention (MDP) setting for the author signature for the specified document.
	CosObj DigSigGetStdXObj(CosDoc cosDoc, DSXObjType dsXObjType) Gets a Cos XObject for one of the standard signature graphics: blank, question mark, and cross.
	CosObj DigSigGetUbiquitySig(PDDoc pdDoc) Gets the LiveCycle Reader Extensions signature for a document, as a Cos object.
	char* DigSigGetUniqueTitle(CosDoc cosDoc) Gets a character string that is suitable as the field name for a new signature field. This is guaranteed not to duplicate an existing field name. Typically, this name would be of the form XXXXnnn, where XXXX is the word 'signature' in a local Latin-alphabet language, and nnn is a unique integer.
	void DigSigHexToByte(unsigned char* hexP, unsigned char* byteP, ASInt32 length) Converts a PDF hex string to a byte string. For example, the 6 byte string "<412f>" converts to the 2-byte string "(A/)".
	ASBool DigSigIsSigSigned(PDDoc pdDoc, CosObj sigField) Tests whether a particular signature field in a document is signed.
	void DigSigKeyDown(PDAnnot pdAnnot, AVPageView avPV, ASUns16 nKey, ASInt16 nFlags) The AcroForm plug-in calls this method when the user tabs to a signature annotation and activates it by pressing the space bar or Enter key, which is equivalent to a left-mouse click. The parameters parallel those of the AVAnnotHandlerDoKeyDownProc() callback. If the key pressed is an ASCII <CR>, this method selects the annotation.
	ASInt32 DigSigMD5ByteRange(ASFile asFile, CosObj byteRange, char* md5hash) Calculates the MD5 hash function over a set of byte ranges in a file.
	DSRetCode DigSigNewSigRefDict(DSSigRefDictParams refParams, DSSigRefDictErrParams errParams) Begins the process of creating a new signature reference dictionary containing an object digest. The caller fills in the values of the refParams structure.
	ASInt32 DigSigOverwriteBytes(ASFile asFile, const DigSigOffset digSigOffset, const char* p) Overwrites any or all entries in a signature dictionary. It reopens the file for write, positions to the specified place, and writes exactly the number of bytes specified in digSigOffset.
	ASUns64 DigSigOverwriteBytes64(ASFile asFile, const DigSigOffset64 digSigOffset, const char* p) Overwrites any or all entries in a signature dictionary. It reopens the file for write, positions to the specified place, and writes exactly the number of bytes specified in digSigOffset.
	ASInt32 DigSigOverwriteHexstring(ASFile asFile, const DigSigOffset digSigOffset, const CosObj cosObj) Overwrites part of a file with a hex string. It reopens the file for write, positions to the specified location, formats the string as characters, and writes. This method is used to overwrite the /Contents entry in the signature dictionary.
	ASUns64 DigSigOverwriteHexstring64(ASFile asFile, const DigSigOffset64 digSigOffset, const CosObj cosObj) Overwrites part of a file with a hex string. It reopens the file for write, positions to the specified location, formats the string as characters, and writes. This method is used to overwrite the /Contents entry in the signature dictionary.
	ASInt32 DigSigOverwriteIntArray(ASFile asFile, const DigSigOffset digSigOffset, const CosObj cosObj) Overwrites part of asFile with an integer array. It reopens the file for write, positions to the specified place, formats the array as characters, and writes. This method is used to overwrite the /ByteRange entry in the signature dictionary.
	ASUns64 DigSigOverwriteIntArray64(ASFile asFile, const DigSigOffset64 digSigOffset, const CosObj cosObj) Overwrites part of asFile with an integer array. It reopens the file for write, positions to the specified place, formats the array as characters, and writes. This method is used to overwrite the /ByteRange entry in the signature dictionary.
	void DigSigPostDraw(PDAnnot pdAnnot, AVPageView avPV, ASBool bIsSelected) Draws signature adornment after the signature appearance is drawn.
	void DigSigRegisterFilter(ExtensionID owner, DigSigHandler digSigHandler) Procs below are provided in version 0x00010000 Registers a signing method plug-in. A signing plug-in must call this method before making any signatures. This object should not be destroyed until after it is un-registered or until exit.
	ASInt32 DigSigRegisterObserver(DSNotificationType notificationID, DSNotificationProc notifyProc, DSNotificationFailureProc notifyFailure, void* clientData) Registers callbacks with the notification server, to be called for specific digital signature events.
	void DigSigRightClick(PDAnnot pdAnnot, AVPageView avPV, ASInt16 nX, ASInt16 nY, ASInt16 nFlags, ASInt16 nClicks) Invokes the signature-panel pull-right menu and allows the user to select an action.
	void DigSigRollbackToSig(PDDoc pdDoc, CosObj sigField) Creates a new temporary file that corresponds to the state of the file after the specified signature was applied.
	void DigSigSignDoc(PDDoc pdDoc, CosObj sigField, ASAtom filterKey) Signs and saves a document, using the specified field and signing method. If sigField is NULL, makes a field of size 0x0 points.
	void DigSigUnregisterFilter(DigSigHandler digSigHandler) Un-registers a signing method plug-in. The caller should deallocate the DigSigHandler object after making this call.
	void DigSigUnregisterObserver(DSNotificationType notificationID, ASInt32 observerID) Un-registers an event interest from the notification server.
	void DigSigUpdatePanel(PDDoc pdDoc) Updates the signature panel, if any, associated with pdDoc.
	DSValidState DigSigVerifySig(PDDoc pdDoc, CosObj sigField, ASBool bUI) Verifies a digital signature.
	DSRetCode DigSigVerifySigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj refDict, DSSigRefDictErrParams errParams) Verifies an object signature stored in a signature reference dictionary. It involves computing the object digest using the transform method and comparing it to the digest value stored in the reference dictionary.

Defines Detail

DigSigHFT_NUMSELECTORS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define DigSigHFT_NUMSELECTORS (DSNUMSELECTORSPlusOne - 1)

File: DigSigHFT.h

Line: 1719

ESOBJ_SigInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define ESOBJ_SigInfo "signatureInfo"

Description

Private data name of ASCab entry in sigInfo ESObject

File: DigSigHFT.h

Line: 364

ESOBJ_SigSeedValue

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define ESOBJ_SigSeedValue "sigSeedValue"

Description

The private data name of the ASCab entry in the seed value ESObject.

File: DigSigHFT.h

Line: 497

kDSException

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kDSException -2

Description

Get the exception string. When this is returned, the exception text should be available from the called routine. If the exception text is NULL, it is considered to be an unknown error.

File: DigSigHFT.h

Line: 341

kDSFalse

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kDSFalse 0

Description

A boolean return value.

File: DigSigHFT.h

Line: 348

kDSOk

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kDSOk 1

Description

Success.

File: DigSigHFT.h

Line: 352

kDSParameterError

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kDSParameterError -1

Description

Error in a parameter to the function call. There is no exception string.

File: DigSigHFT.h

Line: 346

kDSTrue

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kDSTrue 1

Description

A boolean return value.

File: DigSigHFT.h

Line: 350

PROP_DSSigProp_Date

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_Date "M"

Description

PDF Date format, time of signing

File: DigSigHFT.h

Line: 543

PROP_DSSigProp_DisplayOnPageIcon

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_DisplayOnPageIcon sigDisplayOnPageIcon"

Description

only use the values enumerated below. Default is kDSDisplayOnPageIconAlways.

File: DigSigHFT.h

Line: 588

PROP_DSSigProp_ErrText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_ErrText "ErrorText"

Description

Error text, present only if there was error while validating, new in Acrobat 7

File: DigSigHFT.h

Line: 561

PROP_DSSigProp_HashAlgo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_HashAlgo "digestMethod"

Description

Hashing algorithm used to hash the document. Can be empty, new in Acrobat 8

File: DigSigHFT.h

Line: 569

PROP_DSSigProp_IconState

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_IconState sigIconState"

Description

If you want to put this entry in your plugins' signature properties cab please make sure you use the DSSigPropIconState enum below for its values. This will ensure that DigSig use the appropriate icons (in sync with your plugins') to represent the signature's state. If you do not provide this value, DigSig will use validity icons according to what it thinks is the validity status of the signature.

File: DigSigHFT.h

Line: 586

PROP_DSSigProp_IssuerCN

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_IssuerCN "IssuerCN"

Description

Common name of issuer

File: DigSigHFT.h

Line: 549

PROP_DSSigProp_LTVStatus

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_LTVStatus "LTVStatus"

Description

Signature LTV status

File: DigSigHFT.h

Line: 533

PROP_DSSigProp_LTVStatusText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_LTVStatusText "LTVStatusText"

Description

Text of the signature LTV status

File: DigSigHFT.h

Line: 535

PROP_DSSigProp_Name

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_Name "Name"

Description

Common name of signer

File: DigSigHFT.h

Line: 547

PROP_DSSigProp_RevInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_RevInfo "revInfo"

File: DigSigHFT.h

Line: 564

PROP_DSSigProp_RevInfo_CRL

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_RevInfo_CRL "CRL"

File: DigSigHFT.h

Line: 565

PROP_DSSigProp_RevInfo_OCSP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_RevInfo_OCSP "OCSP"

File: DigSigHFT.h

Line: 566

PROP_DSSigProp_SigValTextDetail

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_SigValTextDetail "SigValTextDetail"

Description

Sig validity detail title line

File: DigSigHFT.h

Line: 555

PROP_DSSigProp_SigValTextDetails

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_SigValTextDetails "SigValTextDetails"

Description

ASCab array of ASText sig validity details

File: DigSigHFT.h

Line: 557

PROP_DSSigProp_SigValTextSummary

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_SigValTextSummary "SigValTextTop"

Description

Summary signature validity text, to append to AVPanel sig title

File: DigSigHFT.h

Line: 553

PROP_DSSigProp_SigValTextTooltip

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_SigValTextTooltip "SigValTextTooltip"

Description

Signature validity text to show in tooltip

File: DigSigHFT.h

Line: 559

PROP_DSSigProp_SigValue

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_SigValue "sigValue"

File: DigSigHFT.h

Line: 563

PROP_DSSigProp_SubjectOrg

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_SubjectOrg "SubjectOrg"

Description

Organisation of signer

File: DigSigHFT.h

Line: 551

PROP_DSSigProp_TrustedDate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_TrustedDate "Trusted_M"

Description

indicates whether the signing time was from a trusted time source or not. If the key is not present, its assumed it was from an untrusted (e.g. system) source, new in Acrobat 7

File: DigSigHFT.h

Line: 577

PROP_DSSigProp_VerifyDate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigProp_VerifyDate "VerifyDate"

Description

PDF Date format, time of verification, new in Acrobat 7

File: DigSigHFT.h

Line: 545

PROP_DSSigPropChainExpiration

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigPropChainExpiration "ExpirationTime"

Description

The earliest expiration time for all certificates in the trusted chain

File: DigSigHFT.h

Line: 537

PROP_DSSigPropNumberOfChains

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigPropNumberOfChains "NumberOfChains"

Description

Total number of chains built for the signature validation

File: DigSigHFT.h

Line: 539

PROP_DSSigPropNumberOfTrustedChains

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DSSigPropNumberOfTrustedChains "NumberOfTrustedChains"

Description

Number of trusted chains built for the signature validation

File: DigSigHFT.h

Line: 541

SIGINFO_OBJ

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define SIGINFO_OBJ "SigInfo"

Description

EScript SigInfo object name

File: DigSigHFT.h

Line: 362

VALUE_APCab_TypeDSAPIcon

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define VALUE_APCab_TypeDSAPIcon "apIcon"

File: PubSecHFT.h

Line: 1207

Typedefs Detail

DigSigBBox

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigBBoxRec DigSigBBox;

File: DigSigHFT.h

Line: 674

DigSigBBoxRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigBBoxRec DigSigBBoxRec;

File: DigSigHFT.h

Line: 674

DigSigCosDocSigParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigCosDocSigParamsRec DigSigCosDocSigParams;

File: DigSigHFT.h

Line: 956

DigSigCosDocSigParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigCosDocSigParamsRec DigSigCosDocSigParamsRec;

File: DigSigHFT.h

Line: 956

DigSigDataBufferSigNewParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigDataBufferSigNewParamsRec DigSigDataBufferSigNewParams;

File: DigSigHFT.h

Line: 1019

DigSigDataBufferSigNewParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigDataBufferSigNewParamsRec DigSigDataBufferSigNewParamsRec;

File: DigSigHFT.h

Line: 1019

DigSigDataBufferSigValidateParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigDataBufferSigValidateParamsRec DigSigDataBufferSigValidateParams;

File: DigSigHFT.h

Line: 1077

DigSigDataBufferSigValidateParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigDataBufferSigValidateParamsRec DigSigDataBufferSigValidateParamsRec;

File: DigSigHFT.h

Line: 1077

DigSigDataParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigDataParamsRec DigSigDataParams;

File: DigSigHFT.h

Line: 972

DigSigDataParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigDataParamsRec DigSigDataParamsRec;

File: DigSigHFT.h

Line: 972

DigSigHandler

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigHandlerRec DigSigHandler;

File: DigSigHFT.h

Line: 1694

DigSigHandlerRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigHandlerRec DigSigHandlerRec;

File: DigSigHFT.h

Line: 1694

DigSigNewSigDataParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigNewSigDataParamsRec DigSigNewSigDataParams;

File: DigSigHFT.h

Line: 884

DigSigNewSigDataParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigNewSigDataParamsRec DigSigNewSigDataParamsRec;

File: DigSigHFT.h

Line: 884

DigSigOffset

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigOffsetRec DigSigOffset;

File: DigSigHFT.h

Line: 653

DigSigOffset64

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigOffset64Rec DigSigOffset64;

File: DigSigHFT.h

Line: 663

DigSigOffset64Rec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigOffset64Rec DigSigOffset64Rec;

File: DigSigHFT.h

Line: 663

DigSigOffsetRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DigSigOffsetRec DigSigOffsetRec;

File: DigSigHFT.h

Line: 653

DSAPCreateLayeredStreamExParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSAPCreateLayeredStreamExParams DSAPCreateLayeredStreamExParams;

File: DigSigHFT.h

Line: 1836

DSAPCreateLayeredStreamExParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSAPCreateLayeredStreamExParams DSAPCreateLayeredStreamExParamsRec;

File: DigSigHFT.h

Line: 1836

DSAPTextEntry

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSAPTextEntryRec DSAPTextEntry;

File: DigSigHFT.h

Line: 1731

DSAPTextEntryRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSAPTextEntryRec DSAPTextEntryRec;

File: DigSigHFT.h

Line: 1731

DSAPXObjEntry

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSAPXObjEntryRec DSAPXObjEntry;

File: DigSigHFT.h

Line: 1875

DSAPXObjEntryRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSAPXObjEntryRec DSAPXObjEntryRec;

File: DigSigHFT.h

Line: 1875

DSComparePagesParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSComparePagesParamsRec DSComparePagesParams;

File: DigSigHFT.h

Line: 2031

DSComparePagesParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSComparePagesParamsRec DSComparePagesParamsRec;

File: DigSigHFT.h

Line: 2031

DSCompareWordsParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSCompareWordsParamsRec DSCompareWordsParams;

File: DigSigHFT.h

Line: 2046

DSCompareWordsParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSCompareWordsParamsRec DSCompareWordsParamsRec;

File: DigSigHFT.h

Line: 2046

DSNtfyParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSNtfyParamsRec DSNtfyParams;

File: DigSigHFT.h

Line: 1959

DSNtfyParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSNtfyParamsRec DSNtfyParamsRec;

File: DigSigHFT.h

Line: 1959

DSSigRefDictErrParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSSigRefDictErrParamsRec DSSigRefDictErrParams;

File: DigSigHFT.h

Line: 1775

DSSigRefDictErrParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSSigRefDictErrParamsRec DSSigRefDictErrParamsRec;

File: DigSigHFT.h

Line: 1775

DSSigRefDictParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSSigRefDictParamsRec DSSigRefDictParams;

File: DigSigHFT.h

Line: 1805

DSSigRefDictParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DSSigRefDictParamsRec DSSigRefDictParamsRec;

File: DigSigHFT.h

Line: 1805

ESObject

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _s_ESObjectRec* ESObject;

File: DigSigHFT.h

Line: 326

ESObjectRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _s_ESObjectRec ESObjectRec;

ESObject is an EScript object that is supported as of Acrobat 5.0 by the escript plug-in. The EScript HFT has not been exposed to third party developers, thus you should use or assume NULL for ESObject parameters. Signature support for EScript is available only when using the PubSecHFT for public-key signatures.

File: DigSigHFT.h

Line: 326

Enumeration Detail

DSAPXObjectFromXObjectListFlags

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSAPXObjectFromXObjectListFlags {

  kDSMerge = 0x0001,


 


  kDSForceEmbed = 0x0002

}

File: DigSigHFT.h

Line: 1877

DSCosDocSigObjType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSCosDocSigObjType {

  kDSObjCosDoc = 0,


 


  kDSObjUbiquity,


 


  kDSObjEnumSize

}

File: DigSigHFT.h

Line: 888

Elements

	kDSObjCosDoc	A CosDoc signature.

	kDSObjUbiquity	Usage rights.

	kDSObjEnumSize	The size of the `DSCosDocSigObjType` enumeration.

DSHandlerProperty

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSHandlerProperty {

  kDSHandlerCanDocAuthSign = 0,


 


  kDSHandlerCanDocPDDocSignVisible,


 


  kDSHandlerEScriptAware,


 


  kDSHandlerPropEnumSize

}

See Also

DSGetBoolPropertyProc

File: DigSigHFT.h

Line: 811

Elements

	kDSHandlerCanDocAuthSign	When `true`, the handler supports author signatures.

	kDSHandlerCanDocPDDocSignVisible	When `true`, the handler supports ordinary visible signatures.

	kDSHandlerEScriptAware	When `true`, the handler supports EScript.

	kDSHandlerPropEnumSize	The size of the `DSHandlerProperty` enumeration.

DSLTVEnabled

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSLTVEnabled {

  kDSLTVUnknown,


 


  kDSLTVEnabled,


 


  kDSLTVNotEnabled

}

File: DigSigHFT.h

Line: 455

DSMDPType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSMDPType {

  kDSMDPNone = -1,


 


  kDSMDPAllowAll = 0,


 


  kDSMDPAllowNone,


 


  kDSMDPDefault,


 


  kDSMDPCommentsAndDefault,


 


  kDSMDPEnumSize

}

File: DigSigHFT.h

Line: 790

Elements

	kDSMDPNone	No MDP. The document does not have a signature. In versions earlier than Acrobat 9.0, this status is returned for a document that does not have an author signature, but does have an ordinary signature. In Acrobat 9.0 and later, any signature will invoke MDP analysis of all subsequent changes.

	kDSMDPAllowAll	Allow any changes (disables the MDP feature).

	kDSMDPAllowNone	Allow no changes.

	kDSMDPDefault	Only allow natural changes (form field fill-in, page spawning).

	kDSMDPCommentsAndDefault	Allow all comment types and edit/modify/delete operations, in addition to default changes.

	kDSMDPEnumSize	The size of the `DSMDPType` enumeration.

DSNotificationType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSNotificationType {

  DSSigAdded = 0,


 


  DSSigDeleted,


 


  DSWillSign,


 


  DSDidSign,


 


  DSFailSign,


 


  DSWillVerify,


 


  DSDidVerify,


 


  DSFailVerify,


 


  DSWillClear,


 


  DSDidClear,


 


  DSFailClear,


 


  DigSigNumNotifications

}

See Also

DigSigRegisterObserver

File: DigSigHFT.h

Line: 1886

Elements

	DSSigAdded	The signature field is added.

	DSSigDeleted	The signature field is deleted.

	DSWillSign	A signature is requested (the notification procedure is invoked before the signature is applied).

	DSDidSign	A signature is created (the notification procedure is invoked when signing succeeds).

	DSFailSign	A signature request fails (the notification procedure is invoked when signing fails).

	DSWillVerify	A signature verification is requested.

	DSDidVerify	A signature verification succeeds.

	DSFailVerify	A signature verification request fails.

	DSWillClear	The clearing of a signature is requested.

	DSDidClear	The clearing of a signature succeeds.

	DSFailClear	The clearing of a signature fails.

	DigSigNumNotifications	Number of notifications.

DSNotifySigType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSNotifySigType {

  kDSNotifyNone = 0,


 


  kDSNotifySetUnknown,


 


  kDSNotifyModifiedAfterSig,


 


  kDSNotifySigTypeEnumSize

}

File: DigSigHFT.h

Line: 1081

Elements

	kDSNotifyNone	No notification (not used).

	kDSNotifySetUnknown	Mark the validity of this signature as unknown. This should mark validity caches to indicate that the signature validity is unknown.

	kDSNotifyModifiedAfterSig	The document may have been modified since this signature was applied. The handler should update the signature status after calling DigSigDocModifiedAfterSig(). This is not called as of Acrobat 6.0, but may be used in a later release.

	kDSNotifySigTypeEnumSize	The size of the `DSNotifySigType` enumeration.

DSPropertyType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSPropertyType {

  kDSPropNone = 0,


 


  kDSPropSignature,


 


  kDSPropLegal,


 


  kDSPropViewVersion,


 


  kDSPropTypeEnumSize

}

File: DigSigHFT.h

Line: 824

Elements

	kDSPropNone	Do not show the signature properties dialog box.

	kDSPropSignature	Show the general signature properties dialog box.

	kDSPropLegal	Show the legal notice dialog box.

	kDSPropViewVersion	Show the signature rollback (it will actually roll back to this signature).

	kDSPropTypeEnumSize	The size of the `DSPropertyType` enumeration.

DSQuadding

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSQuadding {

  DSLeftQ = 0,


 


  DSCenterQ,


 


  Q

}

See Also

DigSigAPXObjectFromXObjList

File: DigSigHFT.h

Line: 1841

Elements

	DSLeftQ	Left justification.

	DSCenterQ	Center justification.

	Q	Right justification.

DSSigEncode

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSigEncode {

  kDSSigEncodeNone = 0,


 


  kDSSigEncodePKCS1,


 


  kDSSigEncodePKCS7,


 


  kDSSigEncodeRawSig,


 


  kDSSigEncodePKCS7Detached,


 


  kDSSigEncodeETSICAdES,


 


  kDSSigEncodeETSIDocTimestamp,


 


  kDSSigEncodeEnumSize

}

See Also

DigSigDataSigSign
DigSigDataSigValidate

File: DigSigHFT.h

Line: 761

Elements

	kDSSigEncodeNone	Not specified.

	kDSSigEncodePKCS1	PKCS#1 encoding.

	kDSSigEncodePKCS7	PKCS#7 encoding. This will apply the signature to an SHA1 digest of the data.. This is now deprecated. Use `kDSSigEncodePKCS7Detached` instead.

	kDSSigEncodeRawSig	The digest is directly encrypted. This has never worked before and is now deprecated.

	kDSSigEncodePKCS7Detached	PKCS#7 encoding. Unlike `kDSSigEncodePKCS7`, the signature is directly applied to the data.

	kDSSigEncodeETSICAdES	CAdES-compatible encoding. It is PKCS#7 detached with additional attributes.

	kDSSigEncodeETSIDocTimestamp	PAdES Document Timestamp encoding. This is a Timestamp token per RFC 3161.

	kDSSigEncodeEnumSize	The size of the `DSSigEncode` enumeration.

DSSigPropDisplayOnPageIcon

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSigPropDisplayOnPageIcon {

  kDSDisplayOnPageIconAlways = 0,


 


  kDSDisplayOnPageIconExceptWhenValid,


 


  kDSDisplayOnPageIconNever,


 


  kDSDisplayOnPageIconEnumSize

}

File: DigSigHFT.h

Line: 589

DSSigPropIconState

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSigPropIconState {

  kDSSigIconBlank = 0,


 


  kDSSigIconSigUnknown,


 


  kDSSigIconSigInvalid,


 


  kDSSigIconSigValidIdUnknown,


 


  kDSSigIconSigValidIdUnknownModAfter,


 


  kDSSigIconSigValid,


 


  kDSSigIconSigValidModAfter,


 


  kDSSigIconSigValidTrailingModsAfter,


 


  kDSSigIconAuthUnknown,


 


  kDSSigIconAuthInvalid,


 


  kDSSigIconAuthValidIdUnknown,


 


  kDSSigIconAuthValidIdUnknownModAfter,


 


  kDSSigIconAuthValid,


 


  kDSSigIconAuthValidModAfter,


 


  kDSSigIconSigDeleted,


 


  kDSSigIconEnumSize

}

File: DigSigHFT.h

Line: 597

Elements

	kDSSigIconBlank	sig field is unsigned

	kDSSigIconSigUnknown	sig field is signed but not validated

	kDSSigIconSigInvalid	sig field is signed and failed validate

	kDSSigIconSigValidIdUnknown	sig field is signed and doc is valid, but identity is unknown or not trusted

	kDSSigIconSigValidIdUnknownModAfter	sig field is signed, but identity is unknown or not trusted and mods have been made since sig applied

	kDSSigIconSigValid	sig field is signed and double-checked valid

	kDSSigIconSigValidModAfter	sig field is signed and double check valid, but mods have been made since sig applied

	kDSSigIconSigValidTrailingModsAfter	sig field is signed and double check valid, but mods have been made since sig applied -- AND sig is the last sig in the document

	kDSSigIconAuthUnknown	sig field is auth signed but not validated

	kDSSigIconAuthInvalid	sig field is auth signed and failed validate

	kDSSigIconAuthValidIdUnknown	sig field is auth signed and doc is valid, but identity is unknown or not trusted

	kDSSigIconAuthValidIdUnknownModAfter	sig field is auth signed, but identity is unknown or not trusted and mods have been made since sig applied

	kDSSigIconAuthValid	sig field is auth signed and double-check valid

	kDSSigIconAuthValidModAfter	sig field is auth signed and double check valid, but mods have been made since sig applied

	kDSSigIconSigDeleted	sig field was signed in an earlier version, but has since been deleted

	kDSSigIconEnumSize	The size of the `DSSigPropIconState` enumeration.

DSSigRefErrCode

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSigRefErrCode {

  kDSSigRefErrNone = 0,


 


  kDSSigRefErrMissingPlugin,


 


  kDSSigRefErrNewVersion,


 


  kDSSigRefErrOldVersion,


 


  kDSSigRefErrEnumSize

}

File: DigSigHFT.h

Line: 1747

DSValidState

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSValidState {

  DSSigBlank = 0,


 


  DSSigUnknown,


 


  DSSigInvalid,


 


  DSSigValid,


 


  DSSigDoubleChecked,


 


  DSSigValidStateEnumSize

}

File: DigSigHFT.h

Line: 682

Elements

	DSSigBlank	The signature field is unsigned.

	DSSigUnknown	The signature field is signed but not validated.

	DSSigInvalid	The signature field is signed but failed validation.

	DSSigValid	The signature field is signed and valid.

	DSSigDoubleChecked	The signature field is signed and double-checked as valid.

	DSSigValidStateEnumSize	A validity state constant for a signature field, resulting from verification.

DSXObjType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSXObjType {

  DSBlankXObj = 0,


 


  DSUnknownXObj,


 


  DSInvalidXObj,


 


  DSValidXObj,


 


  DSDoubleCheckedXObj

}

See Also

DSUnValidateSigProc
DigSigGetStdXObj

File: DigSigHFT.h

Line: 704

Elements

	DSBlankXObj	Blank appearance.

	DSUnknownXObj	Signed but not validated appearance.

	DSInvalidXObj	Signed and failed validation appearance.

	DSValidXObj	Signed and valid, but the identity is not verified.

	DSDoubleCheckedXObj	Signed and valid, and the identity is verified.

Variables Detail

gDigSigHFT

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gDigSigHFT;

File: DigSigHFT.h

Line: 317

Structure Detail

_t_DigSigBBoxRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigBBoxRec {

  ASFixed bbWidth;  


 


  ASFixed bbHeight;  

}

A signature annotation bounding box.

See Also

DSNewSigDataProc

File: DigSigHFT.h

Line: 669

Elements

	bbWidth	The width of the signature bounding box.

	bbHeight	The height of the signature bounding box.

_t_DigSigCosDocSigParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigCosDocSigParamsRec {

  ASSize_t size;  


 


  PDDoc pdDoc;  


 


  CosDoc cosDoc;  


 


  ASAtom filter;  


 


  ESObject esSigEngine;  


 


  ASCab sigParamsCab;  


 


  ASInt32 uiType;  


 


  ASText signDialogTitle;  


 


  ASText promptMessage;  


 


  ASText asTextError;  


 


  DSCosDocSigObjType objSigType;  


 


  void* objSigParams;  

}

Parameters passed in to DSCosDocSigSign() and DSCosDocSigValidate() procs. Certain parameters vary depending on what DSCosDocSigObjType objSigType is set to.

If objSigType is kDSObjCosDoc:

Parameter	Description
`objSignParams`	None.
`pdDoc`	Used for window parenting when available, otherwise it is `NULL` (this would be the active document, and not necessarily the document to which the `CosDoc` belongs).
`cosDoc`	The CosDoc that is to be signed.

If objSigType is kDSObjUbiquity:

Parameter	Description
`objSignParams`	A CosDict containing the usage rights sub-options for form filling, annotation changes, page template spawning, and so on. Look at the URD specification in the PDF Reference 1.5, section 8.7.2 for the precise syntax of CosDict and the keys within.
`pdDoc`	Indicates the `PDDoc` to which usage rights are applied.
`cosDoc`	Ignored.

See Also

DSCosDocSigSign
DSCosDocSigValidate

File: DigSigHFT.h

Line: 922

Elements

	size	The size of this `struct`.

	pdDoc	The associated PDDoc, if needed. See DigSigCosDocSigParamsRec for more details.

	cosDoc	The CosDoc to be signed, if needed. See DigSigCosDocSigParamsRec for more details.

	filter	The name of the selected handler to use when signing or validating.

	esSigEngine	If specified, then use it to sign, otherwise use the engine that belongs to the default user interface.

	sigParamsCab	If specified, then provides parameters to use when signing.

	uiType	If `0` then be silent, otherwise prompt the user to sign (it can be `true` even with escript). If `1` then use a simple user interface, otherwise use a complex user interface.

	signDialogTitle	Dialog title to use when signing. The object is owned by `DigSig`.

	promptMessage	The message to use when acquiring resources for signing. The object is owned by `DigSig`.

	asTextError	If an exception occurs, this returns the exception string. The caller must call `ASTextDestroy()`.

	objSigType	The type of `CosDoc` signature.

	objSigParams	The associated `objSigParams`, if needed. See DigSigCosDocSigParamsRec for more details.

_t_DigSigDataBufferSigNewParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigDataBufferSigNewParamsRec {

  ASSize_t size;  


 


  PDDoc inPDDoc;  


 


  ASAtom filter;  


 


  ESObject inESSigEngine;  


 


  ESObject inESSigParams;  


 


  DSDigestMethod inDigestMethod;  


 


  DSSigEncode inSigValueEncoding;  


 


  ASCab inSeedValue;  


 


  ASText inDataTitle;  


 


  ASText inDataDescription;  


 


  ASText inSignDialogTitle;  


 


  ASText inPromptMessage;  


 


  ASInt32 inNUI;  


 


  void* inDataDisplayCallbackProc;  


 


  ASCab outCertChainCab;  


 


  ASCab outSigPropCab;  


 


  ASCab outSigBuildCab;  


 


  ASText outASTextError;  

}

File: DigSigHFT.h

Line: 974

Elements

	size	The size of this `struct`.

	inPDDoc	Used for window parenting.

	filter	The name of the selected handler to use when signing. It must set to `ASAtomNull` if it is not defined. Upon the signature being applied, this will be set to the name of the filter that was used to sign.

	inESSigEngine	If specified, use it to sign, otherwise use the engine that belongs to the default user interface.

	inESSigParams	If specified, it provides parameters to use when signing.

	inDigestMethod	When signing, if it is not none, then the data is to be digested and the digest is to be signed; otherwise directly sign the data.

	inSigValueEncoding	Specifies signature value encoding.

	inDataTitle	The name of the data that is being signed.

	inDataDescription	The description of the data that is being signed.

	inSignDialogTitle	The dialog box title to use when signing. The object is owned by `DigSig`.

	inPromptMessage	The message to use when acquiring resources for signing. The object is owned by `DigSig`.

	inNUI	If this is greater than `0`, prompt the user to sign; otherwise be silent (it can be `true` even with EScript).

	inDataDisplayCallbackProc	The callback to display data that is being signed.

	outCertChainCab	The certificate chain of the signer. It must be an initialized `ASCab`. It is returned by the `sigNew` call.

	outSigPropCab	Signature properties. It must be an initialized `ASCab`. Refer to `PROP_SigProp_*` definitions in PubSecHFT.h for defined properties. It is returned by a `sigNew` call.

	outSigBuildCab	Signature build information. It must be an initialized `ASCab`. Refer to `PROP_SigBuild*` definitions in PubSecHFT.h for defined properties. It is returned by a `sigNew` call.

	outASTextError	If an exception occurs, this returns the exception string. The caller must call `ASTextDestroy()`.

_t_DigSigDataBufferSigValidateParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigDataBufferSigValidateParamsRec {

  ASSize_t size;  


 


  PDDoc inPDDoc;  


 


  ASAtom filter;  


 


  ESObject inESSigEngine;  


 


  ESObject inESSigParams;  


 


  DSDigestMethod inDigestMethod;  


 


  DSSigEncode inSigValueEncoding;  


 


  ASText inDataTitle;  


 


  ASText inDataDescription;  


 


  ASInt32 inNUI;  


 


  void* inDataDisplayCallbackProc;  


 


  ASCab inCertChainCab;  


 


  ASUns8 inDataPtr;  


 


  ASUns32 inDataSize;  


 


  ASUns8 inSigValuePtr;  


 


  ASUns32 inSigValueSize;  


 


  ASText outASTextError;  


 


  VerifyRefCallbackProc inVerifyReferencesCallbackProc;  


 


  void* inVerifyReferencesCallbackProcData;  

}

File: DigSigHFT.h

Line: 1028

Elements

	size	The size of this `struct`.

	inPDDoc	Used for window parenting

	filter	The name of the selected handler to use when verifying. It must be set to ASAtomNull if it is not defined.

	inESSigEngine	If specified, use it to verify; otherwise use the engine that belongs to the default user interface.

	inESSigParams	If specified, it provides parameters to use when signing.

	inDigestMethod	When signing, if it is not none, then the data is to be digested and the digest is to be signed, otherwise directly sign the data.

	inSigValueEncoding	Specifies signature value encoding.

	inDataTitle	The name of the data that is being verified.

	inDataDescription	The description of the data that is being verified.

	inNUI	The dialog box title to use when signing. The object is owned by `DigSig`. Message to use when acquiring resources for signing. The object is owned by `DigSig`. If this is greater than `0`, allow the user interface; otherwise be silent (it can be `true` even with EScript).

	inDataDisplayCallbackProc	The callback to display data that is being signed.

	inCertChainCab	The certificate chain of the signer. It must be an initialized ASCab. It is returned by the `sigNew` call.

	inDataPtr	A pointer to the data to be signed. If it is `NULL`, then signing does not occur.

	inDataSize	The size of the data to be signed.

	inSigValuePtr	The resulting signature value, to be freed using ASfree() by the caller, or the signature value if verifying.

	inSigValueSize	The size of the resulting signature value.

	outASTextError	If an exception occurs, this returns the exception string. The caller must call `ASTextDestroy()`.

	inVerifyReferencesCallbackProc	Callback function used to verify all references used by the data signature.

	inVerifyReferencesCallbackProcData	Data used by `inVerifyReferencesCallbackProc()`.

_t_DigSigDataParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigDataParamsRec {

  ASSize_t size;  


 


  ASUns8 inDataPtr;  


 


  ASUns32 inDataSize;  


 


  ASUns8 outDataPtr;  


 


  ASUns32 outDataSize;  


 


  ASText outASTextError;  

}

File: DigSigHFT.h

Line: 958

Elements

	size	The size of this `struct`.

	inDataPtr	A pointer to the data to be processed.

	inDataSize	The size of the data to be processed.

	outDataPtr	The resulting object value, to be freed using `ASfree()` by the caller.

	outDataSize	The size of the resulting object.

	outASTextError	If an exception occurs, this returns the exception string. The caller must call `ASTextDestroy()`.

_t_DigSigHandlerRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigHandlerRec {

  ASSize_t size;  


 


  const char* uiName;  


 


  ASAtom filterKey;  


 


  ASBool canBlindSign;  


 


  ASBool canEncrypt;  


 


  DSDocOpenProc dsDocOpen;  


 


  DSDocCloseProc dsDocClose;  


 


  DSDefaultValueProc dsDefaultValue;  


 


  DSNewSigDataProc dsNewSigData;  


 


  DSCommitSignProc dsCommitSign;  


 


  DSFinishSignProc dsFinishSign;  


 


  DSFreeSigDataProc dsFreeSigData;  


 


  DSValidateSigProc dsValidateSig;  


 


  DSGetValidStateProc dsGetValidState;  


 


  DSPropertiesProc dsProperties;  


 


  DSUnValidateSigProc dsUnValidateSig;  


 


  DSUnValidateSigProc dsReValidateSig;  


 


  DSClearSigProc dsClearSig;  


 


  DSGetStatusTextProc dsStatusText;  


 


  DSNewSigDataExProc dsNewSigDataEx;  


 


  DSValidateSigExProc dsValidateSigEx;  


 


  DSGetSigInfoProc dsGetSigInfo;  


 


  DSNewSigEngineProc dsNewSigEngine;  


 


  DSSigDataGetErrorTextProc dsSigDataGetErrorText;  


 


  DSNewSigDataWithParamsProc dsNewSigDataWithParams;  


 


  DSPropertiesExProc dsPropertiesEx;  


 


  DSCosDocSigSignProc dsCosDocSigSign;  


 


  DSCosDocSigValidateProc dsCosDocSigValidate;  


 


  DSCanValidateProc dsCanValidate;  


 


  DSNotifySigProc dsNotifySig;  


 


  DSGetSigSeedValueProc dsGetSigSeedValue;  


 


  DSSetSigSeedValueProc dsSetSigSeedValue;  


 


  DSGetBoolPropertyProc dsGetBoolProperty;  


 


  DSGetSigPropProc dsGetSigProp;  


 


  DSIsSignerProc dsIsSigner;  


 


  ASAtom filterAlias;  


 


  DSDataBufferSigSignNewProc dsDataBufferSigSignNew;  


 


  DSDataBufferSigSignFinishProc dsDataBufferSigSignFinish;  


 


  DSDataBufferSigValidateProc dsDataBufferSigValidate;  


 


  DSCommitSign64Proc dsCommitSign64;  


 


  DSFinishSign64Proc dsFinishSign64;  

}

A data structure containing callbacks that define a signature plug-in's behavior. Unused entries should be NULL.

File: DigSigHFT.h

Line: 1590

Elements

	size	The size of the data structure. It must be set to `sizeof(DigSigHandlerRec)`.

	uiName	The language-dependent name to show for signature type selection.

	filterKey	The value of the Filter key in the signature dictionary.

	canBlindSign	`true` if this signature type can do no-appearance signatures, `false` otherwise.

	canEncrypt	`true` if this signature type can do encrypt-and-sign, `false` otherwise.

	dsDocOpen	Called when a new document is opened.

	dsDocClose	Called when a new document is closed.

	dsDefaultValue	Called when a new signature field is created.

	dsNewSigData	Called to gather the signature or cancel.

	dsCommitSign	Called to put the signature into the document or cancel.

	dsFinishSign	Called to calculate the checksum and overwrite.

	dsFreeSigData	Called to free the signature data.

	dsValidateSig	Called to validate a signature.

	dsGetValidState	Gets the validity status for a signature.

	dsProperties	Shows the signature properties dialog box for this signature.

	dsUnValidateSig	Called to change AP back to unvalidated.

	dsReValidateSig	Called to change AP back to whatever it was.

	dsClearSig	A notification that the signature has been cleared.

	dsStatusText	Gets a string describing the status.

	dsNewSigDataEx	Used internally in Acrobat 5.0. Superseded in Acrobat 6.0 by `dsNewSigDataWithParams()`.

	dsValidateSigEx	Used internally by `PubSec`.

	dsGetSigInfo	Used internally by `PubSec`.

	dsNewSigEngine	Used internally by EScript in Acrobat 5.0. It is no longer used.

	dsSigDataGetErrorText	Called to get a descriptive string for an error during new, commit, or free steps.

	dsNewSigDataWithParams	Called to create new signature data to be used by Commit and Finish. Supersedes `dsNewSigDataEx()`.

	dsPropertiesEx	Called to show the signature properties dialog box for the signature.

	dsCosDocSigSign	For internal use only.

	dsCosDocSigValidate	For internal use only.

	dsCanValidate	Called to determine whether the handler can validate a `PDDoc` field signature.

	dsGetSigSeedValue	Used internally by `PubSec`.

	dsSetSigSeedValue	Used internally by `PubSec`.

	dsGetBoolProperty	Called to test whether your handler supports specific functionality.

	dsGetSigProp	Called to get an `ASCab` containing signature properties to be used in the user interface.

	dsIsSigner	Determines whether the current user is the signer of the signature passed in.

	filterAlias	Filter alias.

	dsCommitSign64	Acrobat 10 - Handle files longer than 2147483647 bytes DigSig will attempt to call these if they are defined Called to put the signature into the document or cancel.

	dsFinishSign64	Called to calculate the checksum and overwrite.

_t_DigSigNewSigDataParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigNewSigDataParamsRec {

  ASSize_t size;  


 


  PDDoc pdDoc;  


 


  CosObj sigField;  


 


  CosObj sigAnnot;  


 


  DigSigBBox bb;  


 


  ASAtom filter;  


 


  ESObject esSigEngine;  


 


  ESObject esSigParams;  


 


  ASText esErrorText;  


 


  ASBool bUI;  


 


  ASBool bDocAuthSig;  


 


  CosObj legalPDFDict;  


 


  DSMDPType mdpSetting;  


 


  ASBool bUBSig;  


 


  CosObj urdDict;  

}

Parameters for DSNewSigDataWithParamsProc().

See Also

DSNewSigDataWithParamsProc

File: DigSigHFT.h

Line: 840

Elements

size

The size of the data structure. It must be set to sizeof(DigSigNewSigDataParamsRec).

pdDoc

The PDF document that is being signed.

sigField

The signature form field that is being signed.

sigAnnot

The signature annotation that is being signed (it is usually equivalent to sigField).

The bounding box of the signature appearance.

filter

The name of the selected handler to use when signing.

esSigEngine

Used internally. If specified, then use it to sign; otherwise use the engine that belongs to the default user interface.

esSigParams

Used internally. If specified, it provides parameters to use when signing.

esErrorText

Used internally. If it is not NULL and there is an error that needs reporting for EScript, set it here and return DSSignCancel.

bUI

If true, prompt to sign, otherwise be silent (it can be true with Escript.)

bDocAuthSig

When true, the document is being signed with an author signature.

legalPDFDict

Legal PDF scrubber warnings, populated only when signing a document author signature.

mdpSetting

Modification, detection, and prevention (MDP) setting, populated only when signing a document author signature. It has one of the following values:

Value	Description
`kDSMDPAllowAll`	Allow all changes (disables MDP).
`kDSMDPAllowNone`	Allow no changes.
`kDSMDPDefault`	Allow only natural changes (form field filling, page spawning).
`kDSMDPCommentsAndDefault`	Allow all comment types and edit/modify/delete, in addition to default changes.

bUBSig

Signifies whether user rights are being applied to the document. It is mutually exclusive with bDocAuthSig.

_t_DigSigOffset64Rec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigOffset64Rec {

  CosObj cosObj;  


 


  ASFileOffset64 byteOffset;  


 


  ASInt64 byteLength;  

}

Acrobat 10 - 64-bit positioning

File: DigSigHFT.h

Line: 656

Elements

	cosObj	The CosObj whose byte offset/length is desired.

	byteOffset	The byte offset in the saved PDF file.

	byteLength	The length in the saved PDF file.

_t_DigSigOffsetRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DigSigOffsetRec {

  CosObj cosObj;  


 


  ASInt32 byteOffset;  


 


  ASInt32 byteLength;  

}

A structure that indicates the location of objects in a saved PDF document.

File: DigSigHFT.h

Line: 646

Elements

	cosObj	The CosObj whose byte offset/length is desired.

	byteOffset	The byte offset in the saved PDF file. Its range is `0` to `2147483647`.

	byteLength	The length in the saved PDF file. Its range is `0` to `2147483647`.

_t_DSAPCreateLayeredStreamExParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSAPCreateLayeredStreamExParams {

  CosDoc cosDoc;  


 


  CosObj XObjects;  


 


  ASFixedMatrixP layerMatrices;  


 


  ASInt32 numXObjects;  


 


  ASInt16 layerNNum;  


 


  AFPDWidgetBorder border;  


 


  PDColorValue cBorder;  


 


  PDColorValue cBackGnd;  


 


  ASFixed width;  


 


  ASFixed height;  


 


  PDRotate pdr;  


 


  ASBool layerFlags;  

}

File: DigSigHFT.h

Line: 1808

Elements

	cosDoc	The document in which to include the standard XObject.

	XObjects	A pointer to an array of XObjects for the appearance layers.

	layerMatrices	A pointer to an array of positions.

	numXObjects	The size of the XObjects array.

	layerNNum	The layer number for the optional validity state layer.

	border	The border from AFPDWidgetGetBorder().

	cBorder	The color of the border.

	cBackGnd	The color of the background.

	width	The width of the new stream object.

	height	The height of the new stream object.

	pdr	The rotational parameter from AFPDWidgerGetRotation().

	layerFlags	An array of flag values corresponding to the layers specified by XObject. A value of `true` means that the corresponding layer is displayed.

_t_DSAPTextEntryRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSAPTextEntryRec {

  _t_DSAPTextEntryRec next;  


 


  ASFixed heightRatio;  


 


  ASText text;  

}

A linked list of text items to be merged together.

File: DigSigHFT.h

Line: 1724

Elements

	next	The next entry in the list, or `NULL` if it is the last entry.

	heightRatio	The ratio of the height to the overall height of `bbox` (`0x00010000` is 100%).

	text	The text to render in this object. The caller owns the memory.

_t_DSAPXObjEntryRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSAPXObjEntryRec {

  _t_DSAPXObjEntryRec next;  


 


  CosObj xobj;  


 


  ASFixedRect rect;  


 


  ASText text;  


 


  ASFixed textSize;  


 


  DSQuadding xjustify;  


 


  DSQuadding yjustify;  


 


  ASFixed scale;  


 


  ASBool bMerge;  


 


  ASBool bDestroy;  

}

Structure used in DigSigAPXObjectFromXObjList().

See Also

DigSigAPXObjectFromXObjList

File: DigSigHFT.h

Line: 1854

Elements

	next	The next list entry.

	xobj	If not `NULL`, use this XObject as the entry.

	rect	The rectangle relative to `bbox` in which to render the object.

	text	If not empty, render this string (it can contain new lines).

	textSize	Font size, `0` for auto.

	xjustify	Justification of the XObject (not all options supported).

	yjustify	Justification of the XObject (not all options supported).

	scale	Scale the XObject within `rect`.

	bMerge	If the XObject is Subtype XObject, then the XObject is merged up.

	bDestroy	If `true` and `bMerge` is `true` and the XObject exists, then destroy the XObject.

_t_DSComparePagesParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSComparePagesParamsRec {

  ASSize_t size;  


 


  ASInt32 sensitivityLevel;  

}

Parameters for page comparison.

See Also

DigSigComparePagesEx

File: DigSigHFT.h

Line: 2013

Elements

size

The size of the data structure. It must be set to sizeof(DSComparePagesParamsRec).

sensitivityLevel

The sensitivity level for the comparison. The DPI determines the resolution at which each page is rendered before comparing on a pixel-by-pixel basis. The values are:

Value	Description
`0`	72 DPI.
`1`	36 DPI.
`2`	18 DPI.

_t_DSCompareWordsParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSCompareWordsParamsRec {

  ASSize_t size;  


 


  ASBool useFont;  

}

Parameters for page comparison.

See Also

DigSigCompareWordsEx

File: DigSigHFT.h

Line: 2036

Elements

	size	The size of the data structure. It must be set to `sizeof(DSCompareWordsParamsRec)`.

	useFont	If `true`, the font name, size, and color of each character in a word are considered when matching against other words. If `false`, these attributes are ignored.

_t_DSNtfyParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSNtfyParamsRec {

  ASSize_t size;  


 


  DSNotificationType notificationID;  


 


  PDDoc pdDoc;  


 


  CosDoc cosDoc;  


 


  CosObj sigField;  


 


  CosObj sigDict;  

}

A structure passed to the callback when a digital signature event occurs for which an interest has been registered. The structure contains information about the event.

These are the arguments in DSNtfyParams_t which are applicable:

Value	Description
`DSSigAdded`
`DSSigDeleted`	`size, notificationID, pdDoc, cosDoc, sigField`
`DSWillSign`	`size, notificationID, pdDoc, cosDoc, sigField`
`DSDidSign`	`size, notificationID, pdDoc, cosDoc, sigField, sigDict`
`DSFailSign`	`size, notificationID, pdDoc, cosDoc, sigField`
`DSWillVerify`	`size, notificationID, pdDoc, cosDoc, sigField`
`DSDidVerify`	`size, notificationID, pdDoc, cosDoc, sigField, sigDict`
`DSFailVerify`	`size, notificationID, pdDoc, cosDoc, sigField`
`DSWillClear`	`size, notificationID, pdDoc, cosDoc, sigField, sigDict`
`DSDidClear`	`size, notificationID, pdDoc, cosDoc, sigField`
`DSFailClear`	`size, notificationID, pdDoc, cosDoc, sigField`

File: DigSigHFT.h

Line: 1940

Elements

	size	The size of the data structure. It must be set to `sizeof(DSNotifyParamsRec)`.

	notificationID	The event that occurred.

	pdDoc	The PDF document for which the event occurred.

	cosDoc	The Cos document containing the object for which the event occurred.

	sigField	The signature field for which the event occurred.

	sigDict	The signature dictionary (used only for the events `DSDidSign` and `DSDidClear`).

_t_DSSigRefDictErrParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSSigRefDictErrParamsRec {

  ASSize_t size;  


 


  DSSigRefErrCode errCode;  


 


  ASText errText;  

}

A structure that contains information about exceptions that occurred in signature reference dictionary procedures.

File: DigSigHFT.h

Line: 1765

Elements

	size	The The size of this `struct`.

	errCode	The exception code.

	errText	The text associated with the error code. If `errCode` is `kDSSigRefErrMissingPlugin`, the text is the name of a software module. It must point to an initialized `ASText` object.

_t_DSSigRefDictParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DSSigRefDictParamsRec {

  ASSize_t size;  


 


  CosDoc cosDoc;  


 


  CosObj rootObj;  


 


  CosObj sigDict;  


 


  ASAtom transformMethod;  


 


  CosObj transformParams;  


 


  ASBool bIndirect;  

}

Parameters used by methods that create a signature reference dictionary. See Section 8.7, Digital Signatures, in the PDF Reference, for more information on signature reference dictionaries.

File: DigSigHFT.h

Line: 1781

Elements

	size	The size of the data structure. It must be set to `sizeof(DSSigRefDictParamsRec)`.

	cosDoc	The document containing the object to be signed.

	rootObj	The root object to be signed.

	sigDict	The signature dictionary that this reference dictionary will be part of.

	transformMethod	The transform method name. Its possible values are: `DocMDP` `FieldMDP` `UR` `Identity`

	transformParams	The transform parameters, which are specific to each transform method.

	bIndirect	`true` if the dictionary should be indirect, `false` if it should be direct.

Callbacks Detail

DigSigEnumProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DigSigEnumProc)(PDDoc pdDoc, CosObj sigField, void *clientData)

A user-supplied callback that is passed in the call to DigSigEnumSignatures(). DigSig calls this once for each existing signature.

See Also

DigSigEnumSignatures

File: DigSigHFT.h

Line: 1744

DSCanValidateProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSCanValidateProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASAtom filter)

This function is called to query the handler to find out if it can validate this PDDoc signature field. The call determines if the general signature format is supported by the handler, or if the handler should be given the opportunity to validate this signature.

If the response is false, the handler cannot be called to validate the signature. In this event, the handler will not be able to provide other information (for example, that an updated version of the handler should be obtained in order to validate the signature).

See Also

DigSigVerifySig

File: DigSigHFT.h

Line: 1233

DSClearSigProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSClearSigProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASBool bSilent)

File: DigSigHFT.h

Line: 1490

DSCommitSign64Proc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSCommitSign64Proc)(PDDoc pdDoc, void *sigData, CosObj sigField, CosObj sigAnnot, DigSigOffset64 *offsetArray, ASInt32 *arrayCount)

File: DigSigHFT.h

Line: 1363

DSCommitSignProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSCommitSignProc)(PDDoc pdDoc, void *sigData, CosObj sigField, CosObj sigAnnot, DigSigOffset *offsetArray, ASInt32 *arrayCount)

A callback for DigSigHandler. It is called to put the signature into the document in memory or to cancel. It modifies the signature dictionary as needed. It may allocate storage for an array of signature objects.

The signature includes a signature dictionary written to the /V attribute of the sigField and an optional appearance written to the /AP dictionary of the sigAnnot.

See Section 8.7 in the PDF Reference for the format of the signature dictionary. At least two objects in the signature dictionary, ByteRange and Contents, will need to be overwritten during the DSFinishSignProc() callback.

See Also

DSFinishSignProc
DSNewSigDataProc

File: DigSigHFT.h

Line: 1358

DSCosDocSigSignProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*DSCosDocSigSignProc)(DigSigCosDocSigParams sigParams)

Signs a CosDoc (for example, when signing FDF). It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 6.0.

File: DigSigHFT.h

Line: 1513

DSCosDocSigValidateProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*DSCosDocSigValidateProc)(DigSigCosDocSigParams sigParams, ASCab sigInfoCab)

Validates a CosDoc signature. It returns a valid state in sigInfoCab.

It should populate the following entries in this cab: It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 6.0.

PROP_SigInfo_Status
PROP_SigInfo_StatusText
PROP_SigInfo_HandlerName

File: DigSigHFT.h

Line: 1525

DSDataBufferSigSignFinishProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*DSDataBufferSigSignFinishProc)(void *dataSigContext, DigSigDataParams sigParams)

Finish the signing of a data buffer (for example, when signing XML data). It must be called to destroy the context, whenever signNew returns a context. It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 7.0.

File: DigSigHFT.h

Line: 1540

DSDataBufferSigSignNewProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*DSDataBufferSigSignNewProc)(DigSigDataBufferSigNewParams sigParams, void **pOutDataSigContext)

Initiate the signing of a data buffer (for example, when signing XML data). It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 7.0.

File: DigSigHFT.h

Line: 1532

DSDataBufferSigValidateProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*DSDataBufferSigValidateProc)(DigSigDataBufferSigValidateParams sigParams, ASCab sigInfoCab)

Validate a data buffer signature. It returns a valid state in sigInfoCab. It should populate the following entries in this cab: It is for Adobe use only. This call is subject to change in future releases. It was introduced in Acrobat 7.0.

PROP_SigInfo_Status
PROP_SigInfo_StatusText
PROP_SigInfo_HandlerName

File: DigSigHFT.h

Line: 1553

DSDefaultValueProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSDefaultValueProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot)

A callback for DigSigHandler. It is called when a new signature field is created. This method creates the default signature value dictionary and creates a default value (DV) entry in the signature field dictionary pointing to this dictionary.

See Also

DSDocOpenProc

File: DigSigHFT.h

Line: 1268

DSDocCloseProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSDocCloseProc)(PDDoc pdDoc)

A callback for DigSigHandler. It is called when a new document is closed.

See Also

DSDocOpenProc

File: DigSigHFT.h

Line: 1112

DSDocOpenProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSDocOpenProc)(PDDoc pdDoc)

A callback for DigSigHandler. It is called when a new document is opened.

See Also

DSDocCloseProc

File: DigSigHFT.h

Line: 1106

DSFinishSign64Proc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSFinishSign64Proc)(PDDoc pdDoc, void *sigData, CosObj sigField, CosObj sigAnnot, DigSigOffset64 offsetArray, ASInt32 arrayCount)

File: DigSigHFT.h

Line: 1393

DSFinishSignProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSFinishSignProc)(PDDoc pdDoc, void *sigData, CosObj sigField, CosObj sigAnnot, DigSigOffset offsetArray, ASInt32 arrayCount)

A callback for DigSigHandler. It is called to calculate the checksum and update the disk copy of document. It may use information from the offsetArray parameter.

File: DigSigHFT.h

Line: 1388

DSFreeSigDataProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSFreeSigDataProc)(void *sigData)

A callback for DigSigHandler. It frees signature data.

File: DigSigHFT.h

Line: 1420

DSGetBoolPropertyProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSGetBoolPropertyProc)(ASAtom filter, DSHandlerProperty property)

Gets the boolean value of a DigSig handler property. It returns true for those properties that represent functionality your handler supports, false if it does not support the functionality. (Some properties are available directly from the DigSigHandler.)

File: DigSigHFT.h

Line: 1567

DSGetSigInfoProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSGetSigInfoProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASAtom handlerName, ESObject sigInfo)

Internal use. Add your engine-specific properties to the existing sigInfo ESObject. Any private data should be added to the ASCab that is set as private data in ESOBJ_SigInfo ASCab (see above). This should have been written to pass an ASCab instead of ESObject, but we missed this. handlerName is the name of the handler that is being asked to return the data (not necessarly the same as the value of the /Filter attribute in the sigDict). It is for Adobe use only, and subject to change. It can only be used by EScript-aware DigSig handlers (for example, PubSec).

File: DigSigHFT.h

Line: 1134

DSGetSigPropProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASCab (*DSGetSigPropProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASAtom handlerName)

Called to obtain an ASCab containing values that the handler wants DigSig to use in the user interface. This is called only after the handler is called to validate the signature.

File: DigSigHFT.h

Line: 1507

DSGetSigSeedValueProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSGetSigSeedValueProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ESObject seedValue, ASText *jsErrText)

Internal use. Add your engine-specific properties to the existing seedValue ESObject. Any private data should be added to ESOBJ_SigSeedValue ASCab (see above). It is for Adobe use only, and subject to change. It can only be used by EScript-aware DigSig handlers (for example, PubSec). *jsErrText will be NULL. The handler should set *jsErrText to a new ASText object, which will then be destroyed by DigSig.

File: DigSigHFT.h

Line: 1144

DSGetStatusTextProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASText (*DSGetStatusTextProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASBool bSilent)

Returns a string describing the status of the signature. It must be PDDocEncoding or Unicode, where Unicode strings must start with 0xFE, 0xFF.

File: DigSigHFT.h

Line: 1249

DSGetValidStateProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSValidState (*DSGetValidStateProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot)

A callback for DigSigHandler. It is called by the signature panel display to choose which of the double-checked pass, fail, unknown, or blank icons to show. It may call DigSigUpdatePanel() to update the signature panel.

See Also

DigSigUpdatePanel

File: DigSigHFT.h

Line: 1207

DSIsSignerProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*DSIsSignerProc)(ASAtom handlerName, PDDoc pdd, CosObj sigField)

Returns whether the current application user has the credential that was used to create the signature that was passed in.

File: DigSigHFT.h

Line: 1585

DSNewSigDataExProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSSaveType (*DSNewSigDataExProc)(PDDoc pdDoc, DigSigBBox bb, void **sigData, CosObj sigField, CosObj sigAnnot, ASAtom filter, ESObject sigEngine, ESObject sigInfo)

Use DSNewSigDataWithParamsProc() instead of this call. Support for this call will continue for at least the short term.

File: DigSigHFT.h

Line: 1299

DSNewSigDataProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSNewSigDataProc)(PDDoc pdDoc, DigSigBBox bb, void **sigData, CosObj sigField, CosObj sigAnnot)

A callback for DigSigHandler. It is called to gather signature data or to cancel. It may display dialogs. It may use the default value (DV) field of the signature field if it is not CosNull.

To allow for a user to cancel signing, the handler should not modify the document during this callback. The handler will commit the signature to the PDF file during DSClearSigProc().

File: DigSigHFT.h

Line: 1293

DSNewSigDataWithParamsProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSSaveType (*DSNewSigDataWithParamsProc)(DigSigNewSigDataParams sigParams, void **sigData)

A callback for DigSigHandler. It creates new signature data to be used by Commit and Finish, and is then destroyed by DSFreeSigDataProc().

If a dialog box is not used (bUI is false), exception strings are stored in the signature data and can be retrieved with DSSigDataGetErrorTextProc().

File: DigSigHFT.h

Line: 1323

DSNewSigEngineProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ESObject (*DSNewSigEngineProc)(void *context, ASAtom handlerName, ASBool uiEngine, void *vData)

This call was used only in Acrobat 5.x when the EScript security object was implemented in DigSig. It returns the existing user interface engine object (ESObject) if uiEngine is true, otherwise it returns a new signature engine object (ESObject). handlerName is the name of the handler that is being asked to return the new engine. vData is reserved for future use and is currently not used. This call is no longer used.

File: DigSigHFT.h

Line: 1122

DSNotificationFailureProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSNotificationFailureProc)(ASInt32 error, void *info, void *clientData)

A callback for the Notification Server. It is called when a digital signature event occurs for which you have registered an interest.

This procedure is called for these events:

The failure of a request for a new signature.
The failure of a request for an existing signatureto be cleared.

For field change, request, and success events, the server calls the DSNotificationProc().

File: DigSigHFT.h

Line: 2008

DSNotificationProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSNotificationProc)(void *info, void *clientData)

A callback for the Notification Server. It is called when a digital signature event occurs for which you have registered an interest.

This procedure is called for these events:

Adding or deleting a signature field.
Requesting a new signature, and the success of the request.
Requesting that an existing signature be cleared, and the success of the request.

For failure events, the server calls the DSNotificationFailureProc().

File: DigSigHFT.h

Line: 1983

DSNotifySigProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSNotifySigProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, DSNotifySigType notifyType, ASBool bUI)

Sends a notification for this signature. The only current notification is kDSNotifySetUnknown, which will cause handlers to mark the validity for this signature as unknown. This is done if the document is dirtied or changed in a manner that would cause the current validity status to no longer be valid. This is not the same as the DSUnValidateProc(). The handler should update its cached validity values to the signature unknown state.

File: DigSigHFT.h

Line: 1481

DSPropertiesExProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSPropertiesExProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASAtom handlerName, ESObject sigEngine, DSPropertyType propType)

A callback for DigSigHandler. It is called when a user selects a signature and asks for its properties. It brings up the properties dialog box for the signature.

See Also

DigSigUpdatePanel

File: DigSigHFT.h

Line: 1440

DSPropertiesProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSPropertiesProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot)

A callback for DigSigHandler. It is called when a user selects a signature and asks for its properties. The handler should present its own dialog box that provides details concerning the signature and its validation state.

See Also

DigSigUpdatePanel

File: DigSigHFT.h

Line: 1454

DSSetSigSeedValueProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*DSSetSigSeedValueProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ESObject seedValue, ASText *jsErrText)

Internal use. Add your engine-specific properties to the existing seedValue ESObject. Any private data should be added to ESOBJ_SigSeedValue ASCab (see above). It is for Adobe use only, and subject to change. It can only be used by EScript-aware DigSig handlers (for example, PubSec). *jsErrText will be NULL. The handler should set *jsErrText to a new ASText object, which will then be destroyed by DigSig.

File: DigSigHFT.h

Line: 1154

DSSigDataGetErrorTextProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASText (*DSSigDataGetErrorTextProc)(void *sigData)

Returns an error string to describe failure during new, commit, or free steps. If it is not NULL, then a JavaScript general exception is thrown using this string.

The handler can set this procedure to NULL if desired.

The string is owned by sigData, so it should be freed by DSFreeSigDataProc().

File: DigSigHFT.h

Line: 1411

DSUnValidateSigProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DSUnValidateSigProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot)

A callback for DigSigHandler. It is called to change the appearance key (AP) back to the appearance that is used for the unvalidated state.

File: DigSigHFT.h

Line: 1472

DSValidateSigExProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSValidState (*DSValidateSigExProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot, ASAtom handlerName, ESObject sigEngine, ASBool bUI)

Internal use. Validates a signature (performs an action). If sigEngine is not NULL then use this engine, otherwise use the user interface engine. handlerName is the name of the handler that is being asked to validate the signature (not necessarily the same as the value of the /Filter attribute in the sigDict). If bUI is true, show an alert after validating. Note that this alert may be suppressed depending on preference settings. It is for Adobe use only, and subject to change. Itan only be used by EScript aware DigSig handlers (for example, PubSec).

File: DigSigHFT.h

Line: 1166

DSValidateSigProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSValidState (*DSValidateSigProc)(PDDoc pdDoc, CosObj sigField, CosObj sigAnnot)

A callback for DigSigHandler. It is called to validate a signature. It recalculates any document digest desired, possibly using the DigSigFileGetEOF(), DigSigMD5ByteRange(), DigSigFileRead(), and DigSigFileSetPos() methods.

It may compare this result to the stored one, and do any other signature-specific checks desired. It optionally does a validation against a stored (network) registry. If necessary, it updates the AP dictionary in the signature annotation dictionary to show the validation state of the signature.

File: DigSigHFT.h

Line: 1191

VerifyRefCallbackProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (VerifyRefCallbackProc)(void *callbackData)

Callback function used to verify all references used by the data signature. It is only called if the core signature is valid.

File: DigSigHFT.h

Line: 1025

Method Detail

DigSigAddedSig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigAddedSig(PDDoc pdDoc)

Recalculates the number of signature fields and redraws the signature panel after any signature is added.

It is called by the AcroForm plug-in or any agent that adds a signature field.

Parameters

pdDoc —

The document that contains the signature field.

See Also

DigSigAddedSigEx
DigSigDeletedSig

File: DigSigHFTProcs.h

Line: 405

DigSigAddedSigEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigAddedSigEx(PDDoc pdDoc, CosObj cosField)

Recalculates the number of signature fields and redraws the signature panel after a specified signature field is added.

This version, added in Acrobat 6.0, is more efficient than DigSigAddedSig(), but requires that you specify the signature field that is being added.

Parameters

	`pdDoc` —	The document that contains the signature field.

	`cosField` —	The signature field that was added.

See Also

DigSigAddedSig
DigSigDeletedSigEx

File: DigSigHFTProcs.h

Line: 651

DigSigAPCreateCompositeTextXObj

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigAPCreateCompositeTextXObj(const CosDoc cosDoc, const DSAPTextEntry inText, const ASFixedRect*const  bbox, const CosObj sigField, const CosObj sigAnnot)

Create a new XObject that consists of vertically stacked blocks of text, where each block is auto-sized to fit its own bounding box.

Parameters

	`cosDoc`

	`inText`

	`bbox`

	`sigField`

	`sigAnnot`

Returns

File: DigSigHFTProcs.h

Line: 613

DigSigAPCreateLayeredStream

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigAPCreateLayeredStream(const CosDoc cosDoc, const CosObj layer1XObject, ASFixedMatrixP layer1Matrix, const CosObj layer2XObject, ASFixedMatrixP layer2Matrix, const CosObj layer3XObject, ASFixedMatrixP layer3Matrix, const CosObj layerNXObject, ASFixedMatrixP layerNMatrix, ASInt16 layerNNum, AFPDWidgetBorder border, PDColorValue cBorder, PDColorValue cBackGnd, ASFixed width, ASFixed height, PDRotate pdr)

Creates a stream that is composed of either four or five layers:

Layer	Description
`n0`	Background, inherited from the form annotation background.
`n1`	Middle, question mark or equivalent (uses the default if the layer `1` XObject is CosNull).
`n2`	Main, text and appearance (must be provided).
`n3`	Top, blank or X (uses the default if `layer1XObject` is CosNull).
`nN`	(Optional) Very top layer, used for text showing the validity state (none if CosNull).

Parameters

	`cosDoc`

	`layer1XObject`

	`layer1Matrix`

	`layer2XObject`

	`layer2Matrix`

	`layer3XObject`

	`layer3Matrix`

	`layerNXObject`

	`layerNMatrix`

	`layerNNum`

	`border`

	`cBorder`

	`cBackGnd`

	`width`

	`height`

	`pdr`

Returns

File: DigSigHFTProcs.h

Line: 572

DigSigAPCreateLayeredStreamEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigAPCreateLayeredStreamEx(const DSAPCreateLayeredStreamExParams params)

Creates a signature-appearance layered stream, using a parameters structure.

Parameters

params —

The parameter structure containing the signature appearance layer information.

Returns

A new CosStream composed of different layers.

File: DigSigHFTProcs.h

Line: 813

DigSigAPFileAcquire

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigAPFileAcquire(const ASBool bResolveProblems, const ASBool bCreate)

Acquires the DSAP file and opens it, if it has not already been acquired.

PubSec calls this method to access a file, so a handler does not need to acquire a DSAP file unless it needs to access it for other reasons.

Parameters

	`bResolveProblems` —	When it is `true`, if there are problems trying to open the file, PubSec opens a user interface that gives a user the option to delete the corrupted file.

	`bCreate` —	When it is `true`, if the file does not exist it is created. It is normally `true`.

Returns

true if the file was acquired and opened, false otherwise.

See Also

DSAPFileRelease

File: PubSecHFTProcs.h

Line: 224

DigSigAPFileCanDeleteNthEntry

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigAPFileCanDeleteNthEntry(const ASInt32 index)

Tests whether a signature appearance entry at a specified index in the DSAP file can be edited or is read-only.

Parameters

index —

The position of the entry to test. The first entry is at index 0. A negative value gets the default entry.

Returns

true if the entry is editable, false otherwise.

See Also

DSAPFileGetCount
DSAPFileRemoveNthEntry

File: PubSecHFTProcs.h

Line: 258

DigSigAPFileCopyNthEntry

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigAPFileCopyNthEntry(const ASInt32 index)

Creates a copy of the specified entry in the default DSAP file and appends the copy to the end of the list of signature appearances in the file.

When you copy a default appearance entry, the copy is not considered a default appearance entry.

Parameters

index —

The position of the entry to copy. The first entry is at index 0. A negative value gets the default entry.

Returns

true if the copy was successful and the appearance file was successfully edited and saved, false otherwise.

See Also

DSAPFileCanDeleteNthEntry
DSAPFileEditNthEntry

File: PubSecHFTProcs.h

Line: 318

DigSigAPFileEditNthEntry

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigAPFileEditNthEntry(const APPreview previewData, const ASInt32 index)

Opens the user interface that allows the user to edit the specified signature appearance entry of the DSAP file.

Parameters

	`previewData` —	Data with which to create a signature preview in the edit dialog.

	`index` —	The position of the entry to edit. The first entry is at index `0`. A negative value gets the default entry. An index larger than the current number of entries creates a new entry.

Returns

true if successful (the changes to the entry were made and saved), false otherwise.

See Also

DSAPFileCanDeleteNthEntry
DSAPFileCopyNthEntry

File: PubSecHFTProcs.h

Line: 302

DigSigAPFileGetCount

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigAPFileGetCount()

Gets the number of configured signature appearance entries in the DSAP file,

Returns

The number of configured AP entries.

See Also

DSAPFileCanDeleteNthEntry

File: PubSecHFTProcs.h

Line: 247

DigSigAPFileGetNewNthName

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASText DigSigAPFileGetNewNthName(const ASInt32 index)

Gets a copy of the name of the specified signature appearance entry in the DSAP file. Use this when building a list of signatures for a user to choose from or edit.

Parameters

index —

The position of the entry whose name to obtain. The first entry is at index 0. A negative value gets the default entry.

Returns

A copy of the name as an ASText object.

See Also

DSAPFileGetCount Closes the digital signature appearance (DSAP) file.
DSAPFileAcquire
DSAPFileSave

File: PubSecHFTProcs.h

Line: 273

DigSigAPFileRelease

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigAPFileRelease()

Closes the digital signature appearance (DSAP) file.

See Also

DSAPFileAcquire
DSAPFileSave

File: PubSecHFTProcs.h

Line: 232

DigSigAPFileRemoveNthEntry

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigAPFileRemoveNthEntry(const ASInt32 index)

Deletes the specified signature appearance entry from the DSAP file.

Parameters

index —

The position of the entry to remove. The first entry is at index 0. A negative value gets the default entry.

Returns

true if successful, false otherwise.

See Also

DSAPFileCanDeleteNthEntry
DSAPFileGetCount

File: PubSecHFTProcs.h

Line: 285

DigSigAPFileSave

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigAPFileSave()

Saves the DSAP file if it is dirty, leaving it open.

See Also

DSAPFileRelease

File: PubSecHFTProcs.h

Line: 239

DigSigAPXObjectFromLogo

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigAPXObjectFromLogo(const CosDoc cosDoc, const char* logoStr, const ASInt32 logoStrSize, const ASFixedRect*const  logoBBox, const ASFixedRect*const  bbox)

Takes text for a stream logoStr with bounding box logoBBox and fits it precisely to bbox. It performs uniform x and y scaling, and x-y translation. It can raise an exception. This method might throw an exception, and should be wrapped in a DURING/HANDLER block.

Parameters

	`cosDoc` —	The document.

	`logoStr` —	The stream containing the text.

	`logoStrSize` —	The length of the logo string, or `0` to calculate the length automatically.

	`logoBBox` —	The bounding box for `logoStr`.

	`bbox` —	The bounding rectangle of the result.

Returns

A Cos object XObject that contains the logo.

File: DigSigHFTProcs.h

Line: 604

DigSigAPXObjectFromXObjList

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigAPXObjectFromXObjList(CosDoc cosDoc, const ASFixedRect*const  bbox, DSAPXObjEntry objEntry, TextAppearanceP ta, size_t taSize, AFPDWidgetBorder border, ASUns32 flags)

Creates a new XObject from the list of DSAPXObjEntry objects. Each object in the list is either an existing stream or a string that will be laid out and reflowed into a new stream. The streams are then turned into XObjects. Controls allow you to adjust the vertical position of each stream within bbox. If bMerge is true, this method combines the new XObjects into one large XObject, and the sub XObjects are destroyed. Otherwise the method leaves the component XObjects intact and new XObjects are created but not destroyed for the text entries. Text streams use the text attributes of ta.

Parameters

	`cosDoc` —	The document in which to include the standard XObject.

	`bbox` —	The bounding box for the signature.

	`objEntry` —	A list of DSAPXObjEntry objects.

	`ta` —	The text appearance. For an explanation of the TextAppearanceP type, see "AcroForm Declarations" in the Acrobat and PDF Language API Reference.

	`taSize` —	The border style for the signature, as returned by AFPDWidgetGetBorder(). For an explanation of the AFPDWidgetBorder type, see "AcroForm Declarations" in the Acrobat and PDF Language API Reference.

	`border` —	When `false`, keep the sub XObjects. When `true`, combine them all into one large one.

	`flags`

Returns

An XObject composed from the list.

File: DigSigHFTProcs.h

Line: 988

DigSigAPXObjectFromXObjListObsolete

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigAPXObjectFromXObjListObsolete(CosDoc cosDoc, const ASFixedRect*const  bbox, DSAPXObjEntry objEntry, TextAppearanceP ta, AFPDWidgetBorder border, ASBool bMerge)

Legacy procedure for backwards compatibility.

Parameters

	`cosDoc`

	`bbox`

	`objEntry`

	`ta`

	`border`

	`bMerge`

Returns

File: DigSigHFTProcs.h

Line: 585

DigSigByteToHex

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigByteToHex(unsigned char* byteP, unsigned char* hexP, ASInt32 length)

Converts a byte string to a PDF hex string.

Parameters

	`byteP` —	A pointer to the byte string.

	`hexP` —	(Filled by the method) A pointer to an output buffer to hold the hex string. It must be at least `(length * 2) + 3` bytes. The string begins with `"\<"` and ends with `"\>"`, followed by a `NULL` character. For example, the two byte string `"A/"` is converted to `"\<412f\>\\0"`.

	`length` —	The length of the byte string in bytes.

See Also

DigSigHexToByte

File: DigSigHFTProcs.h

Line: 218

DigSigClearSig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigClearSig(PDDoc pdDoc, CosObj sigField)

Clears a signature field in a document. This removes the signature so that the document is unsigned.

Parameters

	`pdDoc` —	The document.

	`sigField` —	The signature field to clear.

See Also

DigSigVerifySig

File: DigSigHFTProcs.h

Line: 940

DigSigClearSigRefDict

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSRetCode DigSigClearSigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj refDict)

Clears the signature reference dictionary referred to by refDict and removes any reference to it from the document.

Parameters

	`transformMethod` —	The transform method. It should match the one contained in `sigDict`.

	`sigDict` —	The signature dictionary containing the signature reference dictionary.

	`refDict` —	The signature reference dictionary.

Returns

A positive value on success.

File: DigSigHFTProcs.h

Line: 780

DigSigClick

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigClick(PDAnnot pdAnnot, AVPageView avPV, ASInt16 nX, ASInt16 nY, ASInt16 nFlags, ASInt16 nClicks)

The AcroForm plug-in calls this method when a user left-clicks inside a signature annotation.

Parameters

	`pdAnnot` —	The annotation the user clicked on.

	`avPV` —	The page view that contains the annotation.

	`nX` —	The x-coordinate of the mouse click, specified in device space coordinates.

	`nY` —	The y-coordinate of the mouse click, specified in device space coordinates.

	`nFlags` —	Indicates which modifier keys are pressed, if any. It must be an OR of the Modifier Keys values, which are the following: AV_COMMAND AV_OPTION AV_CONTROL AV_SHIFT

	`nClicks` —	The number of clicks.

File: DigSigHFTProcs.h

Line: 336

DigSigCommitSigRefDict

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSRetCode DigSigCommitSigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj* pOutRefDict)

Adds a signature reference dictionary to the document and saves the document.

This method uses the information that was provided in the DSSigRefDictErrParams parameter block during the call to DigSigNewSigRefDict.transformMethod(), and sigDict should match the values provided at that time.

After this operation, some of the values in the reference dictionary are still dummy values, including DigestValue and DigestLocation (see Section 8.7, Digital Signatures in the PDF Reference for more information). DigSigFinishSigRefDict() should be called next to fill in these values.

If signing is cancelled after this operation, DigSigClearSigRefDict() should be called to remove all references to the reference dictionary from the document.

Parameters

	`transformMethod` —	The transform method.

	`sigDict` —	The signature dictionary that contains the signature reference dictionary.

	`pOutRefDict` —	(Filled by the method) A pointer to the committed signature reference dictionary.

Returns

kDSTrue on success, kDSFalse on parameter error, kDSException for all other errors.

File: DigSigHFTProcs.h

Line: 713

DigSigComparePages

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigComparePages(PDDoc docA, PDDoc docB, ASBool insertDiffs)

Compares the pages of two documents, producing a third document of the differences.

Parameters

	`docA` —	The first document to compare.

	`docB` —	The second document to compare.

	`insertDiffs` —	Not used.

Returns

true if the pages of the documents are identical, false otherwise.

See Also

DigSigCompareWords

File: DigSigHFTProcs.h

Line: 421

DigSigComparePagesEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigComparePagesEx(PDDoc docA, PDDoc docB, DSComparePagesParams params)

Compares the pages of two documents, producing a third document of the differences.

Parameters

	`docA` —	The first document being compared.

	`docB` —	The second document being compared.

	`params` —	A structure containing the sensitivity level for the comparison.

Returns

true if the pages of the documents are identical, false otherwise.

See Also

DigSigComparePages
DigSigCompareWords

File: DigSigHFTProcs.h

Line: 899

DigSigCompareWords

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigCompareWords(PDDoc docA, PDDoc docB, ASBool iUseFonts)

Compares the words of two documents, producing a third document of the differences.

Parameters

	`docA` —	The first document being compared.

	`docB` —	The second document being compared.

	`iUseFonts` —	If `true`, the font name, size, and color of each character in a word are considered when matching against other words. If `false`, these attributes are ignored.

Returns

true if the words of the documents are identical, false otherwise.

File: DigSigHFTProcs.h

Line: 443

DigSigCompareWordsAndFontsRecent

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigCompareWordsAndFontsRecent(PDDoc docA, PDDoc docB, ASBool iUseFonts)

Compares the words of two documents, taking into account possible font changes, and produces a third document of the differences.

Parameters

	`docA` —	The first document being compared.

	`docB` —	The second document being compared.

	`iUseFonts` —	If `true`, the font name, size, and color of each character in a word are considered when matching against other words. If `false`, these attributes are ignored.

File: DigSigHFTProcs.h

Line: 495

DigSigCompareWordsEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigCompareWordsEx(PDDoc docA, PDDoc docB, DSCompareWordsParams params)

Compares the words of two documents, producing a third document of the differences.

Parameters

	`docA` —	The first document being compared.

	`docB` —	The second document being compared.

	`params` —	A structure containing the comparison parameters.

Returns

true if the words of the documents are identical, false otherwise.

File: DigSigHFTProcs.h

Line: 918

DigSigCompareWordsRecent

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigCompareWordsRecent(PDDoc docA, PDDoc docB, ASBool iUseFonts)

Compares the words of two documents, producing a third document of the differences.

Parameters

	`docA` —	The first document being compared.

	`docB` —	The second document being compared.

	`iUseFonts` —	If `true`, the font name, size, and color of each character in a word are considered when matching against other words. If `false`, these attributes are ignored.

File: DigSigHFTProcs.h

Line: 464

DigSigCreateStdXObj

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigCreateStdXObj(const CosDoc cosDoc, const ASFixedRect*const  pBBoxRec, DSXObjType dsXObjType)

Returns a new XObject with the specified bounding box. Unlike the XObject returned by DigSigGetStdXObj(), DigSig does not attach the XObject returned by this function to the CosDoc.

Parameters

	`cosDoc` —	The document containing the new object.

	`pBBoxRec` —	A pointer to the desired bounding box.

	`dsXObjType` —	The type of object to create.

Returns

A CosObj containing the new XObject form, or CosNewNull if unsuccessful.

See Also

DigSigGetStdXObj

File: DigSigHFTProcs.h

Line: 548

DigSigDeletedSig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigDeletedSig(PDDoc pdDoc)

Recalculates the number of signature fields and redraws the signature panel after any signature is deleted.

It is called by the AcroForm plug-in or any agent that deletes a signature field.

Parameters

pdDoc —

The document that contains a signature field.

See Also

DigSigAddedSig
DigSigDeletedSigEx

File: DigSigHFTProcs.h

Line: 391

DigSigDeletedSigEx

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigDeletedSigEx(PDDoc pdDoc, CosObj cosField)

Recalculates the number of signature fields and redraws the signature panel after a specified signature is deleted.

This version, added in Acrobat 6.0, is more efficient than DigSigDeletedSig(), but requires that you specify the signature field that is being deleted.

Parameters

	`pdDoc` —	The document that contained the signature field.

	`cosField` —	The signature field that was deleted.

See Also

DigSigAddedSigEx
DigSigDeletedSig

File: DigSigHFTProcs.h

Line: 634

DigSigDocModifiedAfterSig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigDocModifiedAfterSig(PDDoc doc, CosObj sigField)

Tests whether a document has been modified since being signed with the specified signature.

Parameters

	`doc` —	The document containing the signature field.

	`sigField` —	The signature field.

Returns

ASBool true if the document has been modified, false otherwise.

File: DigSigHFTProcs.h

Line: 533

DigSigDoProperties

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigDoProperties(AVDoc avDoc, CosObj sigField)

Opens the DigSig's property dialog box.

Parameters

	`avDoc` —	The document that contained the signature field.

	`sigField` —	The signature field of the document.

File: DigSigHFTProcs.h

Line: 473

DigSigDraw

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigDraw(PDAnnot pdAnnot, AVPageView avPV, ASBool bIsSelected)

Causes the signature to be redrawn.

Parameters

	`pdAnnot` —	IN/OUT The annotation the user clicked on or tabbed into.

	`avPV` —	IN/OUT The page view that contains the annotation.

	`bIsSelected` —	IN/OUT `true` if the annotation is selected, `false` otherwise.

See Also

DigSigHexToByte
DigSigRightClick

File: DigSigHFTProcs.h

Line: 283

DigSigEnumSignatures

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigEnumSignatures(PDDoc pdDoc, DigSigEnumProc proc, void* clientData)

Enumerates the signature fields (signed and unsigned) in the file.

Parameters

	`pdDoc` —	The document that contains the signature field.

	`proc` —	The procedure to call once for each existing signature.

	`clientData` —	A pointer to user-supplied data to pass to `proc` each time it is called.

See Also

DigSigEnumProc

File: DigSigHFTProcs.h

Line: 523

DigSigFileGetEOF

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigFileGetEOF(ASFile asFile)

Gets the number of bytes in an ASFile. It serves as a wrapper for the ASFileGetEOF() method.

Parameters

asFile —

The ASFile whose length is obtained.

Returns

The number of bytes in the ASFile, or 0 if an error is encountered.

File: DigSigHFTProcs.h

Line: 67

DigSigFileGetEOF64

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASFilePos64 DigSigFileGetEOF64(ASFile asFile)

Procs below are provided in version 0x00020000 Gets the number of bytes in an ASFile. It serves as a wrapper for the ASFileGetEOF64() method.

Parameters

asFile —

The ASFile whose length is obtained.

Returns

The number of bytes in the ASFile, or 0 if an error is encountered.

File: DigSigHFTProcs.h

Line: 1007

DigSigFileRead

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigFileRead(ASFile asFile, char* p, ASInt32 count)

Reads from an ASFile. This is a wrapper function for the ASFileRead() method.

Parameters

	`asFile` —	The ASFile to read.

	`p` —	A pointer to a buffer.

	`count` —	The number of bytes to read into the buffer.

Returns

The number of bytes read, or 0 if unsuccessful.

File: DigSigHFTProcs.h

Line: 97

DigSigFileSetPos

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigFileSetPos(ASFile asFile, ASInt32 pos)

Reopens an ASFile for reading and sets the file position.

Parameters

	`asFile` —	The ASFile to position.

	`pos` —	The byte offset to a position in `asFile`.

File: DigSigHFTProcs.h

Line: 81

DigSigFileSetPos64

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigFileSetPos64(ASFile asFile, ASFilePos64 pos)

Reopens an ASFile for reading and sets the file position.

Parameters

	`asFile` —	The ASFile to position.

	`pos` —	The byte offset to a position in `asFile`.

File: DigSigHFTProcs.h

Line: 1021

DigSigFinishSigRefDict

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSRetCode DigSigFinishSigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj refDict, DSSigRefDictErrParams errParams)

Computes the digest value and stores it in the reference dictionary. It should be called after DigSigCommitSigRefDict().

Parameters

	`transformMethod` —	The transform method used to calculate the digest. It must match what was originally specified in DigSigNewSigRefDict().

	`sigDict` —	The signature dictionary that contains the signature reference dictionary.

	`refDict` —	The reference dictionary returned from the call to DigSigCommitSigRefDict().

	`errParams` —	A structure containing information about an exception.

Returns

kDSTrue on success, kDSFalse on parameter error. kDSException means an exception, and the information about it can be found in errParams.

File: DigSigHFTProcs.h

Line: 737

DigSigGetDocAuthorSignature

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigGetDocAuthorSignature(PDDoc doc)

Gets the author signature for a document, as a Cos object.

Parameters

doc —

The document for which the author signature is obtained.

Returns

The CosObj containing the author signature.

See Also

DigSigGetDocMDPSetting

File: DigSigHFTProcs.h

Line: 884

DigSigGetDocMDPSetting

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSMDPType DigSigGetDocMDPSetting(PDDoc pdDoc)

Gets the Modification Detection and Prevention (MDP) setting for the author signature for the specified document.

Parameters

pdDoc —

The document for which the MDP setting is obtained.

Returns

The MDP setting of the document's author signature, or kDSMDPNone if there is no author signature.

See Also

DigSigGetDocAuthorSignature

File: DigSigHFTProcs.h

Line: 951

DigSigGetStdXObj

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigGetStdXObj(CosDoc cosDoc, DSXObjType dsXObjType)

Gets a Cos XObject for one of the standard signature graphics: blank, question mark, and cross.

It creates an AcroForm dictionary if none exists in the document, makes a Default Resources (DR) dictionary if none exists, creates an XObject dictionary if none exists, and creates three standard XObjects: DSBlankXObj, DSUnknownXObj, and DSInvalidXObj if they do not exist. These objects may be used to modify the appearance of a digital signature. Each object has a bounding box of 100 x 100 points and an identity transformation matrix.

Parameters

	`cosDoc` —	The document in which to include the standard XObject.

	`dsXObjType` —	The type of object to get.

Returns

The CosObj of the desired type, or CosNewNull if unsuccessful.

File: DigSigHFTProcs.h

Line: 273

DigSigGetUbiquitySig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





CosObj DigSigGetUbiquitySig(PDDoc pdDoc)

Gets the LiveCycle Reader Extensions signature for a document, as a Cos object.

Parameters

pdDoc —

The document for which the LiveCycle Reader Extensions signature is obtained.

Returns

The CosObj containing the LiveCycle Reader Extensions signature.

See Also

DigSigGetDocAuthorSignature

File: DigSigHFTProcs.h

Line: 960

DigSigGetUniqueTitle

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





char* DigSigGetUniqueTitle(CosDoc cosDoc)

Gets a character string that is suitable as the field name for a new signature field. This is guaranteed not to duplicate an existing field name. Typically, this name would be of the form XXXXnnn, where XXXX is the word 'signature' in a local Latin-alphabet language, and nnn is a unique integer.

Parameters

cosDoc —

The document that will contain the new field.

Returns

The unique field name string.

File: DigSigHFTProcs.h

Line: 378

DigSigHexToByte

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigHexToByte(unsigned char* hexP, unsigned char* byteP, ASInt32 length)

Converts a PDF hex string to a byte string. For example, the 6 byte string "<412f>" converts to the 2-byte string "(A/)".

The first byte of the hex string is ignored. The last byte of an even length hex string is ignored.

Middle bytes outside the ranges 0-9, a-f, and A-F are treated as 0. Pairs of middle bytes are converted to byte values 0-255 and stored in the output buffer.

Parameters

	`hexP` —	Pointer to the hex string. The string must begin with `'<'` and end with `'>'`, optionally followed by a `NULL` character.

	`byteP` —	(Filled by the method) A pointer to an output buffer to hold the byte string. It must be at least `(length - 2) / 2` bytes long.

	`length` —	The length of the hex string in bytes, not including any trailing `NULL` character (that is, `ASstrnlen_safe(hexP)`).

See Also

DigSigByteToHex

File: DigSigHFTProcs.h

Line: 240

DigSigIsSigSigned

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool DigSigIsSigSigned(PDDoc pdDoc, CosObj sigField)

Tests whether a particular signature field in a document is signed.

Parameters

	`pdDoc` —	The document that contains the signature field.

	`sigField` —	The signature field that is tested.

Returns

true if the signature field is signed, false otherwise.

See Also

DigSigIsDocSigned

File: DigSigHFTProcs.h

Line: 825

DigSigKeyDown

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigKeyDown(PDAnnot pdAnnot, AVPageView avPV, ASUns16 nKey, ASInt16 nFlags)

The AcroForm plug-in calls this method when the user tabs to a signature annotation and activates it by pressing the space bar or Enter key, which is equivalent to a left-mouse click. The parameters parallel those of the AVAnnotHandlerDoKeyDownProc() callback. If the key pressed is an ASCII <CR>, this method selects the annotation.

Parameters

	`pdAnnot` —	The annotation the user clicked on.

	`avPV` —	The current page view.

	`nKey` —	The key pressed by the user.

	`nFlags` —	Indicates which modifier keys are pressed, if any. It must be an OR of the Modifier Keys values, which are the following: AV_COMMAND AV_OPTION AV_CONTROL AV_SHIFT

See Also

DigSigDraw
DigSigClick
DigSigRightClick

File: DigSigHFTProcs.h

Line: 309

DigSigMD5ByteRange

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigMD5ByteRange(ASFile asFile, CosObj byteRange, char* md5hash)

Calculates the MD5 hash function over a set of byte ranges in a file.

Parameters

	`asFile` —	The file over which the hash function is calculated.

	`byteRange` —	An array of pairs of integers specifying the byte offset and length of one or more subsets of the file. The hash function is calculated over all these subsets, concatenated in order.

	`md5hash` —	A pointer to a buffer that receives the 16 byte hash value.

Returns

The MD5 hash function over a set of byte ranges in asFile. It also returns the total number of bytes over which the hash is calculated. It returns 0 if the byte range array has an odd number of elements or if it is unsuccessful.

File: DigSigHFTProcs.h

Line: 193

DigSigNewSigRefDict

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSRetCode DigSigNewSigRefDict(DSSigRefDictParams refParams, DSSigRefDictErrParams errParams)

Begins the process of creating a new signature reference dictionary containing an object digest. The caller fills in the values of the refParams structure.

In this method, no persistent changes are made to the document; therefore, it is safe to cancel the creation of the reference dictionary without any cleanup. To save the file, DigSigCommitSigRefDict() should be called next.

Parameters

	`refParams` —	A structure containing information about the signature reference dictionary; it must be filled in by the caller.

	`errParams` —	(Filled by the method) A structure containing information about exceptions that occurred.

Returns

kDSTrue on success, kDSFalse on parameter errors. kDSException means an exception occurred; information can be found in errParams.

File: DigSigHFTProcs.h

Line: 681

DigSigOverwriteBytes

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigOverwriteBytes(ASFile asFile, const DigSigOffset digSigOffset, const char* p)

Overwrites any or all entries in a signature dictionary. It reopens the file for write, positions to the specified place, and writes exactly the number of bytes specified in digSigOffset.

Parameters

	`asFile` —	The ASFile to write to.

	`digSigOffset` —	A structure specifying the byte position and size to overwrite.

	`p` —	A byte string to be written. It must be in the correct format, given the type of entry as defined in Section 8.7 in the PDF Reference.

Returns

The number of bytes written, or 0 if unsuccessful.

File: DigSigHFTProcs.h

Line: 173

DigSigOverwriteBytes64

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns64 DigSigOverwriteBytes64(ASFile asFile, const DigSigOffset64 digSigOffset, const char* p)

Overwrites any or all entries in a signature dictionary. It reopens the file for write, positions to the specified place, and writes exactly the number of bytes specified in digSigOffset.

Parameters

	`asFile` —	The ASFile to write to.

	`digSigOffset` —	A structure specifying the byte position and size to overwrite.

	`p` —	A byte string to be written. It must be in the correct format, given the type of entry as defined in Section 8.7 in the PDF Reference.

Returns

The number of bytes written, or 0 if unsuccessful.

File: DigSigHFTProcs.h

Line: 1097

DigSigOverwriteHexstring

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigOverwriteHexstring(ASFile asFile, const DigSigOffset digSigOffset, const CosObj cosObj)

Overwrites part of a file with a hex string. It reopens the file for write, positions to the specified location, formats the string as characters, and writes. This method is used to overwrite the /Contents entry in the signature dictionary.

Parameters

	`asFile` —	The ASFile to write to.

	`digSigOffset` —	A structure specifying the byte position and size to overwrite: Writes padding blanks to the file if formatted length is less than this length. Does not write and returns `0` if the formatted length is longer than this length. Does not write and returns `0` if the formatted length is greater than `8200` bytes.

	`cosObj` —	The Cos string to be written.

Returns

The number of bytes written.

File: DigSigHFTProcs.h

Line: 149

DigSigOverwriteHexstring64

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns64 DigSigOverwriteHexstring64(ASFile asFile, const DigSigOffset64 digSigOffset, const CosObj cosObj)

Parameters

	`asFile` —	The ASFile to write to.

	`digSigOffset` —	A structure specifying the byte position and size to overwrite: Writes padding blanks to the file if formatted length is less than this length. Does not write and returns `0` if the formatted length is longer than this length. Does not write and returns `0` if the formatted length is greater than `8200` bytes.

	`cosObj` —	The Cos string to be written.

Returns

The number of bytes written.

File: DigSigHFTProcs.h

Line: 1073

DigSigOverwriteIntArray

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigOverwriteIntArray(ASFile asFile, const DigSigOffset digSigOffset, const CosObj cosObj)

Overwrites part of asFile with an integer array. It reopens the file for write, positions to the specified place, formats the array as characters, and writes. This method is used to overwrite the /ByteRange entry in the signature dictionary.

Parameters

	`asFile` —	The ASFile to write to.

	`digSigOffset` —	A structure specifying the byte position and size to overwrite: Writes padding blanks to the file if formatted length is less than this length. Does not write and returns `0` if the formatted length is longer than this length. Does not write and returns `0` if the formatted length is greater than `8200` bytes.

	`cosObj` —	The Cos string to be written.

Returns

The number of bytes written.

File: DigSigHFTProcs.h

Line: 123

DigSigOverwriteIntArray64

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns64 DigSigOverwriteIntArray64(ASFile asFile, const DigSigOffset64 digSigOffset, const CosObj cosObj)

Parameters

	`asFile` —	The ASFile to write to.

	`digSigOffset` —	A structure specifying the byte position and size to overwrite: Writes padding blanks to the file if formatted length is less than this length. Does not write and returns `0` if the formatted length is longer than this length. Does not write and returns `0` if the formatted length is greater than `8200` bytes.

	`cosObj` —	The Cos string to be written.

Returns

The number of bytes written.

File: DigSigHFTProcs.h

Line: 1047

DigSigPostDraw

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigPostDraw(PDAnnot pdAnnot, AVPageView avPV, ASBool bIsSelected)

Draws signature adornment after the signature appearance is drawn.

Parameters

	`pdAnnot` —	IN The annotation the user clicked on or tabbed into.

	`avPV` —	IN The page view that contains the annotation.

	`bIsSelected` —	IN `true` if the annotation is selected, `false` otherwise.

See Also

DigSigHexToByte
DigSigRightClick

File: DigSigHFTProcs.h

Line: 1107

DigSigRegisterFilter

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigRegisterFilter(ExtensionID owner, DigSigHandler digSigHandler)

Procs below are provided in version 0x00010000 Registers a signing method plug-in. A signing plug-in must call this method before making any signatures. This object should not be destroyed until after it is un-registered or until exit.

Parameters

	`owner` —	The handler plug-in identifier, assigned on initialization.

	`digSigHandler` —	A structure specifying the name of the filter and the functions to call to create and validate signatures.

See Also

DigSigUnregisterFilter

File: DigSigHFTProcs.h

Line: 51

DigSigRegisterObserver

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 DigSigRegisterObserver(DSNotificationType notificationID, DSNotificationProc notifyProc, DSNotificationFailureProc notifyFailure, void* clientData)

Registers callbacks with the notification server, to be called for specific digital signature events.

The events are:

Adding or deleting a signature field.
Requesting a new signature, and the success of the request.
Requesting that an existing signature be cleared, and the success of the request.

Parameters

	`notificationID` —	The type of event for which to register a callback.

	`notifyProc` —	The procedure to call when a field change, request, or success event occurs.

	`notifyFailure` —	The procedure to call when a failure event occurs.

	`clientData` —	A pointer to client-supplied data to pass to the callback procedure.

Returns

The observer identifier, which must be provided to DigSigUnregisterObserver().

See Also

DigSigUnregisterObserver

File: DigSigHFTProcs.h

Line: 857

DigSigRightClick

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigRightClick(PDAnnot pdAnnot, AVPageView avPV, ASInt16 nX, ASInt16 nY, ASInt16 nFlags, ASInt16 nClicks)

Invokes the signature-panel pull-right menu and allows the user to select an action.

Parameters

	`pdAnnot` —	The annotation the user clicked on.

	`avPV` —	The page view the annotation is within.

	`nX` —	The x-coordinate of the mouse click, specified in device space coordinates.

	`nY` —	The y-coordinate of the mouse click, specified in device space coordinates

	`nFlags` —	Indicates which modifier keys are pressed, if any. It must be an OR of the Modifier Keys values, which are the following: AV_COMMAND AV_OPTION AV_CONTROL AV_SHIFT

	`nClicks` —	The number of clicks.

See Also

DigSigDraw
DigSigHexToByte
DigSigClick

File: DigSigHFTProcs.h

Line: 364

DigSigRollbackToSig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigRollbackToSig(PDDoc pdDoc, CosObj sigField)

Creates a new temporary file that corresponds to the state of the file after the specified signature was applied.

Parameters

	`pdDoc` —	The document that contained the signature field.

	`sigField` —	The signature field of the document.

File: DigSigHFTProcs.h

Line: 509

DigSigSignDoc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigSignDoc(PDDoc pdDoc, CosObj sigField, ASAtom filterKey)

Signs and saves a document, using the specified field and signing method. If sigField is NULL, makes a field of size 0x0 points.

Parameters

	`pdDoc` —	IN/OUT The document to be signed.

	`sigField` —	IN/OUT The field to be signed or CosNull.

	`filterKey` —	IN/OUT The signing method to use.

File: DigSigHFTProcs.h

Line: 249

DigSigUnregisterFilter

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigUnregisterFilter(DigSigHandler digSigHandler)

Un-registers a signing method plug-in. The caller should deallocate the DigSigHandler object after making this call.

Parameters

digSigHandler —

A structure specifying the name of the filter and the functions to call to create and validate signatures.

See Also

DigSigRegisterFilter

File: DigSigHFTProcs.h

Line: 792

DigSigUnregisterObserver

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigUnregisterObserver(DSNotificationType notificationID, ASInt32 observerID)

Un-registers an event interest from the notification server.

Parameters

	`notificationID` —	The event for which an interest has been registered, as specified in DigSigRegisterObserver().

	`observerID` —	The observer identifier as returned by DigSigRegisterObserver().

See Also

DigSigRegisterObserver

File: DigSigHFTProcs.h

Line: 871

DigSigUpdatePanel

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void DigSigUpdatePanel(PDDoc pdDoc)

Updates the signature panel, if any, associated with pdDoc.

Parameters

pdDoc —

The document whose panel is to be updated. It verifies a digital signature.

File: DigSigHFTProcs.h

Line: 203

DigSigVerifySig

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSValidState DigSigVerifySig(PDDoc pdDoc, CosObj sigField, ASBool bUI)

Verifies a digital signature.

Parameters

	`pdDoc` —	The document.

	`sigField` —	The signature field to verify.

	`bUI` —	When `true`, it can bring up the user interface dialogs if needed.

Returns

The validity state that results from verification.

See Also

DigSigClearSig

File: DigSigHFTProcs.h

Line: 930

DigSigVerifySigRefDict

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





DSRetCode DigSigVerifySigRefDict(ASAtom transformMethod, CosObj sigDict, CosObj refDict, DSSigRefDictErrParams errParams)

Verifies an object signature stored in a signature reference dictionary. It involves computing the object digest using the transform method and comparing it to the digest value stored in the reference dictionary.

Parameters

	`transformMethod` —	The transform method used to calculate the signature. It must match the one stored in `refDict`.

	`sigDict` —	The signature dictionary that contains the signature reference dictionary.

	`refDict` —	The signature reference dictionary that was returned from a call to DigSigCommitSigRefDict().

	`errParams` —	A structure containing information about an exception.

Returns

kDSTrue on success, kDSFalse on parameter error. kDSException means an exception, and the information about it can be found in errParams.

File: DigSigHFTProcs.h

Line: 761

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
DigSig	Defines \| Typedefs \| Enumerations \| Variables \| Structures \| Callbacks \| Methods

	kDSHandlerCanDocAuthSign = 0,

	kDSHandlerCanDocPDDocSignVisible,

	kDSHandlerEScriptAware,

	kDSHandlerPropEnumSize

	kDSMDPNone = -1,

	kDSMDPAllowAll = 0,

	kDSMDPAllowNone,

	kDSMDPDefault,

	kDSMDPCommentsAndDefault,

	kDSMDPEnumSize

	DSSigAdded = 0,

	DSSigDeleted,

	DSWillSign,

	DSDidSign,

	DSFailSign,

	DSWillVerify,

	DSDidVerify,

	DSFailVerify,

	DSWillClear,

	DSDidClear,

	DSFailClear,

	DigSigNumNotifications

	kDSNotifyNone = 0,

	kDSNotifySetUnknown,

	kDSNotifyModifiedAfterSig,

	kDSNotifySigTypeEnumSize

	kDSPropNone = 0,

	kDSPropSignature,

	kDSPropLegal,

	kDSPropViewVersion,

	kDSPropTypeEnumSize

	kDSSigEncodeNone = 0,

	kDSSigEncodePKCS1,

	kDSSigEncodePKCS7,

	kDSSigEncodeRawSig,

	kDSSigEncodePKCS7Detached,

	kDSSigEncodeETSICAdES,

	kDSSigEncodeETSIDocTimestamp,

	kDSSigEncodeEnumSize

	kDSDisplayOnPageIconAlways = 0,

	kDSDisplayOnPageIconExceptWhenValid,

	kDSDisplayOnPageIconNever,

	kDSDisplayOnPageIconEnumSize

	kDSSigIconBlank = 0,

	kDSSigIconSigUnknown,

	kDSSigIconSigInvalid,

	kDSSigIconSigValidIdUnknown,

	kDSSigIconSigValidIdUnknownModAfter,

	kDSSigIconSigValid,

	kDSSigIconSigValidModAfter,

	kDSSigIconSigValidTrailingModsAfter,

	kDSSigIconAuthUnknown,

	kDSSigIconAuthInvalid,

	kDSSigIconAuthValidIdUnknown,

	kDSSigIconAuthValidIdUnknownModAfter,

	kDSSigIconAuthValid,

	kDSSigIconAuthValidModAfter,

	kDSSigIconSigDeleted,

	kDSSigIconEnumSize

	kDSSigRefErrNone = 0,

	kDSSigRefErrMissingPlugin,

	kDSSigRefErrNewVersion,

	kDSSigRefErrOldVersion,

	kDSSigRefErrEnumSize

	DSSigBlank = 0,

	DSSigUnknown,

	DSSigInvalid,

	DSSigValid,

	DSSigDoubleChecked,

	DSSigValidStateEnumSize

	DSBlankXObj = 0,

	DSUnknownXObj,

	DSInvalidXObj,

	DSValidXObj,

	DSDoubleCheckedXObj

	ASSize_t size;

	PDDoc pdDoc;

	CosDoc cosDoc;

	ASAtom filter;

	ESObject esSigEngine;

	ASCab sigParamsCab;

	ASInt32 uiType;

	ASText signDialogTitle;

	ASText promptMessage;

	ASText asTextError;

	DSCosDocSigObjType objSigType;

	void* objSigParams;

	ASSize_t size;

	PDDoc inPDDoc;

	ASAtom filter;

	ESObject inESSigEngine;

	ESObject inESSigParams;

	DSDigestMethod inDigestMethod;

	DSSigEncode inSigValueEncoding;

	ASCab inSeedValue;

	ASText inDataTitle;

	ASText inDataDescription;

	ASText inSignDialogTitle;

	ASText inPromptMessage;

	ASInt32 inNUI;

	void* inDataDisplayCallbackProc;

	ASCab outCertChainCab;

	ASCab outSigPropCab;

	ASCab outSigBuildCab;

	ASText outASTextError;

	ASSize_t size;

	ASUns8 inDataPtr;

	ASUns32 inDataSize;

	ASUns8 outDataPtr;

	ASUns32 outDataSize;

	ASText outASTextError;

Layer	Digital_Signatures
Object	DigSig

	ASSize_t size;

	const char* uiName;

	ASAtom filterKey;

	ASBool canBlindSign;

	ASBool canEncrypt;

	DSDocOpenProc dsDocOpen;

	DSDocCloseProc dsDocClose;

	DSDefaultValueProc dsDefaultValue;

	DSNewSigDataProc dsNewSigData;

	DSCommitSignProc dsCommitSign;

	DSFinishSignProc dsFinishSign;

	DSFreeSigDataProc dsFreeSigData;

	DSValidateSigProc dsValidateSig;

	DSGetValidStateProc dsGetValidState;

	DSPropertiesProc dsProperties;

	DSUnValidateSigProc dsUnValidateSig;

	DSUnValidateSigProc dsReValidateSig;

	DSClearSigProc dsClearSig;

	DSGetStatusTextProc dsStatusText;

	DSNewSigDataExProc dsNewSigDataEx;

	DSValidateSigExProc dsValidateSigEx;

	DSGetSigInfoProc dsGetSigInfo;

	DSNewSigEngineProc dsNewSigEngine;

	DSSigDataGetErrorTextProc dsSigDataGetErrorText;

	DSNewSigDataWithParamsProc dsNewSigDataWithParams;

	DSPropertiesExProc dsPropertiesEx;

	DSCosDocSigSignProc dsCosDocSigSign;

	DSCosDocSigValidateProc dsCosDocSigValidate;

	DSCanValidateProc dsCanValidate;

	DSNotifySigProc dsNotifySig;

	DSGetSigSeedValueProc dsGetSigSeedValue;

	DSSetSigSeedValueProc dsSetSigSeedValue;

	DSGetBoolPropertyProc dsGetBoolProperty;

	DSGetSigPropProc dsGetSigProp;

	DSIsSignerProc dsIsSigner;

	ASAtom filterAlias;

	DSDataBufferSigSignNewProc dsDataBufferSigSignNew;

	DSDataBufferSigSignFinishProc dsDataBufferSigSignFinish;

	DSDataBufferSigValidateProc dsDataBufferSigValidate;

	DSCommitSign64Proc dsCommitSign64;

	DSFinishSign64Proc dsFinishSign64;

	ASSize_t size;

	PDDoc pdDoc;

	CosObj sigField;

	CosObj sigAnnot;

	DigSigBBox bb;

	ASAtom filter;

	ESObject esSigEngine;

	ESObject esSigParams;

	ASText esErrorText;

	ASBool bUI;

	ASBool bDocAuthSig;

	CosObj legalPDFDict;

	DSMDPType mdpSetting;

	ASBool bUBSig;

	CosObj urdDict;

	CosObj cosObj;

	ASFileOffset64 byteOffset;

	ASInt64 byteLength;

	CosObj cosObj;

	ASInt32 byteOffset;

	ASInt32 byteLength;

	CosDoc cosDoc;

	CosObj XObjects;

	ASFixedMatrixP layerMatrices;

	ASInt32 numXObjects;

	ASInt16 layerNNum;

	AFPDWidgetBorder border;

	PDColorValue cBorder;

	PDColorValue cBackGnd;

	ASFixed width;

	ASFixed height;

	PDRotate pdr;

	ASBool layerFlags;

	_t_DSAPTextEntryRec next;

	ASFixed heightRatio;

	ASText text;

	_t_DSAPXObjEntryRec next;

	CosObj xobj;

	ASFixedRect rect;

	ASText text;

	ASFixed textSize;

	DSQuadding xjustify;

	DSQuadding yjustify;

	ASFixed scale;

	ASBool bMerge;

	ASBool bDestroy;

	ASSize_t size;

	DSNotificationType notificationID;

	PDDoc pdDoc;

	CosDoc cosDoc;

	CosObj sigField;

	CosObj sigDict;

	ASSize_t size;

	DSSigRefErrCode errCode;

	ASText errText;

	ASSize_t size;

	CosDoc cosDoc;

	CosObj rootObj;

	CosObj sigDict;

	ASAtom transformMethod;

	CosObj transformParams;

	ASBool bIndirect;