DPAPI Class

Properties Methods Events Config Settings Errors

The DPAPI class allows you to protect and unprotect data.

Syntax

class ipworksencrypt.DPAPI

Remarks

The class supports the classic Microsoft Windows Data Protection API (DPAPI) or CNG DPAPI implementation. The use of use_cng determines which implementation is used.

The classic DPAPI functionality protects data on a single system. The CNG DPAPI is designed with modern use cases involved. In many cases, especially with cloud computing, protection and unprotection may be done on different systems. With this in mind the Microsoft CNG DPAPI allows encrypting to a set of principals that can be used to unprotect the data on other systems after authenticating.

Protecting Data

protect protects the specified data.

The class supports protecting data using either the classic DPAPI or CNG DPAPI implementation. The use of use_cng determines which implementation is used. The list of applicable properties differs depending on whether CNG DPAPI is being used.

When using classic DPAPI (use_cng is False), the following optional properties are applicable:

data_description
password
prompt_title
prompt_user

When using CNG DPAPI (use_cng is True), the following properties are applicable:

protection_descriptor (required)
EscapeDescriptor
UseStreamMode

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

Code Example (Classic DPAPI - use_cng is False)

//Protect Dpapi dpapi = new Dpapi(); dpapi.InputMessage = "test"; dpapi.Protect(); byte[] protectedData = dpapi.OutputMessageB; //Unprotect dpapi = new Dpapi(); dpapi.InputMessageB = protectedData; dpapi.Unprotect(); Console.WriteLine(dpapi.OutputMessage); //outputs "test"

Code Example (CNG DPAPI - use_cng is True)

//Protect Dpapi dpapi = new Dpapi(); dpapi.UseCNG = true; dpapi.ProtectionDescriptor = "LOCAL=user"; dpapi.InputMessage = "test"; dpapi.Protect(); byte[] protectedData = dpapi.OutputMessageB; //Unprotect dpapi = new Dpapi(); dpapi.UseCNG = true; dpapi.InputMessageB = protectedData; dpapi.Unprotect(); Console.WriteLine(dpapi.OutputMessage); //outputs "test"

Unprotecting Data

unprotect unprotects the specified data.

The class supports unprotecting data using either the classic DPAPI or CNG DPAPI implementation. The use of use_cng determines which implementation is used. The list of applicable properties differs depending on whether CNG DPAPI is being used.

When using classic DPAPI (use_cng is False), the following optional properties are applicable:

data_description (populated after completion)
password

When using CNG DPAPI (use_cng is True), the following properties are applicable:

protection_descriptor (populated after completion)
UseStreamMode

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

Code Example (Classic DPAPI - use_cng is False)

Code Example (CNG DPAPI - use_cng is True)

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


data_description	The description of data.
input_file	The file to process.
input_message	The message to process.
output_file	The output file when encrypting or decrypting.
output_message	The output message after processing.
overwrite	Indicates whether or not the class should overwrite files.
password	An optional password to further protect data.
prompt_title	The title of the prompt window.
prompt_user	Whether to display a prompt.
protection_descriptor	The CNG protection descriptor.
use_cng	Whether to use CNG DPAPI.
use_hex	Whether input or output is hex encoded.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


config	Sets or retrieves a configuration setting.
protect	Protects the data.
reset	Resets the class.
unprotect	Unprotects the data.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_error	Fired when information is available about errors during data delivery.
on_progress	Fired as progress is made.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


EscapeDescriptor	Whether to escape the protection descriptor.
ProtectionFlags	Used to specify additional options.
UseStreamMode	Whether to use the CNG streaming operations.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

data_description Property

The description of data.

Syntax

def get_data_description() -> str: ...
def set_data_description(value: str) -> None: ...

data_description = property(get_data_description, set_data_description)

Default Value

Remarks

This property specifies an optional description of the protected data.

This may be set before calling protect. This property will be populated when calling unprotect.

This setting is not applicable when use_cng is set to True.

input_file Property

The file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

Default Value

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

input_message Property

The message to process.

Syntax

def get_input_message() -> bytes: ...
def set_input_message(value: bytes) -> None: ...

input_message = property(get_input_message, set_input_message)

Default Value

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

output_file Property

The output file when encrypting or decrypting.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

Remarks

This property specifies the file to which the output will be written when encrypt or decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to encrypt and decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

output_message Property

The output message after processing.

Syntax

def get_output_message() -> bytes: ...

output_message = property(get_output_message, None)

Default Value

Remarks

This property will be populated with the output from the operation if output_file is not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

This property is read-only.

overwrite Property

Indicates whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file. If overwrite is False, an error will be thrown whenever output_file exists before an operation. The default value is False.

password Property

An optional password to further protect data.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

Remarks

This property may be set to a password to protect the data further.

When protecting data without specifying a password any application running under the same user account can unprotect the data. By specifying a password another piece of information is required to unprotect the data.

This may be set before calling protect. If a password was specified when protecting data it must be set before calling unprotect.

This setting is not applicable when use_cng is set to True.

prompt_title Property

The title of the prompt window.

Syntax

def get_prompt_title() -> str: ...
def set_prompt_title(value: str) -> None: ...

prompt_title = property(get_prompt_title, set_prompt_title)

Default Value

Remarks

This property specifies the title of the prompt dialog if prompt_user is True. The default value is empty string.

This setting is not applicable when use_cng is set to True.

prompt_user Property

Whether to display a prompt.

Syntax

def get_prompt_user() -> bool: ...
def set_prompt_user(value: bool) -> None: ...

prompt_user = property(get_prompt_user, set_prompt_user)

Default Value

FALSE

Remarks

This property specifies whether a prompt is displayed when calling protect. This dialog is created by the system and informs the user of the request action. The user may accept or cancel the request. If the user cancels the request the protect method fails with an error.

When True the prompt_title may be set to customize the window title.

This setting is not applicable when use_cng is set to True. ;

protection_descriptor Property

The CNG protection descriptor.

Syntax

def get_protection_descriptor() -> str: ...
def set_protection_descriptor(value: str) -> None: ...

protection_descriptor = property(get_protection_descriptor, set_protection_descriptor)

Default Value

Remarks

This property specifies the protection descriptor rule string. The protection descriptor is used by the system to decide which entities can unprotect the data at a later time. This property must be specified before calling protect. This property is populated after calling unprotect.

Protection descriptors can be defined for the following types of authorization:

A local user or machine
An account or group in an Active Directory forest
A set of web credentials
A certificate in the user's certificate store

A local user or machine may be used for machines that are or are not on a domain. For instance:

LOCAL=user
LOCAL=machine

The use of SID and SDDL requires that the machine be part of a domain. For instance:

SID=S-1-5-21-4392301 AND SID=S-1-5-21-3101812
SDDL=O:S-1-5-5-0-290724G:SYD:(A;;CCDC;;;S-1-5-5-0-290724)(A;;DC;;;WD)

Certificates may also be used as a descriptor. To decrypt, the certificate with corresponding private key must be present in the user's certificate store. The public certificate can be specified as the SHA1 thumbprint (hash) of the certificate, or the base64 encoded certificate itself. For instance:

CERTIFICATE=HashID:28ac375635b82ca3e20a1c9422145bc93965dae7
CERTIFICATE=CertBlob:MIIC7TCCAdWgAw...pgpVgYpppr

Note: The base64 certificate data should not include any headers, footers, or whitespace.

The use of AND and OR operators are accepted in order to encrypt data for multiple parties or establish multiple conditions for decryption.

For more details about protection descriptors and accepted formats please refer to the Microsoft Documentation for Protection Descriptors

This setting is only applicable when use_cng is set to True.

use_cng Property

Whether to use CNG DPAPI.

Syntax

def get_use_cng() -> bool: ...
def set_use_cng(value: bool) -> None: ...

use_cng = property(get_use_cng, set_use_cng)

Default Value

FALSE

Remarks

The class supports protecting data using either the classic DPAPI or CNG DPAPI implementation. When set to True the CNG DPAPI implementation is sued. When set to False (default) the classic DPAPI implementation is used.

use_hex Property

Whether input or output is hex encoded.

Syntax

def get_use_hex() -> bool: ...
def set_use_hex(value: bool) -> None: ...

use_hex = property(get_use_hex, set_use_hex)

Default Value

FALSE

Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when protect is called the class will perform the encryption as normal and then hex encode the output. output_message or output_file will hold hex encoded data.

If set to True, when unprotect is called the class will expect input_message or input_file to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

protect Method

Protects the data.

Syntax

def protect() -> None: ...

Remarks

protect protects the specified data.

When using classic DPAPI (use_cng is False), the following optional properties are applicable:

data_description
password
prompt_title
prompt_user

When using CNG DPAPI (use_cng is True), the following properties are applicable:

protection_descriptor (required)
EscapeDescriptor
UseStreamMode

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

Code Example (Classic DPAPI - use_cng is False)

Code Example (CNG DPAPI - use_cng is True)

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

When called, the class will reset all of its properties to their default values.

unprotect Method

Unprotects the data.

Syntax

def unprotect() -> None: ...

Remarks

unprotect unprotects the specified data.

When using classic DPAPI (use_cng is False), the following optional properties are applicable:

data_description (populated after completion)
password

When using CNG DPAPI (use_cng is True), the following properties are applicable:

protection_descriptor (populated after completion)
UseStreamMode

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

input_file
input_message

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

output_file
output_message: The output data is written to this property if no other destination is specified.

Code Example (Classic DPAPI - use_cng is False)

Code Example (CNG DPAPI - use_cng is True)

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class DPAPIErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class DPAPI:
@property
def on_error() -> Callable[[DPAPIErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[DPAPIErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_progress Event

Fired as progress is made.

Syntax

class DPAPIProgressEventParams(object):
  @property
  def bytes_processed() -> int: ...

  @property
  def percent_processed() -> int: ...

# In class DPAPI:
@property
def on_progress() -> Callable[[DPAPIProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[DPAPIProgressEventParams], None]) -> None: ...

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

DPAPI Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

DPAPI Config Settings

EscapeDescriptor: Whether to escape the protection descriptor.

This setting controls whether the protection_descriptor value is escaped when protect is called. When set to False (default) the value is passed exactly as provided to the underlying system libraries. When set to True the value is first escaped according to the escaping rules defined by Microsoft.

The default value of EscapeDescriptor is True.

This setting is only applicable when use_cng is set to True.

ProtectionFlags: Used to specify additional options.

Additional options are available to restrict or change the behavior of the protect and unprotect operations.

By default no additional settings are specified (the value is 0). You may set this property to the binary 'OR' of one or more of the following values:


1 (0x1)	CRYPTPROTECT_UI_FORBIDDEN	This flag is used for remote situations where presenting a user interface (UI) is not an option. When this flag is set and a UI is specified for either the protect or unprotect operation, the operation fails.
4 (0x4)	CRYPTPROTECT_LOCAL_MACHINE	When this flag is set, it associates the data encrypted with the current computer instead of with an individual user. This is only applicable when calling protect.
8 (0x8)	CRYPTPROTECT_CRED_SYNC	When this flag is used, no data is actually protected. Instead all MasterKeys are queried from disk, which will cause re-encryption in memory, presumably under a changed password. This is only applicable when calling protect.
16 (0x10)	CRYPTPROTECT_AUDIT	This flag causes DPAPI to generate an audit when this data is protected or unprotected. This is only applicable when calling protect.
64 (0x40)	CRYPTPROTECT_VERIFY_PROTECTION	If the protected data blob would be better protected under a new call to the internal protect function and this call succeeds, then GetLastError will return a CRYPT_I_NEW_PROTECTION_REQUIRED status code. This is only applicable when calling unprotect.
536870912 (0x20000000)	CRYPTPROTECT_SYSTEM	If data was protected with this flag set, then this flag must be set to unprotect the data.

This setting is not applicable when use_cng is set to True.

UseStreamMode: Whether to use the CNG streaming operations.

When set to True the class will use the CNG streaming operations when protect and unprotect are called. When working with large amounts of data this can reduce the memory overhead during processing. Note that when enabled input_file and output_file should be used for optimal memory usage.

The default value of UseStreamMode is False.

This setting is only applicable when use_cng is set to True.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

DPAPI Errors


	104 Cannot read or write file.
	109 Cannot protect data.
	110 Cannot unprotect data
	111 OutputFile already exists and Overwrite is False.
	304 Cannot write file.
	305 Cannot read file.
	306 Cannot create file.