IPWorks Encrypt 2022 Java Edition
Version 22.0 [Build 8369]

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 Key. To create a new key call CreateKey. Alternatively an existing certificate may be specified by setting Certificate

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:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

RSA Keys

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

The public key consists of the following parameters:

The class also includes the PublicKey field 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 PublicKey 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: The class also include the PrivateKey field 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.

CertificateThe certificate used for signing and decryption.
HashAlgorithmThe hash algorithm used for signing and signature verification.
HashSignatureThe hash signature.
HashValueThe hash value of the data.
InputFileThe file to process.
InputMessageThe message to process.
KeyThe RSA key.
OutputFileThe output file when encrypting or decrypting.
OutputMessageThe output message after processing.
OverwriteIndicates whether or not the class should overwrite files.
RecipientCertThe certificate used for encryption.
RecipientKeyThe recipient's public key used when encrypting.
SignerCertThe certificate used for signature verification.
SignerKeyThe public key used to verify the signature.
UseHexWhether input or output is hex encoded.
UseOAEPWhether to use Optimal Asymmetric Encryption Padding (OAEP).
UsePSSWhether 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.

ConfigSets or retrieves a configuration setting.
CreateKeyCreates a new key.
DecryptDecrypts the input data using the specified private key.
EncryptEncrypts the input data using the recipient's public key.
ResetResets the class.
SetInputStreamSets the stream from which the class will read data to encrypt or decrypt.
SetOutputStreamSets the stream to which the class will write encrypted or decrypted data.
SignCreates a hash signature.
VerifySignatureVerifies 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.

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

CloseInputStreamAfterProcessingDetermines whether or not the input stream is closed after processing.
CloseOutputStreamAfterProcessingDetermines whether or not the output stream is closed after processing.
KeyFormatHow the public and private key are formatted.
KeySizeThe size, in bits, of the secret key.
OAEPMGF1HashAlgorithmThe MGF1 hash algorithm used with OAEP.
OAEPParamsThe hex encoded OAEP parameters.
OAEPRSAHashAlgorithmThe RSA hash algorithm used with OAEP.
BuildInfoInformation about the product's build.
GUIAvailableTells the class whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Certificate Property (RSA Class)

The certificate used for signing and decryption.

Syntax


public Certificate getCertificate();


public void setCertificate(Certificate certificate);

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.

HashAlgorithm Property (RSA Class)

The hash algorithm used for signing and signature verification.

Syntax


public int getHashAlgorithm();


public void setHashAlgorithm(int hashAlgorithm);


Enumerated values:
  public final static int rhaSHA1 = 0;
  public final static int rhaSHA224 = 1;
  public final static int rhaSHA256 = 2;
  public final static int rhaSHA384 = 3;
  public final static int rhaSHA512 = 4;
  public final static int rhaRIPEMD160 = 5;
  public final static int rhaMD2 = 6;
  public final static int rhaMD5 = 7;
  public final static int rhaMD5SHA1 = 8;

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

HashSignature Property (RSA Class)

The hash signature.

Syntax


public byte[] getHashSignature();


public void setHashSignature(byte[] hashSignature);

Default Value

""

Remarks

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

HashValue Property (RSA Class)

The hash value of the data.

Syntax


public byte[] getHashValue();


public void setHashValue(byte[] hashValue);

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 SetInputStream, 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 SetInputStream, 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 SetInputStream, InputFile, or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

InputFile Property (RSA Class)

The file to process.

Syntax


public String getInputFile();


public void setInputFile(String inputFile);

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (RSA Class)

The message to process.

Syntax


public byte[] getInputMessage();


public void setInputMessage(byte[] inputMessage);

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Property (RSA Class)

The RSA key.

Syntax


public RSAKey getKey();


public void setKey(RSAKey key);

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:

The class also includes the PublicKey field 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 PublicKey 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

OutputFile Property (RSA Class)

The output file when encrypting or decrypting.

Syntax


public String getOutputFile();


public void setOutputFile(String outputFile);

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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

OutputMessage Property (RSA Class)

The output message after processing.

Syntax


public byte[] getOutputMessage();


Default Value

""

Remarks

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Overwrite Property (RSA Class)

Indicates whether or not the class should overwrite files.

Syntax


public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

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.

RecipientCert Property (RSA Class)

The certificate used for encryption.

Syntax


public Certificate getRecipientCert();


public void setRecipientCert(Certificate recipientCert);

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.

RecipientKey Property (RSA Class)

The recipient's public key used when encrypting.

Syntax


public RSAKey getRecipientKey();


public void setRecipientKey(RSAKey recipientKey);

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:

The class also includes the PublicKey field 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 PublicKey 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

SignerCert Property (RSA Class)

The certificate used for signature verification.

Syntax


public Certificate getSignerCert();


public void setSignerCert(Certificate signerCert);

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.

SignerKey Property (RSA Class)

The public key used to verify the signature.

Syntax


public RSAKey getSignerKey();


public void setSignerKey(RSAKey signerKey);

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:

The class also includes the PublicKey field 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 PublicKey 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

UseHex Property (RSA Class)

Whether input or output is hex encoded.

Syntax


public boolean isUseHex();


public void setUseHex(boolean useHex);

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.

UseOAEP Property (RSA Class)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax


public boolean isUseOAEP();


public void setUseOAEP(boolean useOAEP);

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.

UsePSS Property (RSA Class)

Whether to use RSA-PSS during signing and verification.

Syntax


public boolean isUsePSS();


public void setUsePSS(boolean usePSS);

Default Value

False

Remarks

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

Config Method (Rsa Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

CreateKey Method (Rsa Class)

Creates a new key.

Syntax

public void createKey();

Remarks

This method creates a new public and private key.

When calling CreateKey the Key property is 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:

The class also includes the PublicKey field 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 PublicKey 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Decrypt Method (Rsa Class)

Decrypts the input data using the specified private key.

Syntax

public void decrypt();

Remarks

This method decrypts the input data using the private key specified in Key. 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:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Encrypt Method (Rsa Class)

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

Syntax

public void encrypt();

Remarks

This method encrypts the input data using the public key specified in RecipientKey. 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:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Reset Method (Rsa Class)

Resets the class.

Syntax

public void reset();

Remarks

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

SetInputStream Method (Rsa Class)

Sets the stream from which the class will read data to encrypt or decrypt.

Syntax

public void setInputStream(java.io.InputStream inputStream);

Remarks

This method sets the stream from which the class will read data 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:

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

SetOutputStream Method (Rsa Class)

Sets the stream to which the class will write encrypted or decrypted data.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method sets the stream to which the class will write encrypted or decrypted data.

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:

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Sign Method (Rsa Class)

Creates a hash signature.

Syntax

public void sign();

Remarks

This method will create a hash signature.

Before calling this method specify the input file by setting SetInputStream, 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.

VerifySignature Method (Rsa Class)

Verifies the signature for the specified data.

Syntax

public boolean verifySignature();

Remarks

This method will verify a hash signature.

Before calling this method specify the input file by setting SetInputStream, 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.

Error Event (Rsa Class)

Information about errors during data delivery.

Syntax

public class DefaultRsaEventListener implements RsaEventListener {
  ...
  public void error(RsaErrorEvent e) {}
  ...
}

public class RsaErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

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.

Progress Event (Rsa Class)

Fired as progress is made.

Syntax

public class DefaultRsaEventListener implements RsaEventListener {
  ...
  public void progress(RsaProgressEvent e) {}
  ...
}

public class RsaProgressEvent {
  public long bytesProcessed;
  public int percentProcessed;
}

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
String

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

EncodedB
byte[]

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject 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 field 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 StorePassword. KeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of StorePassword. 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.

PrivateKey
String

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String

This is the name of the PrivateKey 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 field 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
int

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 field 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
String

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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 StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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
int

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 field 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).
20 (cstSecurityKey)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 cstSecurityKey, 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 Store and set StorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; 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.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.
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 field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

SubjectAltNames
String

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String

This field contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA1
String

This field contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA256
String

This field contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.

Usage
String

This field contains the text description of UsageFlags.

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
int

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String

This field 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( certificateFile);

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

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  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( certStoreType,  store,  storePassword,  subject,  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( certStoreType,  store,  storePassword,  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( certStoreType,  storeBlob,  storePassword,  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( certStoreType,  storeBlob,  storePassword,  subject,  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( certStoreType,  storeBlob,  storePassword,  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:

The class also includes the PublicKey field 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 PublicKey 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: The class also include the PrivateKey field which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Fields

D
String

Represents the D parameter for the RSA algorithm.

DB
byte[]

Represents the D parameter for the RSA algorithm.

DP
String

Represents the DP parameter for the RSA algorithm.

DPB
byte[]

Represents the DP parameter for the RSA algorithm.

DQ
String

Represents the DQ parameter for the RSA algorithm.

DQB
byte[]

Represents the DQ parameter for the RSA algorithm.

Exponent
String

Represents the Exponent parameter for the RSA algorithm.

ExponentB
byte[]

Represents the Exponent parameter for the RSA algorithm.

InverseQ
String

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
String

Represents the Modulus parameter for the RSA algorithm.

ModulusB
byte[]

Represents the Modulus parameter for the RSA algorithm.

P
String

Represents the P parameter for the RSA algorithm.

PB
byte[]

Represents the P parameter for the RSA algorithm.

PrivateKey
String

This field is a PEM formatted private key. The purpose of this field is to allow easier management of the private key parameters by using only a single value.

PublicKey
String

This field is a PEM formatted public key. The purpose of this field is to allow easier management of the public key parameters by using only a single value.

Q
String

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( modulus,  exponent);

The public key constructor assigns an existing public key.

public RSAKey( modulus,  D,  P,  Q,  DP,  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 (Rsa Class)

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

CloseInputStreamAfterProcessing:   Determines whether or not the input stream is closed after processing.

Determines whether or not the input stream set by SetInputStream is closed after processing is complete. The default value is True.

CloseOutputStreamAfterProcessing:   Determines whether or not the output stream is closed after processing.

Determines whether or not the output stream set by SetOutputStream is closed after processing is complete. The default value is True.

KeyFormat:   How the public and private key are formatted.

This setting controls the format of PublicKey and PrivateKey. By default these fields 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 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.

GUIAvailable:   Tells the class whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

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.
UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

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.

Trappable Errors (Rsa Class)

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.

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