security.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_SECURITY_H_INCLUDED_
#define PDFSDK_CORE_SECURITY_H_INCLUDED_
 
#include <pdfsdk/core/document.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum PDPermReqObj {
    kPDPermReqObjDoc,       
    kPDPermReqObjPage,      
    kPDPermReqObjContent,   
    kPDPermReqObjAnnot,     
    kPDPermReqObjForm,      
    kPDPermReqObjBookmark,  
    kPDPermReqObjAttachment 
} PDPermReqObj;
 
typedef enum PDPermReqOp {
    kPDPermReqOpInsert,                     
    kPDPermReqOpDelete,                     
    kPDPermReqOpMove,                       
    kPDPermReqOpRotate,                     
    kPDPermReqOpModify,                     
    kPDPermReqOpExtract,                    
    kPDPermReqOpAccessible,                 
    kPDPermReqOpOpen,                       
    kPDPermReqOpSecure,                     
    kPDPermReqOpPrint,                      
    kPDPermReqOpPrintHigh,                  
    kPDPermReqOpFillIn,                     
    kPDPermReqOpFullSave,                   
    kPDPermReqOpCopy,                       
    kPDPermReqOpCopyForAccessibility,       
    kPDPermReqOpCreationOfTemplatePages,    
    kPDPermReqOpAllowDocAssembly            
} PDPermReqOp;
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptNewAuthDataProc)(void* clientData, void** pAuthData);
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptFreeAuthDataProc)(void* authData);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptNewSecurityDataProc)(void* clientData,
                                                               PDObject encryptDict,
                                                               void** pSecurityData);
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptCopySecurityDataProc)(void* securityData,
                                                                void** pSecurityData);
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptFreeSecurityDataProc)(void* securityData);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptGetKeyDataProc)(void* securityData,
                                                          PDAtom cryptFilter,
                                                          PDObject decodeParms,
                                                          void* buffer,
                                                          size_t bufsize,
                                                          size_t* pSize,
                                                          PDAtom* pMethod);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptEncryptProc)(void* securityData,
                                                       const void* input,
                                                       size_t inputSize,
                                                       void* output,
                                                       size_t outputSize,
                                                       uint32_t objnum,
                                                       uint16_t generation,
                                                       PDAtom cryptFilter,
                                                       PDObject decodeParms,
                                                       size_t* pOutputSize);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptAuthorizeProc)(void* securityData,
                                                         PDPermReqObj object,
                                                         PDPermReqOp operation,
                                                         const void* authData,
                                                         bool* pGranted);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptFillEncryptDictProc)(void* securityData,
                                                               PDDoc doc,
                                                               PDObject encryptDict);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptEncryptMetadataProc)(void* securityData, bool* pEncrypt);
 
typedef PDErrCode(PDFSDK_CALLCONV* PDCryptFreeClientDataProc)(void* clientData);
 
typedef struct PDSecurityHandler {
    PDCryptNewAuthDataProc newAuthData;
    PDCryptFreeAuthDataProc freeAuthData;
    PDCryptNewSecurityDataProc newSecurityData;
    PDCryptCopySecurityDataProc copySecurityData;
    PDCryptFreeSecurityDataProc freeSecurityData;
    PDCryptGetKeyDataProc getCryptKey;
    PDCryptEncryptProc encrypt;
    PDCryptEncryptProc decrypt;
    PDCryptFillEncryptDictProc fillEncryptDict;
    PDCryptAuthorizeProc authorize;
    PDCryptEncryptMetadataProc encryptMetadata;
    PDCryptFreeClientDataProc freeClientData;
} PDSecurityHandler;
 
typedef void* PDStdSecurityData;
 
enum {
    kPDStdPermOpen = 0x01,              
    kPDStdPermSecure = 0x02,            
    kPDStdPermPrint = 0x04,             
    kPDStdPermEdit = 0x08,              
    kPDStdPermCopy = 0x10,              
    kPDStdPermEditNotes = 0x20,         
    kPDStdPermSaveAs = 0x40,            
    kPDStdPermExt = 0x80,               
    kPDStdPermFillAndSign = 0x100,      
    kPDStdPermAccessible = 0x200,       
    kPDStdPermDocAssembly = 0x400,      
    kPDStdPermHighPrint = 0x800,        
    kPDStdPermOwner = 0x8000,           
    kPDStdPermFormSubmit = 0x10000,     
    kPDStdPermFormSpawnTempl = 0x20000  
};
typedef uint32_t PDStdPerms;
 
enum { kPDStdPasswordMaxChars = 255 };
typedef wchar_t PDStdPassword[kPDStdPasswordMaxChars + 1];
 
typedef struct
{
    PDStdPassword userPassword;
 
    bool hasUserPassword;
 
    PDStdPassword ownerPassword;
 
    /*
     * Set to `true` if there is an owner password.
     * If this is `true` but `ownerPassword` is empty then owner is not authorized yet
     */
    bool hasOwnerPassword;
 
    PDStdPerms permissions;
 
    int revision;
 
    int version;
 
    PDAtom cryptMethod;
 
    int keyLength;
 
    bool encryptMetadata;
 
    bool encryptAttachmentsOnly;
 
} PDStdSecurityParams;
 
enum {
    kPDStdSecurityModifyUserPassword = 0x01,
    kPDStdSecurityModifyOwnerPassword = 0x02
};
typedef uint32_t PDStdSecurityModifyFlags;
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetNewSecurityHandler(PDDoc doc, PDAtom name, void* securityData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetSecurityHandlerData(PDDoc doc, void** pSecurityData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetSecurityHandlerName(PDDoc doc, PDAtom* pName);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetNewSecurityHandlerData(PDDoc doc, void** pSecurityData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetNewSecurityHandlerName(PDDoc doc, PDAtom* pFilter);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocEncryptionIsModified(PDDoc doc, bool* pValue);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocPermRequest(PDDoc doc, PDPermReqObj permReqObj, PDPermReqOp permReqOp, const void* authData, bool* pGranted);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocPermRequestSecurity(PDDoc doc, PDPermReqObj permReqObj, PDPermReqOp permReqOp, const void* authData, bool* pGranted);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocPermRequestWithAuth(PDDoc doc, PDPermReqObj permReqObj, PDPermReqOp permReqOp, bool* pGranted);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSecurityRegisterHandler(PDAtom filter, const PDSecurityHandler* handler, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSecurityNewAuthData(PDAtom filter, void** pAuthData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSecurityFreeAuthData(PDAtom filter, void* authData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDStdSecurityDataNew(PDDoc doc, PDStdSecurityData* pSecurityData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDStdSecurityDataUpdateParams(PDStdSecurityData securityData,
                                                                     PDStdSecurityModifyFlags modifyFlags,
                                                                     const PDStdSecurityParams* params);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDStdSecurityDataGetParams(PDStdSecurityData securityData, PDStdSecurityParams* pParams);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDStdSecurityDataFree(PDStdSecurityData securityData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDStdPasswordSetChars(PDStdPassword* authData, const wchar_t* chars);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_SECURITY_H_INCLUDED_