fpdf_signature_r.h

Go to the documentation of this file.

#ifndef _FSPDF_SIGNATURE_R_H_
#define _FSPDF_SIGNATURE_R_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************/
/* Base Definitions for Signature                                              */
/*                                                                             */
/* Handle definitions, macro definitions                                       */
/*******************************************************************************/
#ifndef _FSPDF_DEF_HANDLE_SIGNATURE_
#define _FSPDF_DEF_HANDLE_SIGNATURE_

FSCRT_DEFINEHANDLE(FSPDF_SIGNATURE);

#endif /* _FSPDF_DEF_HANDLE_SIGNATURE_ */

#ifndef _FSPDF_DEF_MACRO_SIGNATURE_STATE_
#define _FSPDF_DEF_MACRO_SIGNATURE_STATE_

#define FSPDF_SIGNATURE_STATE_UNKNOWN           0

#define FSPDF_SIGNATURE_STATE_UNSIGNED          1

#define FSPDF_SIGNATURE_STATE_VALID                     2

#define FSPDF_SIGNATURE_STATE_INVALID           3

#endif /* _FSPDF_DEF_MACRO_SIGNATURE_STATE_ */

#ifndef _FSPDF_DEF_MACRO_SIGNATURE_APPEARANCE_
#define _FSPDF_DEF_MACRO_SIGNATURE_APPEARANCE_

#define FSPDF_SIGNATURE_APPEARANCE_FOXITFLAG            0x0001

#define FSPDF_SIGNATURE_APPEARANCE_LABEL                        0x0002

#define FSPDF_SIGNATURE_APPEARANCE_REASON                       0x0004

#define FSPDF_SIGNATURE_APPEARANCE_DATE                         0x0008

#define FSPDF_SIGNATURE_APPEARANCE_DN                           0x0010

#define FSPDF_SIGNATURE_APPEARANCE_LOCATION                     0x0020

#define FSPDF_SIGNATURE_APPEARANCE_NAME                         0x0040

#define FSPDF_SIGNATURE_APPEARANCE_IMAGE                        0x0080

#define FSPDF_SIGNATURE_APPEARANCE_TEXT                         0x0100

#endif /* _FSPDF_DEF_MACRO_SIGNATURE_APPEARANCE_ */

#ifndef _FSPDF_DEF_MACRO_SIGNATURE_ICONFITMODE_
#define _FSPDF_DEF_MACRO_SIGNATURE_ICONFITMODE_

#define FSPDF_SIGNATURE_ICONFITMODE_NORMAL              0

#define FSPDF_SIGNATURE_ICONFITMODE_FITFIELD    1

#endif /* _FSPDF_DEF_MACRO_SIGNATURE_ICONFITMODE_ */

#ifndef _FSPDF_DEF_HANDLER_SIGNATURE_
#define _FSPDF_DEF_HANDLER_SIGNATURE_

typedef struct _FSPDF_SIGNATUREHANDLER
{
        FS_LPVOID       clientData;

        FS_RESULT       (*StartCalcDigest)(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FSCRT_FILE file, const FS_DWORD* byteRangeArray, FS_DWORD sizeofArray, FS_LPVOID* context);
        
        FS_RESULT       (*ContinueCalcDigest)(FS_LPVOID clientData, FS_LPVOID context, FSCRT_PAUSEHANDLER* pause);
        
        FS_RESULT       (*FinishCalcDigest)(FS_LPVOID clientData, FS_LPVOID context, FSCRT_BSTR* digest);

        FS_RESULT       (*Sign)(FS_LPVOID clientData, FS_LPVOID context, FSPDF_SIGNATURE sig, const FSCRT_BSTR* digest, FSCRT_BSTR* signedData);

        FS_RESULT       (*Verify)(FS_LPVOID clientData, FS_LPVOID context, FSPDF_SIGNATURE sig, const FSCRT_BSTR* digest, const FSCRT_BSTR* signedData);

}FSPDF_SIGNATUREHANDLER;

#endif /* _FSPDF_DEF_HANDLER_SIGNATURE_ */

#ifndef _FSPDF_DEF_HANDLER_SIGNATUREICONPROVIDER_
#define _FSPDF_DEF_HANDLER_SIGNATUREICONPROVIDER_

typedef struct _FSPDF_SIGNATUREICONPROVIDER
{
        FS_LPVOID       clientData;

        FS_RESULT       (*GetIcon)(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FSCRT_BITMAP* bitmap);

        FS_RESULT       (*GetIconFitMode)(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FS_INT32* fitMode);

        FS_RESULT       (*NeedRotate)(FS_LPVOID clientData, FSPDF_SIGNATURE sig, FS_INT32 nState, FS_BOOL* needRotate);

}FSPDF_SIGNATUREICONPROVIDER;

#endif /* _FSPDF_DEF_HANDLER_SIGNATUREICONPROVIDER_ */

/*******************************************************************************/
/* Signature handler                                                           */
/*******************************************************************************/
FS_RESULT       FSPDF_Signature_RegisterHandler(const FSCRT_BSTR* filter, const FSCRT_BSTR* subFilter, FSPDF_SIGNATUREHANDLER* sigHandler);

FS_RESULT       FSPDF_Signature_SetIconProvider(FSPDF_SIGNATUREICONPROVIDER* iconProvider);

/*******************************************************************************/
/* PDF signature                                                               */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_CountSignatures(FSCRT_DOCUMENT doc, FS_INT32* count);

FS_RESULT       FSPDF_Doc_GetSignature(FSCRT_DOCUMENT doc, FS_INT32 index, FSPDF_SIGNATURE* sig);

FS_RESULT       FSPDF_Signature_GetAtPos(FSCRT_PAGE page, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSPDF_SIGNATURE* sig);

/*******************************************************************************/
/* Access signature properties                                                 */
/*******************************************************************************/
FS_RESULT       FSPDF_Signature_GetDoc(FSPDF_SIGNATURE sig, FSCRT_DOCUMENT* doc);

FS_RESULT       FSPDF_Signature_GetPageIndex(FSPDF_SIGNATURE sig, FS_INT32* pageIndex);

FS_RESULT       FSPDF_Signature_GetFlags(FSPDF_SIGNATURE sig, FS_DWORD* flags);

FS_RESULT       FSPDF_Signature_GetFilter(FSPDF_SIGNATURE sig, FSCRT_BSTR* filter);

FS_RESULT       FSPDF_Signature_GetSubFilter(FSPDF_SIGNATURE sig, FSCRT_BSTR* subFilter);

FS_RESULT       FSPDF_Signature_GetSigner(FSPDF_SIGNATURE sig, FSCRT_BSTR* signer);

FS_RESULT       FSPDF_Signature_GetDateTime(FSPDF_SIGNATURE sig, FSCRT_DATETIMEZONE* dt);

FS_RESULT       FSPDF_Signature_GetLocation(FSPDF_SIGNATURE sig, FSCRT_BSTR* location); 

FS_RESULT       FSPDF_Signature_GetReason(FSPDF_SIGNATURE sig, FSCRT_BSTR* reason); 

FS_RESULT       FSPDF_Signature_GetContactInfo(FSPDF_SIGNATURE sig, FSCRT_BSTR* contactInfo);

FS_RESULT       FSPDF_Signature_GetDistinguishedName(FSPDF_SIGNATURE sig, FSCRT_BSTR* dn);

FS_RESULT       FSPDF_Signature_GetText(FSPDF_SIGNATURE sig, FSCRT_BSTR* text); 

FS_RESULT       FSPDF_Signature_GetBitmap(FSPDF_SIGNATURE sig, FSCRT_BITMAP* bitmap);

FS_RESULT       FSPDF_Signature_GetAppearanceFlags(FSPDF_SIGNATURE sig, FS_DWORD* apFlags);

FS_RESULT       FSPDF_Signature_CountCerts(FSPDF_SIGNATURE sig, FS_INT32* certCount);

FS_RESULT       FSPDF_Signature_GetCert(FSPDF_SIGNATURE sig, FS_INT32 index, FSCRT_BSTR* signedCert);

/*******************************************************************************/
/* Verify Signature                                                            */
/*******************************************************************************/
FS_RESULT       FSPDF_Signature_StartVerify(FSPDF_SIGNATURE sig, FSCRT_PROGRESS* verifyProgress);

FS_RESULT       FSPDF_Signature_GetState(FSPDF_SIGNATURE sig, FS_INT32* state);

FS_RESULT       FSPDF_Signature_IsSigned(FSPDF_SIGNATURE sig, FS_BOOL* isSigned);

/*******************************************************************************/
/* Render Signature                                                            */
/*******************************************************************************/
FS_RESULT       FSPDF_RenderContext_DrawSignature(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, FSPDF_SIGNATURE sig);

FS_RESULT       FSPDF_RenderContext_StartPageSignatures(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, 
                                                                                                        FSCRT_PAGE page, FSCRT_PROGRESS* renderProgress);



#ifdef __cplusplus
};
#endif
 /* group FPDFSIGNATURE */

#endif /* _FSPDF_SIGNATURE_R_H_ */