Foxit PDF SDK
|
Public Member Functions | |
virtual global::System.IntPtr | CreateContext (string filter, string sub_filter, string encrypt_info) |
A callback function used to create context for encryption and decryption. More... | |
virtual System.IntPtr | DecryptData (global::System.IntPtr decryptor, global::System.IntPtr encrypted_data, int encrypted_data_len) |
A callback function used to decrypt the encrypted data. More... | |
virtual bool | EncryptData (global::System.IntPtr context, int obj_num, int gen_num, global::System.IntPtr src_data, int src_data_len, global::System.IntPtr out_dst_buffer, out int out_dst_buffer_len) |
A callback function used to get encrypted data. More... | |
virtual string | FinishDecryptor (global::System.IntPtr decryptor) |
A callback function used to finish the decryption. More... | |
virtual SecurityHandler.CipherType | GetCipher (global::System.IntPtr context) |
A callback function used to get the cipher type. More... | |
virtual int | GetDecryptedSize (global::System.IntPtr context, int src_data_size) |
A callback function used to get the estimated decrypted data size. More... | |
virtual int | GetEncryptedSize (global::System.IntPtr context, int obj_num, int gen_num, global::System.IntPtr src_data, int src_data_len) |
A callback function used to get the estimated encrypted size. More... | |
virtual string | GetEncryptKey (global::System.IntPtr context) |
A callback function used to get the encryption key. More... | |
override PDFDoc.EncryptType | GetSecurityType () |
Get the encryption type of security callback. More... | |
virtual int | GetUserPermissions (global::System.IntPtr context, int user_permission) |
A callback function used to get the user permissions. More... | |
virtual bool | IsOwner (global::System.IntPtr context) |
A callback function used to check if current user is the owner of the PDF document. More... | |
virtual bool | ReleaseContext (global::System.IntPtr context) |
A callback function used to release the context for encryption and decryption. More... | |
virtual global::System.IntPtr | StartDecryptor (global::System.IntPtr context, int obj_num, int gen_num) |
A callback function used to start a decryption. More... | |
virtual bool | UseStandardCryptoMethod (global::System.IntPtr context) |
A callback function to check if to use standard crypto method or custom crypto method. More... | |
![]() | |
virtual void | Release () |
A callback function used to release current callback object itself. 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 common.Library.RegisterSecurityCallback with with any custom filter name (following the PDF name conventions). Function common.Library.UnregisterSecurityCallback can be called to unregister the security callback object with the registered filter name.
|
inlinevirtual |
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. |
|
inlinevirtual |
A callback function used to decrypt the encrypted data.
[in] | decryptor | The decryptor implemented and created by user, returned by callback function CustomSecurityCallback.StartDecryptor . |
[in] | encrypted_data | The buffer which stores the encrypted data. |
[in] | encrypted_data_len | The length of encrypted data, in bytes. |
|
inlinevirtual |
A callback function used to get encrypted data.
[in] | context | The context for encryption and decryption, returned by callback function 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. |
[out] | out_dst_buffer | Output parameter that receives the encrypted content. |
[out] | out_dst_buffer_len | Output parameter that receives the length of the encrypted data. |
|
inlinevirtual |
A callback function used to finish the decryption.
[in] | decryptor | The decryptor implemented and created by user, returned by callback function CustomSecurityCallback.StartDecryptor . |
|
inlinevirtual |
A callback function used to get the cipher type.
[in] | context | The context for encryption and decryption, returned by callback function CustomSecurityCallback.CreateContext . |
|
inlinevirtual |
A callback function used to get the estimated decrypted data size.
[in] | context | The context for encryption and decryption, returned by callback function CustomSecurityCallback.CreateContext . |
[in] | src_data_size | Size of source data which is to be decrypted. |
|
inlinevirtual |
A callback function used to get the estimated encrypted size.
[in] | context | The context for encryption and decryption, returned by callback function 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. |
|
inlinevirtual |
A callback function used to get the encryption key.
[in] | context | The context for encryption and decryption, returned by callback function CustomSecurityCallback.CreateContext . |
|
inlinevirtual |
Get the encryption type of security callback.
Reimplemented from foxit.pdf.SecurityCallback.
Reimplemented in foxit.pdf.RMSSecurityCallback.
|
inlinevirtual |
A callback function used to get the user permissions.
[in] | context | The context for encryption and decryption, returned by callback function CustomSecurityCallback.CreateContext . |
[in] | user_permission | Original permission settings of the document. Please refer to values starting from foxit.pdf.PDFDoc.UserPermissions.e_PermPrint and this would be one or combination of these values. |
|
inlinevirtual |
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 CustomSecurityCallback.CreateContext . |
|
inlinevirtual |
A callback function used to release the context for encryption and decryption.
[in] | context | The context for encryption and decryption, returned by callback function CustomSecurityCallback.CreateContext . |
|
inlinevirtual |
A callback function used to start a decryption.
[in] | context | The context for encryption and decryption, returned by callback function CustomSecurityCallback.CreateContext . |
[in] | obj_num | The object number for a PDF object. |
[in] | gen_num | The generation number for a PDF object. |
|
inlinevirtual |
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 CustomSecurityCallback.CreateContext . |
<ul> <li> <b>true</b> means to use standard crypto method. In this case, callback functions @link CustomSecurityCallback::GetDecryptedSize CustomSecurityCallback.GetDecryptedSize @endlink, @link CustomSecurityCallback::StartDecryptor CustomSecurityCallback.StartDecryptor @endlink, @link CustomSecurityCallback::DecryptData CustomSecurityCallback.DecryptData @endlink, @link CustomSecurityCallback::FinishDecryptor CustomSecurityCallback.FinishDecryptor @endlink, @link CustomSecurityCallback::GetEncryptedSize CustomSecurityCallback.GetEncryptedSize @endlink, and @link CustomSecurityCallback::EncryptData 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>