RSA Class

Properties   Methods   Events   Config Settings   Errors  

Implements RSA public-key cryptography to encrypt/decrypt and sign/verify messages.

Syntax

ipworksencrypt.rsa()

Remarks

The RSA class implements RSA public-key cryptography to encrypt/decrypt messages and sign/verify hash signatures.

To begin you must either specify an existing key or create a new key. Existing private keys may be specified by setting the Key* properties. To create a new key call CreateKey. Alternatively an existing certificate may be specified by setting the Certificate* properties

Signing

To sign data first set Key or Certificate. Specify the input data using InputFile or InputMessage. Next call Sign. The class will populate HashValue and HashSignature. After calling Sign the public key must be sent to the recipient along with HashSignature.

Encrypting

To encrypt data set RecipientKey or RecipientCert. Specify the input data using InputFile or InputMessage. Next call Encrypt. The class will populate OutputMessage, or write to the file specified by OutputFile.

Signature Verification

To verify a signature specify the input data using InputFile or InputMessage. Set SignerKey or SignerCert. Next set HashSignature and call VerifySignature. The VerifySignature method will return True if the signature was successfully verified.

Decrypting

To decrypt data first set Key or Certificate. Specify the input data using InputFile or InputMessage. Next call Decrypt. The class will populate OutputMessage, or write to the file specified by OutputFile.

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Property List

---

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

Certificate	The certificate used for signing and decryption.
HashAlgorithm	The hash algorithm used for signing and signature verification.
HashSignature	The hash signature.
HashValue	The hash value of the data.
InputFile	The file to process.
InputMessage	The message to process.
Key	The RSA key.
OutputFile	The output file when encrypting or decrypting.
OutputMessage	The output message after processing.
Overwrite	Indicates whether or not the class should overwrite files.
RecipientCert	The certificate used for encryption.
RecipientKey	The recipient's public key used when encrypting.
SignerCert	The certificate used for signature verification.
SignerKey	The public key used to verify the signature.
UseHex	Whether input or output is hex encoded.
UseOAEP	Whether to use Optimal Asymmetric Encryption Padding (OAEP).
UsePSS	Whether to use RSA-PSS during signing and verification.

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.
CreateKey	Creates a new key.
Decrypt	Decrypts the input data using the specified private key.
Encrypt	Encrypts the input data using the recipient's public key.
Reset	Resets the class.
Sign	Creates a hash signature.
VerifySignature	Verifies the signature for the specified 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.

Error	Information about errors during data delivery.
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.

KeyFormat	How the public and private key are formatted.
KeySize	The size, in bits, of the secret key.
OAEPMGF1HashAlgorithm	The MGF1 hash algorithm used with OAEP.
OAEPParams	The hex encoded OAEP parameters.
OAEPRSAHashAlgorithm	The RSA hash algorithm used with OAEP.
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.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

RSA.Certificate Property

The certificate used for signing and decryption.

Syntax

 getCertificate(): Certificate;

 setCertificate(certificate: Certificate): void;

Default Value

Remarks

This property specifies a certificate with private key.

This may be set instead of Key. This allows a Certificate object to be used instead of a RSAKey object. This certificate is used when calling Sign and Decrypt. The specified certificate must have a private key.

If both this property and Key are specified, Key will be used and this property will be ignored.

RSA.HashAlgorithm Property

The hash algorithm used for signing and signature verification.

Syntax

 getHashAlgorithm(): RsaHashAlgorithms;

 setHashAlgorithm(hashAlgorithm: RsaHashAlgorithms): void;

enum RsaHashAlgorithms {
  rhaSHA1,
  rhaSHA224,
  rhaSHA256,
  rhaSHA384,
  rhaSHA512,
  rhaRIPEMD160,
  rhaMD2,
  rhaMD5,
  rhaMD5SHA1
}

Default Value

2

Remarks

This property specifies the hash algorithm used for signing and signature verification. Possible values are:

0 (rhaSHA1)	SHA-1
1 (rhaSHA224)	SHA-224
2 (rhaSHA256 - default)	SHA-256
3 (rhaSHA384)	SHA-384
4 (rhaSHA512)	SHA-512
5 (rhaRIPEMD160)	RIPEMD-160
6 (rhaMD2)	MD2
7 (rhaMD5)	MD5
8 (rhaMD5SHA1)	MD5SHA1

RSA.HashSignature Property

The hash signature.

Syntax

 getHashSignature(): Uint8Array;

 setHashSignature(hashSignature: Uint8Array): void;

Default Value

""

Remarks

This property holds the computed hash signature. This is populated after calling Sign. This must be set before calling VerifySignature.

RSA.HashValue Property

The hash value of the data.

Syntax

 getHashValue(): Uint8Array;

 setHashValue(hashValue: Uint8Array): void;

Default Value

""

Remarks

This property holds the computed hash value for the specified data. This is populated when calling Sign or VerifySignature when an input file is specified by setting InputFile or InputMessage.

If you know the hash value prior to using the class you may specify the pre-computed hash value here.

Hash Notes

The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by InputFile or InputMessage the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set the class will only sign the hash or verify the hash signature. Setting InputFile or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

RSA.InputFile Property

The file to process.

Syntax

 getInputFile(): string;

 setInputFile(inputFile: string): void;

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

RSA.InputMessage Property

The message to process.

Syntax

 getInputMessage(): Uint8Array;

 setInputMessage(inputMessage: Uint8Array): void;

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

RSA.Key Property

The RSA key.

Syntax

 getKey(): RSAKey;

 setKey(key: RSAKey): void;

Default Value

Remarks

This property specifies the RSA key used to sign or decrypt data. This property must be set before calling Sign or Decrypt. Alternatively, a certificate may be specified by setting Certificate

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

RSA.OutputFile Property

The output file when encrypting or decrypting.

Syntax

 getOutputFile(): string;

 setOutputFile(outputFile: string): void;

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

RSA.OutputMessage Property

The output message after processing.

Syntax

 getOutputMessage(): Uint8Array;

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile 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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

This property is read-only and not available at design time.

RSA.Overwrite Property

Indicates whether or not the class should overwrite files.

Syntax

 isOverwrite(): boolean;

 setOverwrite(overwrite: boolean): void;

Default Value

FALSE

Remarks

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

RSA.RecipientCert Property

The certificate used for encryption.

Syntax

 getRecipientCert(): Certificate;

 setRecipientCert(recipientCert: Certificate): void;

Default Value

Remarks

This property specifies a certificate for encryption.

This may be set instead of RecipientKey. This allows a Certificate object to be used instead of a RSAKey object. This certificate is used when calling Encrypt.

If both this property and RecipientKey are specified, RecipientKey will be used and this property will be ignored.

RSA.RecipientKey Property

The recipient's public key used when encrypting.

Syntax

 getRecipientKey(): RSAKey;

 setRecipientKey(recipientKey: RSAKey): void;

Default Value

Remarks

This property specifies the recipient's public key. This property must be set before calling Encrypt. Alternatively, a certificate may be specified by setting RecipientCert

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

RSA.SignerCert Property

The certificate used for signature verification.

Syntax

 getSignerCert(): Certificate;

 setSignerCert(signerCert: Certificate): void;

Default Value

Remarks

This property specifies a certificate for signature verification.

This may be set instead of SignerKey. This allows a Certificate object to be used instead of a RSAKey object. This certificate is used when calling VerifySignature.

If both this property and SignerKey are specified, SignerKey will be used and this property will be ignored.

RSA.SignerKey Property

The public key used to verify the signature.

Syntax

 getSignerKey(): RSAKey;

 setSignerKey(signerKey: RSAKey): void;

Default Value

Remarks

This property specifies the public key used to verify the signature. This public key corresponds to the private key used when creating the signature. This must be set before calling VerifySignature. Alternatively, a certificate may be specified by setting SignerCert

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

RSA.UseHex Property

Whether input or output is hex encoded.

Syntax

 isUseHex(): boolean;

 setUseHex(useHex: boolean): void;

Default Value

FALSE

Remarks

This property specifies whether the encrypted data, HashValue, and HashSignature are hex encoded.

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

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

If set to True, when Sign is called the class will compute the hash for the specified file and populate HashValue with the hex encoded hash value. It will then create the hash signature and populate HashSignature with the hex encoded hash signature value. If HashValue is specified directly it must be a hex encoded value.

If set to True, when VerifySignature is called the class will compute the hash value for the specified file and populate HashValue with the hex encoded hash value. It will then hex decode HashSignature and verify the signature. HashSignature must hold a hex encoded value. If HashValue is specified directly it must be a hex encoded value.

RSA.UseOAEP Property

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

 isUseOAEP(): boolean;

 setUseOAEP(useOAEP: boolean): void;

Default Value

FALSE

Remarks

Whether to use Optimal Asymmetric Encryption Padding (OAEP). By default this value is False and the class will use PKCS1.

Note: When set to True the HashAlgorithm is also applicable when calling Encrypt and Decrypt.

RSA.UsePSS Property

Whether to use RSA-PSS during signing and verification.

Syntax

 isUsePSS(): boolean;

 setUsePSS(usePSS: boolean): void;

Default Value

FALSE

Remarks

This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False.

RSA.config Method

Sets or retrieves a configuration setting.

Syntax

async rsa.config(configurationString : string): Promise<string>

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.

RSA.createKey Method

Creates a new key.

Syntax

async rsa.createKey(): Promise<void>

Remarks

This method creates a new public and private key.

When calling CreateKey the Key* properties are populated with a new private and public key.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

RSA.decrypt Method

Decrypts the input data using the specified private key.

Syntax

async rsa.decrypt(): Promise<void>

Remarks

This method decrypts the input data using the private key specified in the Key* properties. Alternatively, a certificate may be specified by setting Certificate

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Key Size and the Maximum Length of Data

RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.

When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.

RSA Key Length (bits)	Length (bits)	Length (bytes)
1024	936	117
2048	1960	245
3072	2984	373
4096	4008	501

When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.

RSA Key Length (bits)	Length (bits)	Length (bytes)
1024	496	62
2048	1520	190
3072	2544	318
4096	3568	446

RSA.encrypt Method

Encrypts the input data using the recipient's public key.

Syntax

async rsa.encrypt(): Promise<void>

Remarks

This method encrypts the input data using the public key specified in the RecipientKey* properties. Alternatively, a certificate may be specified by setting RecipientCert

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Key Size and the Maximum Length of Data

RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.

When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.

RSA Key Length (bits)	Length (bits)	Length (bytes)
1024	936	117
2048	1960	245
3072	2984	373
4096	4008	501

When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.

RSA Key Length (bits)	Length (bits)	Length (bytes)
1024	496	62
2048	1520	190
3072	2544	318
4096	3568	446

RSA.reset Method

Resets the class.

Syntax

async rsa.reset(): Promise<void>

Remarks

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

RSA.sign Method

Creates a hash signature.

Syntax

async rsa.sign(): Promise<void>

Remarks

This method will create a hash signature.

Before calling this method specify the input file by setting InputFile or InputMessage.

A key is required to create the hash signature. You may create a new key by calling CreateKey, or specify an existing key pair in Key. Alternatively, a certificate may be specified by setting Certificate. When this method is called the class will compute the hash for the specified file and populate HashValue. It will then create the hash signature using the specified Key and populate HashSignature.

To create the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

RSA.verifySignature Method

Verifies the signature for the specified data.

Syntax

async rsa.verifySignature(): Promise<boolean>

Remarks

This method will verify a hash signature.

Before calling this method specify the input file by setting InputFile or InputMessage.

A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Alternatively, a certificate may be specified by setting SignerCert. Specify the hash signature in HashSignature.

When this method is called the class will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

To verify the hash signature without first computing the hash simply specify HashValue before calling this method.

The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.

RSA.Error Event

Information about errors during data delivery.

Syntax

rsa.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

RSA.Progress Event

Fired as progress is made.

Syntax

rsa.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

EffectiveDate string	This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.
Encoded Uint8Array	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
EncodedB byte[]	This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.
ExpirationDate string	This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00.
ExtendedKeyUsage string	This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint string	This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1 string	This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256 string	This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer string	This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
KeyPassword string	This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys. Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .
PrivateKey string	This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The may be available but not exportable. In this case, returns an empty string.
PrivateKeyAvailable boolean	This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer string	This is the name of the container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey string	This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm string	This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength number	This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber string	This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm string	The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store Uint8Array	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StoreB byte[]	This is the name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows: MY A certificate store holding personal certificates with their associated private keys. CA Certifying authority certificates. ROOT Root certificates. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
StorePassword string	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType CertStoreTypes	This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values: 0 (cstUser - default) For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. 1 (cstMachine) For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. 2 (cstPFXFile) The certificate store is the name of a PFX (PKCS12) file containing certificates. 3 (cstPFXBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. 4 (cstJKSFile) The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. 5 (cstJKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. 6 (cstPEMKeyFile) The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. 7 (cstPEMKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. 8 (cstPublicKeyFile) The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. 9 (cstPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. 10 (cstSSHPublicKeyBlob) The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. 11 (cstP7BFile) The certificate store is the name of a PKCS7 file containing certificates. 12 (cstP7BBlob) The certificate store is a string (binary) representing a certificate store in PKCS7 format. 13 (cstSSHPublicKeyFile) The certificate store is the name of a file that contains an SSH-style public key. 14 (cstPPKFile) The certificate store is the name of a file that contains a PPK (PuTTY Private Key). 15 (cstPPKBlob) The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). 16 (cstXMLFile) The certificate store is the name of a file that contains a certificate in XML format. 17 (cstXMLBlob) The certificate store is a string that contains a certificate in XML format. 18 (cstJWKFile) The certificate store is the name of a file that contains a JWK (JSON Web Key). 19 (cstJWKBlob) The certificate store is a string that contains a JWK (JSON Web Key). 21 (cstBCFKSFile) The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. 22 (cstBCFKSBlob) The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. 23 (cstPKCS11) The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); 99 (cstAuto) The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.
Subject string	This is the subject of the certificate used for client authentication. This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below. Field Meaning CN Common Name. This is commonly a host name like www.server.com. O Organization OU Organizational Unit L Locality S State C Country E Email Address If a field value contains a comma it must be quoted.
SubjectAltNames string	This property contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5 string	This property contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA1 string	This property contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.
ThumbprintSHA256 string	This property contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.
Usage string	This property contains the text description of . This value will be of one or more of the following strings and will be separated by commas: Digital Signatures Key Authentication Key Encryption Data Encryption Key Agreement Certificate Signing Key Signing If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags number	This property contains the flags that show intended use for the certificate. The value of is a combination of the following flags: 0x80 Digital Signatures 0x40 Key Authentication 0x20 Key Encryption 0x10 Data Encryption 0x08 Key Agreement 0x04 Certificate Signing 0x02 Key Signing Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL.
Version string	This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

RSAKey Type

Contains the typical parameters for the RSA algorithm.

Remarks

This type is made up of fields that represent the private and public key parameters used by the RSA algorithm.

RSA Keys

A RSA key is made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyModulus
• KeyExponent

The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both sides of the encryption/signing and decryption/signature verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.

The private key may be represented in one of two ways. Both are mathematically equivalent. Private key format 1:

• KeyModulus
• KeyP
• KeyQ
• KeyDP
• KeyDQ

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is:

• KeyModulus
• KeyD

The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Fields

D Uint8Array	Represents the D parameter for the RSA algorithm.
DB byte[]	Represents the D parameter for the RSA algorithm.
DP Uint8Array	Represents the DP parameter for the RSA algorithm.
DPB byte[]	Represents the DP parameter for the RSA algorithm.
DQ Uint8Array	Represents the DQ parameter for the RSA algorithm.
DQB byte[]	Represents the DQ parameter for the RSA algorithm.
Exponent Uint8Array	Represents the Exponent parameter for the RSA algorithm.
ExponentB byte[]	Represents the Exponent parameter for the RSA algorithm.
InverseQ Uint8Array	Represents the InverseQ parameter for the RSA algorithm. This parameter is optional and is automatically calculated as necessary.
InverseQB byte[]	Represents the InverseQ parameter for the RSA algorithm. This parameter is optional and is automatically calculated as necessary.
Modulus Uint8Array	Represents the Modulus parameter for the RSA algorithm.
ModulusB byte[]	Represents the Modulus parameter for the RSA algorithm.
P Uint8Array	Represents the P parameter for the RSA algorithm.
PB byte[]	Represents the P parameter for the RSA algorithm.
PrivateKey string	This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.
PublicKey string	This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Q Uint8Array	Represents the Q parameter for the RSA algorithm.
QB byte[]	Represents the Q parameter for the RSA algorithm.

Constructors

public RSAKey();

The default constructor creates a new RSAKey instance but does not assign a public or private key.

public RSAKey(byte[] modulus, byte[] exponent);

The public key constructor assigns an existing public key.

public RSAKey(byte[] modulus, byte[] D, byte[] P, byte[] Q, byte[] DP, byte[] DQ);

The private key constructor assigns an existing private key. Any valid combination of parameters representing a private key may be supplied. See the description at the top of this page for details on RSA private key formats.

Config Settings (class ipworksencrypt.rsa)

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.

RSA Config Settings

KeyFormat:   How the public and private key are formatted. This setting controls the format of KeyPublicKey and KeyPrivateKey. By default these properties hold PEM formatted public and private key data. When set to 1 (XML) the keys are stored in a XML format. This only affects the values returned by the class; the actual keys remain the same regardless of this setting. Possible values are: 0 (PEM - PKCS#1) 1 (XML) 2 (PEM - PKCS#8 - default) The default value is 2 (PEM - PKCS#8).

KeySize:   The size, in bits, of the secret key. This specifies the size, in bits, of the secret key. The minimum key size for RSA is 384. The maximum key size is 4096. Note that large values such as 4096 will impact performance. The default value is 1024.

OAEPMGF1HashAlgorithm:   The MGF1 hash algorithm used with OAEP. This configuration setting specifies the MGF1 hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows: "SHA1" "SHA224" "SHA256" (default) "SHA384" "SHA512" "RIPEMD160" "MD2" "MD5" "MD5SHA1"

OAEPParams:   The hex encoded OAEP parameters. This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when UseOAEP is set to True. The specified value should be hex encoded.

OAEPRSAHashAlgorithm:   The RSA hash algorithm used with OAEP. This configuration setting specifies that RSA hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows: "SHA1" "SHA224" "SHA256" (default) "SHA384" "SHA512" "RIPEMD160" "MD2" "MD5" "MD5SHA1"

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

UseInternalSecurityAPI:   Tells the class 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 setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms.

Trappable Errors (class ipworksencrypt.rsa)

RSA Errors

	102   No Key specified.
	104   Cannot read or write file.
	105   key parameters incorrect.
	106   Cannot create hash.
	111   OutputFile already exists and Overwrite is False.
	113   Input data or HashValue must be specified.
	121   Invalid certificate.
	124   HashSignature must be specified.
	304   Cannot write file.
	305   Cannot read file.
	306   Cannot create file.
	1101   Missing RSA parameter: Modulus
	1102   Invalid RSA parameter: Modulus cannot be zero.
	1103   Missing RSA parameters: Public or Private exponent must be present.
	1104   Invalid RSA parameter: Exponent cannot be zero.
	1105   Invalid RSA parameter: D cannot be zero.
	1106   Invalid hash algorithm.
	1107   Missing hash value.
	1108   HashSignature must be specified.
	1109   Invalid hash size.
	1110   Public key must be specified.
	1111   Key must be specified.
	1112   RSA key too short to sign message.
	1113   Missing the data to encrypt/decrypt.
	1114   Invalid cipher length. The data may not have been encrypted with the public key corresponding to the specified private key data.
	1115   Invalid cipher text. The data may not have been encrypted with the public key corresponding to the specified private key data.
	1116   Inadequate padding. The data may not have been encrypted with the public key corresponding to the specified private key data.
	1117   Missing delimiter. The data may not have been encrypted with the public key corresponding to the specified private key data.
	1118   Message too long.