|
Foxit PDF SDK
|
Public Member Functions | |
| def | CreateContext (filter, sub_filter, encrypt_info) |
| A callback function used to create context for encryption and decryption. More... | |
| def | DecryptData (decryptor, encrypted_data, encrypted_data_len) |
| A callback function used to decrypt the encrypted data. More... | |
| def | FinishDecryptor (decryptor) |
| A callback function used to finish the decryption. More... | |
| def | GetCipher (context) |
| A callback function used to get the cipher type. More... | |
| def | GetDecryptedSize (context, src_data_size) |
| A callback function used to get the estimated decrypted data size. More... | |
| def | GetEncryptedSize (context, obj_num, gen_num, src_data, src_data_len) |
| A callback function used to get the estimated encrypted size. More... | |
| def | GetEncryptKey (context) |
| A callback function used to get the encryption key. More... | |
| def | GetSecurityType () |
| Get the encryption type of security callback. More... | |
| def | GetUserPermissions (context, user_permission) |
| A callback function used to get the user permissions. More... | |
| def | IsOwner (context) |
| A callback function used to check if current user is the owner of the PDF document. More... | |
| def | ReleaseContext (context) |
| A callback function used to release the context for encryption and decryption. More... | |
| def | StartDecryptor (context, obj_num, gen_num) |
| A callback function used to start a decryption. More... | |
| def | UseStandardCryptoMethod (context) |
| A callback function to check if to use standard crypto method or custom crypto method. 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 fsdk.LibraryRegisterSecurityCallback with with any custom filter name (following the PDF name conventions). Function fsdk.LibraryUnregisterSecurityCallback can be called to unregister the security callback object with the registered filter name.
| def fsdk.CustomSecurityCallback.CreateContext | ( | filter, | |
| sub_filter, | |||
| encrypt_info | |||
| ) |
A callback function used to create context for encryption and decryption.
| [in] | filter | The filter name of the custom security callback object. |
| [in] | sub_filter | The sub filter name that specifies the syntax of the encryption dictionary contents. |
| [in] | encrypt_info | The encryption information of the PDF document. |
| def fsdk.CustomSecurityCallback.DecryptData | ( | decryptor, | |
| encrypted_data, | |||
| encrypted_data_len | |||
| ) |
A callback function used to decrypt the encrypted data.
| [in] | decryptor | The decryptor implemented and created by user, returned by callback function fsdk.CustomSecurityCallback.StartDecryptor . |
| [in] | encrypted_data | The buffer which stores the encrypted data. |
| [in] | encrypted_data_len | The length of encrypted data, in bytes. |
| def fsdk.CustomSecurityCallback.FinishDecryptor | ( | decryptor | ) |
A callback function used to finish the decryption.
| [in] | decryptor | The decryptor implemented and created by user, returned by callback function fsdk.CustomSecurityCallback.StartDecryptor . |
| def fsdk.CustomSecurityCallback.GetCipher | ( | context | ) |
A callback function used to get the cipher type.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| def fsdk.CustomSecurityCallback.GetDecryptedSize | ( | context, | |
| src_data_size | |||
| ) |
A callback function used to get the estimated decrypted data size.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| [in] | src_data_size | Size of source data which is to be decrypted. |
| def fsdk.CustomSecurityCallback.GetEncryptedSize | ( | context, | |
| obj_num, | |||
| gen_num, | |||
| src_data, | |||
| src_data_len | |||
| ) |
A callback function used to get the estimated encrypted size.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| [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. |
| def fsdk.CustomSecurityCallback.GetEncryptKey | ( | context | ) |
A callback function used to get the encryption key.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| def fsdk.CustomSecurityCallback.GetSecurityType | ( | ) |
Get the encryption type of security callback.
| def fsdk.CustomSecurityCallback.GetUserPermissions | ( | context, | |
| user_permission | |||
| ) |
A callback function used to get the user permissions.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| [in] | user_permission | Original permission settings of the document. Please refer to values starting from fsdk.PDFDocE_PermPrint and this would be one or combination of these values. |
| def fsdk.CustomSecurityCallback.IsOwner | ( | context | ) |
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 fsdk.CustomSecurityCallback.CreateContext . |
| def fsdk.CustomSecurityCallback.ReleaseContext | ( | context | ) |
A callback function used to release the context for encryption and decryption.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| def fsdk.CustomSecurityCallback.StartDecryptor | ( | context, | |
| obj_num, | |||
| gen_num | |||
| ) |
A callback function used to start a decryption.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
| [in] | obj_num | The object number for a PDF object. |
| [in] | gen_num | The generation number for a PDF object. |
| def fsdk.CustomSecurityCallback.UseStandardCryptoMethod | ( | context | ) |
A callback function to check if to use standard crypto method or custom crypto method.
| [in] | context | The context for encryption and decryption, returned by callback function fsdk.CustomSecurityCallback.CreateContext . |
<ul> <li> <b>true</b> means to use standard crypto method. In this case, callback functions @link fsdk::CustomSecurityCallback::GetDecryptedSize fsdk.CustomSecurityCallback.GetDecryptedSize @endlink, @link fsdk::CustomSecurityCallback::StartDecryptor fsdk.CustomSecurityCallback.StartDecryptor @endlink, @link fsdk::CustomSecurityCallback::DecryptData fsdk.CustomSecurityCallback.DecryptData @endlink, @link fsdk::CustomSecurityCallback::FinishDecryptor fsdk.CustomSecurityCallback.FinishDecryptor @endlink, @link fsdk::CustomSecurityCallback::GetEncryptedSize fsdk.CustomSecurityCallback.GetEncryptedSize @endlink, and @link CustomSecurityCallback::EncryptData @endlink will be uselss and user can just use empty implementation for them. </li> <li> <b>false</b> means use custom crypto method. In this case, please ensure callback functions mentioned above have all been implemented. </li> </ul>