IP*Works! Encrypt V9 - Online Help
IP*Works! Encrypt V9
Questions / Feedback?

RSA Class

Properties   Methods   Events   Configuration 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:

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

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 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:

Private key format 2 is simpler but has decreased performance when decrypting and signing. This format is: 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.

CertEncodedThe certificate (PEM/base64 encoded).
CertStoreThe name of the certificate store for the client certificate.
CertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
CertStoreTypeThe type of certificate store for this certificate.
CertSubjectThe subject of the certificate used for client authentication.
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.
KeyDRepresents the D parameter for the RSA algorithm.
KeyDPRepresents the DP parameter for the RSA algorithm.
KeyDQRepresents the DQ parameter for the RSA algorithm.
KeyExponentRepresents the Exponent parameter for the RSA algorithm.
KeyInverseQRepresents the InverseQ parameter for the RSA algorithm.
KeyModulusRepresents the Modulus parameter for the RSA algorithm.
KeyPRepresents the P parameter for the RSA algorithm.
KeyPrivateKeyThis property is a PEM formatted private key.
KeyPublicKeyThis property is a PEM formatted public key.
KeyQRepresents the Q parameter for the RSA algorithm.
OutputFileThe output file.
OutputMessageThe output message after processing.
OverwriteIndicates whether or not the component should overwrite files.
RecipientCertEncodedThe certificate (PEM/base64 encoded).
RecipientCertStoreThe name of the certificate store for the client certificate.
RecipientCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
RecipientCertStoreTypeThe type of certificate store for this certificate.
RecipientCertSubjectThe subject of the certificate used for client authentication.
RecipientKeyExponentRepresents the Exponent parameter for the RSA algorithm.
RecipientKeyModulusRepresents the Modulus parameter for the RSA algorithm.
RecipientKeyPublicKeyThis property is a PEM formatted public key.
SignerCertEncodedThe certificate (PEM/base64 encoded).
SignerCertStoreThe name of the certificate store for the client certificate.
SignerCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SignerCertStoreTypeThe type of certificate store for this certificate.
SignerCertSubjectThe subject of the certificate used for client authentication.
SignerKeyExponentRepresents the Exponent parameter for the RSA algorithm.
SignerKeyModulusRepresents the Modulus parameter for the RSA algorithm.
SignerKeyPublicKeyThis property is a PEM formatted public key.
UseHexWhether input or output is hex encoded.

Method List


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

ConfigSets or retrieves a configuration setting .
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 component.
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.

Configuration Settings


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

UseOAEPWhether to use Optimal Asymmetric Encryption Padding (OAEP).
OAEPParamsThe hex encoded OAEP parameters.
MGF1HashAlgorithmThe MGF1 hash algorithm used with OAEP.
KeySizeThe size, in bits, of the secret key.
KeyFormatHow the public and private key are formatted.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0