IPWorks Encrypt 2022 Python Edition
Version 22.0 [Build 8369]

AES Class

Properties   Methods   Events   Config Settings   Errors  

The AES class can be used to encrypt and decrypt data through Advanced Encryption Standard (AES) cryptography.

Syntax

class ipworksencrypt.AES

Remarks

The AES component can be used to encrypt and decrypt data through Advanced Encryption Standard (AES) cryptography. Includes support for AES 128, 192, and 256 bit keys.

To begin simply specify the data you wish to encrypt or 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:

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

Before encrypting you must have a valid key and iv. There are a few options available to you in regards to key management. The easiest option is to simply set key_password. When key_password is set the component will automatically create a key and iv using the PKCS5 password digest algorithm. This means there is only one value you need to keep track of.

If you wish to have more control over the key and iv values you may specify the properties yourself. If iv is left empty, one will be created for you when you call encrypt or decrypt.

A simple example: Component.InputFile = "C:\MyFile.txt"; Component.OutputFile = "C:\Encrypted.txt"; Component.KeyPassword = "password"; Component.Encrypt();

Note that by default the component uses a key size of 256. You may specify the key size (such as 128 or 192) by setting KeySize.

Property List


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

cipher_modeThe cipher mode of operation.
input_fileThe file to process.
input_messageThe message to process.
ivThe initialization vector (IV).
keyThe secret key for the symmetric algorithm.
key_passwordA password to generate the Key and IV .
output_fileThe output file when encrypting or decrypting.
output_messageThe output message after processing.
overwriteIndicates whether or not the class should overwrite files.
padding_modeThe padding mode.
use_hexWhether 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.

configSets or retrieves a configuration setting.
decryptDecrypts the data.
decrypt_blockDecrypts a block and returns the decrypted data.
encryptEncrypts the data.
encrypt_blockEncrypts data and returns the encrypted block.
resetResets the class.

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_errorInformation about errors during data delivery.
on_progressFired 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.

AdditionalAuthDataAdditional authentication data (AAD) used in GCM mode.
AuthTagThe authentication tag used in GCM mode.
AuthTagLengthThe authentication tag length used in GCM mode.
BlockSizeThe block size, in bits, of the cryptographic operation.
EncryptedDataEncodingThe encoding of the encrypted input or output data.
IncludeAuthTagWhether to append the authentication tag to the cipher text in GCM mode.
IncludeIVWhether to prepend the IV to the output data and read the IV from the input data.
KeyPasswordAlgorithmThe hash algorithm used to derive the Key and IV from the KeyPassword property.
KeyPasswordIterationsThe number of iterations performed when using KeyPassword to derive the Key and IV.
KeyPasswordSaltThe salt value used in conjunction with the KeyPassword to derive the Key and IV.
KeySizeThe size, in bits, of secret key for the symmetric algorithm.
UsePlatformAESWhether to use the platform AES implementation.
XTSDataUnitLengthThe length of the XTS data unit.
XTSInitialTweakThe initial XTS tweak value.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

cipher_mode Property

The cipher mode of operation.

Syntax

def get_cipher_mode() -> int: ...
def set_cipher_mode(value: int) -> None: ...

cipher_mode = property(get_cipher_mode, set_cipher_mode)

Default Value

0

Remarks

The cipher mode of operation.

Possible values are:

0 (cmCBC - default) The Cipher Block Chaining (CBC) is a mode of operation for a block cipher, one in which a sequence of bits is encrypted as a single unit or block with a cipher key applied to the entire block.
1 (cmECB) The Electronic Codebook (ECB) mode encrypts each block separately. Important: It is not recommend to use this model when encrypting more than one block because it may introduce security risks.
2 (cmOFB) The Output Feedback (n-bit, NOFB) mode makes a block cipher into a synchronous stream cipher. It has some similarities to CFB mode in that it permits encryption of differing block sizes, but has the key difference that the output of the encryption block function is the feedback (instead of the ciphertext).
3 (cmCFB) The Cipher Feedback (CFB) mode processes a small amount of incremental text into ciphertext, rather than processing a whole block at one time.
4 (cmCTS) The Cipher Text Stealing (CTS) mode handles any length of plain text and produces cipher text whose length matches the plain text length. This mode behaves like the CBC mode for all but the last two blocks of the plain text.
5 (cm8OFB) 8-bit Output Feedback (OFB) cipher mode.
7 (cm8CFB) 8-bit Cipher Feedback (CFB) cipher mode.
6 (acmGCM) Galois/Counter (GCM) cipher mode.
8 (acmCTR) Counter (CTR) cipher mode.
9 (acmXTS) XEX Tweakable Block Cipher with Ciphertext Stealing (XTS) cipher mode.

GCM Notes

When setting this value to 6 (acmGCM) the following settings are also applicable:

GCM mode code example: //Encrypt aes.CipherMode = AesCipherModes.acmGCM; aes.KeyPassword = "test"; aes.InputMessage = "input data"; aes.Config("AdditionalData=" + hex_aad); //Optional aes.Encrypt(); string authTag = aes.Config("AuthTag"); byte[] outputMessage = aes.OutputMessageB; //Decrypt aes.CipherMode = AesCipherModes.acmGCM; aes.KeyPassword = "test"; aes.InputMessageB = outputMessage; aes.Config("AdditionalData=" + hex_aa); aes.Config("AuthenticationTag=" + authTag); aes.Decrypt(); XTS Notes

When setting this value to 9 (acmXTS) the following settings are also applicable:

padding_mode has no effect when using acmXTS -- the input_message MUST be a multiple of XTSDataUnitLength.

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:

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

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:

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

iv Property

The initialization vector (IV).

Syntax

def get_iv() -> bytes: ...
def set_iv(value: bytes) -> None: ...

iv = property(get_iv, set_iv)

Default Value

""

Remarks

This property specifies the initialization vector (IV). By default this property is empty and the class will automatically generate a new iv value if key_password or key is set before encrypt or encrypt_block is called. The size of the IV property must be equal to the BlockSize divided by 8.

key Property

The secret key for the symmetric algorithm.

Syntax

def get_key() -> bytes: ...
def set_key(value: bytes) -> None: ...

key = property(get_key, set_key)

Default Value

""

Remarks

This secret key is used both for encryption and decryption. The secret key should be known only to the sender and the receiver. The legal key size varies depending on the algorithm.

If this property is left empty and key_password is specified, a key value will be generated by the class as necessary.

Legal Key and Block Sizes (in bits)

AES Rijndael CAST DES IDEA RC2 RC4 TripleDES Blowfish Twofish TEA
Minimum Key Size 128 128 112 64 128 112 112 128 112 128 128
Maximum Key Size 256 256 128 64 128 128 2048 192 448 256 128
Key Size Step 64 64 8 0 0 8 8 64 1 8 0
Block Size 128 128/192/256 64 64 64 64 N/A 64 64 128 64*

Note: When using TEA if algorithm is set to XXTEA valid block sizes are 64 + n * 32. Where n is any positive integer.

The default KeySize is the Maximum Key Size.

key_password Property

A password to generate the Key and IV .

Syntax

def get_key_password() -> str: ...
def set_key_password(value: str) -> None: ...

key_password = property(get_key_password, set_key_password)

Default Value

""

Remarks

When this property is set the class will calculate values for key and iv using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing key and iv values directly.

The size of the key generated is dependent on the value of KeySize.

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:

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:

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.

padding_mode Property

The padding mode.

Syntax

def get_padding_mode() -> int: ...
def set_padding_mode(value: int) -> None: ...

padding_mode = property(get_padding_mode, set_padding_mode)

Default Value

0

Remarks

PaddingMode is used to pad the final input block to guarantee that it is the correct size required for the selected cipher_mode. If the input size is a multiple of the cipher's BlockSize, an extra block of padding will be appended to the input. This enables the decrypting agent to know with certainty how many bytes of padding are included. Each mode pads the data differently. Possible values are:

0 (pmPKCS7 - default) The data is padded with a series of bytes that are each equal to the number of bytes used. For instance, in the example below the data must be padded with 3 additional bytes, so each byte value will be 3.

Raw Data: AA AA AA AA AA

PKCS7 Padded Data: AA AA AA AA AA 03 03 03

1 (pmZeros) The data is padded with null bytes.
2 (pmNone) No padding will be performed.
3 (pmANSIX923) The ANSIX923 padding string consists of a sequence of bytes filled with zeros before the length. For instance, in the example below the data must be padded with 3 additional bytes, so last byte value will be 3.

Raw Data: AA AA AA AA AA

ANSIX923 padding Data: AA AA AA AA AA 00 00 03

4 (pmISO10126) The ISO10126 padding string consists of random data before the length. For instance, in the example below the data must be padded with 3 additional bytes, so last byte value will be 3.

Raw Data: AA AA AA AA AA

ISO10126 padding Data: AA AA AA AA AA F8 EF 03

When calling decrypt the padding_mode must match the value used when the data was encrypted.

Note: When using a value of 2 (pmNone), unless the length of input is an exact multiple of the cipher's input BlockSize, the final block of plaintext may be lost.

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 encrypt 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 decrypt 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.

decrypt Method

Decrypts the data.

Syntax

def decrypt() -> None: ...

Remarks

This method will decrypt the specified data. The following properties are applicable:

Note that cipher_mode must be set to the same value used during encryption or the results may be unexpected. If the cipher_mode value does not match the value used during encryption the operation may succeed but the decrypted data may not be correct.

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:

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

decrypt_block Method

Decrypts a block and returns the decrypted data.

Syntax

def decrypt_block(input_buffer: bytes, last_block: bool) -> bytes: ...

Remarks

This method will decrypt the specified block and return the decrypted data.

InputBuffer specifies the encrypted block to decrypt.

LastBlock indicates whether the block is the last block.

encrypt Method

Encrypts the data.

Syntax

def encrypt() -> None: ...

Remarks

This method will encrypt the specified data. The following properties are applicable:

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:

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

encrypt_block Method

Encrypts data and returns the encrypted block.

Syntax

def encrypt_block(input_buffer: bytes, last_block: bool) -> bytes: ...

Remarks

This method will encrypt the input data and return the encrypted block.

InputBuffer specifies the input data to encrypt.

LastBlock specifies whether the block is the last block.

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

Remarks

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

ErrorCode contains an error code and Description 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 AESProgressEventParams(object):
  @property
  def bytes_processed() -> int: ...

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

# In class AES:
@property
def on_progress() -> Callable[[AESProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[AESProgressEventParams], 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.

AES 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.

AES Config Settings

AdditionalAuthData:   Additional authentication data (AAD) used in GCM mode.

This setting optionally specifies additional authentication data. The data specified must be hex encoded. This is only applicable when cipher_mode is set to 6 (cmGCM). This may be set prior to calling encrypt or decrypt. Note that AAD data is authenticated but not encrypted, so it is not included in output_message

AuthTag:   The authentication tag used in GCM mode.

This setting is only applicable when cipher_mode is set to 6 (cmGCM). This is populated with a hex encoded value after calling encrypt. It must be specified with a hex encoded value before calling decrypt.

AuthTagLength:   The authentication tag length used in GCM mode.

This setting is only applicable when cipher_mode is set to 6 (cmGCM). This may be set before calling encrypt. It may also be set before calling decrypt, but is not required. The default value is 128. Valid values are

  • 0*
  • 96
  • 104
  • 112
  • 120
  • 128 (default)
* May be set to 0 when calling decrypt only. In this case no value needs to be passed to AuthTag. Be aware that this is a security risk as the ciphertext will not be authenticated. If it was tampered with there would be no indication. NIST Special Publication 800-38D forbids implementations from validating or generating messages without an authentication tag, but this functionality can be useful in certain real-world scenarios.
BlockSize:   The block size, in bits, of the cryptographic operation.

The block size is a basic data unit in the operation of encrypt or decrypt. Messages longer than the block size are seen as successive blocks. If the message is shorter than the block size, the message will be padded with extra bits to reach the block size according to padding_mode. Different symmetric algorithm has different valid block sizes.

The following algorithms have a fixed block size: AES, CAST, DES, IDEA, RC2, TripleDES, Blowfish, and Twofish.

EncryptedDataEncoding:   The encoding of the encrypted input or output data.

This configuration setting specifies how the encrypted data is encoded (if at all).

When encrypt is called the class will perform the encryption as normal and then encode the output as specified here. output_message or output_file will hold the encoded data.

When decrypt is called the class will expect input_message or input_file to hold the encoded data as specified here. The class will then decode the data and perform decryption as normal.

Possible values are:

  • 0 (none - default)
  • 1 (Base64)
  • 2 (Hex)
  • 3 (Base64URL)

IncludeAuthTag:   Whether to append the authentication tag to the cipher text in GCM mode.

This setting controls whether AuthTag is appended to the cipher text. This may be useful in cases where the other party knows to look for the authentication tag at the end of the data. The default value is False.

IncludeIV:   Whether to prepend the IV to the output data and read the IV from the input data.

If this config is true, the IV will be automatically prepended to the output data when calling encrypt. When calling decrypt and this setting is True, the IV is automatically extracted form the ciphertext. The default value is False.

KeyPasswordAlgorithm:   The hash algorithm used to derive the Key and IV from the KeyPassword property.

This configuration setting specifies which hash algorithm will be used when deriving the key and iv from key_password. The default value is "MD5". Possible values are:

  • "SHA1"
  • "MD2"
  • "MD5" (default)
  • "HMAC-SHA1"
  • "HMAC-SHA224"
  • "HMAC-SHA256"
  • "HMAC-SHA384"
  • "HMAC-SHA512"
  • "HMAC-MD5"
  • "HMAC-RIPEMD160"

When using any HMAC algorithm the PBKDF#2 method from RFC 2898 is used. Any other algorithm uses PBKDF#1 from the same RFC.

KeyPasswordIterations:   The number of iterations performed when using KeyPassword to derive the Key and IV.

This configuration setting specifies the number of iterations performed when using key_password to calculate values for key and iv. When using PBKDF#2 the default number of iterations is 10,000. When using PBKDF#1 the default number is 10.

KeyPasswordSalt:   The salt value used in conjunction with the KeyPassword to derive the Key and IV.

This configuration setting specifies the hex encoded salt value to be used along with the key_password when calculating values for key and iv.

KeySize:   The size, in bits, of secret key for the symmetric algorithm.

The legal key sizes vary depending on the algorithm. The KeySize and BlockSize configuration settings may be set to specify the key and block size (in bits).

This setting is only applicable when key_password is specified.

Note that when using the EzCrypt class, KeySize should be set after setting the algorithm property.

UsePlatformAES:   Whether to use the platform AES implementation.

This setting controls whether the class uses it's own AES implementation or the current platform's implementation. Using the platform implementation is only supported on Windows.

XTSDataUnitLength:   The length of the XTS data unit.

When cipher_mode is acmXTS, set this to the length of the XTS data unit in bytes. The default value is 512.

XTSInitialTweak:   The initial XTS tweak value.

Set this to the initial tweak value when cipher_mode is acmXTS. This can be set to either a decimal or hexadecimal number representing the value. The default value is 0. Here are two examples: aes.Config("XTSInitialTweak=6700"); // Decimal aes.Config("XTSInitialTweak=C1DD77FDGA"); // Hexadecimal

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:

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

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

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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.
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:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

AES Errors

AES Errors

101   Unsupported algorithm.
102   No Key specified.
103   No IV specified.
104   Cannot read or write file.
107   Block size is not valid for this algorithm.
108   Key size is not valid for this algorithm.
111   OutputFile already exists and Overwrite is False.
121   The specified key is invalid.
123   IV size is not valid for this algorithm.
304   Cannot write file.
305   Cannot read file.
306   Cannot create file.
2004   Invalid padding. This may be an indication that the key is incorrect.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2022 Python Edition - Version 22.0 [Build 8369]