Foxit PDF SDK
fsdk.CustomSecurityCallback类 参考

Public 成员函数

def CreateContext (filter, sub_filter, encrypt_info)
 用于创建加密和解密上下文的回调函数。 更多...
 
def DecryptData (decryptor, encrypted_data, encrypted_data_len)
 用于解密加密数据的回调函数。 更多...
 
def FinishDecryptor (decryptor)
 用于完成解密的回调函数。 更多...
 
def GetCipher (context)
 用于获取密码类型的回调函数。 更多...
 
def GetDecryptedSize (context, src_data_size)
 用于获取估计的解密数据大小的回调函数。 更多...
 
def GetEncryptedSize (context, obj_num, gen_num, src_data, src_data_len)
 用于获取估计的加密大小的回调函数。 更多...
 
def GetEncryptKey (context)
 用于获取加密密钥的回调函数。 更多...
 
def GetSecurityType ()
 获取安全回调的加密类型。 更多...
 
def GetUserPermissions (context, user_permission)
 用于获取用户权限的回调函数。 更多...
 
def IsOwner (context)
 用于检查当前用户是否是PDF文档所有者的回调函数。 更多...
 
def ReleaseContext (context)
 用于释放加密和解密上下文的回调函数。 更多...
 
def StartDecryptor (context, obj_num, gen_num)
 用于开始解密的回调函数。 更多...
 
def UseStandardCryptoMethod (context)
 用于检查是否使用标准加密方法或自定义加密方法的回调函数。 更多...
 

详细描述

此类表示自定义解密和加密的回调对象。如果用户想要使用 自定义安全回调,用户应该继承此回调类并实现纯虚函数 (作为回调函数),然后通过函数 fsdk.LibraryRegisterSecurityCallback 并使用任何自定义过滤器名称(遵循PDF名称约定)向 Foxit PDF SDK 注册自定义安全回调对象。 函数 fsdk.LibraryUnregisterSecurityCallback 可以用来注销具有 注册过滤器名称的安全回调对象。

成员函数说明

◆ CreateContext()

def fsdk.CustomSecurityCallback.CreateContext (   filter,
  sub_filter,
  encrypt_info 
)

用于创建加密和解密上下文的回调函数。

参数
[in]filter自定义安全回调对象的过滤器名称。
[in]sub_filter指定加密字典内容语法的子过滤器名称。
[in]encrypt_infoPDF文档的加密信息。
注解
用户应该实现此回调函数。
返回
加密上下文。

◆ DecryptData()

def fsdk.CustomSecurityCallback.DecryptData (   decryptor,
  encrypted_data,
  encrypted_data_len 
)

用于解密加密数据的回调函数。

参数
[in]decryptor用户实现和创建的解密器,由回调函数 fsdk.CustomSecurityCallback.StartDecryptor 返回。
[in]encrypted_data存储加密数据的缓冲区。
[in]encrypted_data_len加密数据的长度,以字节为单位。
注解
用户应该实现此回调函数。
返回
解密的数据内容。

◆ FinishDecryptor()

def fsdk.CustomSecurityCallback.FinishDecryptor (   decryptor)

用于完成解密的回调函数。

参数
[in]decryptor用户实现和创建的解密器,由回调函数 fsdk.CustomSecurityCallback.StartDecryptor 返回。
注解
用户应该实现此回调函数。
返回
解密的数据内容。

◆ GetCipher()

def fsdk.CustomSecurityCallback.GetCipher (   context)

用于获取密码类型的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
注解
用户应该实现此回调函数。
返回
密码类型。请参考从 fsdk.SecurityHandlerE_CipherNone 开始的值, 应该是这些值中的一个。

◆ GetDecryptedSize()

def fsdk.CustomSecurityCallback.GetDecryptedSize (   context,
  src_data_size 
)

用于获取估计的解密数据大小的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
[in]src_data_size要解密的源数据大小。
注解
用户应该实现此回调函数。
返回
估计的解密数据大小。

◆ GetEncryptedSize()

def fsdk.CustomSecurityCallback.GetEncryptedSize (   context,
  obj_num,
  gen_num,
  src_data,
  src_data_len 
)

用于获取估计的加密大小的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
[in]obj_numPDF对象的对象编号。
[in]gen_numPDF对象的生成编号。
[in]src_data存储要加密的纯文本的缓冲区。
[in]src_data_len缓冲区的长度。
注解
用户应该实现此回调函数。
返回
估计的加密大小。

◆ GetEncryptKey()

def fsdk.CustomSecurityCallback.GetEncryptKey (   context)

用于获取加密密钥的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
注解
用户应该实现此回调函数。
返回
加密密钥。

◆ GetSecurityType()

def fsdk.CustomSecurityCallback.GetSecurityType ( )

获取安全回调的加密类型。

注解
用户不应覆盖此函数,否则会有意外行为。
返回
加密类型。它总是返回 fsdk.PDFDocE_EncryptCustom

◆ GetUserPermissions()

def fsdk.CustomSecurityCallback.GetUserPermissions (   context,
  user_permission 
)

用于获取用户权限的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
[in]user_permission文档的原始权限设置。请参考从 fsdk.PDFDocE_PermPrint 开始的值,可以是这些值中的一个或多个的组合。
注解
用户应该实现此回调函数。
返回
新的用户权限。请参考从 fsdk.PDFDocE_PermPrint 开始的值, 应该是这些值中的一个或多个的组合。

◆ IsOwner()

def fsdk.CustomSecurityCallback.IsOwner (   context)

用于检查当前用户是否是PDF文档所有者的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
注解
用户应该实现此回调函数。
返回
true 表示当前用户是所有者,false 表示当前用户不是所有者。

◆ ReleaseContext()

def fsdk.CustomSecurityCallback.ReleaseContext (   context)

用于释放加密和解密上下文的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
注解
用户应该实现此回调函数。
返回
true 表示成功,false 表示失败。

◆ StartDecryptor()

def fsdk.CustomSecurityCallback.StartDecryptor (   context,
  obj_num,
  gen_num 
)

用于开始解密的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
[in]obj_numPDF对象的对象编号。
[in]gen_numPDF对象的生成编号。
注解
用户应该实现此回调函数。
返回
用户实现和创建的解密器。

◆ UseStandardCryptoMethod()

def fsdk.CustomSecurityCallback.UseStandardCryptoMethod (   context)

用于检查是否使用标准加密方法或自定义加密方法的回调函数。

参数
[in]context加密和解密的上下文,由回调函数 fsdk.CustomSecurityCallback.CreateContext 返回。
返回
<ul>
<li>
<b>true</b> 表示使用标准加密方法。在这种情况下,回调函数 @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 和 @link CustomSecurityCallback::EncryptData @endlink 将无用, 用户可以为它们使用空实现。  
</li>
<li>
<b>false</b> 表示使用自定义加密方法。在这种情况下,请确保上述提到的回调函数都已实现。  
</li>
</ul>