Foxit PDF SDK

fs_ofdenvelope.h
1 #ifndef FS_OFD_Envelope_H_
2 #define FS_OFD_Envelope_H_
3
4 #include "common/fs_common.h"
5
11 namespace foxit {
15 namespace ofd {
17 class OFDEnvelopeInfo FS_FINAL : public Base {
18 public:
24 typedef enum _EnvelopeEncryptType {
26 e_EnvelopeEncryptTypeRC4 = 0,
28 e_EnvelopeEncryptTypeAES128 = 1,
30 e_EnvelopeEncryptTypeAES192 = 2,
32 e_EnvelopeEncryptTypeAES256 = 3,
34 e_EnvelopeEncryptTypeSM4 = 4
35 } EnvelopeEncryptType;
36
37
41 OFDEnvelopeInfo();
42
44 ~OFDEnvelopeInfo();
45
51 OFDEnvelopeInfo(const OFDEnvelopeInfo& other);
52
60 OFDEnvelopeInfo& operator = (const OFDEnvelopeInfo& other);
61
69 bool operator == (const OFDEnvelopeInfo& other) const;
70
78 bool operator != (const OFDEnvelopeInfo& other) const;
79
87 bool IsEmpty() const;
88
94 WString GetTitle() const;
95
101 WString GetDocType() const;
102
108 WString GetDescription() const;
109
115 WString GetCreator() const;
116
122 foxit::DateTime GetCreateTime() const;
123
129 foxit::DateTime GetStartTime() const;
130
136 foxit::DateTime GetExpirationTime() const;
137
143 WString GetPassword() const;
144
150 WString GetPermission() const;
151
157 WString GetFileCode() const;
158
164 WString GetHashKey() const;
165
171 WString GetFilter() const;
172
178 WString GetSubFilter() const;
179
186 EnvelopeEncryptType GetCipher() const;
187
193 WString GetSecurityType() const;
194
200 WString GetCryptoType() const;
201
209 void SetTitle(const WString& title);
210
218 void SetDocType(const WString& doc_type);
219
227 void SetDescription(const WString& description);
228
236 void SetCreator(const WString& creator);
237
245 void SetCreateTime(const foxit::DateTime& create_time);
246
254 void SetStartTime(const foxit::DateTime& start_time);
255
263 void SetExpirationTime(const foxit::DateTime& expiration_time);
264
272 void SetPassword(const WString& password);
273
281 void SetPermission(const WString& permission);
282
290 void SetFileCode(const WString& file_code);
291
300 void SetCipher(EnvelopeEncryptType cipher);
301
302 explicit OFDEnvelopeInfo(FS_HANDLE handle);
303 };
304
306 class OFDEnvelope FS_FINAL : public CFX_Object {
307 public:
315 static OFDEnvelopeInfo GetEnvelopeInfo(const WString& input_envelope_file);
316
325 static bool VerifyPassword(const String& password, const OFDEnvelopeInfo& info);
326
336 static bool Encrypt(const OFDEnvelopeInfo& info, const WString& input_ofd_file, const WString& output_envelope_file);
337
348 static bool Decrypt(const String& password, const WString& input_envelope_file, const WString& output_ofd_file);
349 };
350
351 } // namespace ofd
352 } // namespace foxit
353
354 #endif // FS_OFD_Envelope_H_
foxit::ofd::OFDEnvelopeInfo::GetDescription
WString GetDescription() const
获取文件描述。
foxit::ofd::OFDEnvelopeInfo::SetCipher
void SetCipher(EnvelopeEncryptType cipher)
设置加密类型。
foxit::ofd::OFDEnvelopeInfo::GetCryptoType
WString GetCryptoType() const
获取加密类型。
foxit::ofd::OFDEnvelopeInfo::GetCreator
WString GetCreator() const
获取创建人。
foxit::ofd::OFDEnvelopeInfo::GetSubFilter
WString GetSubFilter() const
获取加密子标志位。
foxit::ofd::OFDEnvelopeInfo::GetExpirationTime
foxit::DateTime GetExpirationTime() const
获取有效期限结束时间。
foxit::ofd::OFDEnvelopeInfo::SetDescription
void SetDescription(const WString &description)
设置文件描述。
foxit::ofd::OFDEnvelopeInfo::GetPassword
WString GetPassword() const
获取密码。
foxit::ofd::OFDEnvelopeInfo::SetTitle
void SetTitle(const WString &title)
设置文件名称。
foxit::ofd::OFDEnvelope::Decrypt
static bool Decrypt(const String &password, const WString &input_envelope_file, const WString &output_ofd_file)
信封文件解密。
foxit::ofd::OFDEnvelopeInfo::e_EnvelopeEncryptTypeAES192
加密类型：AES192。
Definition: fs_ofdenvelope.h:30
foxit::ofd::OFDEnvelopeInfo::GetTitle
WString GetTitle() const
获取标题。
foxit::ofd::OFDEnvelopeInfo::operator !=
bool operator !=(const OFDEnvelopeInfo &other) const
不相等操作符。
foxit::ofd::OFDEnvelopeInfo::GetFilter
WString GetFilter() const
获取密码机密和证书加密标志位。
foxit::ofd::OFDEnvelopeInfo::GetFileCode
WString GetFileCode() const
获取文件代码。
foxit::DateTime
Definition: fs_basictypes.h:498
foxit::ofd::OFDEnvelopeInfo::SetPermission
void SetPermission(const WString &permission)
设置用户权限。
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::ofd::OFDEnvelopeInfo::SetStartTime
void SetStartTime(const foxit::DateTime &start_time)
设置有效期限开始时间。
foxit::ofd::OFDEnvelopeInfo::operator==
bool operator==(const OFDEnvelopeInfo &other) const
相等操作符。
foxit::ofd::OFDEnvelopeInfo::operator=
OFDEnvelopeInfo & operator=(const OFDEnvelopeInfo &other)
赋值操作符。
foxit::ofd::OFDEnvelopeInfo::SetExpirationTime
void SetExpirationTime(const foxit::DateTime &expiration_time)
设置有效期限结束时间。
foxit::ofd::OFDEnvelopeInfo::GetDocType
WString GetDocType() const
获取文件类型。
foxit::ofd::OFDEnvelopeInfo::SetPassword
void SetPassword(const WString &password)
设置密码。
foxit::ofd::OFDEnvelopeInfo::e_EnvelopeEncryptTypeRC4
加密类型：RC4。
Definition: fs_ofdenvelope.h:26
foxit::ofd::OFDEnvelope
Definition: fs_ofdenvelope.h:306
foxit::ofd::OFDEnvelope::GetEnvelopeInfo
static OFDEnvelopeInfo GetEnvelopeInfo(const WString &input_envelope_file)
获取信封文件信息。
foxit::ofd::OFDEnvelopeInfo::GetPermission
WString GetPermission() const
获取用户权限。
foxit::ofd::OFDEnvelopeInfo::GetStartTime
foxit::DateTime GetStartTime() const
获取有效期限开始时间。
foxit::ofd::OFDEnvelopeInfo::GetHashKey
WString GetHashKey() const
获取密码哈希值。
foxit::ofd::OFDEnvelopeInfo::~OFDEnvelopeInfo
~OFDEnvelopeInfo()
析构函数。
foxit::ofd::OFDEnvelopeInfo::OFDEnvelopeInfo
OFDEnvelopeInfo()
构造函数。
foxit::ofd::OFDEnvelopeInfo::e_EnvelopeEncryptTypeSM4
加密类型：SM4。
Definition: fs_ofdenvelope.h:34
foxit::ofd::OFDEnvelope::Encrypt
static bool Encrypt(const OFDEnvelopeInfo &info, const WString &input_ofd_file, const WString &output_envelope_file)
信封密码加密。
foxit::ofd::OFDEnvelopeInfo::SetCreator
void SetCreator(const WString &creator)
设置创建人。
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
fs_common.h
通用定义和类的头文件。
foxit::Base
Definition: fs_basictypes.h:465
foxit::ofd::OFDEnvelope::VerifyPassword
static bool VerifyPassword(const String &password, const OFDEnvelopeInfo &info)
信封文件密码验证。
foxit::ofd::OFDEnvelopeInfo::e_EnvelopeEncryptTypeAES256
加密类型：AES256。
Definition: fs_ofdenvelope.h:32
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::ofd::OFDEnvelopeInfo::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::ofd::OFDEnvelopeInfo::SetDocType
void SetDocType(const WString &doc_type)
设置文件类型。
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
foxit::ofd::OFDEnvelopeInfo
Definition: fs_ofdenvelope.h:17
foxit::ofd::OFDEnvelopeInfo::EnvelopeEncryptType
EnvelopeEncryptType
OFD信封加密类型定义枚举类型。
Definition: fs_ofdenvelope.h:24
foxit::ofd::OFDEnvelopeInfo::e_EnvelopeEncryptTypeAES128
加密类型：AES128。
Definition: fs_ofdenvelope.h:28
foxit::ofd::OFDEnvelopeInfo::GetSecurityType
WString GetSecurityType() const
获取安全类型。
foxit::ofd::OFDEnvelopeInfo::GetCreateTime
foxit::DateTime GetCreateTime() const
获取创建时间。
foxit::ofd::OFDEnvelopeInfo::SetCreateTime
void SetCreateTime(const foxit::DateTime &create_time)
设置创建时间。
foxit::ofd::OFDEnvelopeInfo::SetFileCode
void SetFileCode(const WString &file_code)
设置文件代码。
foxit::ofd::OFDEnvelopeInfo::GetCipher
EnvelopeEncryptType GetCipher() const
获取加密类型。