Public Member Functions | |
| constructor () | |
| Constructor. | |
| constructor (r) | |
| Initialize (encrypt_data, user_password, owner_password) | |
| (Not support AES-256) Initialize current standard security handler. More... | |
| InitializeW (encrypt_data, user_password, owner_password) | |
| (Only for AES-256) Initialize current standard security handler. More... | |
| SetAES256ModifyFlags (modify_flags) | |
| (Only for AES-256) Set modify flags to decide which security data or password will be modified during encryption process. More... | |
 Public Member Functions inherited from SecurityHandler | |
| constructor () | |
| Constructor. | |
| constructor (r) | |
| GetSecurityType () | |
| Get the encryption type of current security handler. More... | |
| IsEmpty () | |
| Check whether current object is empty or not. More... | |
| Public Member Functions inherited from NativeObjectWrapper | |
| constructor (r) | |
| GetPointerAsNumber () | |
Static Public Attributes | |
| static | e_ModifyOwnerPassword |
| If set, only owner password will be modified during encryption process. | |
| static | e_ModifyPermission |
| (Only for AES-256) Enumeration for modify flag used to decide which security data or password will be modified during encryption process More... | |
| static | e_ModifyUserPassword |
| If set, user password and owner password will be modified during encryption process. | |
| Static Public Attributes inherited from SecurityHandler | |
| static | e_CipherAES |
| Use AES encryption algorithm, with the key length be 16 bytes (as AES-128) or 32 bytes (as AES-256, only supported in PDF 2.0). | |
| static | e_CipherNone |
| Enumeration for Encryption Algorithm. More... | |
| static | e_CipherRC4 |
| Use RC4 encryption algorithm, with the key length between 5 bytes and 16 bytes. | |
Detailed Description
This class represents a standard security handler, used for password encryption.
- See also
- SecurityHandler
Member Function Documentation
◆ constructor()
| StdSecurityHandler.constructor | ( | r | ) |
@constructor
- Parameters
-
{NativeObjectReference} r - The native object reference to wrap
@description Creates a new wrapper instance around a native C++ object. The wrapper manages the object's lifecycle according to the ownership rules.
◆ Initialize()
| StdSecurityHandler.Initialize | ( | encrypt_data | , |
| user_password | , | ||
| owner_password | |||
| ) |
(Not support AES-256) Initialize current standard security handler.
- Parameters
-
[in] user_password A user password, which is used to open the PDF document. This can be empty when parameter owner_password is not empty. [in] owner_password An owner password, which is used to take ownership of the PDF document. This can be empty when parameter user_password is not empty. [in] encrypt_data A standard encrypt data object. In the encryption data, cipher type should not be SecurityHandler.e_CipherNone, or SecurityHandler.e_CipherAES with key length 32 (that means not support AES-256). Please refer to comment of class StdEncryptData to ensure the validation of each member.
- Returns
- true means success, while false means failure.
◆ InitializeW()
| StdSecurityHandler.InitializeW | ( | encrypt_data | , |
| user_password | , | ||
| owner_password | |||
| ) |
(Only for AES-256) Initialize current standard security handler.
- Parameters
-
[in] user_password A user password, which is used to open the PDF document. This can be empty when parameter owner_password is not empty. [in] owner_password An owner password, which is used to take ownership of the PDF document. This can be empty when parameter user_password is not empty. [in] encrypt_data A standard encrypt data object. In the encryption data, cipher type should be SecurityHandler.e_CipherAES and key length should be 32.
- Returns
- true means success, while false means failure.
◆ SetAES256ModifyFlags()
| StdSecurityHandler.SetAES256ModifyFlags | ( | modify_flags | ) |
(Only for AES-256) Set modify flags to decide which security data or password will be modified during encryption process.
Modify flags are useful only when a PDF document has been encrypted by AES-256 and current StdSecurityHandler object is to be used to modify some security data or password for this PDF document. For other case, these modify flags will be ignored during encryption process. Security data and passwords are set through function StdSecurityHandler.InitializeW. If this function has not been called by current StdSecurityHandler object, that means to modify all the security data and password by default.
- Parameters
-
[in] modify_flags Modify flags used to decide which security data or password will be modified during encryption process. Please refer to values starting from StdSecurityHandler.e_ModifyPermission and this should be one or combination of these values.
- Returns
- None.
Member Data Documentation
◆ e_ModifyPermission
|
static |
(Only for AES-256) Enumeration for modify flag used to decide which security data or password will be modified during encryption process
Values of this enumeration can be used alone or in combination.
If set, user permissions and "is encrypt metadata" values (which are defined in StdEncryptData) will be modified during encryption process.
