15 #ifndef FS_SECURITY_H_ 16 #define FS_SECURITY_H_ 32 class CustomSecurityCallback;
33 class RMSSecurityCallback;
63 typedef enum _CipherType {
457 #if (_FX_OS_ == _FX_IOS_ || _FX_OS_ == _FX_ANDROID_ || defined(SWIG)) && !defined(_SWIG_JAVA_) && !defined(_SWIG_DOTNET_) && !defined(_OC_) && !defined(_SWIG_MACOC_) 459 class Envelope :
public Base {
467 Envelope(
const void* buffer,
size_t size);
473 Envelope(
const char* certFilePath);
478 Envelope(
const Envelope& other);
492 String GetDecryptionKey(
const char* p12FilePath,
const String& password);
517 #if (_FX_OS_ == _FX_IOS_ || _FX_OS_ == _FX_ANDROID_ || defined(SWIG)) && !defined(_SWIG_JAVA_) && !defined(_SWIG_DOTNET_) && !defined(_OC_) && !defined(_SWIG_MACOC_) 531 #endif // (_FX_OS_ == _FX_IOS_ || _FX_OS_ == _FX_ANDROID_ || defined(SWIG)) && !defined(_SWIG_JAVA_) && !defined(_SWIG_DOTNET_) && !defined(_OC_) && !defined(_SWIG_MACOC_) 1266 virtual bool IsOwner(
const PDFDoc& document,
const char* sub_filter) = 0;
1361 virtual void*
CreateContext(
const char* filter,
const char* sub_filter,
const char* encrypt_info) = 0;
1397 virtual bool IsOwner(
const void* context) = 0;
1445 virtual void*
StartDecryptor(
const void* context,
int obj_num,
int gen_num) = 0;
1485 const void* src_data,
uint32 src_data_len) = 0;
1502 virtual bool EncryptData(
const void* context,
int obj_num,
int gen_num,
1503 const void* src_data,
uint32 src_data_len,
1504 void* out_dst_buffer,
uint32* out_dst_buffer_len) = 0;
1534 #endif // FS_SECURITY_H_ StdEncryptData()
Constructor.
Definition: fs_security.h:163
String sub_filter
The sub filter of PDF document for encryption. It should not be an empty string.
Definition: fs_security.h:893
bool InitializeW(const StdEncryptData &encrypt_data, const WString &user_password, const WString &owner_password)
(Only for AES-256) Initialize current standard security handler.
bool Initialize(const CustomEncryptData &encrypt_data, const CustomSecurityCallback *callback, const char *encrypt_info="")
Initialize current custom security handler.
bool SetDRMValue(const char *key, const WString &value)
Set the DRM value for a specified parameter.
CertificateEncryptData(const CertificateEncryptData &other)
Constructor, with another CertificateEncryptData object.
Definition: fs_security.h:363
bool is_encrypt_metadata
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata...
Definition: fs_security.h:889
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of current security callback.
Definition: fs_security.h:1221
SecurityHandler::CipherType cipher
Cipher type. Please refer to values starting from SecurityHandler::e_CipherRC4 and this should be one...
Definition: fs_security.h:269
String filter
The filter of PDF document for encryption. It should not be an empty string.
Definition: fs_security.h:891
bool operator!=(const StdEncryptData &other) const
Not equal operator.
Definition: fs_security.h:220
virtual String GetEncryptKey(const void *context)=0
A callback function used to get the encryption key.
bool Initialize(const CertificateEncryptData &encrypt_data, const String &encrypt_key)
Initialize current certificate security handler.
RMSSecurityHandler()
Constructor.
SecurityHandler()
Constructor.
~StdEncryptData()
Destructor.
Definition: fs_security.h:170
bool operator==(const RMSEncryptData &other) const
Equal operator.
Definition: fs_security.h:1019
virtual String GetInitialKey(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the initial key to decrypt the DRM protected document.
virtual bool ReleaseContext(void *context)=0
A callback function used to release the context for encryption and decryption.
virtual bool EncryptData(const void *context, int obj_num, int gen_num, const void *src_data, uint32 src_data_len, void *out_dst_buffer, uint32 *out_dst_buffer_len)=0
A callback function used to get encrypted data.
SecurityHandler::CipherType cipher
Cipher type. Please refer to values starting from SecurityHandler::e_CipherRC4 and this should be one...
Definition: fs_security.h:696
Header file for PDF document related definitions and classes.
int key_length
The key length, in bytes.
Definition: fs_security.h:279
RMSEncryptData(bool is_encrypt_metadata, const char *publish_license, const StringArray &server_eul_list, float irm_version=1.0)
Constructor, with parameters.
Definition: fs_security.h:965
Definition: fs_security.h:1212
Definition: fs_security.h:1246
DRMSecurityHandler()
Constructor function.
Definition: fs_security.h:721
virtual SecurityHandler::CipherType GetCipher(const void *context)=0
A callback function used to get the cipher type.
virtual ~SecurityHandler()
Destructor.
Definition: fs_security.h:506
virtual uint32 GetEncryptedSize(const void *context, int obj_num, int gen_num, const void *src_data, uint32 src_data_len)=0
A callback function used to get the estimated encrypted size.
String publish_license
The Encoded Publishing License issued from server to the Content publisher, in ASCII encoding...
Definition: fs_security.h:1107
CertificateSecurityHandler()
Constructor.
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:373
WIDE STRING CLASS.
Definition: fx_string.h:1463
WString GetDRMValue(const char *key)
Get the DRM value for a specified parameter.
virtual void * CreateContext(const char *filter, const char *sub_filter, const char *encrypt_info)=0
A callback function used to create context for encryption and decryption.
bool is_owner
A boolean value to decide whether current user is owner or not. true means current user is owner...
Definition: fs_security.h:708
virtual String GetDecryptionKey(const void *envelope_buffer, uint32 envelope_length)=0
A callback function used to get the key for decrypting certificate protected PDF document.
RMSEncryptData & operator=(const RMSEncryptData &other)
Assign operator.
Definition: fs_security.h:1004
Definition: fs_pdfdoc.h:338
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_security.h:550
~DRMEncryptData()
Destructor.
Definition: fs_security.h:591
Not use encryption algorithm.
Definition: fs_security.h:65
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1527
virtual uint32 GetUserPermissions(const void *context, uint32 user_permission)=0
A callback function used to get the user permissions.
DRMEncryptData & operator=(const DRMEncryptData &other)
Assign operator.
Definition: fs_security.h:614
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1198
void Set(bool is_encrypt_metadata, const String &filter, const String &sub_filter)
Set value.
Definition: fs_security.h:879
bool operator==(const StdEncryptData &other) const
Equal operator.
Definition: fs_security.h:206
bool operator!=(const DRMEncryptData &other) const
Not equal operator.
Definition: fs_security.h:646
RMSEncryptData(const RMSEncryptData &other)
Constructor, with another RMSEncryptData object.
Definition: fs_security.h:990
Definition: fs_security.h:937
Definition: fs_security.h:133
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:125
CustomEncryptData(const CustomEncryptData &other)
Constructor, with another CustomEncryptData object.
Definition: fs_security.h:827
bool Initialize(const RMSEncryptData &encrypt_data, const RMSSecurityCallback *callback)
Initialize current Microsoft RMS security handler.
Use AES encryption algorithm, with the key length be 16 bytes (as AES-128) or 32 bytes (as AES-256...
Definition: fs_security.h:72
StringArray envelopes
A string array which specifies an array of certificate envelopes. This array should contains one or m...
Definition: fs_security.h:454
CipherType
Enumeration for Encryption Algorithm.
Definition: fs_security.h:63
~CertificateEncryptData()
Destructor.
Definition: fs_security.h:356
bool operator!=(const CustomEncryptData &other) const
Not equal operator.
Definition: fs_security.h:865
SecurityHandler & operator=(const SecurityHandler &other)
Assign operator.
DRMEncryptData(bool is_encrypt_metadata, const String &sub_filter, SecurityHandler::CipherType cipher, int key_length, bool is_owner, uint32 user_permissions)
Constructor, with parameters.
Definition: fs_security.h:571
bool operator!=(const SecurityHandler &other)
Not equal operator.
void Set(bool is_encrypt_metadata, const String &sub_filter, SecurityHandler::CipherType cipher, int key_length, bool is_owner, uint32 user_permissions)
Set value.
Definition: fs_security.h:675
bool is_encrypt_metadata
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata...
Definition: fs_security.h:444
virtual bool IsOwner(const void *context)=0
A callback function used to check if current user is the owner of the PDF document.
virtual bool IsOwner(const PDFDoc &document, const char *sub_filter)=0
A callback function used to check if current user is the owner of the PDF document.
bool Initialize(const StdEncryptData &encrypt_data, const String &user_password, const String &owner_password)
(Not support AES-256) Initialize current standard security handler.
virtual void * StartDecryptor(const void *context, int obj_num, int gen_num)=0
A callback function used to start a decryption.
SecurityHandler::CipherType cipher
Cipher type. Please refer to values starting from SecurityHandler::e_CipherRC4 and this should be one...
Definition: fs_security.h:449
~CustomEncryptData()
Destructor.
Definition: fs_security.h:820
CustomEncryptData(bool is_encrypt_metadata, const String &filter, const String &sub_filter)
Constructor, with parameters.
Definition: fs_security.h:807
DRMEncryptData(const DRMEncryptData &other)
Constructor, with another DRMEncryptData object.
Definition: fs_security.h:598
Definition: fx_basic.h:1246
StdEncryptData(bool is_encrypt_metadata, uint32 user_permissions, SecurityHandler::CipherType cipher, int key_length)
Constructor, with parameters.
Definition: fs_security.h:154
virtual uint32 GetUserPermissions(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the current user permissions.
void Set(bool is_encrypt_metadata, uint32 user_permissions, SecurityHandler::CipherType cipher, int key_length)
Set value.
Definition: fs_security.h:248
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:369
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
Header file for common definitions and classes.
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1255
float irm_version
Microsoft IRM version. It should be above 1. If input version is below 1, Foxit PDF SDK will use 1 as...
Definition: fs_security.h:1125
StdSecurityHandler()
Constructor.
virtual void Release()=0
A callback function used to release current security callback object itself.
Definition: fs_security.h:1340
Definition: fs_security.h:1518
CertificateEncryptData(bool is_encrypt_metadata, SecurityHandler::CipherType cipher, const StringArray &envelopes)
Constructor, with parameters.
Definition: fs_security.h:344
DRMEncryptData()
Constructor.
Definition: fs_security.h:582
Definition: fs_security.h:797
virtual uint32 GetDecryptedSize(const void *context, uint32 src_data_size)=0
A callback function used to get the estimated decrypted data size.
bool Initialize(const DRMEncryptData &encrypt_data, const char *file_id, const String &initial_key)
Initialize current DRM security handler.
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:375
bool is_encrypt_metadata
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata...
Definition: fs_security.h:259
Definition: fs_basictypes.h:333
Definition: fs_basictypes.h:225
size_t GetSize() const
Get the size of current array.
StdEncryptData(const StdEncryptData &other)
Constructor, with another StdEncryptData object.
Definition: fs_security.h:177
Definition: fs_security.h:1184
CertificateEncryptData()
Constructor.
Definition: fs_security.h:351
CustomEncryptData & operator=(const CustomEncryptData &other)
Assign operator.
Definition: fs_security.h:839
virtual uint32 GetKeyLength(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the length of cipher key.
StringArray server_eul_list
A string array that contains pairs of strings to represent content of a dictionary object which is en...
Definition: fs_security.h:1120
void Set(bool is_encrypt_metadata, SecurityHandler::CipherType cipher, const StringArray &envelopes)
Set value.
Definition: fs_security.h:434
Definition: fs_security.h:901
Definition: fs_security.h:56
bool VerifyEncryptionParams()
Verify encryption parameters.
RMSEncryptData()
Constructor.
Definition: fs_security.h:977
Foxit namespace.
Definition: fs_connectedpdf.h:26
Definition: fs_security.h:1138
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of current security handler.
BYTE STRING CLASS.
Definition: fx_string.h:317
Unknown encryption type.
Definition: fs_pdfdoc.h:363
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:361
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1349
virtual String DecryptData(const void *decryptor, const void *encrypted_data, uint32 encrypted_data_len)=0
A callback function used to decrypt the encrypted data.
bool is_encrypt_metadata
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata...
Definition: fs_security.h:1096
bool operator!=(const CertificateEncryptData &other) const
Not equal operator.
Definition: fs_security.h:409
uint32 user_permissions
The user permissions. Please refer to values starting from PDFDoc::e_PermPrint and this can be one or...
Definition: fs_security.h:713
virtual String FinishDecryptor(void *decryptor)=0
A callback function used to finish the decryption.
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:137
~RMSEncryptData()
Destructor.
Definition: fs_security.h:983
int key_length
The key length, in bytes. For SecurityHandler::e_CipherRC4 cipher, this value should be between 5 an...
Definition: fs_security.h:703
uint32 user_permissions
The user permissions. Please refer to values starting from PDFDoc::e_PermPrint and this should be one...
Definition: fs_security.h:264
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:371
virtual SecurityHandler::CipherType GetCipherType(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the cipher type for encryption algorithm.
StdEncryptData & operator=(const StdEncryptData &other)
Assign operator.
Definition: fs_security.h:191
bool operator==(const DRMEncryptData &other) const
Equal operator.
Definition: fs_security.h:631
void Set(bool is_encrypt_metadata, const char *publish_license, const StringArray &server_eul_list, float irm_version=1.0)
Set value.
Definition: fs_security.h:1081
CertificateEncryptData & operator=(const CertificateEncryptData &other)
Assign operator.
Definition: fs_security.h:376
Definition: fs_security.h:287
CustomSecurityHandler()
Constructor.
bool is_encrypt_metadata
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata...
Definition: fs_security.h:689
Definition: fs_security.h:332
virtual String GetFileID(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the file identity string.
bool operator==(const CustomEncryptData &other) const
Equal operator.
Definition: fs_security.h:853
bool operator==(const SecurityHandler &other)
Equal operator.
Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes.
Definition: fs_security.h:67
CustomEncryptData()
Constructor.
Definition: fs_security.h:814
bool operator==(const CertificateEncryptData &other) const
Equal operator.
Definition: fs_security.h:390
String sub_filter
The sub filter of PDF document.
Definition: fs_security.h:691
bool operator!=(const RMSEncryptData &other) const
Not equal operator.
Definition: fs_security.h:1039