Foxit PDF SDK
|
Instance Methods | |
(void *) | - createContext:sub_filter:encrypt_info: |
A callback function used to create context for encryption and decryption. More... | |
(NSData *) | - decryptData:encrypted_data:encrypted_data_len: |
A callback function used to decrypt the encrypted data. More... | |
(BOOL) | - encryptData:obj_num:gen_num:src_data:src_data_len:out_dst_buffer:out_dst_buffer_len: |
A callback function used to get encrypted data. More... | |
(NSData *) | - finishDecryptor: |
A callback function used to finish the decryption. More... | |
(FSSecurityHandlerCipherType) | - getCipher: |
A callback function used to get the cipher type. More... | |
(unsigned int) | - getDecryptedSize:src_data_size: |
A callback function used to get the estimated decrypted data size. More... | |
(unsigned int) | - getEncryptedSize:obj_num:gen_num:src_data:src_data_len: |
A callback function used to get the estimated encrypted size. More... | |
(NSData *) | - getEncryptKey: |
A callback function used to get the encryption key. More... | |
(unsigned int) | - getUserPermissions:user_permission: |
A callback function used to get the user permissions. More... | |
(BOOL) | - isOwner: |
A callback function used to check if current user is the owner of the PDF document. More... | |
(BOOL) | - releaseContext: |
A callback function used to release the context for encryption and decryption. More... | |
(void *) | - startDecryptor:obj_num:gen_num: |
A callback function used to start a decryption. More... | |
![]() | |
(FSPDFDocEncryptType) | - GetSecurityType |
Get the encryption type of security callback. More... | |
This class represents a callback object for custom decryption and encryption. If user wants to use custom security callback, user should inherit this callback class and implement the pure virtual functions (as callback functions), and then register the custom security callback object to Foxit PDF SDK by function FSLibrary::registerSecurityCallback:callback: with with any custom filter name (following the PDF name conventions). Function FSLibrary::unregisterSecurityCallback: can be called to unregister the security callback object with the registered filter name.
|
required |
A callback function used to create context for encryption and decryption.
[in] | filter | The encryption filter of the PDF document. |
[in] | sub_filter | The sub filter of the PDF document. |
[in] | encrypt_info | The encryption information of the PDF document. |
|
required |
A callback function used to decrypt the encrypted data.
[in] | decryptor | The decryptor implemented and created by user, returned by callback function FSCustomSecurityCallback::startDecryptor:obj_num:gen_num:. |
[in] | encrypted_data | The buffer which stores the encrypted data. |
[in] | encrypted_data_len | The length of encrypted data, in bytes. |
|
required |
A callback function used to get encrypted data.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
[in] | obj_num | The object number for a PDF object. |
[in] | gen_num | The generation number for a PDF object. |
[in] | src_data | The buffer which stores the plain text to be encrypted. |
[in] | src_data_len | The length of the buffer. |
[out] | out_dst_buffer | Output parameter used to receives the encrypted content. |
[out] | out_dst_buffer_len | Output parameter used to received the length of the encrypted data. |
|
required |
A callback function used to finish the decryption.
[in] | decryptor | The decryptor implemented and created by user, returned by callback function FSCustomSecurityCallback::startDecryptor:obj_num:gen_num:. |
|
required |
A callback function used to get the cipher type.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
|
required |
A callback function used to get the estimated decrypted data size.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
[in] | src_data_size | Size of source data which is to be decrypted. |
|
required |
A callback function used to get the estimated encrypted size.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
[in] | obj_num | The object number for a PDF object. |
[in] | gen_num | The generation number for a PDF object. |
[in] | src_data | The buffer which stores the plain text to be encrypted. |
[in] | src_data_len | The length of the buffer. |
|
required |
A callback function used to get the encryption key.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
|
required |
A callback function used to get the user permissions.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
[in] | user_permission | Original permission settings of the document. Please refer to values starting from FSPDFDocPermPrint and this would be one or combination of these values. |
|
required |
A callback function used to check if current user is the owner of the PDF document.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
|
required |
A callback function used to release the context for encryption and decryption.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
|
required |
A callback function used to start a decryption.
[in] | context | The context for encryption and decryption, returned by callback function FSCustomSecurityCallback::createContext:sub_filter:encrypt_info:. |
[in] | obj_num | The object number for a PDF object. |
[in] | gen_num | The generation number for a PDF object. |