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_) 1272 virtual bool IsOwner(
const PDFDoc& document,
const char* sub_filter) = 0;
1367 virtual void*
CreateContext(
const char* filter,
const char* sub_filter,
const char* encrypt_info) = 0;
1403 virtual bool IsOwner(
const void* context) = 0;
1451 virtual void*
StartDecryptor(
const void* context,
int obj_num,
int gen_num) = 0;
1491 const void* src_data,
uint32 src_data_len) = 0;
1508 virtual bool EncryptData(
const void* context,
int obj_num,
int gen_num,
1509 const void* src_data,
uint32 src_data_len,
1510 void* out_dst_buffer,
uint32* out_dst_buffer_len) = 0;
1540 #endif // FS_SECURITY_H_ virtual uint32 GetDecryptedSize(const void *context, uint32 src_data_size)=0
A callback function used to get the estimated decrypted data size.
SecurityHandler::CipherType cipher
Cipher type. Please refer to values starting from SecurityHandler::e_CipherRC4 and this should be one...
Definition: fs_security.h:269
bool IsEmpty() const
Check whether current object is empty or not.
virtual String FinishDecryptor(void *decryptor)=0
A callback function used to finish the decryption.
bool operator==(const SecurityHandler &other)
Equal operator.
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:967
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.
~RMSEncryptData()
Destructor.
Definition: fs_security.h:985
String filter
The filter of PDF document for encryption. It should not be an empty string.
Definition: fs_security.h:891
virtual SecurityHandler::CipherType GetCipherType(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the cipher type for encryption algorithm.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
bool operator==(const DRMEncryptData &other) const
Equal operator.
Definition: fs_security.h:631
CustomEncryptData(bool is_encrypt_metadata, const String &filter, const String &sub_filter)
Constructor, with parameters.
Definition: fs_security.h:807
bool operator !=(const StdEncryptData &other) const
Not equal operator.
Definition: fs_security.h:220
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.
RMSSecurityHandler()
Constructor.
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1355
DRMSecurityHandler()
Constructor function.
Definition: fs_security.h:1524
CertificateEncryptData(const CertificateEncryptData &other)
Constructor, with another certificate encrypt data object.
Definition: fs_security.h:363
bool operator==(const CertificateEncryptData &other) const
Equal operator.
Definition: fs_security.h:390
bool operator !=(const RMSEncryptData &other) const
Not equal operator.
Definition: fs_security.h:1041
Definition: fs_basictypes.h:228
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of current security callback.
Definition: fs_security.h:1227
size_t GetSize() const
Get the size of elements in current array.
CustomEncryptData(const CustomEncryptData &other)
Constructor, with another custom encrypt data object.
Definition: fs_security.h:827
Definition: fs_security.h:332
CertificateSecurityHandler()
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:259
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 void * StartDecryptor(const void *context, int obj_num, int gen_num)=0
A callback function used to start a decryption.
~StdEncryptData()
Destructor.
Definition: fs_security.h:170
String sub_filter
The sub filter of PDF document for encryption. It should not be an empty string.
Definition: fs_security.h:893
CustomEncryptData & operator=(const CustomEncryptData &other)
Assign operator.
Definition: fs_security.h:839
bool Initialize(const StdEncryptData &encrypt_data, const String &user_password, const String &owner_password)
(Not support AES-256) Initialize current standard security handler.
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
Header file for common definitions and classes.
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.
Definition: fx_basic.h:1287
virtual String DecryptData(const void *decryptor, const void *encrypted_data, uint32 encrypted_data_len)=0
A callback function used to decrypt the encrypted data.
Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes.
Definition: fs_security.h:67
bool SetDRMValue(const char *key, const WString &value)
Set the DRM value for a specified parameter.
Definition: fs_security.h:937
Definition: fs_security.h:1346
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of current security handler.
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1204
StdEncryptData & operator=(const StdEncryptData &other)
Assign operator.
Definition: fs_security.h:191
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:371
~CertificateEncryptData()
Destructor.
Definition: fs_security.h:356
Definition: fs_security.h:901
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1533
void Set(bool is_encrypt_metadata, uint32 user_permissions, SecurityHandler::CipherType cipher, int key_length)
Set value.
Definition: fs_security.h:248
virtual bool IsOwner(const void *context)=0
A callback function used to check if current user is the owner of the PDF document.
Definition: fs_security.h:506
SecurityHandler()
Constructor.
CustomSecurityHandler()
Constructor.
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
String publish_license
The Encoded Publishing License issued from server to the Content publisher, in ASCII encoding....
Definition: fs_security.h:1111
CipherType
Enumeration for Encryption Algorithm.
Definition: fs_security.h:63
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.
void Set(bool is_encrypt_metadata, const String &filter, const String &sub_filter)
Set value.
Definition: fs_security.h:879
Definition: fs_security.h:797
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
virtual uint32 GetUserPermissions(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the current user permissions.
~CustomEncryptData()
Destructor.
Definition: fs_security.h:820
Definition: fs_security.h:1190
Definition: fs_security.h:1218
RMSEncryptData(const RMSEncryptData &other)
Constructor, with another RMS encrypt data object.
Definition: fs_security.h:992
BYTE STRING CLASS.
Definition: fx_string.h:317
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
~DRMEncryptData()
Destructor.
Definition: fs_security.h:591
StdEncryptData(bool is_encrypt_metadata, uint32 user_permissions, SecurityHandler::CipherType cipher, int key_length)
Constructor, with parameters.
Definition: fs_security.h:154
virtual PDFDoc::EncryptType GetSecurityType()
Get the encryption type of security callback.
Definition: fs_security.h:1261
RMSEncryptData & operator=(const RMSEncryptData &other)
Assign operator.
Definition: fs_security.h:1006
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:375
bool Initialize(const CustomEncryptData &encrypt_data, const CustomSecurityCallback *callback, const char *encrypt_info="")
Initialize current custom security handler.
int key_length
The key length, in bytes.
Definition: fs_security.h:279
DRMEncryptData()
Constructor.
Definition: fs_security.h:582
Unknown encryption type.
Definition: fs_pdfdoc.h:363
virtual ~SecurityHandler()
Destructor.
CertificateEncryptData(bool is_encrypt_metadata, SecurityHandler::CipherType cipher, const StringArray &envelopes)
Constructor, with parameters.
Definition: fs_security.h:344
SecurityHandler::CipherType cipher
Cipher type. Please refer to values starting from SecurityHandler::e_CipherRC4 and this should be one...
Definition: fs_security.h:449
bool Initialize(const DRMEncryptData &encrypt_data, const char *file_id, const String &initial_key)
Initialize current DRM security handler.
Definition: fs_security.h:133
DRMEncryptData & operator=(const DRMEncryptData &other)
Assign operator.
Definition: fs_security.h:614
StdEncryptData()
Constructor.
Definition: fs_security.h:163
Definition: fs_security.h:287
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
virtual void Release()=0
A callback function used to release current callback object itself.
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:1125
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:1130
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:361
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 CertificateEncryptData &encrypt_data, const String &encrypt_key)
Initialize current certificate security handler.
Foxit namespace.
Definition: fs_connectedpdf.h:26
Definition: fs_security.h:56
bool VerifyEncryptionParams()
Verify encryption parameters.
void Set(bool is_encrypt_metadata, SecurityHandler::CipherType cipher, const StringArray &envelopes)
Set value.
Definition: fs_security.h:434
DRMEncryptData(const DRMEncryptData &other)
Constructor, with another DRM encrypt data object.
Definition: fs_security.h:598
StringArray envelopes
A string array which specifies an array of certificate envelopes. This array should contains one or m...
Definition: fs_security.h:454
Definition: fs_security.h:1143
StdEncryptData(const StdEncryptData &other)
Constructor, with another standard encrypt data object.
Definition: fs_security.h:177
WString GetDRMValue(const char *key)
Get the DRM value for a specified parameter.
virtual SecurityHandler::CipherType GetCipher(const void *context)=0
A callback function used to get the cipher type.
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:369
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
CertificateEncryptData()
Constructor.
Definition: fs_security.h:351
bool operator !=(const DRMEncryptData &other) const
Not equal operator.
Definition: fs_security.h:646
Header file for PDF document related definitions and classes.
virtual uint32 GetUserPermissions(const void *context, uint32 user_permission)=0
A callback function used to get the user permissions.
virtual bool ReleaseContext(void *context)=0
A callback function used to release the context for encryption and decryption.
CustomEncryptData()
Constructor.
Definition: fs_security.h:814
Definition: fs_pdfdoc.h:338
virtual String GetEncryptKey(const void *context)=0
A callback function used to get the encryption key.
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
Not use encryption algorithm.
Definition: fs_security.h:65
bool operator==(const CustomEncryptData &other) const
Equal operator.
Definition: fs_security.h:853
bool is_encrypt_metadata
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata,...
Definition: fs_security.h:1100
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
SecurityHandler & operator=(const SecurityHandler &other)
Assign operator.
bool Initialize(const RMSEncryptData &encrypt_data, const RMSSecurityCallback *callback)
Initialize current Microsoft RMS security handler.
Definition: fs_security.h:550
bool operator !=(const SecurityHandler &other)
Not equal operator.
bool operator==(const StdEncryptData &other) const
Equal operator.
Definition: fs_security.h:206
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
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:373
virtual String GetFileID(const PDFDoc &document, const char *sub_filter)=0
A callback function used to get the file identity string.
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
bool operator !=(const CustomEncryptData &other) const
Not equal operator.
Definition: fs_security.h:865
bool operator !=(const CertificateEncryptData &other) const
Not equal operator.
Definition: fs_security.h:409
StdSecurityHandler()
Constructor.
WIDE STRING CLASS.
Definition: fx_string.h:1470
Definition: fs_security.h:721
String sub_filter
The sub filter of PDF document.
Definition: fs_security.h:691
RMSEncryptData()
Constructor.
Definition: fs_security.h:979
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
Definition: fs_security.h:1252
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:1085
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
bool InitializeW(const StdEncryptData &encrypt_data, const WString &user_password, const WString &owner_password)
(Only for AES-256) Initialize current standard security handler.
CertificateEncryptData & operator=(const CertificateEncryptData &other)
Assign operator.
Definition: fs_security.h:376
Definition: fs_basictypes.h:342
bool operator==(const RMSEncryptData &other) const
Equal operator.
Definition: fs_security.h:1021
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
SecurityHandler::CipherType cipher
Cipher type. Please refer to values starting from SecurityHandler::e_CipherRC4 and this should be one...
Definition: fs_security.h:696