ECCKey Type
Contains the parameters for the ECC algorithm.
Remarks
This type is made up of fields that represent the private and public key parameters used by the ECC operations. The PrivateKey and PublicKey parameters hold a PEM formatted value for easy transport and storage of keys.
NIST Curve Notes
Keys for use with the secp256r1, secp384r1, and secp521r1 curves are made up of a number of individual parameters.
The public key consists of the following parameters:
The private key consists of one value:
Curve25519 and Curve448 Notes
Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.
XPk holds the public key.
XSk holds the private key.
Fields
|
Algorithm int |
This field holds the algorithm associated with the key. Possible values are:
When assigning a key using the PEM formatted PrivateKey and PublicKey the Algorithm field will be automatically updated with the key algorithm. When assigning a key using the raw key parameters (K, Rx, and Ry for NIST or XPk, and XSk for Curve25519/Curve448) the Algorithm field must be set manually to the key algorithm. The following table summarizes the supported operations for keys created with each algorithm:
| ||||||||||||||||||||||||
|
K String |
Represent the private key (K) parameter. Note: This value is only applicable when using a NIST curve. | ||||||||||||||||||||||||
|
KB byte[] |
Represent the private key (K) parameter. Note: This value is only applicable when using a NIST curve. | ||||||||||||||||||||||||
|
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. | ||||||||||||||||||||||||
|
Rx String |
Represents the public key's Rx parameter. Note: This value is only applicable when using a NIST curve. | ||||||||||||||||||||||||
|
RxB byte[] |
Represents the public key's Rx parameter. Note: This value is only applicable when using a NIST curve. | ||||||||||||||||||||||||
|
Ry String |
Represents the public key's Ry parameter. Note: This value is only applicable when using a NIST curve. | ||||||||||||||||||||||||
|
RyB byte[] |
Represents the public key's Ry parameter. Note: This value is only applicable when using a NIST curve. | ||||||||||||||||||||||||
|
XPk String |
Holds the public key data. Note: This value is only applicable when using Curve25519 or Curve448. | ||||||||||||||||||||||||
|
XPkB byte[] |
Holds the public key data. Note: This value is only applicable when using Curve25519 or Curve448. | ||||||||||||||||||||||||
|
XSk String |
Holds the private key data. Note: This value is only applicable when using Curve25519 or Curve448. | ||||||||||||||||||||||||
|
XSkB byte[] |
Holds the private key data. Note: This value is only applicable when using Curve25519 or Curve448. |
Constructors
public ECCKey();
The default constructor creates a new ECCKey instance but does not assign a public or private key.
public ECCKey(byte[] rx, byte[] ry, int algorithm);
The public key constructor assigns an existing public key.
public ECCKey(byte[] K, byte[] rx, byte[] ry, int algorithm);
The private key constructor assigns an existing private key.