IPWorks Encrypt 2020 JavaScript Edition

Questions / Feedback?

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.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 JavaScript Edition - Version 20.0 [Build 8262]