Digital_Signatures.PubSec (Acrobat)

	Define
	kPSDTypeCode Adobe Photoshop PSD file.
	kPSSigTrustAll Trusted for everything.
	kPSSigTrustAnchor Trusted as an anchor: no checks are done for certificates above this certificate.
	kPSSigTrustAuthenticDocuments Trusted for authoring documents (creating author signatures).
	kPSSigTrustCrossDomain Trusted for by-passing Crossdomain check.
	kPSSigTrustDataInjection Trusted for Forms data injection.
	kPSSigTrustDynamicContent Trusted for authoring documents with dyamic (multimedia) content.
	kPSSigTrustExternalStream Trusted for accessing external resources/Streams.
	kPSSigTrustIdentity Trusted for identity: it must be present to use in trust calculations.
	kPSSigTrustJavaScript Trusted for authoring documents with full access JavaScript.
	kPSSigTrustNonExplicitPolicy Trusted to be the root for non-explicit Policy Constraints checking model Must be also a trust anchor.
	kPSSigTrustScriptInjection Trusted for Forms Script injection.
	kPSSigTrustSigning Trusted for signing (creating recipient signatures).
	kPSSigTrustSilentPrint Trusted for silent printing.
	kPSSigTrustUbiquity Trusted for feature-enabling signatures (Adobe internal use only).
	kPSSigTrustUnsafeJavaScript Trusted for Unsafe JavaScript.
	kPSSigTrustUntrusted The certificate is untrusted.
	kPSSigTrustWebLink Trusted for Connecting to Web.
	PARAM_ESSecurity_Cert
	PARAM_ESSecurity_Certs
	PARAM_ESSecurity_CPS
	PARAM_ESSecurity_DigestSHA1
	PARAM_ESSecurity_DIPath
	PARAM_ESSecurity_Document
	PARAM_ESSecurity_Domain
	PARAM_ESSecurity_EndUserCryptCert
	PARAM_ESSecurity_EndUserSignCert
	PARAM_ESSecurity_Filename
	PARAM_ESSecurity_Message
	PARAM_ESSecurity_Method
	PARAM_ESSecurity_Object
	PARAM_ESSecurity_Params
	PARAM_ESSecurity_Password
	PARAM_ESSecurity_PFX
	PARAM_ESSecurity_RDN
	PARAM_ESSecurity_Select
	PARAM_ESSecurity_SimplifiedUI
	PARAM_ESSecurity_Stores
	PARAM_ESSecurity_Timeout
	PARAM_ESSecurity_Type
	PARAM_ESSecurity_URI
	PARAM_ESSecurity_UserId
	PROP_APCab_Index
	PROP_APCab_Name
	PROP_APCab_Type
	PROP_APIndex
	PROP_CertIdentification
	PROP_CertPolicyCab_OID
	PROP_CertPolicyCab_UFName
	PROP_ContactCab_Certs
	PROP_ContactCab_CMS
	PROP_ContactCab_CN
	PROP_ContactCab_Contact
	PROP_ContactCab_ContactInfo
	PROP_ContactCab_EMail
	PROP_ContactCab_Group
	PROP_ContactCab_O
	PROP_ContactCab_Policy
	PROP_ContactCab_Trust
	PROP_CountryID
	PROP_DirHandlerInfo_ID (Required) A unique identifier for the directory handler. The handler is rejected if the ASAtom conflicts with one already registered.
	PROP_DirHandlerInfo_Name (Required) The user interface name for the handler.
	PROP_DirSettingCab_Attr
	PROP_DirSettingCab_Type
	PROP_EnabledID
	PROP_ESCPS_NOTICE
	PROP_ESCPS_OID
	PROP_ESCPS_URL
	PROP_ESRDN_BIZCATEGORY
	PROP_ESRDN_C
	PROP_ESRDN_CITIZENSHIP
	PROP_ESRDN_CN
	PROP_ESRDN_DC
	PROP_ESRDN_DNQUALIFIER
	PROP_ESRDN_DOB
	PROP_ESRDN_E
	PROP_ESRDN_GENDER
	PROP_ESRDN_GENQUALIFIER
	PROP_ESRDN_GIVENNAME
	PROP_ESRDN_INITIALS
	PROP_ESRDN_LOCALITY
	PROP_ESRDN_NAME
	PROP_ESRDN_NAMEATBIRTH
	PROP_ESRDN_O
	PROP_ESRDN_OU
	PROP_ESRDN_POB
	PROP_ESRDN_POSTALADDR
	PROP_ESRDN_POSTALCODE
	PROP_ESRDN_PSEUDONYM
	PROP_ESRDN_RESIDENCE
	PROP_ESRDN_SERIALNUM
	PROP_ESRDN_STATE
	PROP_ESRDN_STREET
	PROP_ESRDN_SURNAME
	PROP_ESRDN_TITLE
	PROP_ExportDataCab_CN
	PROP_ExportDataCab_Contacts
	PROP_ExportDataCab_DirSettings
	PROP_ExportDataCab_EMail
	PROP_ExportDataCab_Filter
	PROP_ExportDataCab_URL
	PROP_Left
	PROP_LockValue_Auto
	PROP_LockValue_False LockDocument properties
	PROP_LockValue_True
	PROP_MDPType_AllowAll Values for the mdp property of a SigInfo Object. See PSSigMDPType enum.
	PROP_MDPType_AllowNone
	PROP_MDPType_Default
	PROP_MDPType_DefaultAndComments
	PROP_More
	PROP_Op_Certificates
	PROP_Op_ContactInfo
	PROP_PSENG_Appearances
	PROP_PSENG_ASAtom_DefaultSubFilter The preferred signing format to use, specifing the value of the SubFilter. It is overridden by SeedValue and SigInfo.
	PROP_PSENG_ASAtom_DigSigHandlerAlias The alias of the handler registered with DigSigHFT (primarily used for backward compatibility, where the handler has changed its name over time).
	PROP_PSENG_ASAtom_DigSigHandlerName The name by which this handler is to be registered with DigSigHFT.
	PROP_PSENG_ASAtom_PubSecHandlerAlias The alias of the handler registered with PubSecHFT.
	PROP_PSENG_ASAtom_PubSecHandlerName The name by which this handler is to be registered with PubSecHFT (usually the same name as DigSig).
	PROP_PSENG_ASInt32_AppearanceNum Return an ASInt32 indicating the number of appearances the handler has. This is used for JavaScript.
	PROP_PSENG_ASInt32_DirectoryNum Return an ASInt32 indicating the number of directories the handler has. This is used for JavaScript.
	PROP_PSENG_ASInt32_HandlerVersion Return the version of this plug-in. The handler should be careful about setting this value in relation to the build dictionary that is created. If a handler ever needs to revoke signatures that are created with a version of software that has errors, and the PreRelease flag in the build dictionary is not set, then the handler will probably need to use the value of this number.
	PROP_PSENG_BuildDate
	PROP_PSENG_CN
	PROP_PSENG_CosSign
	PROP_PSENG_CosValidate
	PROP_PSENG_Directories
	PROP_PSENG_DirectoryHandlers
	PROP_PSENG_Exception
	PROP_PSENG_ExportContact
	PROP_PSENG_ExportDirSettings
	PROP_PSENG_HandlerUIName
	PROP_PSENG_HashAlgoRIPEMD160 Return true if the handler is capable of hashing using RIPEMD160.
	PROP_PSENG_HashAlgoSHA224 Return true if the handler is capable of hashing using SHA224.
	PROP_PSENG_HashAlgoSHA256 Return true if the handler is capable of hashing using SHA256.
	PROP_PSENG_HashAlgoSHA384 Return true if the handler is capable of hashing using SHA384.
	PROP_PSENG_HashAlgoSHA512 Return true if the handler is capable of hashing using SHA152.
	PROP_PSENG_ImportContact
	PROP_PSENG_ImportDirSettings
	PROP_PSENG_IsLoggedOn
	PROP_PSENG_PDDecrypt
	PROP_PSENG_PDEncrypt
	PROP_PSENG_PDSignAuthor
	PROP_PSENG_PDSignCustomAP
	PROP_PSENG_PDSignInvisible
	PROP_PSENG_PDSignValidate
	PROP_PSENG_PDSignVisible
	PROP_PSENG_ProfilePath
	PROP_PSENG_SignFormatETSIPAdES Return true if the handler is capable of signing and verifying ETSI.PAdES signatures. The handler is then required to support ETSI.CAdES.detached signatures.
	PROP_PSENG_SignFormatETSIPAdESDigest Return true if the handler must do its own digesting when signing and verifying ETSI.CAdES.detached signatures (the handler cannot directly sign the digest).
	PROP_PSENG_SignFormatETSIRFC3161 Return true if the handler is capable of signing and verifying ETSI.RFC3161 (Timestamp) signatures. The handler is then required to support ETSI.RFC3161 signatures.
	PROP_PSENG_SignFormatETSIRFC3161Digest Return true if the handler must do its own digesting when signing and verifying ETSI.RFC3161 timestamp signatures (the handler cannot directly sign the digest).
	PROP_PSENG_SignFormatPKCS1 Return true if the handler is capable of signing and verifying PKCS#1 signatures. The handler is then required to support adbe.x509.rsa_sha1 signatures.
	PROP_PSENG_SignFormatPKCS1Digest Return true if the handler must do its own digesting when signing and verifying adbe.x509.rsa_sha1 signatures (the handler cannot directly sign the digest).
	PROP_PSENG_SignFormatPKCS7 Return true if the handler is capable of signing and verifying PKCS#7 signatures. The handler is then required to support both adbe.pkcs7.sha1 and adbe.pkcs7.detached formats.
	PROP_PSENG_SignFormatPKCS7DetachedDigest Return true if the handler must do its own digesting when signing and verifying adbe.pkcs7.detached signatures (the handler cannot directly sign the digest).
	PROP_PSENG_Text_HandlerVersion
	PROP_PSENG_UserInterface
	PROP_Reasons
	PROP_SigBuild_PreRelease Indicates if the signature was created by pre-release software. Its default value is false.
	PROP_SigBuild_V Signature properties that are written to the build dictionary. These property names exactly match the corresponding build dictionary names. These are used in PSSigSigPropParamsRec.outNewSigBuildCab Handlers can specify custom sig properties. These should be named using format ACME_MyProperty, where ACME is the abbreviated company name. Signature dictionary formatting version number, for specific/private use by the handler. The handler may use this to determine whether the handler supports verification of this signature. Set it to 0 if it is unused.
	PROP_SigInfo_Appearance write-only
	PROP_SigInfo_AppRightsAnnots
	PROP_SigInfo_AppRightsAnnotsEx
	PROP_SigInfo_AppRightsDoc Ubiquity Rights array of ASText. See PDF Reference.
	PROP_SigInfo_AppRightsEF
	PROP_SigInfo_AppRightsForm
	PROP_SigInfo_AppRightsFormEx
	PROP_SigInfo_AppRightsSignature
	PROP_SigInfo_BuildInfo
	PROP_SigInfo_ByteRange array of ASInt32
	PROP_SigInfo_Certificates ESObjects properties. Implemented in PubSec.
	PROP_SigInfo_ContactInfo ASText properties used only for Public key signatures
	PROP_SigInfo_DataSigSignerStatusText
	PROP_SigInfo_DataSigStatusText
	PROP_SigInfo_Date in PDF date format
	PROP_SigInfo_DateTrusted boolean indicating if date is from a trusted source, new in A7
	PROP_SigInfo_docValidity result of byte range test (value is DSSigValState)
	PROP_SigInfo_Handler name specifed by /Filter
	PROP_SigInfo_HandlerUIName
	PROP_SigInfo_HandlerUserName same as handlerUIName
	PROP_SigInfo_HashAlgo
	PROP_SigInfo_idPrivValidity result of handler id validity test (value is handler specific)
	PROP_SigInfo_idValidity result of id validity test (value is DSSigValState)
	PROP_SigInfo_Location
	PROP_SigInfo_MDP
	PROP_SigInfo_Name ASText properties
	PROP_SigInfo_NumFieldsAltered
	PROP_SigInfo_NumFieldsFilledIn
	PROP_SigInfo_NumPagesAltered
	PROP_SigInfo_NumRevisions
	PROP_SigInfo_objValidity result of MDP test (value is DSSigValState)
	PROP_SigInfo_Password write-only
	PROP_SigInfo_Reason
	PROP_SigInfo_RevInfo
	PROP_SigInfo_RevInfo_CRL
	PROP_SigInfo_RevInfo_OCSP
	PROP_SigInfo_Revision ASInt32 properties
	PROP_SigInfo_SignFormat
	PROP_SigInfo_SigValue binary properties
	PROP_SigInfo_Status
	PROP_SigInfo_StatusText
	PROP_SigInfo_Subfilter
	PROP_SigInfo_TimeStamp
	PROP_SigInfo_trustFlags contains a PSSigTrust, which is defined in PubSecHFT.h
	PROP_SigInfo_VerifyDate in PDF date format, new in A7
	PROP_SigInfo_VerifyHandler name of handler used to validate signature
	PROP_SigInfo_VerifyHandlerUIName
	PROP_SigProp_AuthTime
	PROP_SigProp_AuthType
	PROP_SigProp_ContactInfo
	PROP_SigProp_Date
	PROP_SigProp_Filter
	PROP_SigProp_Location
	PROP_SigProp_MDP
	PROP_SigProp_Name Signature properties that are written to the signature dictionary. These property names exactly match the corresponding signature dictionary names. These are used in PSSigSigPropParamsRec.outNewSigPropCab . Handlers can specify custom signature properties. These should be named using the format ACME_Prop_MyProperty, where ACME is the abbreviated company name.
	PROP_SigProp_PDFMinorVersion
	PROP_SigProp_Reason
	PROP_SigSeedValue_AppearanceFilter Appearance filter.
	PROP_SigSeedValue_Attestations An ASText array of legal attestations for MDP signing.
	PROP_SigSeedValue_DigestMethod A string specifying the hashing algorithm.
	PROP_SigSeedValue_Filter An ASAtom giving the name of the required handler to use when signing.
	PROP_SigSeedValue_Flags ASInt32 flags.
	PROP_SigSeedValue_Lock Lock properties.
	PROP_SigSeedValue_MDP A string giving the Modification Detection and Prevention (MDP) parameters.
	PROP_SigSeedValue_Reasons An ASText array of reasons for signing.
	PROP_SigSeedValue_SubFilter An ASAtom array giving the names of acceptable signing formats.
	PROP_SigSeedValue_Version A double indicating the required revision of the handler.
	PROP_SigVal_Author
	PROP_SigVal_AuthSig
	PROP_SigVal_Data
	PROP_SigVal_Digest
	PROP_SigVal_Doc
	PROP_SigVal_DS
	PROP_SigVal_FDF
	PROP_SigVal_Id
	PROP_SigVal_IdPriv
	PROP_SigVal_IdPrivText
	PROP_SigVal_Mod
	PROP_SigVal_Obj
	PROP_SigVal_TrustFlags
	PROP_SigVal_Ubiquity
	PROP_SourceID
	PROP_Top
	PROP_VisibleID
	PS_SIG_MAX_SIZE The maximum size of the binary signature blob in bytes.
	PubSecHFT_NUMSELECTORS

	Typedef
	APPreview
	APPreviewRec
	DirAuthenticationContext An ASCab object containing authentication details such as the user name and password. It could be used to override the default authentication entries, or to avoid repeated authentications in case the context could be cached. The actual contents depend on the directory handlers. The currently supported directory handlers (AAB and LDAP) do not support this feature.
	DirDSP Directory Service Provider (DSP) Object. As of Acrobat 6.0 this is a PubSecEngine object that acts as a DSP. In future releases this may become a stand-alone structure.
	DirHandlerInfo A directory handler information ASCab contains a vector of nested ASCab objects, one for every directory handler contained within the engine. Each directory handler ASCab contains a user interface name and a unique ID (for example, "Adobe.PPKMS.LDAP").
	DSAPFile A signature appearance file object to be used by handlers to access the built-in APIcon appearance handler.
	DSRetCode Return values of DS calls (DSRetCode, or ASInt32). All negative return values are considered exceptions. If the value is kDSException, exception text should be available from the called routine. If this exception text is NULL, it should be considered an unknown error.
	PSDataBuffer
	PSDataBufferRec A buffer of data to be hashed when signing or verifying signatures. The buffer contains the bytes to be signed (by ByteRange) when signing a PDF file.
	PSExportDataExchangeParams
	PSExportDataExchangeParamsRec
	PSImportDataExchangeParams
	PSImportDataExchangeParamsRec
	PSImportDataParams
	PSImportDataParamsRec
	PSOpenCMSEnvelopeParams
	PSOpenCMSEnvelopeParamsRec
	PSSigCosDocParams
	PSSigCosDocParamsRec
	PSSigDataBufferParams
	PSSigDataBufferParamsRec
	PSSigGetSigValueParams
	PSSigGetSigValueParamsRec
	PSSigPDDocParams
	PSSigPDDocParamsRec
	PSSigSignReportParams
	PSSigSignReportParamsRec
	PSSigSigPropParams
	PSSigSigPropParamsRec
	PSSigTrust Bit flag constants that specify a level of trust for a certificate.
	PSSigValidateDialogParams
	PSSigValidateDialogParamsRec
	PSSigValidateParams
	PSSigValidateParamsRec
	PSSigValidateSupportParams
	PSSigValidateSupportParamsRec
	PubSecEngine A PubSec engine object. There can be multiple engine objects per handler.
	PubSecHandler
	PubSecHandlerRec

	Enumeration
	`DSDigestMethod` Constants that specify the method to use for creating a signature digest.
	`DSSaveType` A return type for the DigSig and PubSec callbacks.
	`DSSigValState` Enum of all possible PROP_SigInfo_docValidity and PROP_SigInfo_objValidity values (document/data/object hash validity states).
	`DSSigValText` The types of text requested by PSSigValGetTextProc() for a signature-validity ASCab object. The strings are generated by the handler, usually on the fly, when requested. A handler can cache the values in the sigVal ASCab (Acrobat plug-ins do not do this). PubSec copies values for DSTop, DSDetail, DSDetails and DSTooltip to the signature-propeties ASCab.
	`PSAPSigType` A signature type to use for generating a signature appearance.
	`PSDecryptionReason` Reasons why opening a CMS envelope could be requested
	`PSExportDataType` The format of data to be exported using PSExportDataProc() or PSExportDataExchange().
	`PSExportDestType` File output options for PSExportDataExchangeParams().
	`PSImportDataType` The format of data to be imported using PSImportDataProc(). The operation is only executed if the corresponding property (PROP_ImportContact or PROP_ImportDirSettings) is set, which indicates that the handler supports this format. If PROP_ImportContact is set, both of the corresponding formats must be supported.
	`PSPerformOpType` The type of operation to be performed by PSPerformOperationProc(). The PubSec plug-in interprets relevant calls and dispatches them to handlers for the operation to be performed.
	`PSSessionOpType` Operations for which a PubSec session can be acquired.
	`PSSigDialogStatus` Dialog information, returned from GetSigProperties() and other calls to tell PubSec what flow of subsequent dialogs or actions to execute. Not all values are legal for all procs.
	`PSSigDocType` The type of document being signed.
	`PSSigFileType` A constant value that indicates the file type and environment in which data is being signed, used to set up buttons and text in the signing dialog.
	`PSSigMethod` Constants that specify the method to use for creating a signature. For details, see the PDF Reference.
	`PSSigType` Types of PDDoc signatures.
	`PSSigValSupport` Constant values indicating how a handler supports validation for a particular signature.

	Variable
	gPubSecHFT

	Structure
	_t_APPreviewRec Data with which to build a signature preview in the edit dialog box for a signature appearance file entry.
	_t_PSExportDataExchangeParamsRec Parameters for exporting data from PubSec to a file.
	_t_PSImportDataExchangeParamsRec Parameters for importing data from a file into PubSec.
	_t_PSImportDataParamsRec Parameters for importing data from a file into PubSec; it is used in PSImportDataProc().
	_t_PSOpenCMSEnvelopeParamsRec Parameters that are used when opening a CMS envelope.
	_t_PSSigCosDocParamsRec Signature parameters for a CosDoc. It is used internally.
	_t_PSSigDataBufferParamsRec Signature parameters for signing transitional data, such as XFA.
	_t_PSSigGetSigValueParamsRec A structure containing parameters and return values for PSSigGetSigValueProc().
	_t_PSSigPDDocParamsRec Validation parameters for validating a document signature or specific signature field.
	_t_PSSigSignReportParamsRec
	_t_PSSigSigPropParamsRec A structure containing parameters and return values for PSSigGetSigPropertiesProc().
	_t_PSSigValidateDialogParamsRec A structure containing parameters and return values for PSSigValidateDialogProc().
	_t_PSSigValidateParamsRecRec A structure containing parameters and return values for PSSigValidateProc().
	_t_PSSigValidateSupportParamsRec A structure containing signature parameters for PSSigValidateSupportedProc().
	_t_PubSecHandlerRec PubSecHandlerRec Definition. See PSRegisterHandler for registration of PubSecHandlers.

	Callback
	PSDestroyEngineProc Destroys a public key security engine for this handler, freeing the memory.
	PSExportDataProc This function gets data of the specified type from a handler, to be exported to an FDF or CMS file and possibly sent as an email attachment. The function is called when exporting to FDF, for example, in response to an FDF Data Exchange certificate request.
	PSGetAtomPropertyProc Gets an ASAtom property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.
	PSGetBoolPropertyProc Gets an ASBool property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.
	PSGetDirHandlerInfo Gets information about directory handlers in an engine that is acting as a directory service provider.
	PSGetDirInfo Gets information about directories in an engine that is acting as a directory service provider.
	PSGetDirList Gets a list of directories in an engine that is acting as a directory service provider.
	PSGetImplicitRecipientsProc Gets information about directory handlers in an engine that is acting as a directory service provider.
	PSGetInt32PropertyProc Gets an ASInt32 property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.
	PSGetLogoProc Gets custom artwork from the handler, to be used as a label for a particular validity state. The artwork for standard labels does not need to be specifically retrieved. If you are not using dynamic signature appearances or not using custom artwork, the handler need only handle the null label case.
	PSGetTextPropertyProc Gets an ASText property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.
	PSImportDataProc This function sends data of a particular type to a handler to import into its own data store. This is call is executed in response to data received (for example, through an FDF file or through the signature dictionary).
	PSNewEngineProc Create a new public key security engine for this handler. This engine would not be associated with any user interface.
	PSOpenCMSEnvelopeExProc Open the provided PKCS#7 (CMS) Enveloped Data object and return the data contained in it.
	PSOpenCMSEnvelopeProc This procedure is required. It is called to open the provided PKCS#7 cryptographic message service (CMS) enveloped data object and return the data contained in it.
	PSOpenConnection Opens a connection to a specified directory to use for authentication.
	PSPerformOperationProc Performs the specified operation using parameters contained in cab. This interface is used by EScript.
	PSSessionAcquireProc Called to acquire resources that will be needed to begin a PubSec session. For example, it might need to log on before performing a desired operation. If resources are already available, the handler may not need to do anything. When the function completes successfully, PubSec calls PSSessionReleaseProc() with the same operation type. Multiple calls can be made to acquire the same or different operation types, before a previously acquired resource is released. Handlers should keep a reference count if required for a particular resource.
	PSSessionReadyProc Returns kDSTrue if the resources and information needed to perform the specified operation have been acquired.
	PSSessionReleaseProc Releases any resources that were required for the specified operation, such as file handles. It is up to a handler to decide what resources to release. A handler can, for example, leave a user logged on, even after a session is released. This call can fail. For example, you might want the call to fail if the operation is kPSOpTypeEScriptLogin and encrypted documents are open.
	PSSetDirInfo Sets information about a directory in an engine that is acting as a directory service provider.
	PSSigAuthenticateProc Called to authenticate the signer. The caller can determine whether authentication is required by calling PSGetBoolPropertyProc() with the property PROP_PSENG_IsAuthenticated.
	PSSigCreateAPNXObjProc Creates the signature appearance that is put into the /AP dictionary /N entry.
	PSSigGetSigPropertiesProc Called when creating a new signature. For PDDoc signatures, this call replaces SigNew() and SigCommit() calls. It returns the values that PubSec writes into the signature dictionary in the parameters structure. Before making this call, the handler should use PSSessionAcquireProc() to choose the credential to be used for signing. The handler can use the user interface during this call to allow authentication and to bring up the signing dialog.
	PSSigGetSigValueProc Called to sign the digest and return the signature value. The memory for the signature value becomes the property of the caller.
	PSSigPropDialogProc Called to display a dialog box that shows signature properties.
	PSSigSignReportProc Ask the handler to report a summary on a signature that has just been signed by this handler.
	PSSigValGetAPLabelProc Called to get a name to use for a particular layer of signature appearance. This is used when the signature appearance uses the n1 and n3 layers for dynamic signature appearances. Beginning in Acrobat 6.0, Acrobat is discouraging the use of dynamic signature appearances and is instead showing the signature validity as an icon that is rendered at run time.
	PSSigValGetTextProc Called to get the text result of validation. For most values of textType, the handler should return NULL, causing PubSec to use the default text strings ("Valid", "Invalid", or "Unknown", depending on the validity state). Handlers will normally need to provide their own ID validity strings.
	PSSigValidateDialogProc Called to show a dialog box that shows validation status after the signature is validated.
	PSSigValidateProc Called to validate a signature.
	PSSigValidateSupportedProc Called to determine whether the handler can validate a signature.

	Method
	void AABFindCertsByName(const ASUns8* inCertNameData, ASInt32 inCertNameSize, ASCab outResults) Performs a lookup in the Acrobat Address Book by certificate subject name. It returns all certificates that match the name along with trust information associated with them.
	ASBool AABGetCertChain(const ASUns8* inX509Cert, ASInt32 inX509CertSize, ASCab inTrustedCerts, ASCab inUntrustedCerts, ASCab outChain) Finds the certificate chain for the specified certificate in the Acrobat Address Book.
	PSSigTrust AABGetCertTrust(const ASUns8* inX509Cert, ASInt32 inX509CertSize, ASCab inCertChain, ASCab inHelperCerts) Finds the specified certificate in the Acrobat Address Book and returns the trust level.
	void AABGetTrustedCerts(PSSigTrust inTrust, ASCab outResults) Finds the certificates with a specified level of trust in the Acrobat Address Book.
	ASBool AABIsCertPresent(const ASUns8* x509, ASInt32 size) Finds the specified certificate in the Acrobat Address Book. Use this method to distinguish a certificate that is not found by AABGetCertTrust from one whose trust level is reported as untrusted.
	ASBool AABIsCertUnderAdobeRoot(ASCab inCertChain) Tests whether any certificate in a chain has been issued under the Adobe Root Certificate Policy.
	ASBool PSAddSecureAttachmentToDoc(ASText inDIPath, ASText inAttName, const ASUns8* inCertChain, ASInt32 inCertSize, PDDoc pdDoc) Attach the a document to an eEnvelope using the specified certificate data.
	ASBool PSCertIssuedUnderTestCP(ASCab inCertChain) Tests whether any certificate in a chain has been issued under the Adobe Test Certificate Policy.
	ASBool PSCloseEncryptedDocs(PubSecEngine engine) Closes all encrypted documents associated with a PubSec engine, regardless of whether they need to be saved. Use PSCountEncryptedDocs() to determine if there are any documents that will need to be opened or saved.
	void PSCountEncryptedDocs(PubSecEngine engine, ASUns32* outNeedSave, ASUns32* outCanClose) Returns the number of encrypted documents associated with a PubSec engine. It returns separate values for documents that need to be saved, and for those that do not need to be saved and can be safely closed.
	ASBool PSDataBufferDigest(PSDataBuffer dataBuffer, ASUns8* digestValue, DSDigestMethod digestMethod) Computes the digest for a set of data. A handler will use this call to make PubSec compute the digest for a data buffer when signing or verifying signatures. This method calls PSDataBufferEnum() to get the bytes and computes an MD5 or SHA-1 digest.
	ASBool PSDataBufferEnum(PSDataBuffer dataBuffer, ASInt32 maxSize, ASUns8** pReturnBuffer, ASInt32* pReturnSize) Validates a specified signature field in a PDDoc. For example, you might call this from the validate button of a signature properties dialog, or if any information used during validation is changed. It does not bring up any user interface.
	void PSDataBufferReset(PSDataBuffer dataBuffer) As functions PSDataBufferEnum() or PSDataBufferDigest() are stateful (for example, the dataBuffer object keeps track of the bytes that have been returned), call this function whenever the state maintained within the dataBuffer need to be re-initialized.
	ASBool PSExportDataExchange(PSExportDataExchangeParams params) Exports certificates, requests for certificates, and so on, to FDF files or other file types, using a user interface wizard. It includes support to export to a file or to email.
	ASBool PSImportDataExchange(PSImportDataExchangeParams params) Imports FDF data from a file, using a user interface wizard. The parameters structure specifies the type and location of the data. This call is used, for example, by the Directory configuration dialog box to import directory settings from an FDF file.
	ASBool PSRegisterHandler(ExtensionID owner, PubSecHandler psHandler) Registers a handler with the PubSec HFT. The caller retains ownership of the PubSecHandlerRec.
	ASBool PSSigValidatePDDocSigField(PSSigPDDocParams docParams)
	void PSUnregisterHandler(PubSecHandler psHandler) Unregisters a handler from the PubSec HFT. This does not destroy the handler; the caller owns the PubSecHandlerRec.

Defines Detail

kPSDTypeCode

Product availability: All

Platform availability: All

Syntax


#define kPSDTypeCode ASFourCharCode('8BIM')

Description

Adobe Photoshop PSD file.

File: ASExpT.h

Line: 1722

kPSSigTrustAll

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustAll 0x0000FFFF

Description

Trusted for everything.

File: PubSecHFT.h

Line: 821

kPSSigTrustAnchor

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustAnchor 0x0040

Description

Trusted as an anchor: no checks are done for certificates above this certificate.

File: PubSecHFT.h

Line: 775

kPSSigTrustAuthenticDocuments

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustAuthenticDocuments 0x0002

Description

Trusted for authoring documents (creating author signatures).

File: PubSecHFT.h

Line: 750

kPSSigTrustCrossDomain

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustCrossDomain 0x0080

Description

Trusted for by-passing Crossdomain check.

File: PubSecHFT.h

Line: 780

kPSSigTrustDataInjection

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustDataInjection 0x0800

Description

Trusted for Forms data injection.

File: PubSecHFT.h

Line: 800

kPSSigTrustDynamicContent

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustDynamicContent 0x0004

Description

Trusted for authoring documents with dyamic (multimedia) content.

File: PubSecHFT.h

Line: 755

kPSSigTrustExternalStream

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustExternalStream 0x0100

Description

Trusted for accessing external resources/Streams.

File: PubSecHFT.h

Line: 785

kPSSigTrustIdentity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustIdentity 0x0020

Description

Trusted for identity: it must be present to use in trust calculations.

File: PubSecHFT.h

Line: 770

kPSSigTrustJavaScript

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustJavaScript 0x0010

Description

Trusted for authoring documents with full access JavaScript.

File: PubSecHFT.h

Line: 765

kPSSigTrustNonExplicitPolicy

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustNonExplicitPolicy 0x4000

Description

Trusted to be the root for non-explicit Policy Constraints checking model Must be also a trust anchor.

File: PubSecHFT.h

Line: 816

kPSSigTrustScriptInjection

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustScriptInjection 0x1000

Description

Trusted for Forms Script injection.

File: PubSecHFT.h

Line: 805

kPSSigTrustSigning

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustSigning 0x0001

Description

Trusted for signing (creating recipient signatures).

File: PubSecHFT.h

Line: 745

kPSSigTrustSilentPrint

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustSilentPrint 0x0200

Description

Trusted for silent printing.

File: PubSecHFT.h

Line: 790

kPSSigTrustUbiquity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustUbiquity 0x0008

Description

Trusted for feature-enabling signatures (Adobe internal use only).

File: PubSecHFT.h

Line: 760

kPSSigTrustUnsafeJavaScript

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustUnsafeJavaScript 0x2000

Description

Trusted for Unsafe JavaScript.

File: PubSecHFT.h

Line: 810

kPSSigTrustUntrusted

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustUntrusted 0x0000

Description

The certificate is untrusted.

File: PubSecHFT.h

Line: 739

kPSSigTrustWebLink

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define kPSSigTrustWebLink 0x0400

Description

Trusted for Connecting to Web.

File: PubSecHFT.h

Line: 795

PARAM_ESSecurity_Cert

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Cert "oCert"

File: PubSecHFT.h

Line: 1154

PARAM_ESSecurity_Certs

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Certs "certs"

File: PubSecHFT.h

Line: 1158

PARAM_ESSecurity_CPS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_CPS "oCPS"

File: PubSecHFT.h

Line: 1146

PARAM_ESSecurity_DigestSHA1

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_DigestSHA1 "cDigestSHA1"

File: PubSecHFT.h

Line: 1148

PARAM_ESSecurity_DIPath

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_DIPath "cDIPath"

File: PubSecHFT.h

Line: 1143

PARAM_ESSecurity_Document

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Document "oDocObj"

File: PubSecHFT.h

Line: 1165

PARAM_ESSecurity_Domain

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Domain "cDomain"

File: PubSecHFT.h

Line: 1162

PARAM_ESSecurity_EndUserCryptCert

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_EndUserCryptCert "oEndUserCryptCert"

File: PubSecHFT.h

Line: 1157

PARAM_ESSecurity_EndUserSignCert

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_EndUserSignCert "oEndUserSignCert"

File: PubSecHFT.h

Line: 1156

PARAM_ESSecurity_Filename

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Filename "cFilename"

File: PubSecHFT.h

Line: 1166

PARAM_ESSecurity_Message

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Message "cMsg"

File: PubSecHFT.h

Line: 1149

PARAM_ESSecurity_Method

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Method "cMethod"

File: PubSecHFT.h

Line: 1150

PARAM_ESSecurity_Object

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Object "oObject"

File: PubSecHFT.h

Line: 1155

PARAM_ESSecurity_Params

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Params "oParams"

File: PubSecHFT.h

Line: 1151

PARAM_ESSecurity_Password

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Password "cPassword"

File: PubSecHFT.h

Line: 1142

PARAM_ESSecurity_PFX

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_PFX "cPFX"

File: PubSecHFT.h

Line: 1144

PARAM_ESSecurity_RDN

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_RDN "oRDN"

File: PubSecHFT.h

Line: 1145

PARAM_ESSecurity_Select

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Select "oSelect"

File: PubSecHFT.h

Line: 1152

PARAM_ESSecurity_SimplifiedUI

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_SimplifiedUI "bSimplifiedUI"

File: PubSecHFT.h

Line: 1167

PARAM_ESSecurity_Stores

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Stores "stores"

File: PubSecHFT.h

Line: 1159

PARAM_ESSecurity_Timeout

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Timeout "iTimeout"

File: PubSecHFT.h

Line: 1147

PARAM_ESSecurity_Type

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_Type "cType"

File: PubSecHFT.h

Line: 1153

PARAM_ESSecurity_URI

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_URI "cURI"

File: PubSecHFT.h

Line: 1160

PARAM_ESSecurity_UserId

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PARAM_ESSecurity_UserId "cUserId"

File: PubSecHFT.h

Line: 1161

PROP_APCab_Index

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_APCab_Index "index"

File: PubSecHFT.h

Line: 1204

PROP_APCab_Name

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_APCab_Name "text"

File: PubSecHFT.h

Line: 1203

PROP_APCab_Type

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_APCab_Type "type"

File: PubSecHFT.h

Line: 1202

PROP_APIndex

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_APIndex "apIndex"

File: PubSecHFT.h

Line: 1214

PROP_CertIdentification

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_CertIdentification "Identification"

File: PubSecHFT.h

Line: 2013

PROP_CertPolicyCab_OID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_CertPolicyCab_OID "PolicyOID"

File: PubSecHFT.h

Line: 2009

PROP_CertPolicyCab_UFName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_CertPolicyCab_UFName "PolicyUFName"

File: PubSecHFT.h

Line: 2010

PROP_ContactCab_Certs

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_Certs "Certs"

File: PubSecHFT.h

Line: 1998

PROP_ContactCab_CMS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_CMS "CMS"

File: PubSecHFT.h

Line: 1997

PROP_ContactCab_CN

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_CN "cn"

File: PubSecHFT.h

Line: 1993

PROP_ContactCab_Contact

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_Contact "Contact"

File: PubSecHFT.h

Line: 2002

PROP_ContactCab_ContactInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_ContactInfo "ContactInfo"

File: PubSecHFT.h

Line: 1996

PROP_ContactCab_EMail

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_EMail "EMail"

File: PubSecHFT.h

Line: 1994

PROP_ContactCab_Group

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_Group "Group"

File: PubSecHFT.h

Line: 2001

PROP_ContactCab_O

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_O "o"

File: PubSecHFT.h

Line: 1995

PROP_ContactCab_Policy

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_Policy "Policy"

File: PubSecHFT.h

Line: 2000

PROP_ContactCab_Trust

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ContactCab_Trust "Trust"

File: PubSecHFT.h

Line: 1999

PROP_CountryID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_CountryID "Country"

File: PubSecHFT.h

Line: 2014

PROP_DirHandlerInfo_ID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DirHandlerInfo_ID "id"

Description

(Required) A unique identifier for the directory handler. The handler is rejected if the ASAtom conflicts with one already registered.

File: PubSecHFT.h

Line: 1247

PROP_DirHandlerInfo_Name

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DirHandlerInfo_Name "name"

Description

(Required) The user interface name for the handler.

File: PubSecHFT.h

Line: 1241

PROP_DirSettingCab_Attr

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DirSettingCab_Attr "Attr"

File: PubSecHFT.h

Line: 2006

PROP_DirSettingCab_Type

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_DirSettingCab_Type "Type"

File: PubSecHFT.h

Line: 2005

PROP_EnabledID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_EnabledID "Enabled"

File: PubSecHFT.h

Line: 2016

PROP_ESCPS_NOTICE

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESCPS_NOTICE "notice"

File: PubSecHFT.h

Line: 1139

PROP_ESCPS_OID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESCPS_OID "oid"

File: PubSecHFT.h

Line: 1137

PROP_ESCPS_URL

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESCPS_URL "url"

File: PubSecHFT.h

Line: 1138

PROP_ESRDN_BIZCATEGORY

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_BIZCATEGORY "businessCategory"

File: PubSecHFT.h

Line: 1124

PROP_ESRDN_C

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_C "c"

File: PubSecHFT.h

Line: 1109

PROP_ESRDN_CITIZENSHIP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_CITIZENSHIP "countryOfCitizenship"

File: PubSecHFT.h

Line: 1131

PROP_ESRDN_CN

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_CN "cn"

File: PubSecHFT.h

Line: 1106

PROP_ESRDN_DC

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_DC "dc"

File: PubSecHFT.h

Line: 1122

PROP_ESRDN_DNQUALIFIER

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_DNQUALIFIER "dnQualifier"

File: PubSecHFT.h

Line: 1117

PROP_ESRDN_DOB

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_DOB "dateOfBirth"

File: PubSecHFT.h

Line: 1128

PROP_ESRDN_E

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_E "e"

File: PubSecHFT.h

Line: 1110

PROP_ESRDN_GENDER

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_GENDER "gender"

File: PubSecHFT.h

Line: 1130

PROP_ESRDN_GENQUALIFIER

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_GENQUALIFIER "generationQualifier"

File: PubSecHFT.h

Line: 1116

PROP_ESRDN_GIVENNAME

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_GIVENNAME "givenName"

File: PubSecHFT.h

Line: 1114

PROP_ESRDN_INITIALS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_INITIALS "initials"

File: PubSecHFT.h

Line: 1115

PROP_ESRDN_LOCALITY

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_LOCALITY "l"

File: PubSecHFT.h

Line: 1118

PROP_ESRDN_NAME

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_NAME "name"

File: PubSecHFT.h

Line: 1112

PROP_ESRDN_NAMEATBIRTH

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_NAMEATBIRTH "nameAtBirth"

File: PubSecHFT.h

Line: 1133

PROP_ESRDN_O

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_O "o"

File: PubSecHFT.h

Line: 1107

PROP_ESRDN_OU

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_OU "ou"

File: PubSecHFT.h

Line: 1108

PROP_ESRDN_POB

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_POB "placeOfBirth"

File: PubSecHFT.h

Line: 1129

PROP_ESRDN_POSTALADDR

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_POSTALADDR "postalAddress"

File: PubSecHFT.h

Line: 1127

PROP_ESRDN_POSTALCODE

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_POSTALCODE "postalCode"

File: PubSecHFT.h

Line: 1126

PROP_ESRDN_PSEUDONYM

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_PSEUDONYM "pseudonym"

File: PubSecHFT.h

Line: 1123

PROP_ESRDN_RESIDENCE

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_RESIDENCE "countryOfResidence"

File: PubSecHFT.h

Line: 1132

PROP_ESRDN_SERIALNUM

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_SERIALNUM "serialNumber"

File: PubSecHFT.h

Line: 1121

PROP_ESRDN_STATE

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_STATE "st"

File: PubSecHFT.h

Line: 1119

PROP_ESRDN_STREET

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_STREET "street"

File: PubSecHFT.h

Line: 1125

PROP_ESRDN_SURNAME

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_SURNAME "sn"

File: PubSecHFT.h

Line: 1113

PROP_ESRDN_TITLE

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ESRDN_TITLE "title"

File: PubSecHFT.h

Line: 1120

PROP_ExportDataCab_CN

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ExportDataCab_CN "cn"

File: PubSecHFT.h

Line: 1985

PROP_ExportDataCab_Contacts

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ExportDataCab_Contacts "Contacts"

File: PubSecHFT.h

Line: 1989

PROP_ExportDataCab_DirSettings

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ExportDataCab_DirSettings "DirSettings"

File: PubSecHFT.h

Line: 1990

PROP_ExportDataCab_EMail

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ExportDataCab_EMail "EMail"

File: PubSecHFT.h

Line: 1986

PROP_ExportDataCab_Filter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ExportDataCab_Filter "Filter"

File: PubSecHFT.h

Line: 1988

PROP_ExportDataCab_URL

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_ExportDataCab_URL "URL"

File: PubSecHFT.h

Line: 1987

PROP_Left

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_Left "left"

File: PubSecHFT.h

Line: 1212

PROP_LockValue_Auto

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_LockValue_Auto "auto"

File: DigSigHFT.h

Line: 451

PROP_LockValue_False

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_LockValue_False "false"

Description

LockDocument properties

File: DigSigHFT.h

Line: 449

PROP_LockValue_True

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_LockValue_True "true"

File: DigSigHFT.h

Line: 450

PROP_MDPType_AllowAll

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_MDPType_AllowAll "allowAll"

Description

Values for the mdp property of a SigInfo Object. See PSSigMDPType enum.

File: DigSigHFT.h

Line: 423

PROP_MDPType_AllowNone

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_MDPType_AllowNone "allowNone"

File: DigSigHFT.h

Line: 424

PROP_MDPType_Default

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_MDPType_Default "default"

File: DigSigHFT.h

Line: 425

PROP_MDPType_DefaultAndComments

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_MDPType_DefaultAndComments "defaultAndComments"

File: DigSigHFT.h

Line: 426

PROP_More

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_More "more"

File: PubSecHFT.h

Line: 1211

PROP_Op_Certificates

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_Op_Certificates "certificates"

File: PubSecHFT.h

Line: 1169

PROP_Op_ContactInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_Op_ContactInfo "contactInfo"

File: PubSecHFT.h

Line: 1170

PROP_PSENG_Appearances

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_Appearances "appearances"

File: PubSecHFT.h

Line: 941

PROP_PSENG_ASAtom_DefaultSubFilter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASAtom_DefaultSubFilter "SubFilter"

Description

The preferred signing format to use, specifing the value of the SubFilter. It is overridden by SeedValue and SigInfo.

File: PubSecHFT.h

Line: 1033

PROP_PSENG_ASAtom_DigSigHandlerAlias

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASAtom_DigSigHandlerAlias "DigSigHandlerAlias"

Description

The alias of the handler registered with DigSigHFT (primarily used for backward compatibility, where the handler has changed its name over time).

File: PubSecHFT.h

Line: 1023

PROP_PSENG_ASAtom_DigSigHandlerName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASAtom_DigSigHandlerName "DigSigHandlerName"

Description

The name by which this handler is to be registered with DigSigHFT.

File: PubSecHFT.h

Line: 1019

PROP_PSENG_ASAtom_PubSecHandlerAlias

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASAtom_PubSecHandlerAlias "PubSecHandlerAlias"

Description

The alias of the handler registered with PubSecHFT.

File: PubSecHFT.h

Line: 1030

PROP_PSENG_ASAtom_PubSecHandlerName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASAtom_PubSecHandlerName "PubSecHandlerName"

Description

The name by which this handler is to be registered with PubSecHFT (usually the same name as DigSig).

File: PubSecHFT.h

Line: 1027

PROP_PSENG_ASInt32_AppearanceNum

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASInt32_AppearanceNum "appearances"

Description

Return an ASInt32 indicating the number of appearances the handler has. This is used for JavaScript.

File: PubSecHFT.h

Line: 1006

PROP_PSENG_ASInt32_DirectoryNum

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASInt32_DirectoryNum "directories"

Description

Return an ASInt32 indicating the number of directories the handler has. This is used for JavaScript.

File: PubSecHFT.h

Line: 1009

PROP_PSENG_ASInt32_HandlerVersion

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ASInt32_HandlerVersion "version"

Description

Return the version of this plug-in. The handler should be careful about setting this value in relation to the build dictionary that is created. If a handler ever needs to revoke signatures that are created with a version of software that has errors, and the PreRelease flag in the build dictionary is not set, then the handler will probably need to use the value of this number.

File: PubSecHFT.h

Line: 1015

PROP_PSENG_BuildDate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_BuildDate "buildDate"

File: PubSecHFT.h

Line: 944

PROP_PSENG_CN

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_CN "loginName"

File: PubSecHFT.h

Line: 938

PROP_PSENG_CosSign

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_CosSign "signFDF"

File: PubSecHFT.h

Line: 951

PROP_PSENG_CosValidate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_CosValidate "validateFDF"

File: PubSecHFT.h

Line: 952

PROP_PSENG_Directories

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_Directories "directories"

File: PubSecHFT.h

Line: 942

PROP_PSENG_DirectoryHandlers

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_DirectoryHandlers "directoryHandlers"

File: PubSecHFT.h

Line: 943

PROP_PSENG_Exception

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_Exception "exception"

File: PubSecHFT.h

Line: 936

PROP_PSENG_ExportContact

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ExportContact "exportContact"

File: PubSecHFT.h

Line: 960

PROP_PSENG_ExportDirSettings

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ExportDirSettings "exportDirSettings"

File: PubSecHFT.h

Line: 961

PROP_PSENG_HandlerUIName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_HandlerUIName "uiName"

File: PubSecHFT.h

Line: 939

PROP_PSENG_HashAlgoRIPEMD160

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_HashAlgoRIPEMD160 "hashRIPEMD160"

Description

Return true if the handler is capable of hashing using RIPEMD160.

File: PubSecHFT.h

Line: 1001

PROP_PSENG_HashAlgoSHA224

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_HashAlgoSHA224 "hashSHA224"

Description

Return true if the handler is capable of hashing using SHA224.

File: PubSecHFT.h

Line: 995

PROP_PSENG_HashAlgoSHA256

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_HashAlgoSHA256 "hashSHA256"

Description

Return true if the handler is capable of hashing using SHA256.

File: PubSecHFT.h

Line: 993

PROP_PSENG_HashAlgoSHA384

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_HashAlgoSHA384 "hashSHA384"

Description

Return true if the handler is capable of hashing using SHA384.

File: PubSecHFT.h

Line: 997

PROP_PSENG_HashAlgoSHA512

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_HashAlgoSHA512 "hashSHA512"

Description

Return true if the handler is capable of hashing using SHA152.

File: PubSecHFT.h

Line: 999

PROP_PSENG_ImportContact

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ImportContact "importContact"

File: PubSecHFT.h

Line: 958

PROP_PSENG_ImportDirSettings

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ImportDirSettings "importDirSettings"

File: PubSecHFT.h

Line: 959

PROP_PSENG_IsLoggedOn

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_IsLoggedOn "isLoggedIn"

File: PubSecHFT.h

Line: 955

PROP_PSENG_PDDecrypt

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDDecrypt "docDecrypt"

File: PubSecHFT.h

Line: 954

PROP_PSENG_PDEncrypt

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDEncrypt "docEncrypt"

File: PubSecHFT.h

Line: 953

PROP_PSENG_PDSignAuthor

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDSignAuthor "signAuthor"

File: PubSecHFT.h

Line: 949

PROP_PSENG_PDSignCustomAP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDSignCustomAP "signCustomAP"

File: PubSecHFT.h

Line: 956

PROP_PSENG_PDSignInvisible

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDSignInvisible "signInvisible"

File: PubSecHFT.h

Line: 948

PROP_PSENG_PDSignValidate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDSignValidate "signValidate"

File: PubSecHFT.h

Line: 950

PROP_PSENG_PDSignVisible

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_PDSignVisible "signVisible"

File: PubSecHFT.h

Line: 947

PROP_PSENG_ProfilePath

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_ProfilePath "loginPath"

File: PubSecHFT.h

Line: 937

PROP_PSENG_SignFormatETSIPAdES

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatETSIPAdES "signETSIPAdES"

Description

Return true if the handler is capable of signing and verifying ETSI.PAdES signatures. The handler is then required to support ETSI.CAdES.detached signatures.

File: PubSecHFT.h

Line: 971

PROP_PSENG_SignFormatETSIPAdESDigest

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatETSIPAdESDigest "signETSIPAdESDetachedDigest"

Description

Return true if the handler must do its own digesting when signing and verifying ETSI.CAdES.detached signatures (the handler cannot directly sign the digest).

File: PubSecHFT.h

Line: 983

PROP_PSENG_SignFormatETSIRFC3161

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatETSIRFC3161 "signETSIRFC3161"

Description

Return true if the handler is capable of signing and verifying ETSI.RFC3161 (Timestamp) signatures. The handler is then required to support ETSI.RFC3161 signatures.

File: PubSecHFT.h

Line: 974

PROP_PSENG_SignFormatETSIRFC3161Digest

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatETSIRFC3161Digest "signETSIRFC3161Digest"

Description

Return true if the handler must do its own digesting when signing and verifying ETSI.RFC3161 timestamp signatures (the handler cannot directly sign the digest).

File: PubSecHFT.h

Line: 986

PROP_PSENG_SignFormatPKCS1

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatPKCS1 "signPKCS1"

Description

Return true if the handler is capable of signing and verifying PKCS#1 signatures. The handler is then required to support adbe.x509.rsa_sha1 signatures.

File: PubSecHFT.h

Line: 965

PROP_PSENG_SignFormatPKCS1Digest

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatPKCS1Digest "signPKCS1Digest"

Description

Return true if the handler must do its own digesting when signing and verifying adbe.x509.rsa_sha1 signatures (the handler cannot directly sign the digest).

File: PubSecHFT.h

Line: 977

PROP_PSENG_SignFormatPKCS7

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatPKCS7 "signPKCS7"

Description

Return true if the handler is capable of signing and verifying PKCS#7 signatures. The handler is then required to support both adbe.pkcs7.sha1 and adbe.pkcs7.detached formats.

File: PubSecHFT.h

Line: 968

PROP_PSENG_SignFormatPKCS7DetachedDigest

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_SignFormatPKCS7DetachedDigest "signPKCS7DetachedDigest"

Description

Return true if the handler must do its own digesting when signing and verifying adbe.pkcs7.detached signatures (the handler cannot directly sign the digest).

File: PubSecHFT.h

Line: 980

PROP_PSENG_Text_HandlerVersion

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_Text_HandlerVersion "version"

File: PubSecHFT.h

Line: 940

PROP_PSENG_UserInterface

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_PSENG_UserInterface "userInterface"

File: PubSecHFT.h

Line: 957

PROP_Reasons

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_Reasons "reasons"

File: PubSecHFT.h

Line: 1210

PROP_SigBuild_PreRelease

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigBuild_PreRelease "PreRelease"

Description

Indicates if the signature was created by pre-release software. Its default value is false.

File: PubSecHFT.h

Line: 1199

PROP_SigBuild_V

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigBuild_V "V"

Description

Signature properties that are written to the build dictionary. These property names exactly match the corresponding build dictionary names. These are used in PSSigSigPropParamsRec.outNewSigBuildCab Handlers can specify custom sig properties. These should be named using format ACME_MyProperty, where ACME is the abbreviated company name. Signature dictionary formatting version number, for specific/private use by the handler. The handler may use this to determine whether the handler supports verification of this signature. Set it to 0 if it is unused.

File: PubSecHFT.h

Line: 1197

PROP_SigInfo_Appearance

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Appearance "appearance"

Description

write-only

File: DigSigHFT.h

Line: 391

PROP_SigInfo_AppRightsAnnots

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsAnnots "appRightsAnnots"

File: DigSigHFT.h

Line: 432

PROP_SigInfo_AppRightsAnnotsEx

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsAnnotsEx "appRightsAnnotsEx"

File: DigSigHFT.h

Line: 434

PROP_SigInfo_AppRightsDoc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsDoc "appRightsDocument"

Description

Ubiquity Rights array of ASText. See PDF Reference.

File: DigSigHFT.h

Line: 429

PROP_SigInfo_AppRightsEF

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsEF "appRightsEF"

File: DigSigHFT.h

Line: 435

PROP_SigInfo_AppRightsForm

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsForm "appRightsForm"

File: DigSigHFT.h

Line: 430

PROP_SigInfo_AppRightsFormEx

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsFormEx "appRightsFormEx"

File: DigSigHFT.h

Line: 433

PROP_SigInfo_AppRightsSignature

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_AppRightsSignature "appRightsSignature"

File: DigSigHFT.h

Line: 431

PROP_SigInfo_BuildInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_BuildInfo "buildInfo"

File: DigSigHFT.h

Line: 420

PROP_SigInfo_ByteRange

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_ByteRange "byteRange"

Description

array of ASInt32

File: DigSigHFT.h

Line: 406

PROP_SigInfo_Certificates

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Certificates "certificates"

Description

ESObjects properties. Implemented in PubSec.

File: DigSigHFT.h

Line: 419

PROP_SigInfo_ContactInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_ContactInfo "contactInfo"

Description

ASText properties used only for Public key signatures

File: DigSigHFT.h

Line: 389

PROP_SigInfo_DataSigSignerStatusText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_DataSigSignerStatusText "dataSigSignerText"

File: DigSigHFT.h

Line: 375

PROP_SigInfo_DataSigStatusText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_DataSigStatusText "dataSigText"

File: DigSigHFT.h

Line: 374

PROP_SigInfo_Date

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Date "date"

Description

in PDF date format

File: DigSigHFT.h

Line: 371

PROP_SigInfo_DateTrusted

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_DateTrusted "dateTrusted"

Description

boolean indicating if date is from a trusted source, new in A7

File: DigSigHFT.h

Line: 439

PROP_SigInfo_docValidity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_docValidity "docValidity"

Description

result of byte range test (value is DSSigValState)

File: DigSigHFT.h

Line: 408

PROP_SigInfo_Handler

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Handler "handlerName"

Description

name specifed by /Filter

File: DigSigHFT.h

Line: 379

PROP_SigInfo_HandlerUIName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_HandlerUIName "handlerUIName"

File: DigSigHFT.h

Line: 380

PROP_SigInfo_HandlerUserName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_HandlerUserName "handlerUserName"

Description

same as handlerUIName

File: DigSigHFT.h

Line: 382

PROP_SigInfo_HashAlgo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_HashAlgo "digestMethod"

File: DigSigHFT.h

Line: 396

PROP_SigInfo_idPrivValidity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_idPrivValidity "idPrivValidity"

Description

result of handler id validity test (value is handler specific)

File: DigSigHFT.h

Line: 414

PROP_SigInfo_idValidity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_idValidity "idValidity"

Description

result of id validity test (value is DSSigValState)

File: DigSigHFT.h

Line: 412

PROP_SigInfo_Location

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Location "location"

File: DigSigHFT.h

Line: 369

PROP_SigInfo_MDP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_MDP "mdp"

File: DigSigHFT.h

Line: 386

PROP_SigInfo_Name

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Name "name"

Description

ASText properties

File: DigSigHFT.h

Line: 367

PROP_SigInfo_NumFieldsAltered

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_NumFieldsAltered "numFieldsAltered"

File: DigSigHFT.h

Line: 403

PROP_SigInfo_NumFieldsFilledIn

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_NumFieldsFilledIn "numFieldsFilledIn"

File: DigSigHFT.h

Line: 404

PROP_SigInfo_NumPagesAltered

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_NumPagesAltered "numPagesAltered"

File: DigSigHFT.h

Line: 402

PROP_SigInfo_NumRevisions

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_NumRevisions "numRevisions"

File: DigSigHFT.h

Line: 400

PROP_SigInfo_objValidity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_objValidity "objValidity"

Description

result of MDP test (value is DSSigValState)

File: DigSigHFT.h

Line: 410

PROP_SigInfo_Password

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Password "password"

Description

write-only

File: DigSigHFT.h

Line: 393

PROP_SigInfo_Reason

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Reason "reason"

File: DigSigHFT.h

Line: 368

PROP_SigInfo_RevInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_RevInfo "revInfo"

File: DigSigHFT.h

Line: 444

PROP_SigInfo_RevInfo_CRL

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_RevInfo_CRL "CRL"

File: DigSigHFT.h

Line: 446

PROP_SigInfo_RevInfo_OCSP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_RevInfo_OCSP "OCSP"

File: DigSigHFT.h

Line: 445

PROP_SigInfo_Revision

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Revision "revision"

Description

ASInt32 properties

File: DigSigHFT.h

Line: 399

PROP_SigInfo_SignFormat

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_SignFormat "subFilter"

File: DigSigHFT.h

Line: 394

PROP_SigInfo_SigValue

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_SigValue "sigValue"

Description

binary properties

File: DigSigHFT.h

Line: 442

PROP_SigInfo_Status

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Status "status"

File: DigSigHFT.h

Line: 401

PROP_SigInfo_StatusText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_StatusText "statusText"

File: DigSigHFT.h

Line: 376

PROP_SigInfo_Subfilter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_Subfilter "subFilter"

File: DigSigHFT.h

Line: 377

PROP_SigInfo_TimeStamp

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_TimeStamp "timeStamp"

File: DigSigHFT.h

Line: 395

PROP_SigInfo_trustFlags

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_trustFlags "trustFlags"

Description

contains a PSSigTrust, which is defined in PubSecHFT.h

File: DigSigHFT.h

Line: 416

PROP_SigInfo_VerifyDate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_VerifyDate "verifyDate"

Description

in PDF date format, new in A7

File: DigSigHFT.h

Line: 373

PROP_SigInfo_VerifyHandler

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_VerifyHandler "verifyHandlerName"

Description

name of handler used to validate signature

File: DigSigHFT.h

Line: 384

PROP_SigInfo_VerifyHandlerUIName

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigInfo_VerifyHandlerUIName "verifyHandlerUIName"

File: DigSigHFT.h

Line: 385

PROP_SigProp_AuthTime

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_AuthTime "Prop_AuthTime"

File: PubSecHFT.h

Line: 1184

PROP_SigProp_AuthType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_AuthType "Prop_AuthType"

File: PubSecHFT.h

Line: 1183

PROP_SigProp_ContactInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_ContactInfo "ContactInfo"

File: PubSecHFT.h

Line: 1180

PROP_SigProp_Date

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_Date "M"

File: PubSecHFT.h

Line: 1181

PROP_SigProp_Filter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_Filter "Filter"

File: PubSecHFT.h

Line: 1182

PROP_SigProp_Location

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_Location "Location"

File: PubSecHFT.h

Line: 1179

PROP_SigProp_MDP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_MDP "Prop_MDP"

File: PubSecHFT.h

Line: 1185

PROP_SigProp_Name

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_Name "Name"

Description

Signature properties that are written to the signature dictionary. These property names exactly match the corresponding signature dictionary names. These are used in PSSigSigPropParamsRec.outNewSigPropCab. Handlers can specify custom signature properties. These should be named using the format ACME_Prop_MyProperty, where ACME is the abbreviated company name.

File: PubSecHFT.h

Line: 1177

PROP_SigProp_PDFMinorVersion

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_PDFMinorVersion "PDFMinorVersion"

File: PubSecHFT.h

Line: 1187

PROP_SigProp_Reason

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigProp_Reason "Reason"

File: PubSecHFT.h

Line: 1178

PROP_SigSeedValue_AppearanceFilter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_AppearanceFilter "appearanceFilter"

Description

Appearance filter.

File: DigSigHFT.h

Line: 516

PROP_SigSeedValue_Attestations

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_Attestations "legalAttestations"

Description

An ASText array of legal attestations for MDP signing.

File: DigSigHFT.h

Line: 512

PROP_SigSeedValue_DigestMethod

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_DigestMethod "digestMethod"

Description

A string specifying the hashing algorithm.

File: DigSigHFT.h

Line: 504

PROP_SigSeedValue_Filter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_Filter "filter"

Description

An ASAtom giving the name of the required handler to use when signing.

File: DigSigHFT.h

Line: 500

PROP_SigSeedValue_Flags

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_Flags "flags"

Description

ASInt32 flags.

File: DigSigHFT.h

Line: 518

PROP_SigSeedValue_Lock

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_Lock "lockDocument"

Description

Lock properties.

File: DigSigHFT.h

Line: 514

PROP_SigSeedValue_MDP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_MDP "mdp"

Description

A string giving the Modification Detection and Prevention (MDP) parameters.

File: DigSigHFT.h

Line: 510

PROP_SigSeedValue_Reasons

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_Reasons "reasons"

Description

An ASText array of reasons for signing.

File: DigSigHFT.h

Line: 508

PROP_SigSeedValue_SubFilter

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_SubFilter "subFilter"

Description

An ASAtom array giving the names of acceptable signing formats.

File: DigSigHFT.h

Line: 502

PROP_SigSeedValue_Version

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigSeedValue_Version "version"

Description

A double indicating the required revision of the handler.

File: DigSigHFT.h

Line: 506

PROP_SigVal_Author

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Author "auth"

File: PubSecHFT.h

Line: 673

PROP_SigVal_AuthSig

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_AuthSig "authSig"

File: PubSecHFT.h

Line: 671

PROP_SigVal_Data

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Data "data"

File: PubSecHFT.h

Line: 675

PROP_SigVal_Digest

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Digest "digest"

File: PubSecHFT.h

Line: 665

PROP_SigVal_Doc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Doc "doc"

File: PubSecHFT.h

Line: 666

PROP_SigVal_DS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_DS "ds"

File: PubSecHFT.h

Line: 664

PROP_SigVal_FDF

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_FDF "fdf"

File: PubSecHFT.h

Line: 676

PROP_SigVal_Id

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Id "id"

File: PubSecHFT.h

Line: 668

PROP_SigVal_IdPriv

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_IdPriv "idPriv"

File: PubSecHFT.h

Line: 669

PROP_SigVal_IdPrivText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_IdPrivText "idPrivText"

File: PubSecHFT.h

Line: 670

PROP_SigVal_Mod

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Mod "mod"

File: PubSecHFT.h

Line: 672

PROP_SigVal_Obj

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Obj "obj"

File: PubSecHFT.h

Line: 667

PROP_SigVal_TrustFlags

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_TrustFlags "trustFlags"

File: PubSecHFT.h

Line: 677

PROP_SigVal_Ubiquity

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SigVal_Ubiquity "ubiquity"

File: PubSecHFT.h

Line: 674

PROP_SourceID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_SourceID "Source"

File: PubSecHFT.h

Line: 2015

PROP_Top

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_Top "top"

File: PubSecHFT.h

Line: 1213

PROP_VisibleID

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PROP_VisibleID "Viewable"

File: PubSecHFT.h

Line: 2017

PS_SIG_MAX_SIZE

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PS_SIG_MAX_SIZE 2097152

Description

The maximum size of the binary signature blob in bytes.

File: PubSecHFT.h

Line: 72

PubSecHFT_NUMSELECTORS

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax


#define PubSecHFT_NUMSELECTORS (PubSecHFTNUMSELECTORSPlusOne - 1)

File: PubSecHFT.h

Line: 1976

Typedefs Detail

APPreview

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_APPreviewRec APPreview;

File: PubSecHFT.h

Line: 1099

APPreviewRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_APPreviewRec APPreviewRec;

File: PubSecHFT.h

Line: 1099

DirAuthenticationContext

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirAuthenticationContext;

An ASCab object containing authentication details such as the user name and password. It could be used to override the default authentication entries, or to avoid repeated authentications in case the context could be cached. The actual contents depend on the directory handlers. The currently supported directory handlers (AAB and LDAP) do not support this feature.

See Also

PSOpenConnection

File: PubSecHFT.h

Line: 1257

DirDSP

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* DirDSP;

Directory Service Provider (DSP) Object. As of Acrobat 6.0 this is a PubSecEngine object that acts as a DSP. In future releases this may become a stand-alone structure.

File: PubSecHFT.h

Line: 1224

DirHandlerInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirHandlerInfo;

A directory handler information ASCab contains a vector of nested ASCab objects, one for every directory handler contained within the engine. Each directory handler ASCab contains a user interface name and a unique ID (for example, "Adobe.PPKMS.LDAP").

See Also

PSGetDirHandlerInfo

File: PubSecHFT.h

Line: 1238

DSAPFile

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct CAPIconFile* DSAPFile;

A signature appearance file object to be used by handlers to access the built-in APIcon appearance handler.

See Also

DSAPFileAcquire

File: PubSecHFT.h

Line: 86

DSRetCode

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 DSRetCode;

Return values of DS calls (DSRetCode, or ASInt32). All negative return values are considered exceptions. If the value is kDSException, exception text should be available from the called routine. If this exception text is NULL, it should be considered an unknown error.

File: DigSigHFT.h

Line: 333

PSDataBuffer

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _s_PSDataBufferRec* PSDataBuffer;

File: PubSecHFT.h

Line: 152

PSDataBufferRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _s_PSDataBufferRec PSDataBufferRec;

A buffer of data to be hashed when signing or verifying signatures. The buffer contains the bytes to be signed (by ByteRange) when signing a PDF file.

See Also

PSDataBufferDigest
PSDataBufferEnum

File: PubSecHFT.h

Line: 152

PSExportDataExchangeParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSExportDataExchangeParamsRec PSExportDataExchangeParams;

File: PubSecHFT.h

Line: 2125

PSExportDataExchangeParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSExportDataExchangeParamsRec PSExportDataExchangeParamsRec;

File: PubSecHFT.h

Line: 2125

PSImportDataExchangeParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSImportDataExchangeParamsRec PSImportDataExchangeParams;

File: PubSecHFT.h

Line: 2033

PSImportDataExchangeParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSImportDataExchangeParamsRec PSImportDataExchangeParamsRec;

File: PubSecHFT.h

Line: 2033

PSImportDataParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSImportDataParamsRec PSImportDataParams;

File: PubSecHFT.h

Line: 868

PSImportDataParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSImportDataParamsRec PSImportDataParamsRec;

File: PubSecHFT.h

Line: 868

PSOpenCMSEnvelopeParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSOpenCMSEnvelopeParamsRec PSOpenCMSEnvelopeParams;

File: PubSecHFT.h

Line: 632

PSOpenCMSEnvelopeParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSOpenCMSEnvelopeParamsRec PSOpenCMSEnvelopeParamsRec;

File: PubSecHFT.h

Line: 632

PSSigCosDocParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigCosDocParamsRec PSSigCosDocParams;

File: PubSecHFT.h

Line: 562

PSSigCosDocParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigCosDocParamsRec PSSigCosDocParamsRec;

File: PubSecHFT.h

Line: 562

PSSigDataBufferParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigDataBufferParamsRec PSSigDataBufferParams;

File: PubSecHFT.h

Line: 579

PSSigDataBufferParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigDataBufferParamsRec PSSigDataBufferParamsRec;

File: PubSecHFT.h

Line: 579

PSSigGetSigValueParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigGetSigValueParamsRec PSSigGetSigValueParams;

File: PubSecHFT.h

Line: 375

PSSigGetSigValueParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigGetSigValueParamsRec PSSigGetSigValueParamsRec;

File: PubSecHFT.h

Line: 375

PSSigPDDocParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigPDDocParamsRec PSSigPDDocParams;

File: PubSecHFT.h

Line: 546

PSSigPDDocParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigPDDocParamsRec PSSigPDDocParamsRec;

File: PubSecHFT.h

Line: 546

PSSigSignReportParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigSignReportParamsRec PSSigSignReportParams;

File: PubSecHFT.h

Line: 640

PSSigSignReportParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigSignReportParamsRec PSSigSignReportParamsRec;

File: PubSecHFT.h

Line: 640

PSSigSigPropParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigSigPropParamsRec PSSigSigPropParams;

File: PubSecHFT.h

Line: 345

PSSigSigPropParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigSigPropParamsRec PSSigSigPropParamsRec;

File: PubSecHFT.h

Line: 345

PSSigTrust

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 PSSigTrust;

Bit flag constants that specify a level of trust for a certificate.

See Also

AABGetTrustedCerts
PSImportDataParams

File: PubSecHFT.h

Line: 735

PSSigValidateDialogParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigValidateDialogParamsRec PSSigValidateDialogParams;

File: PubSecHFT.h

Line: 520

PSSigValidateDialogParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigValidateDialogParamsRec PSSigValidateDialogParamsRec;

File: PubSecHFT.h

Line: 520

PSSigValidateParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigValidateParamsRecRec PSSigValidateParams;

File: PubSecHFT.h

Line: 461

PSSigValidateParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigValidateParamsRecRec PSSigValidateParamsRec;

File: PubSecHFT.h

Line: 461

PSSigValidateSupportParams

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigValidateSupportParamsRec PSSigValidateSupportParams;

File: PubSecHFT.h

Line: 392

PSSigValidateSupportParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PSSigValidateSupportParamsRec PSSigValidateSupportParamsRec;

File: PubSecHFT.h

Line: 392

PubSecEngine

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* PubSecEngine;

A PubSec engine object. There can be multiple engine objects per handler.

File: PubSecHFT.h

Line: 79

PubSecHandler

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PubSecHandlerRec PubSecHandler;

File: PubSecHFT.h

Line: 1962

PubSecHandlerRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PubSecHandlerRec PubSecHandlerRec;

File: PubSecHFT.h

Line: 1962

Enumeration Detail

DSDigestMethod

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSDigestMethod {

  kDSDigestNone = 0,


 


  kDSDigestMD5,


 


  kDSDigestSHA1,


 


  kDSDigestSHA256,


 


  kDSDigestSHA384,


 


  kDSDigestSHA512,


 


  kDSDigestRIPEMD160,


 


  kDSDigestSHA224,


 


  kDSDigestEnumSize

}

File: DigSigHFT.h

Line: 735

DSSaveType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSaveType {

  DSSignCancel = 0,


 


  DSSignSave,


 


  DSSignSaveAs,


 


  DSSaveTypeEnumSize

}

File: DigSigHFT.h

Line: 721

Elements

	DSSignCancel	Do not proceed with signing.

	DSSignSave	Save over old file.

	DSSignSaveAs	Save into new file.

	DSSaveTypeEnumSize	No save option is specified (new in Acrobat 6). The size of the `DSSaveType` enumeration.

DSSigValState

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSigValState {

  kDSSigValUnknown = 0,


 


  kDSSigValUnknownTrouble,


 


  kDSSigValUnknownBytesNotReady,


 


  kDSSigValInvalidTrouble,


 


  kDSSigValUnused,


 


  kDSSigValJustSigned,


 


  kDSSigValFalse,


 


  kDSSigValTrue,


 


  kDSSigValEnumSize

}

File: DigSigHFT.h

Line: 462

Elements

	kDSSigValUnknown	Validity is not yet determined.

	kDSSigValUnknownTrouble	Validity could not be determined because of error.

	kDSSigValUnknownBytesNotReady	Validity could not be determined because all bytes are not ready.

	kDSSigValInvalidTrouble	Validation has been attempted, but there were errors that meant the signature could not be validated, with the conclusion that the result is invalid.

	kDSSigValUnused	Validity for this digest is not used (for example, there is no document validity if there is no byte range).

	kDSSigValJustSigned	The signature was just signed, so it is implicitly valid.

	kDSSigValFalse	The signature document/object digest is invalid.

	kDSSigValTrue	The signature document/object digest is valid.

	kDSSigValEnumSize	The size of the `DSSigValState` enumeration.

DSSigValText

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum DSSigValText {

  kDSSigValTextNull,


 


  kDSSigValTextDSTop,


 


  kDSSigValTextDSDetail,


 


  kDSSigValTextDSTooltip,


 


  kDSSigValTextSigInfo,


 


  kDSSigValTextVal,


 


  kDSSigValTextProp,


 


  kDSSigValTextAP,


 


  kDSSigValTextPropIdValidity,


 


  kDSSigValTextDSAVIdValidity,


 


  kDSSigValTextDSTTIdValidity,


 


  kDSSigValTextEnumSize

}

File: PubSecHFT.h

Line: 690

Elements

	kDSSigValTextNull	Never called. It should return `NULL`.

	kDSSigValTextDSDetail	(Optional) Get text to show in the AVPanel, shown in the signature detail title line.

	kDSSigValTextDSTooltip	(Optional) Get text to show in the tooltip when the mouse is over the signature annotation.

	kDSSigValTextSigInfo	(Optional) Get text to show in the EScript SignatureInfo object.

	kDSSigValTextVal	(Optional) Get text to show in the validate alert dialog.

	kDSSigValTextProp	(Optional) Get text to show in the signature properties dialog.

	kDSSigValTextAP	(Optional) Get text to show in the appearance, if the signature appearance uses layer n4 (not recommended). In this case, you must also pass an index.

	kDSSigValTextDSAVIdValidity	Get text to describe the validity of the signer certificate (used in AVPanel).

	kDSSigValTextDSTTIdValidity	Get text to describe the validity of the signer certificate (appended to the tooltip, and called only when describing why the certificate is invalid).

PSAPSigType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSAPSigType {

  kPSAPSigPreExists = 0,


 


  kPSAPSigTentative,


 


  kPSAPSigPreview

}

See Also

PSSigCreateAPNXObjProc

File: PubSecHFT.h

Line: 133

Elements

	kPSAPSigPreExists	Signing a prexisting signature field.

	kPSAPSigTentative	Creating a signature, on the fly, on a page.

	kPSAPSigPreview	Creating a preview of a signature.

PSDecryptionReason

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSDecryptionReason {

  kPSDecryptionReasonUnspecified = 0,


 


  kPSDecryptingDocument,


 


  kPSDecryptingAttachment,


 


  kPSDecryptingBatchCommand

}

File: PubSecHFT.h

Line: 582

PSExportDataType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSExportDataType {

  kPSExportDataNone = 0,


 


  kPSExportDataMyContact,


 


  kPSExportDataContacts,


 


  kPSExportDataDirSettings,


 


  kPSExportDataEnumSize

}

See Also

PSExportDataProc
PSExportDataExchange

File: PubSecHFT.h

Line: 875

Elements

	kPSExportDataNone	None. No export operation is performed.

	kPSExportDataMyContact	Export certificates for self. This operation is performed only if the PROP_PSENG_ExportContact property is set, indicating that the handler supports this format.

	kPSExportDataDirSettings	Export a list of directory settings. This operation is performed only if the PROP_PSENG_ExportDirSettings property is set, indicating that the handler supports this format.

	kPSExportDataEnumSize	The enum size.

PSExportDestType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSExportDestType {

  kPSExportDestNone = 0,


 


  kPSExportDestFile,


 


  kPSExportDestCMSFile,


 


  kPSExportDestCertFile,


 


  kPSExportDestFDFFile,


 


  kPSExportDestEMailFDF,


 


  kPSExportDestCertURL,


 


  kPSExportDestEnumSize

}

See Also

PSExportDataProc
PSExportDataExchange

File: PubSecHFT.h

Line: 907

Elements

	kPSExportDestNone	None. Prompt for the output file type. This is recommended.

	kPSExportDestFile	Save as an unspecified file type, possibly prompting for the file type.

	kPSExportDestCMSFile	Save as a CMS file (.p7c).

	kPSExportDestCertFile	Save as a Certificate file (.cer).

	kPSExportDestFDFFile	Save as an FDF file.

	kPSExportDestEMailFDF	Email an FDF file.

	kPSExportDestCertURL	Send a single certificate to the URL.

PSImportDataType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSImportDataType {

  kPSImportDataNone = 0,


 


  kPSImportDataContactsCab,


 


  kPSImportDataContactsCabFromSig,


 


  kPSImportDataDirsCab,


 


  kPSImportDataEnumSize

}

File: PubSecHFT.h

Line: 832

Elements

	kPSImportDataNone	None. No import operation is performed.

	kPSImportDataContactsCab	An ASCab containing a list (`"0", "1", ...`) of contact cabs. Contact cabs have the entries PROP_ContactCab_*.

	kPSImportDataContactsCabFromSig	An ASCab containing a list (`"0", "1", ...`) containing a single contact cab. This Contact cab will have only the PROP_ContactCab_Certs entry set. This is sent only when trusting the signer of a signature.

	kPSImportDataDirsCab	An ASCab containing a list (`"0", "1", ...`) of directory setting cabs, which have the entries `PROP_DirSettingCab_*`.

	kPSImportDataEnumSize	The size of the PSImportDataType.

PSPerformOpType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSPerformOpType {

  kPSOpPerformNone = 0,


 


  kPSOpPerformESLogin,


 


  kPSOpPerformESLogout,


 


  kPSOpPerformESNewUser,


 


  kPSOpPerformESSetValidateMethod,


 


  kPSOpPerformESPasswordTimeout,


 


  kPSOpPerformDisplayCertList,


 


  kPSOpPerformGetCerts,


 


  kPSOpPerformGetStores,


 


  kPSOpPerformEnumSize

}

See Also

PSPerformOperationProc

File: PubSecHFT.h

Line: 1047

Elements

	kPSOpPerformNone	None

	kPSOpPerformESLogin	Silent scripted operation. Access/select the file/store containing digital IDs.

	kPSOpPerformESLogout	Silent scripted operation. Deaccess the file/store containing digital IDs.

	kPSOpPerformESNewUser	Silent scripted operation. Create a new self-sign digital ID.

	kPSOpPerformESSetValidateMethod	Silent scripted operation. Deprecated.

	kPSOpPerformESPasswordTimeout	Silent scripted operation. Set the password timeout policy.

	kPSOpPerformDisplayCertList	Brings up a user interface to display a list of certificates contained in an ASCab. It returns `true` if it is implemented by the handler.

	kPSOpPerformGetCerts	Returns a list of certificates in an ASCab.

	kPSOpPerformGetStores	Returns a list of credential stores.

PSSessionOpType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSessionOpType {

  kPSOpTypeNone = 0,


 


  kPSOpTypePDDocSign,


 


  kPSOpTypePDDocSigValidate,


 


  kPSOpTypeCosDocSign,


 


  kPSOpTypeCosDocSigValidate,


 


  kPSOpTypeDataSign,


 


  kPSOpTypeDataSigValidate,


 


  kPSOpTypeMyContactExport,


 


  kPSOpTypeContactImport,


 


  kPSOpTypePolicyModify,


 


  kPSOpTypeAPRead,


 


  kPSOpTypePDCryptDocCreate,


 


  kPSOpTypePDCryptDocOpen,


 


  kPSOpTypeLogin,


 


  kPSOpTypeLogout,


 


  kPSOpTypeCertEnum,


 


  kPSOpTypeDirEnum,


 


  kPSOpTypeDirGet,


 


  kPSOpTypeStoreEnum

}

File: PubSecHFT.h

Line: 89

Elements

	kPSOpTypeNone	None

	kPSOpTypePDDocSign	Sign a PDDoc to create a PDDoc signature.

	kPSOpTypePDDocSigValidate	Validate a PDDoc signature.

	kPSOpTypeCosDocSign	Sign a CosDoc.

	kPSOpTypeCosDocSigValidate	Validate a CosDoc signature.

	kPSOpTypeDataSign	Sign bytes.

	kPSOpTypeDataSigValidate	Validate bytes.

	kPSOpTypeMyContactExport	Read and export My Contact information.

	kPSOpTypeContactImport	Import contacts into address book.

	kPSOpTypePolicyModify	Modify credential access policy (used by EScript).

	kPSOpTypeAPRead	Read an appearance file (used by EScript).

	kPSOpTypePDCryptDocCreate	Prepare to encrypt documents.

	kPSOpTypePDCryptDocOpen	Prepare to open encrypted documents.

	kPSOpTypeLogin	Authenticate or login user (used by EScript).

	kPSOpTypeLogout	De-authenticate or logout user (used by EScript).

	kPSOpTypeCertEnum	Enumerate certificates available for signing and encryption.

	kPSOpTypeDirEnum	Enumerate directories and get directory information.

	kPSOpTypeDirGet	Connect to and use a directory.

PSSigDialogStatus

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSigDialogStatus {

  kPSSigDialogNone = 0,


 


  kPSSigDialogSign,


 


  kPSSigDialogSignWithPassword,


 


  kPSSigDialogSignThenAuthenticate,


 


  kPSSigDialogStatusEnumSize

}

File: PubSecHFT.h

Line: 236

Elements

	kPSSigDialogNone	No further dialogs are required.

	kPSSigDialogSign	PubSec's sign dialog box should be executed.

	kPSSigDialogSignWithPassword	PubSec's sign dialog box should be executed, and should ask for a password.

	kPSSigDialogSignThenAuthenticate	PubSec's sign dialog box should be executed, then SigAuthenticate() should be called.

	kPSSigDialogStatusEnumSize	The size of the PSSigDialogStatus enum.

PSSigDocType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSigDocType {

  kPSSigDocTypeNone = 0,


 


  kPSSigDocTypePDDoc,


 


  kPSSigDocTypeCosDoc,


 


  kPSSigDocTypeTransData,


 


  kPSSigDocTypeEnumSize

}

File: PubSecHFT.h

Line: 173

PSSigFileType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSigFileType {

  kPSFileNone = 0,


 


  kPSFileAVDoc,


 


  kPSFileBrowserDoc,


 


  kPSFileExternalDoc,


 


  kPSFileTempDoc,


 


  kPSFileFDFData,


 


  kPSFileCosDoc,


 


  kPSFileTransData,


 


  kPSFileEnumSize

}

See Also

PSSigSigPropParams

File: PubSecHFT.h

Line: 190

Elements

	kPSFileNone	Uninitialized.

	kPSFileAVDoc	Normal PDDoc signing. Enable the Save and SaveAs buttons.

	kPSFileBrowserDoc	External browser window. Enable the Sign button.

	kPSFileExternalDoc	External non-browser window. Enable the Sign button.

	kPSFileTempDoc	Temp file. Enable the SaveAs button.

	kPSFileFDFData	Signing an FDF Data Exchange file. Enable the Sign button.

	kPSFileCosDoc	Signing a CosDoc. Enable the Sign button.

	kPSFileTransData	Signing transactional data.

PSSigMethod

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSigMethod {

  kPSSigMethodNone = 0,


 


  kPSSigMethodPKCS1,


 


  kPSSigMethodPKCS7Detached,


 


  kPSSigMethodPKCS7SHA1,


 


  kPSSigMethodETSICADES,


 


  kPSSigMethodETSIDocTimestamp,


 


  kPSSigMethodEnumSize

}

File: PubSecHFT.h

Line: 216

Elements

	kPSSigMethodNone	None

	kPSSigMethodPKCS1	`PKCS#1`, `adbe.x509.rsa.sha1`

	kPSSigMethodPKCS7Detached	`adbe.pkcs7.detached`

	kPSSigMethodPKCS7SHA1	`adbe.pkcs7.sha1`

	kPSSigMethodETSICADES	`ETSI.CAdES.detached`

	kPSSigMethodETSIDocTimestamp	`ETSI.RFC3161`

PSSigType

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSigType {

  kPSSigTypeUnknown = 0,


 


  kPSSigTypeUser,


 


  kPSSigTypeAuthor,


 


  kPSSigTypeUbiquity,


 


  kPSSigTypeEnumSize

}

File: PubSecHFT.h

Line: 155

PSSigValSupport

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PSSigValSupport {

  kPSSigValSupportFalse,


 


  kPSSigValSupportTrue,


 


  kPSSigValSupportUpdate,


 


  kPSSigValSupportPreRelease,


 


  kPSSigValSupportEnumSize

}

File: PubSecHFT.h

Line: 251

Elements

	kPSSigValSupportFalse	The handler does not support validation of this signature.

	kPSSigValSupportTrue	The handler supports validation of this signature.

	kPSSigValSupportUpdate	A handler software update is needed to support validation of this signature.

	kPSSigValSupportPreRelease	The signature was created with a pre-release or invalid release of the software. The user is warned.

	kPSSigValSupportEnumSize	The size of the PSSigValSupport enum.

Variables Detail

gPubSecHFT

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gPubSecHFT;

File: PubSecHFT.h

Line: 61

Structure Detail

_t_APPreviewRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_APPreviewRec {

  const char* logo;  


 


  ASFixedRect logoBBox;  


 


  ASText fName;  


 


  ASText fDN;  


 


  ASText fReason;  


 


  ASText fLocation;  


 


  ASFixed fWidth;  


 


  ASFixed fHeight;  


 


  bool fbAuthSig;  

}

Data with which to build a signature preview in the edit dialog box for a signature appearance file entry.

File: PubSecHFT.h

Line: 1080

Elements

	logo	The logo string.

	logoBBox	The bounding box for the logo string.

	fName	The entry name.

	fDN	The distinguished name.

	fReason	The reason for signing.

	fLocation	The location of the signature.

	fWidth	The width that determines the aspect ratio of the preview image.

	fHeight	The height that determines the aspect ratio of the preview image.

	fbAuthSig	`true` if this is an author signature, `false` otherwise.

_t_PSExportDataExchangeParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSExportDataExchangeParamsRec {

  ASSize_t size;  


 


  PubSecHandler psHandler;  


 


  PubSecEngine psEngine;  


 


  PSExportDataType dataType;  


 


  ASCab dataCab;  


 


  PSExportDataType requestType;  


 


  PSExportDestType destType;  

}

Parameters for exporting data from PubSec to a file.

The PSExportDataExchangeParamsRec.dataCab format is as follows: A top level cab will contain lists of PROP_ExportDataCab_Contacts, PROP_ExportDataCab_DirSettings or whatever other data is to be included. This top level cab can include entries for an email address (used as the return email address) and a common name (cn). It is recommended that the cn entry be set to the common name of the user; this will be used only in creating the file name for the FDF (or PKCS#7) file. If either the cn or email address is not provided, they will be fetched from the AVIdentity preference settings.

Contents of the individual list entries are added as CosDict objects to the FDF file with almost no filtering. The filtering is to add a /Type attribute and to turn /Certs entries into /CMS entries (meaning that a contact can contain a Certs entry that is a list of certificates). Refer to the FDF Data Exchange specification for details on attributes. Each contact can include a list of certificates and an email address. Contacts that contain lists of certificates will have these lists turned into a CMS object because the FDF format supports only CMS. Contacts can directly provide the CMS object if they choose. Each directory entry contains directory-specific information that can be converted to a CosDict before storing in the FDF file. File entries give device-independent paths to files that are to be embedded. PubSecHandler and PubSecEngine are used to specify the handler to use to sign the data exchange file (if it is signed at all).

Example cab for exporting MyContact:

dataCab : Cab

"Contacts" : Cab

"0" : Cab

"EMail" : "jsmith<p>----smithcorp.com"

"Certs" : Cab

"0" : binary end entity cert

"cn" : "John Smith"

"EMail" : "jsmith<p>----smithcorp.com"

Example cab for exporting directory settings:

dataCab : Cab

"DirSettings" : Cab

"0" : Cab

"Port" : 369

See Also

PSExportDataExchange

File: PubSecHFT.h

Line: 2081

Elements

size

The size of the structure.

psHandler

If exporting FDF, it is the handler to use to sign the FDF. If it is not supplied, the user is prompted for a handler.

psEngine

If exporting FDF, it is the engine to use to sign the FDF. If it is not supplied, the method uses the default (user interface) engine.

dataType

The type of data to be exported. It is one of the following values:

Value	Description
kPSExportDataNone	Not specified.
kPSExportDataMyContact	Export the user's own contact information (certificates for encryption and/or signing).
kPSExportDataContacts	Export a list of contacts from an address book or directory that are to be shared.
kPSExportDataDirSettings	Export a list of directory settings that can be used to help someone else configure his directory.

dataCab

(Required) Data to export, or an empty ASCab if there is no data to export. The format is defined below.

requestType

The type of data to be requested. If it is supplied, the method adds a request to the FDF for this data type and forces the export format to be FDF. It has the same possible values as dataType.

destType

The destination type that specifies how data should be delivered. It is one of the following values:

Value	Description
kPSExportDestNone	Not specified, prompt the user (recommended).
kPSExportDestFile	Save as unspecified file type, possibly prompting for the file type.
kPSExportDestCMSFile	Save as CMS file.
kPSExportDestFDFFile	Save as FDF file.
kPSExportDestEMailFDF	Save an email FDF file.
kPSExportDestCertURL	Send single certificate to URL.

_t_PSImportDataExchangeParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSImportDataExchangeParamsRec {

  ASSize_t size;  


 


  PubSecHandler psHandler;  


 


  PubSecEngine psEngine;  


 


  PSExportDataType dataType;  


 


  ASFileSys fileSys;  


 


  ASPathName filePath;  

}

Parameters for importing data from a file into PubSec.

File: PubSecHFT.h

Line: 2020

Elements

	size	The size of the structure.

	psHandler	The handler to use to accept the import data, if it accepts the specified type.

	psEngine	The engine to use to accept the import data. If it is not supplied, the method uses the default (user interface) engine.

	dataType	The type of data to be imported. If data of this type is not found in the FDF, the operation fails.

	fileSys	The file system used for `filePath`.

	filePath	The path of the file to be opened for import.

_t_PSImportDataParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSImportDataParamsRec {

  ASSize_t size;  


 


  PSImportDataType dataType;  


 


  ASCab dataCab;  


 


  PSSigTrust sigTrust;  

}

Parameters for importing data from a file into PubSec; it is used in PSImportDataProc().

See Also

PSImportDataProc

File: PubSecHFT.h

Line: 856

Elements

	size	The size of the structure.

	dataType	The format of the data to be imported.

	dataCab	If `dataType` is kPSImportDataSigDict, it is the signature dictionary. If `dataType` is kPSImportDataFDFImportArray, it is the import array. If `dataType` is kPSImportDataFDFDirArray, it is the directory settings array.

	sigTrust	A flag that indicates whether this data comes from a trusted source.

_t_PSOpenCMSEnvelopeParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSOpenCMSEnvelopeParamsRec {

  ASSize_t size;  


 


  ASUns8 cmsEnvelopeData;  


 


  ASUns32 cmsEnvelopeSize;  


 


  ASUns8 outEnvelopeContentsData;  


 


  ASUns32 outEnvelopeContentsSize;  


 


  ASUns8 outSessionKeyData;  


 


  ASUns32 outSessionKeySize;  


 


  ASCab outCertificates;  


 


  PSDecryptionReason inReason;  

}

Parameters that are used when opening a CMS envelope.

File: PubSecHFT.h

Line: 593

Elements

	size	The size of this structure.

	cmsEnvelopeData	(Constant) The ASN1 encoded PKCS#7 Enveloped Data to open.

	cmsEnvelopeSize	The size in bytes of the data pointed to by `cmsEnvelopeData`.

	outEnvelopeContentsData	Returns the envelope contents data. PubSec owns, allocates and frees the memory.

	outEnvelopeContentsSize	The size in bytes of the data pointed to by `cmsEnvelopeContentsData`.

	outSessionKeyData	(Optional) Returns the session key recovered when opening the envelope. If a session key is returned by the handler, PubSec uses it to open other recipient groups and enable the user to edit them.

	outSessionKeySize	The size in bytes of the data pointed to by `outSessionKeyData`.

	outCertificates	(Optional) The certificate corresponding to the private key used to open the envelope. When it is provided, PubSec displays the name of the opener when the user edits the recipient list.

	inReason	The reason why the opening of a CMS envelope is requested.

_t_PSSigCosDocParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigCosDocParamsRec {

  ASSize_t size;  


 


  PSSigDocType sigType;  


 


  PDDoc pdDoc;  


 


  CosDoc cosDoc;  

}

Signature parameters for a CosDoc. It is used internally.

File: PubSecHFT.h

Line: 551

Elements

	size	The size of the structure.

	sigType	(Constant) Always kPSSigDocTypeCosDoc.

	pdDoc	(Constant) `NULL` if there is no parent.

	cosDoc	(Constant) The document being signed.

_t_PSSigDataBufferParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigDataBufferParamsRec {

  ASSize_t size;  


 


  PSSigDocType sigType;  


 


  PDDoc pdDoc;  


 


  CosDoc cosDoc;  

}

Signature parameters for signing transitional data, such as XFA.

File: PubSecHFT.h

Line: 568

Elements

	size	The size of the structure.

	sigType	(Constant) Always kPSSigDocTypeTransData.

	pdDoc	(Constant) `NULL` if there is no parent.

	cosDoc	(Constant) The document being signed.

_t_PSSigGetSigValueParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigGetSigValueParamsRec {

  ASSize_t size;  


 


  PSSigMethod sigMethod;  


 


  DSDigestMethod digestMethod;  


 


  ASUns8 digestValue;  


 


  PSDataBuffer dataBuffer;  


 


  ASBool bGetSigValue;  


 


  ASUns8 outSigValueData;  


 


  ASUns32 outSigValueSize;  


 


  ASCab outSigPropCab;  

}

A structure containing parameters and return values for PSSigGetSigValueProc().

File: PubSecHFT.h

Line: 348

Elements

	size	The size of the structure.

	sigMethod	(Constant) The method used to create the signature value.

	digestMethod	(Constant) The method used to create the digest.

	digestValue	(Constant) A digest value to be signed, or `NULL`.

	dataBuffer	The handle to use for fetching bytes to digest.

	bGetSigValue	(Constant) If `true`, get a signature value, otherwise return the size of the signature value.

	outSigValueData	Return the signature value data. The caller will call ASfree() to destroy the structure.

	outSigValueSize	The return size of `SignatureValue`.

	outSigPropCab	Return an ASCab containing signature properties that should be displayed instead of signature dictionary entries.

_t_PSSigPDDocParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigPDDocParamsRec {

  ASSize_t size;  


 


  PSSigDocType sigType;  


 


  PDDoc pdDoc;  


 


  CosObj sigField;  


 


  CosObj sigAnnot;  


 


  ASFixed annotWidth;  


 


  ASFixed annotHeight;  


 


  ASCab sigAPCab;  

}

Validation parameters for validating a document signature or specific signature field.

File: PubSecHFT.h

Line: 528

Elements

	size	The size of the structure.

	sigType	(Constant) It is always kPSSigDocTypePDDoc.

	pdDoc	(Constant) The document being signed.

	sigField	(Constant) The field being signed.

	sigAnnot	(Constant) The annotation associated with this field.

	annotWidth	(Constant) The width of the annotion, if the signature is visible.

	annotHeight	(Constant) The height of the annotion, if the signature is visible.

	sigAPCab	Returns handler-specific appearance information for PSSigGetSigPropertiesProc().

_t_PSSigSignReportParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigSignReportParamsRec {

  ASSize_t size;  


 


  ASCab sigPropCab;  

}

File: PubSecHFT.h

Line: 635

Elements

	size	The size of this structure.

	sigPropCab	Signature properties of the signature we would like to report on.

_t_PSSigSigPropParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigSigPropParamsRec {

  ASSize_t size;  


 


  PDDoc pdDoc;  


 


  PSSigFileType fileOptions;  


 


  ASBool bUI;  


 


  ASText dialogTitle;  


 


  ASCab sigParamsCab;  


 


  DSSaveType outSaveOptions;  


 


  PSSigDialogStatus outDialogStatus;  


 


  ASCab outCertListCab;  


 


  ASCab outNewSigPropCab;  


 


  ASCab outNewSigBuildCab;  


 


  PSSigDocType docType;  


 


  void* docParams;  


 


  PSSigMethod sigMethod;  


 


  DSDigestMethod digestMethod;  


 


  PSSigType inSigType;  

}

A structure containing parameters and return values for PSSigGetSigPropertiesProc().

See Also

SigGetSigPropertiesProc

File: PubSecHFT.h

Line: 268

Elements

size

The size of the structure.

pdDoc

(Constant) The PDDoc being signed. If a PDDoc is not being signed, this is only used for window parenting and can be NULL.

fileOptions

(Constant) The file type and signing environment, which the handler uses to display appropriate save buttons.

bUI

(Constant) When it is true, the call is being made from the user interface; when it is false it is being made from a script or batch file.

dialogTitle

The title to use for the signing dialog, if bUI is true. It is usually NULL, which allows the handler to use the default.

sigParamsCab

(Constant) It represents the parameters passed in by EScript converted to an ASCab, or NULL if the call is not from EScript.

outSaveOptions

If you are not providing your own sign dialog, set this value to DSSignSave.

If you are providing your own sign dialog, return the result of your sign dialog. Setting the value to DSignCancel cancels the signing operation.

outDialogStatus

Return status information that tells PubSec what dialogs to display and how to authenticate the handler.

The legal return values are:

Value	Description
kPSSigDialogNone	The handler provides its own sign dialog.
kPSSigDialogSign	PubSec provides a sign dialog.
kPSSigDialogSignWithPassword	PubSec provides a sign dialog box with a password.
kPSSigDialogSignThenAuthenticate	PubSec provides a sign dialog, then afterwards calls the handler to allow the handler to authenticate the user.

outCertListCab

(Required) Return an ASCab containing an ordered certificate chain, signing certificate first (at key 0).

outNewSigPropCab

(Required) Populate this existing ASCab with signature properties that will be written to the signature dictionary when the signature is committed.

outNewSigBuildCab

(Optional) Populate this existing ASCab with return build properties that will be written to the signature dictionary when the signature is committed.

docType

(Constant) The type of document being signed.

docParams

A structure containing signature parameters appropriate to the type of document. Depending on sigType, it is a structure of type PSSigPDDocParams, PSSigCosDocParams, or PSSigDataBufferParams.

sigMethod

(Constant) A specification for SignatureValue. See the PDF Reference for details.

digestMethod

(Constant) A method used to create a digest.

inSigType

Additions for Acrobat 7. The type of the signature being created

_t_PSSigValidateDialogParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigValidateDialogParamsRec {

  ASSize_t size;  


 


  ASCab certListCab;  


 


  ASBool reqRevokeChecks;  


 


  ASInt32 maxRevokeInfoCacheLifetime;  


 


  ASCab sigValCab;  


 


  ASBool bModalParent;  


 


  DSPropertyType dsPropType;  


 


  PSSigDocType docType;  


 


  void* docParams;  


 


  ASCab sigPropCab;  


 


  ASCab sigDictCab;  

}

A structure containing parameters and return values for PSSigValidateDialogProc().

File: PubSecHFT.h

Line: 467

Elements

	size	The size of the structure.

	certListCab	(In and out) For a PKCS#1 signature, PubSec fills in the certificate chain. For a PKCS#7 signature, PubSec returns an empty ASCab. For both signature types, the handler must provide the certificate chain that was validated.

	reqRevokeChecks	Informs the handler whether revocation checks are required. Handlers should always do revocation checks, but return failure only when this value is `true`.

	maxRevokeInfoCacheLifetime	The maximum lifetime (in minutes) of the cached information that is used for revocation checking. This is relevant for some types of revocation checking (such as CRL-based revocation checking) and not for others (such as OCSP).

	sigValCab	An ASCab containing the validity of the signature. It is never `NULL`. The handler can validate the signature and update this object if desired.

	bModalParent	Indicates whether it is being called when a modal parent dialog box is open. If it is `true`, rollback and verify buttons should be disabled because: Rollback is not possible while the modal parent is open. The verify status may not be propagated properly to various caching locations.

	dsPropType	Returns a value that tells PubSec whether to roll back the signature or show a properties dialog box for the signature.

	docType	(Constant) The type of document being signed.

	docParams	A structure containing signature parameters appropriate to the type of document. Depending on `sigType`, it is a structure of type PSSigPDDocParams or PSSigCosDocParams.

_t_PSSigValidateParamsRecRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigValidateParamsRecRec {

  ASSize_t size;  


 


  PSSigMethod sigMethod;  


 


  DSDigestMethod digestMethod;  


 


  ASUns8 digestValue;  


 


  ASUns8 sigValueData;  


 


  ASUns32 sigValueSize;  


 


  ASCab certListCab;  


 


  ASBool reqRevokeChecks;  


 


  ASInt32 maxRevokeInfoCacheLifetime;  


 


  ASCab sigValCab;  


 


  ASCab outSigPropCab;  


 


  PSDataBuffer dataBuffer;  


 


  ASTimeRec inSignTime;  


 


  PSSigType inSigType;  


 


  CosDoc cosDoc;  

}

A structure containing parameters and return values for PSSigValidateProc().

See Also

PSSigValidateProc

File: PubSecHFT.h

Line: 396

Elements

	size	The size of the structure.

	sigMethod	(Constant) The method used to create the signature value.

	digestMethod	(Constant) The method used to create the digest.

	digestValue	(Constant) A digest value to be signed, or `NULL`.

	sigValueData	(Constant) A signature value to be verified.

	sigValueSize	(Constant) The size of the signature value.

	certListCab	(In and out) For a PKCS#1 signature, PubSec fills in the certificate chain. For a PKCS#7 signature, PubSec returns an empty ASCab. For both signature types, the handler must provide the certificate chain that was validated.

	reqRevokeChecks	Informs the handler whether revocation checks are required. Handlers should always do revocation checks, but return failure only when this value is `true`.

	maxRevokeInfoCacheLifetime	The maximum lifetime (in minutes) of the cached information that is used for revocation checking. This is relevant for some types of revocation checking (such as CRL-based revocation checking) and not for others (such as OCSP).

	sigValCab	Returns an ASCab containing the validity of the signature. It must not be `NULL`. The handler must set the values for PROP_SigVal_Id and PROP_SigVal_TrustFlags, and can optionally set PROP_SigVal_IdPriv and/or PROP_SigVal_IDPrivTextValidity. The handler should also set the value of PROP_SigVal_Digest, if it is not already set. All other values should be left unmodified, since they will not be preserved by PubSec.

	outSigPropCab	Returns signature properties to display instead of signature dictionary entries.

	dataBuffer	The handle to use for fetching bytes to digest.

	inSignTime	PubSec provides the time that it thinks signing occured.

	inSigType	The type of signature being validated.

	cosDoc	Cos document to which signature belongs

_t_PSSigValidateSupportParamsRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PSSigValidateSupportParamsRec {

  ASSize_t size;  


 


  ASAtom filter;  


 


  ASAtom subFilter;  


 


  ASInt32 version;  


 


  ASInt32 revision;  


 


  ASCab buildCab;  

}

A structure containing signature parameters for PSSigValidateSupportedProc().

See Also

PSSigValidateSupportedProc

File: PubSecHFT.h

Line: 379

Elements

	size	The size of the structure.

	filter	(Constant) The value of the /Filter attribute for the signature.

	subFilter	(Constant) The value of the /SubFilter attribute for the signature.

	version	(Constant) The value of the /V attribute for the signature.

	revision	(Constant) The value of the /R attribute for the signature.

	buildCab	(Constant) The handler's build properties dictionary, as an ASCab.

_t_PubSecHandlerRec

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PubSecHandlerRec {

  ASSize_t size;  


 


  _t_PubSecHandlerRec next;  


 


  DigSigHandler dsHandler;  


 


  PDCryptHandler cryptHandler;  


 


  PubSecEngine engine;  


 


  PSNewEngineProc newEngine;  


 


  PSDestroyEngineProc destroyEngine;  


 


  PSGetBoolPropertyProc getBoolProperty;  


 


  PSGetAtomPropertyProc getAtomProperty;  


 


  PSGetInt32PropertyProc getInt32Property;  


 


  PSGetTextPropertyProc getTextProperty;  


 


  PSSessionAcquireProc sessionAcquire;  


 


  PSSessionReleaseProc sessionRelease;  


 


  PSSessionReadyProc sessionReady;  


 


  PSPerformOperationProc performOperation;  


 


  PSSigGetSigPropertiesProc sigGetSigProperties;  


 


  PSSigAuthenticateProc sigAuthenticate;  


 


  PSSigGetSigValueProc sigGetSigValue;  


 


  PSSigValidateSupportedProc sigValidateSupported;  


 


  PSSigValidateProc sigValidate;  


 


  PSSigValidateDialogProc sigValidateDialog;  


 


  PSSigPropDialogProc sigPropDialog;  


 


  PSSigValGetTextProc sigValGetText;  


 


  PSGetLogoProc getLogo;  


 


  PSSigValGetAPLabelProc sigValGetAPLabel;  


 


  PSSigCreateAPNXObjProc sigCreateAPNXObj;  


 


  PSImportDataProc importData;  


 


  PSExportDataProc exportData;  


 


  PSOpenCMSEnvelopeProc cryptOpenCMSEnvelope;  


 


  PSGetImplicitRecipientsProc cryptGetImplicitRecipients;  


 


  PSGetDirHandlerInfo dirGetDirHandlerInfo;  


 


  PSGetDirList dirGetDirList;  


 


  PSGetDirInfo dirGetDirInfo;  


 


  PSSetDirInfo dirSetDirInfo;  


 


  PSOpenConnection dirOpenConnection;  


 


  PSOpenCMSEnvelopeExProc cryptOpenCMSEnvelopeEx;  


 


  PSSigSignReportProc sigSignReport;  

}

PubSecHandlerRec Definition. See PSRegisterHandler for registration of PubSecHandlers.

See Also

PSRegisterHandler

File: PubSecHFT.h

Line: 1867

Callbacks Detail

PSDestroyEngineProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PSDestroyEngineProc)(PubSecEngine engine)

Destroys a public key security engine for this handler, freeing the memory.

See Also

PSNewEngineProc

File: PubSecHFT.h

Line: 1275

PSExportDataProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSExportDataProc)(PubSecEngine engine, PSExportDataType dataType, ASCab outCab, ASBool bInUIAllowed)

This function gets data of the specified type from a handler, to be exported to an FDF or CMS file and possibly sent as an email attachment. The function is called when exporting to FDF, for example, in response to an FDF Data Exchange certificate request.

Acrobat calls PSGetBoolPropertyProc() to see if the relevant data type is supported in the handler implementation. See PSExportDataType.

See Also

PSImportDataProc

File: PubSecHFT.h

Line: 1705

PSGetAtomPropertyProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom (*PSGetAtomPropertyProc)(PubSecEngine engine, const char *szPropertyName)

Gets an ASAtom property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.

File: PubSecHFT.h

Line: 1300

PSGetBoolPropertyProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PSGetBoolPropertyProc)(PubSecEngine engine, const char *szPropertyName, const ASBool defaultValue)

Gets an ASBool property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.

File: PubSecHFT.h

Line: 1288

PSGetDirHandlerInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSGetDirHandlerInfo)(PubSecEngine engine, DirHandlerInfo outDirHandlerInfo)

Gets information about directory handlers in an engine that is acting as a directory service provider.

File: PubSecHFT.h

Line: 1776

PSGetDirInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSGetDirInfo)(PubSecEngine engine, ASAtom inDirID, DirectoryInfo outDirInfo)

Gets information about directories in an engine that is acting as a directory service provider.

File: PubSecHFT.h

Line: 1810

PSGetDirList

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSGetDirList)(PubSecEngine engine, DirectoryList outDirList)

Gets a list of directories in an engine that is acting as a directory service provider.

File: PubSecHFT.h

Line: 1792

PSGetImplicitRecipientsProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSGetImplicitRecipientsProc)(PubSecEngine engine, ASCab outCertList, ASBool bInUIAllowed)

Gets information about directory handlers in an engine that is acting as a directory service provider.

See Also

PSGetDirInfo
PSGetDirList
PSSetDirInfo

File: PubSecHFT.h

Line: 1759

PSGetInt32PropertyProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*PSGetInt32PropertyProc)(PubSecEngine engine, const char *szPropertyName, const ASInt32 defaultValue)

Gets an ASInt32 property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.

File: PubSecHFT.h

Line: 1313

PSGetLogoProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PSGetLogoProc)(ASAtom label, const char **pcLogo, const ASFixedRect **pRect)

Gets custom artwork from the handler, to be used as a label for a particular validity state. The artwork for standard labels does not need to be specifically retrieved. If you are not using dynamic signature appearances or not using custom artwork, the handler need only handle the null label case.

File: PubSecHFT.h

Line: 1628

PSGetTextPropertyProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASText (*PSGetTextPropertyProc)(PubSecEngine engine, const char *szPropertyName, const ASInt32 index)

Gets an ASText property of an engine. For a list of public properties of a PubSecEngine, see PubSecHFT.h.

For the PROP_PSENG_Exception property, index is a DSRetCode value. If a handler receives a a call to get PROP_PSENG_Exception, it must reset its exception status so that subsequent calls to get an exception string return NULL. NULL return values are legal for all properties.

File: PubSecHFT.h

Line: 1332

PSImportDataProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSImportDataProc)(PubSecEngine engine, PSImportDataParams params, ASBool bInUIAllowed)

This function sends data of a particular type to a handler to import into its own data store. This is call is executed in response to data received (for example, through an FDF file or through the signature dictionary).

Acrobat calls PSGetBoolPropertyProc() to see if the relevant data type is supported in the handler implementation. See PSImportDataType.

See Also

PSExportDataProc

File: PubSecHFT.h

Line: 1681

PSNewEngineProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

PubSecEngine (*PSNewEngineProc)()

Create a new public key security engine for this handler. This engine would not be associated with any user interface.

See Also

PSDestroyEngineProc

File: PubSecHFT.h

Line: 1268

PSOpenCMSEnvelopeExProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSOpenCMSEnvelopeExProc)(PubSecEngine engine, PSOpenCMSEnvelopeParams params, ASBool bInUIAllowed)

Open the provided PKCS#7 (CMS) Enveloped Data object and return the data contained in it.

File: PubSecHFT.h

Line: 1742

PSOpenCMSEnvelopeProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSOpenCMSEnvelopeProc)(PubSecEngine engine, ASUns8 *inCMSEnvelope, ASUns32 inCMSEnvelopeSize, ASUns8 **pOutData, ASUns32 *pOutDataSize, ASBool bInUIAllowed)

This procedure is required. It is called to open the provided PKCS#7 cryptographic message service (CMS) enveloped data object and return the data contained in it.

File: PubSecHFT.h

Line: 1727

PSOpenConnection

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSOpenConnection)(PubSecEngine engine, ASAtom inDirID, DirAuthenticationContext inAuthCtx, ASBool inUI, DirConnection *pOutConnection)

Opens a connection to a specified directory to use for authentication.

File: PubSecHFT.h

Line: 1856

PSPerformOperationProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSPerformOperationProc)(PubSecEngine engine, PSPerformOpType type, const ASCab cab, ASBool bUI)

Performs the specified operation using parameters contained in cab. This interface is used by EScript.

File: PubSecHFT.h

Line: 1399

PSSessionAcquireProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSessionAcquireProc)(PubSecEngine engine, PDDoc pdDoc, PSSessionOpType opType, ASText opText, ASCab cabParams, ASBool bUIAllowed)

Called to acquire resources that will be needed to begin a PubSec session. For example, it might need to log on before performing a desired operation. If resources are already available, the handler may not need to do anything. When the function completes successfully, PubSec calls PSSessionReleaseProc() with the same operation type. Multiple calls can be made to acquire the same or different operation types, before a previously acquired resource is released. Handlers should keep a reference count if required for a particular resource.

Despite the name, this function does not acquire a session; it just acquires the resources that will be needed by the session. For example, to begin a signing session, PubSec calls PSSessionAcquire() with kPSOpTypePDDocSign. The PubSec handler should select the resources and credentials that are to be used for signing. If the call is successful, PubSec will proceed with the PSSigGetSigPropertiesProc() and PSSigGetSigValueProc() calls.

See Also

PSSessionReadyProc
PSSessionReleaseProc

File: PubSecHFT.h

Line: 1362

PSSessionReadyProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSessionReadyProc)(PubSecEngine engine, PSSessionOpType opType)

Returns kDSTrue if the resources and information needed to perform the specified operation have been acquired.

File: PubSecHFT.h

Line: 1387

PSSessionReleaseProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSessionReleaseProc)(PubSecEngine engine, PSSessionOpType opType)

Releases any resources that were required for the specified operation, such as file handles. It is up to a handler to decide what resources to release. A handler can, for example, leave a user logged on, even after a session is released. This call can fail. For example, you might want the call to fail if the operation is kPSOpTypeEScriptLogin and encrypted documents are open.

See Also

PSSessionAcquireProc
PSSessionReadyProc

File: PubSecHFT.h

Line: 1376

PSSetDirInfo

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSetDirInfo)(PubSecEngine engine, DirectoryInfo inDirInfo)

Sets information about a directory in an engine that is acting as a directory service provider.

File: PubSecHFT.h

Line: 1833

PSSigAuthenticateProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigAuthenticateProc)(PubSecEngine engine, const PDDoc pdDoc, ASCab inESParams, ASBool bInUIAllowed)

Called to authenticate the signer. The caller can determine whether authentication is required by calling PSGetBoolPropertyProc() with the property PROP_PSENG_IsAuthenticated.

This procedure is called only if specified by the PSSigSigPropParams passed to PSSigGetSigPropertiesProc(). If your handler does not need this call, it should be defined to always return kDSTrue.

File: PubSecHFT.h

Line: 1446

PSSigCreateAPNXObjProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigCreateAPNXObjProc)(PubSecEngine engine, CosObj *pOutXObj, PSSigPDDocParams docParams, PSAPSigType sigType)

Creates the signature appearance that is put into the /AP dictionary /N entry.

It is recommended that you set this procedure to NULL, which allows PubSec to use the default APHandler to generate the XObj for the appearance.

See Also

PSGetLogoProc
PSSigValGetAPLabelProc

File: PubSecHFT.h

Line: 1607

PSSigGetSigPropertiesProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigGetSigPropertiesProc)(PubSecEngine engine, PSSigSigPropParams params)

Called when creating a new signature. For PDDoc signatures, this call replaces SigNew() and SigCommit() calls. It returns the values that PubSec writes into the signature dictionary in the parameters structure. Before making this call, the handler should use PSSessionAcquireProc() to choose the credential to be used for signing. The handler can use the user interface during this call to allow authentication and to bring up the signing dialog.

File: PubSecHFT.h

Line: 1418

PSSigGetSigValueProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigGetSigValueProc)(PubSecEngine engine, PSSigGetSigValueParams inOutParams)

Called to sign the digest and return the signature value. The memory for the signature value becomes the property of the caller.

When it is called for a PKCS #7 signature, there is a size-only option: if the value of pOutSigValueData in the inOutParams structure is NULL, it returns the expected size of the signature value.

For most values of digestMethod in the inOutParams structure, the digest is passed into the handler, and the handler needs to sign it. However if a handler specifies that it must do its own digest (for example, for the legacy EntrustFile toolkit) then a NULL digest is passed in. The handler can specify this using PROP_PSENG_SignFormatPKCS7Digest. If this property is true, the digest is not passed to the handler.

This procedure should not show any user interface and should not allow a user to cancel the signing operation.

File: PubSecHFT.h

Line: 1480

PSSigPropDialogProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigPropDialogProc)(PubSecEngine engine, PSSigValidateDialogParams valParams)

Called to display a dialog box that shows signature properties.

If this procedure is NULL (which is recommended), PubSec opens its own properties dialog. The default properties dialog box includes buttons that allow the user to import and to display certificates:

The import button calls PSImportDataProc().
If the handler implements the kPSOpPerformDisplayCertList operation (see PSPerformOperationProc()) the show-certificate button can open the handler-provided display dialog. Otherwise, the button opens the default certificate-display dialog.

See Also

PSSigValidateDialogProc

File: PubSecHFT.h

Line: 1564

PSSigSignReportProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PSSigSignReportProc)(PubSecEngine engine, PSSigSignReportParams)

Ask the handler to report a summary on a signature that has just been signed by this handler.

File: PubSecHFT.h

Line: 1860

PSSigValGetAPLabelProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom (*PSSigValGetAPLabelProc)(ASCab valCab, const ASInt32 layerNum)

Called to get a name to use for a particular layer of signature appearance. This is used when the signature appearance uses the n1 and n3 layers for dynamic signature appearances. Beginning in Acrobat 6.0, Acrobat is discouraging the use of dynamic signature appearances and is instead showing the signature validity as an icon that is rendered at run time.

Provide this procedure for handlers that need to be backward compatible with earlier implementations that use custom artwork. The procedure can be set to NULL when you are not using dynamic signature appearances.

If the value DSAPValid, DSAPDoubleValid, or DSAPInvalid is returned, Acrobat uses standard labels. Otherwise Acrobat calls PSGetLogoProc() to return logo artwork to use for the XObject. A return value of ASAtomNull causes Acrobat to use a blank XObject for the specified layer.

See Also

PSGetLogoProc
PSSigCreateAPNXObjProc

File: PubSecHFT.h

Line: 1659

PSSigValGetTextProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASText (*PSSigValGetTextProc)(ASCab valCab, const DSSigValText textType, const ASInt32 index)

Called to get the text result of validation. For most values of textType, the handler should return NULL, causing PubSec to use the default text strings ("Valid", "Invalid", or "Unknown", depending on the validity state). Handlers will normally need to provide their own ID validity strings.

File: PubSecHFT.h

Line: 1584

PSSigValidateDialogProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigValidateDialogProc)(PubSecEngine engine, PSSigValidateDialogParams valParams)

Called to show a dialog box that shows validation status after the signature is validated.

If this procedure is NULL (which is recommended), PubSec opens its own validation dialog.

File: PubSecHFT.h

Line: 1536

PSSigValidateProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

DSRetCode (*PSSigValidateProc)(PubSecEngine engine, PSSigValidateParams params)

Called to validate a signature.

File: PubSecHFT.h

Line: 1512

PSSigValidateSupportedProc

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

PSSigValSupport (*PSSigValidateSupportedProc)(PubSecEngine engine, PSSigValidateSupportParams params)

Called to determine whether the handler can validate a signature.

File: PubSecHFT.h

Line: 1496

Method Detail

AABFindCertsByName

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AABFindCertsByName(const ASUns8* inCertNameData, ASInt32 inCertNameSize, ASCab outResults)

Performs a lookup in the Acrobat Address Book by certificate subject name. It returns all certificates that match the name along with trust information associated with them.

The returned ASCab contains:

An entry for each certificate, with a 0-based index followed by the X509 certificate as ASN1-encoded binary data.
An entry with a key Tn containing the associated trust value of each certificate, where n corresponds to the certificate's index key.

If a trust key is missing, the value should be assumed to be untrusted. For example:

{ ("0", cert1), ("1", cert2), ("T1", kPSSigTrustAuthenticDocuments) }

In this case, cert1 is untrusted, cert2 is trusted for authentic documents.

Parameters

	`inCertNameData` —	The subject name of the certificates to find. Specify a BER-encoded value of `ASN.1 type Name` defined in X.509 (RFC 3280).

	`inCertNameSize` —	The size of the certificate subject name data.

	`outResults` —	(Filled by the method) An ASCab containing any certificates, and their trust information, found by the lookup.

See Also

AABGetCertTrust
AABGetTrustedCerts

File: PubSecHFTProcs.h

Line: 404

AABGetCertChain

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AABGetCertChain(const ASUns8* inX509Cert, ASInt32 inX509CertSize, ASCab inTrustedCerts, ASCab inUntrustedCerts, ASCab outChain)

Finds the certificate chain for the specified certificate in the Acrobat Address Book.

A certificate ASCab contains an entry for each certificate,with a 0-based index followed by the X509 certificate as ASN1-encoded binary data. For example:

{ ("0", cert1), ("1", cert2), ... }

Parameters

	`inX509Cert` —	The certificate identifier, as defined in X.509 (RFC 3280). This is a generic 8-bit pointer to the certificate data.

	`inX509CertSize` —	The size in bytes of the X.509 certificate pointed to by `inX509Cert`.

	`inTrustedCerts` —	An ASCab containing the user's trusted certificates.

	`inUntrustedCerts` —	An ASCab containing additional certificates needed to build the certificate chain.

	`outChain` —	(Filled by the method) An ASCab containing the certificate chain. The specified certificate itself is at index `0`, followed by the chain certificates in issuing order.

Returns

true if successful, false otherwise.

See Also

AABGetTrustedCerts

File: PubSecHFTProcs.h

Line: 452

AABGetCertTrust

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





PSSigTrust AABGetCertTrust(const ASUns8* inX509Cert, ASInt32 inX509CertSize, ASCab inCertChain, ASCab inHelperCerts)

Finds the specified certificate in the Acrobat Address Book and returns the trust level.

Parameters

	`inX509Cert` —	The certificate identifier, as defined in X.509 (RFC 3280). This is a generic 8-bit pointer to the certificate data.

	`inX509CertSize` —	The size in bytes of the X.509 certificate pointed to by `inX509Cert`.

	`inCertChain` —	An ASCab containing the certificate chain for the certificate, with the trust level for each certificate. It starts with the `inX509Cert` parameter's issuer at index `0` and continues in the issuing order. Can be `NULL` if the chain is not available.

	`inHelperCerts` —	An ASCab containing an unordered sequence of certificates that can be used to build the certificate chain. If `inCertChain` is `NULL` and `inX509Cert` is not self-signed, PubSec attempts to build a chain of certificates using a default mechanism. A certificate ASCab contains an entry for each certificate,with a 0-based index followed by the X509 certificate as ASN1-encoded binary data. For example: `{ ("0", cert1), ("1", cert2), ... }`

Returns

The trust value for the specified certificate, if found. If no certificate is found, it returns kPSSigTrustUntrusted. To distinguish a certificate that is not found from one whose trust level is reported as untrusted, use AABIsCertPresent().

See Also

AABGetTrustedCerts
AABIsCertPresent

File: PubSecHFTProcs.h

Line: 371

AABGetTrustedCerts

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AABGetTrustedCerts(PSSigTrust inTrust, ASCab outResults)

Finds the certificates with a specified level of trust in the Acrobat Address Book.

Parameters

inTrust —

The level of trust for which to find certificates. It is a logical OR of PSSigTrust bit flags.

outResults —

(Filled by the method) An ASCab containing the trusted certificates found in the AAB. A certificate ASCab contains an entry for each certificate, with a 0-based index followed by the X509 certificate as ASN1-encoded binary data. For example:

{ ("0", cert1), ("1", cert2), ... }

See Also

AABGetCertTrust

File: PubSecHFTProcs.h

Line: 423

AABIsCertPresent

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AABIsCertPresent(const ASUns8* x509, ASInt32 size)

Finds the specified certificate in the Acrobat Address Book. Use this method to distinguish a certificate that is not found by AABGetCertTrust from one whose trust level is reported as untrusted.

Parameters

	`x509` —	The certificate identifier, as defined in X.509 (RFC 3280).

	`size` —	The size of the certificate pointed to by `x509`.

Returns

true if the certificate is found, false otherwise.

See Also

AABGetCertTrust

File: PubSecHFTProcs.h

Line: 336

AABIsCertUnderAdobeRoot

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AABIsCertUnderAdobeRoot(ASCab inCertChain)

Tests whether any certificate in a chain has been issued under the Adobe Root Certificate Policy.

Parameters

inCertChain —

The certificate chain to test, as an ASCab array. The first certificate is the end entity, and certificates should follow in the issuing order. For example:

{ ("0", cert1), ("1", cert2), ... }

Returns

true if any certificate in the chain was issued under the Adobe Root Certificate Policy.

File: PubSecHFTProcs.h

Line: 552

PSAddSecureAttachmentToDoc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSAddSecureAttachmentToDoc(ASText inDIPath, ASText inAttName, const ASUns8* inCertChain, ASInt32 inCertSize, PDDoc pdDoc)

Attach the a document to an eEnvelope using the specified certificate data.

This function calls addRecipientListCryptFilter and importDataObject.

Parameters

	`inDIPath` —	Path to the document to add and secure as an attachment to `pdDoc`.

	`inAttName` —	The attachment's name.

	`inCertChain` —	The certificate identifier. This is a generic 8-bit pointer to the hex-encoded raw value of the certificate data.

	`inCertSize` —	The size in bytes of the certificate pointed to by `inCertChain`.

	`pdDoc` —	The document provided by the caller to which `szAttName` will be attached and secured.

Returns

true if the the pddAttachment is secured and attached properly to the pdDoc.

See Also

addRecipientListCryptFilter
importDataObject

File: PubSecHFTProcs.h

Line: 578

PSCertIssuedUnderTestCP

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSCertIssuedUnderTestCP(ASCab inCertChain)

Tests whether any certificate in a chain has been issued under the Adobe Test Certificate Policy.

If this function returns true, PubSec handlers are recommended to provide feedback to the user regarding the test nature of the certificate, which may render it untrustworthy.

Parameters

inCertChain —

The certificate chain to test, as an ASCab array. The first certificate is the end entity, and certificates should follow in the issuing order. For example:

{ ("0", cert1), ("1", cert2), ... }

certn is an X509 certificate as ASN1-encoded binary data.

Returns

true if any certificate in the chain was issued under the Adobe Test Certificate Policy.

File: PubSecHFTProcs.h

Line: 526

PSCloseEncryptedDocs

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSCloseEncryptedDocs(PubSecEngine engine)

Closes all encrypted documents associated with a PubSec engine, regardless of whether they need to be saved. Use PSCountEncryptedDocs() to determine if there are any documents that will need to be opened or saved.

PubSec keeps a list of all open encrypted documents. For security reasons, handlers will want all of these documents to be closed when it releases access to critical resources, (for example, when logging out). Use this method (rather than closing the documents directly) so that PubSec can maintain its cache correctly.

Parameters

engine —

The engine for which the encrypted documents are closed.

Returns

true if successful, false otherwise.

See Also

PSCountEncryptedDocs

File: PubSecHFTProcs.h

Line: 119

PSCountEncryptedDocs

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void PSCountEncryptedDocs(PubSecEngine engine, ASUns32* outNeedSave, ASUns32* outCanClose)

Returns the number of encrypted documents associated with a PubSec engine. It returns separate values for documents that need to be saved, and for those that do not need to be saved and can be safely closed.

Parameters

	`engine` —	The engine for which the encrypted docs are counted.

	`outNeedSave` —	(Filled by the method) A pointer to the number of encrypted documents associated with the engine that need to be saved.

	`outCanClose` —	(Filled by the method) A pointer to the number of encrypted documents associated with the engine that do not need to be saved and can be safely closed.

See Also

PSCloseEncryptedDocs

File: PubSecHFTProcs.h

Line: 98

PSDataBufferDigest

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSDataBufferDigest(PSDataBuffer dataBuffer, ASUns8* digestValue, DSDigestMethod digestMethod)

Computes the digest for a set of data. A handler will use this call to make PubSec compute the digest for a data buffer when signing or verifying signatures. This method calls PSDataBufferEnum() to get the bytes and computes an MD5 or SHA-1 digest.

Parameters

	`dataBuffer` —	The buffer containing the data.

	`digestValue` —	(Filled by the method) A pointer to the digest value. The buffer must large enough for the requested digest method: For an MD5 digest, it must be at least 16 bytes. For an SHA-1 digest, it must be at least 20 bytes.

	`digestMethod` —	The method to use to compute the digest.

Returns

true if successful, false otherwise.

See Also

PSDataBufferReset
PSDataBufferEnum

File: PubSecHFTProcs.h

Line: 204

PSDataBufferEnum

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSDataBufferEnum(PSDataBuffer dataBuffer, ASInt32 maxSize, ASUns8** pReturnBuffer, ASInt32* pReturnSize)

Validates a specified signature field in a PDDoc. For example, you might call this from the validate button of a signature properties dialog, or if any information used during validation is changed. It does not bring up any user interface.

A return value of true indicates that the validation operation was successfully peformed, but does not provide any information about the result of the validation (that is, the signature's validity value). The method does not return validity information, but simply updates the DigSig and PubSec validation caches.

Parameters

	`dataBuffer` —	The validation parameters.

	`maxSize` —	The buffer containing the data.

	`pReturnBuffer` —	The maximum number of bytes to return in the return buffer.

	`pReturnSize` —	(Filled by the method) A pointer to the buffer containing the current bytes to be processed. If it is `NULL`, an error occurred and you should abort the enumeration.

Returns

true if the validation was successfully performed, false otherwise.

true as long as there is more data to process, false when the end of the buffer is reached.

See Also

PSDataBufferReset
PSDataBufferDigest

File: PubSecHFTProcs.h

Line: 180

PSDataBufferReset

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void PSDataBufferReset(PSDataBuffer dataBuffer)

As functions PSDataBufferEnum() or PSDataBufferDigest() are stateful (for example, the dataBuffer object keeps track of the bytes that have been returned), call this function whenever the state maintained within the dataBuffer need to be re-initialized.

Parameters

dataBuffer —

The buffer containing the stateful information.

See Also

PSDataBufferEnum
PSDataBufferDigest

File: PubSecHFTProcs.h

Line: 536

PSExportDataExchange

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSExportDataExchange(PSExportDataExchangeParams params)

Exports certificates, requests for certificates, and so on, to FDF files or other file types, using a user interface wizard. It includes support to export to a file or to email.

The specified type of data is exported to a file and optionally emailed to a destination that is chosen using the wizard:

If the data is saved to a file and is the user's own contact information, it can be a PKCS#7 file (.p7c).
If the data contains just one certificate and is saved to a file, it can be a raw certificate file (.cer).
Otherwise, it is always an FDF file.

It does not raise or throw exceptions. It displays an alert if it is unsuccessful.

Parameters

params —

A structure containing the export parameters.

Returns

true if successful, false otherwise.

See Also

PSImportDataExchange

File: PubSecHFTProcs.h

Line: 483

PSImportDataExchange

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSImportDataExchange(PSImportDataExchangeParams params)

Imports FDF data from a file, using a user interface wizard. The parameters structure specifies the type and location of the data. This call is used, for example, by the Directory configuration dialog box to import directory settings from an FDF file.

When you use this call (rather than opening the FDF file directly) the PubSec FDF handling code is used, which provided support for FDF signature verification. PubSec opens the FDF file, and then calls the handler's PSImportDataProc() using the handler and engine specified in the parameters structure.

The operation fails if the data is not of the specified type. It does not raise or throw exceptions. It displays an alert if unsuccessful.

Parameters

params —

A structure containing the import parameters.

Returns

true if successful, false otherwise.

See Also

PSExportDataExchange

File: PubSecHFTProcs.h

Line: 506

PSRegisterHandler

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSRegisterHandler(ExtensionID owner, PubSecHandler psHandler)

Registers a handler with the PubSec HFT. The caller retains ownership of the PubSecHandlerRec.

Parameters

	`owner` —	The handler's plug-in ExtensionID, assigned at initialization.

	`psHandler` —	The handler structure containing the handler methods to register.

Returns

true if successful, false otherwise.

See Also

PSUnregisterHandler

File: PubSecHFTProcs.h

Line: 60

PSSigValidatePDDocSigField

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PSSigValidatePDDocSigField(PSSigPDDocParams docParams)

Parameters

docParams

Returns

File: PubSecHFTProcs.h

Line: 121

PSUnregisterHandler

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void PSUnregisterHandler(PubSecHandler psHandler)

Unregisters a handler from the PubSec HFT. This does not destroy the handler; the caller owns the PubSecHandlerRec.

Parameters

psHandler —

The handler to unregister.

See Also

PSRegisterHandler

File: PubSecHFTProcs.h

Line: 72

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

	kDSDigestNone = 0,

	kDSDigestMD5,

	kDSDigestSHA1,

	kDSDigestSHA256,

	kDSDigestSHA384,

	kDSDigestSHA512,

	kDSDigestRIPEMD160,

	kDSDigestSHA224,

	kDSDigestEnumSize

	DSSignCancel = 0,

	DSSignSave,

	DSSignSaveAs,

	DSSaveTypeEnumSize

	kDSSigValUnknown = 0,

	kDSSigValUnknownTrouble,

	kDSSigValUnknownBytesNotReady,

	kDSSigValInvalidTrouble,

	kDSSigValUnused,

	kDSSigValJustSigned,

	kDSSigValFalse,

	kDSSigValTrue,

	kDSSigValEnumSize

	kDSSigValTextNull,

	kDSSigValTextDSTop,

	kDSSigValTextDSDetail,

	kDSSigValTextDSTooltip,

	kDSSigValTextSigInfo,

	kDSSigValTextVal,

	kDSSigValTextProp,

	kDSSigValTextAP,

	kDSSigValTextPropIdValidity,

	kDSSigValTextDSAVIdValidity,

	kDSSigValTextDSTTIdValidity,

	kDSSigValTextEnumSize

	kPSAPSigPreExists = 0,

	kPSAPSigTentative,

	kPSAPSigPreview

	kPSDecryptionReasonUnspecified = 0,

	kPSDecryptingDocument,

	kPSDecryptingAttachment,

	kPSDecryptingBatchCommand

	kPSExportDataNone = 0,

	kPSExportDataMyContact,

	kPSExportDataContacts,

	kPSExportDataDirSettings,

	kPSExportDataEnumSize

	kPSExportDestNone = 0,

	kPSExportDestFile,

	kPSExportDestCMSFile,

	kPSExportDestCertFile,

	kPSExportDestFDFFile,

	kPSExportDestEMailFDF,

	kPSExportDestCertURL,

	kPSExportDestEnumSize

	kPSImportDataNone = 0,

	kPSImportDataContactsCab,

	kPSImportDataContactsCabFromSig,

	kPSImportDataDirsCab,

	kPSImportDataEnumSize

	kPSOpPerformNone = 0,

	kPSOpPerformESLogin,

	kPSOpPerformESLogout,

	kPSOpPerformESNewUser,

	kPSOpPerformESSetValidateMethod,

	kPSOpPerformESPasswordTimeout,

	kPSOpPerformDisplayCertList,

	kPSOpPerformGetCerts,

	kPSOpPerformGetStores,

	kPSOpPerformEnumSize

	kPSOpTypeNone = 0,

	kPSOpTypePDDocSign,

	kPSOpTypePDDocSigValidate,

	kPSOpTypeCosDocSign,

	kPSOpTypeCosDocSigValidate,

	kPSOpTypeDataSign,

	kPSOpTypeDataSigValidate,

	kPSOpTypeMyContactExport,

	kPSOpTypeContactImport,

	kPSOpTypePolicyModify,

	kPSOpTypeAPRead,

	kPSOpTypePDCryptDocCreate,

	kPSOpTypePDCryptDocOpen,

	kPSOpTypeLogin,

	kPSOpTypeLogout,

	kPSOpTypeCertEnum,

	kPSOpTypeDirEnum,

	kPSOpTypeDirGet,

	kPSOpTypeStoreEnum

	kPSSigDialogNone = 0,

	kPSSigDialogSign,

	kPSSigDialogSignWithPassword,

	kPSSigDialogSignThenAuthenticate,

	kPSSigDialogStatusEnumSize

	kPSSigDocTypeNone = 0,

	kPSSigDocTypePDDoc,

	kPSSigDocTypeCosDoc,

	kPSSigDocTypeTransData,

	kPSSigDocTypeEnumSize

	kPSFileNone = 0,

	kPSFileAVDoc,

	kPSFileBrowserDoc,

	kPSFileExternalDoc,

	kPSFileTempDoc,

	kPSFileFDFData,

	kPSFileCosDoc,

	kPSFileTransData,

	kPSFileEnumSize

Layer	Digital_Signatures
Object	PubSec

	kPSSigMethodNone = 0,

	kPSSigMethodPKCS1,

	kPSSigMethodPKCS7Detached,

	kPSSigMethodPKCS7SHA1,

	kPSSigMethodETSICADES,

	kPSSigMethodETSIDocTimestamp,

	kPSSigMethodEnumSize

	kPSSigTypeUnknown = 0,

	kPSSigTypeUser,

	kPSSigTypeAuthor,

	kPSSigTypeUbiquity,

	kPSSigTypeEnumSize

	kPSSigValSupportFalse,

	kPSSigValSupportTrue,

	kPSSigValSupportUpdate,

	kPSSigValSupportPreRelease,

	kPSSigValSupportEnumSize

	const char* logo;

	ASFixedRect logoBBox;

	ASText fName;

	ASText fDN;

	ASText fReason;

	ASText fLocation;

	ASFixed fWidth;

	ASFixed fHeight;

	bool fbAuthSig;

	ASSize_t size;

	PubSecHandler psHandler;

	PubSecEngine psEngine;

	PSExportDataType dataType;

	ASCab dataCab;

	PSExportDataType requestType;

	PSExportDestType destType;

	ASSize_t size;

	PSImportDataType dataType;

	ASCab dataCab;

	PSSigTrust sigTrust;

	ASSize_t size;

	ASUns8 cmsEnvelopeData;

	ASUns32 cmsEnvelopeSize;

	ASUns8 outEnvelopeContentsData;

	ASUns32 outEnvelopeContentsSize;

	ASUns8 outSessionKeyData;

	ASUns32 outSessionKeySize;

	ASCab outCertificates;

	PSDecryptionReason inReason;

	ASSize_t size;

	PSSigDocType sigType;

	PDDoc pdDoc;

	CosDoc cosDoc;

	ASSize_t size;

	PSSigMethod sigMethod;

	DSDigestMethod digestMethod;

	ASUns8 digestValue;

	PSDataBuffer dataBuffer;

	ASBool bGetSigValue;

	ASUns8 outSigValueData;

	ASUns32 outSigValueSize;

	ASCab outSigPropCab;

	ASSize_t size;

	PDDoc pdDoc;

	PSSigFileType fileOptions;

	ASBool bUI;

	ASText dialogTitle;

	ASCab sigParamsCab;

	DSSaveType outSaveOptions;

	PSSigDialogStatus outDialogStatus;

	ASCab outCertListCab;

	ASCab outNewSigPropCab;

	ASCab outNewSigBuildCab;

	PSSigDocType docType;

	void* docParams;

	PSSigMethod sigMethod;

	DSDigestMethod digestMethod;

	PSSigType inSigType;

	ASSize_t size;

	ASCab certListCab;

	ASBool reqRevokeChecks;

	ASInt32 maxRevokeInfoCacheLifetime;

	ASCab sigValCab;

	ASBool bModalParent;

	DSPropertyType dsPropType;

	PSSigDocType docType;

	void* docParams;

	ASCab sigPropCab;

	ASCab sigDictCab;

	ASSize_t size;

	ASAtom filter;

	ASAtom subFilter;

	ASInt32 version;

	ASInt32 revision;

	ASCab buildCab;

	ASSize_t size;

	_t_PubSecHandlerRec next;

	DigSigHandler dsHandler;

	PDCryptHandler cryptHandler;

	PubSecEngine engine;

	PSNewEngineProc newEngine;

	PSDestroyEngineProc destroyEngine;

	PSGetBoolPropertyProc getBoolProperty;

	PSGetAtomPropertyProc getAtomProperty;

	PSGetInt32PropertyProc getInt32Property;

	PSGetTextPropertyProc getTextProperty;

	PSSessionAcquireProc sessionAcquire;

	PSSessionReleaseProc sessionRelease;

	PSSessionReadyProc sessionReady;

	PSPerformOperationProc performOperation;

	PSSigGetSigPropertiesProc sigGetSigProperties;

	PSSigAuthenticateProc sigAuthenticate;

	PSSigGetSigValueProc sigGetSigValue;

	PSSigValidateSupportedProc sigValidateSupported;

	PSSigValidateProc sigValidate;

	PSSigValidateDialogProc sigValidateDialog;

	PSSigPropDialogProc sigPropDialog;

	PSSigValGetTextProc sigValGetText;

	PSGetLogoProc getLogo;

	PSSigValGetAPLabelProc sigValGetAPLabel;

	PSSigCreateAPNXObjProc sigCreateAPNXObj;

	PSImportDataProc importData;

	PSExportDataProc exportData;

	PSOpenCMSEnvelopeProc cryptOpenCMSEnvelope;

	PSGetImplicitRecipientsProc cryptGetImplicitRecipients;

	PSGetDirHandlerInfo dirGetDirHandlerInfo;

	PSGetDirList dirGetDirList;

	PSGetDirInfo dirGetDirInfo;

	PSSetDirInfo dirSetDirInfo;

	PSOpenConnection dirOpenConnection;

	PSOpenCMSEnvelopeExProc cryptOpenCMSEnvelopeEx;

	PSSigSignReportProc sigSignReport;