SecurityHandler.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPSDFSecurityHandler
#define PDFTRON_H_CPPSDFSecurityHandler
 
#include <vector>
#include <Common/UString.h>
#include <Filters/Filter.h>
 
namespace pdftron { 
    namespace SDF {
 
class Obj;
class SDFDoc;
 

class SecurityHandler
{
public:
 
    enum Permission
    {
        e_owner = 1,     
        e_doc_open,         
        e_doc_modify,       
        e_print,            
        e_print_high,       
        e_extract_content,  
        e_mod_annot,        
        e_fill_forms,       
        e_access_support,   
        e_assemble_doc      
    };

     bool GetPermission(Permission p);

     int GetKeyLength() const;

     int GetEncryptionAlgorithmID() const;

     const char* GetHandlerDocName() const;

     bool IsModified () const;

     bool IsValid () const;
    
     
     void SetModified (bool is_modified = true);
 

    enum AlgorithmType {
                e_RC4_40 = 1,      
                e_RC4_128,         
                e_AES,             
                e_AES_256         
    };
 
     SecurityHandler (AlgorithmType crypt_type);    

     SecurityHandler (const char* name, int key_len, int enc_code);  
     SecurityHandler ();
 
     SecurityHandler (const SecurityHandler& s);
     SecurityHandler& operator= (const SecurityHandler&);
     virtual ~SecurityHandler ();
    
     void ChangeUserPasswordASCII(const char* password);

     void ChangeUserPassword(const char* password, size_t pwd_length );

    void ChangeUserPassword(const pdftron::UString& password);
     
    void ChangeUserPassword(const std::vector<pdftron::UInt8>& password_buf);
 
     const char* GetUserPassword();
         
     size_t GetUserPasswordSize() const;

     void ChangeMasterPasswordASCII(const char* password);
    
    void ChangeMasterPassword(const char* password, size_t pwd_length);

    void ChangeMasterPassword(const pdftron::UString& password);
     
    void ChangeMasterPassword(const std::vector<pdftron::UInt8>& password_buf);
 
    const char* GetMasterPassword();
 
     size_t GetMasterPasswordSize() const;

     void SetPermission (Permission perm, bool value);

     void ChangeRevisionNumber (int rev_num);

     void SetEncryptMetadata(bool encrypt_metadata);

     int GetRevisionNumber ();

     bool IsUserPasswordRequired ();

     bool IsMasterPasswordRequired ();

     bool IsAES() const;

     bool IsAES(Obj stream) const;

     bool IsRC4() const;
 
     operator bool () { return mp_handler!=0;}

     virtual void AuthorizeFailed();

     virtual bool Authorize (Permission p);

     virtual bool GetAuthorizationData (Permission req_opr);

     virtual bool EditSecurityData(SDFDoc& doc);

     virtual Obj FillEncryptDict(class SDFDoc& doc);

    virtual SecurityHandler* Clone(TRN_SecurityHandler base) const;
 
     void InitPasswordASCII(const char* password);
 
     void InitPassword(const char* password, size_t pwd_length);
     
     void InitPassword(const pdftron::UString& password);
     
     void InitPassword(const std::vector<pdftron::UInt8>& password_buf);
 
 
     enum OverloadedFunction {
         has_CloneProc         = 0x01,
         has_AuthProc          = 0x02, 
         has_AuthFailedProc    = 0x04, 
         has_GetAuthDataProc   = 0x08, 
         has_EditSecurDataProc = 0x10, 
         has_FillEncDictProc   = 0x20
     };
 
     void SetDerived(UInt32 overloaded_funct);
 
     SecurityHandler* GetDerived() const;
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
     SecurityHandler(TRN_SecurityHandler impl, bool owner, UInt32 derived_procs);
     TRN_SecurityHandler mp_handler;
     bool m_owner; 
     UInt32 m_derived_procs;
#endif
// @endcond
};
 
 
    };  // namespace SDF
};  // namespace pdftron
 
#include <Impl/SDFDoc.inl>
 
#endif // PDFTRON_H_CPPSDFSecurityHandler