public final class KeyPair extends Object
In addition, this class features a key generation method.
PublicKey
,
PrivateKey
Modifier and Type | Field and Description |
---|---|
static byte |
ALG_DH
KeyPair object containing an DH key pair for modular
exponentiation based Diffie Hellman KeyAgreement operations. |
static byte |
ALG_DSA
KeyPair object containing a DSA key pair. |
static byte |
ALG_EC_F2M
KeyPair object containing an EC key pair for EC operations
over fields of characteristic 2 with polynomial basis. |
static byte |
ALG_EC_FP
KeyPair object containing an EC key pair for EC operations
over large prime fields |
static byte |
ALG_RSA
KeyPair object containing a RSA key pair. |
static byte |
ALG_RSA_CRT
KeyPair object containing a RSA key pair with private key
in its Chinese Remainder Theorem form. |
Constructor and Description |
---|
KeyPair(byte algorithm,
short keyLength)
Constructs a
KeyPair instance for the specified algorithm
and keylength; the encapsulated keys are uninitialized. |
KeyPair(PublicKey publicKey,
PrivateKey privateKey)
Constructs a new
KeyPair object containing the specified
public key and private key. |
Modifier and Type | Method and Description |
---|---|
void |
genKeyPair()
(Re)Initializes the key objects encapsulated in this
KeyPair
instance with new key values. |
PrivateKey |
getPrivate()
Returns a reference to the private key component of this
KeyPair object. |
PublicKey |
getPublic()
Returns a reference to the public key component of this
KeyPair object. |
public static final byte ALG_RSA
KeyPair
object containing a RSA key pair.public static final byte ALG_RSA_CRT
KeyPair
object containing a RSA key pair with private key
in its Chinese Remainder Theorem form.public static final byte ALG_DSA
KeyPair
object containing a DSA key pair.public static final byte ALG_EC_F2M
KeyPair
object containing an EC key pair for EC operations
over fields of characteristic 2 with polynomial basis.public static final byte ALG_EC_FP
KeyPair
object containing an EC key pair for EC operations
over large prime fieldspublic static final byte ALG_DH
KeyPair
object containing an DH key pair for modular
exponentiation based Diffie Hellman KeyAgreement
operations.public KeyPair(byte algorithm, short keyLength) throws CryptoException
KeyPair
instance for the specified algorithm
and keylength; the encapsulated keys are uninitialized. To initialize the
KeyPair
instance use the genKeyPair()
method.
The encapsulated key objects are of the specified keyLength
size and implement the appropriate Key
interface
associated with the specified algorithm (example -
RSAPublicKey
interface for the public key and
RSAPrivateKey
interface for the private key within an
ALG_RSA
key pair).
Notes:
KeyPair
object
need not support the KeyEncryption
interface.
algorithm
- the type of algorithm whose key pair needs to be generated.
Valid codes listed in ALG_*
constants above, for example
ALG_RSA
.keyLength
- the key size in bits. The valid key bit lengths are key type
dependent. See the KeyBuilder
class.CryptoException
- with the following reason codes:
CryptoException.NO_SUCH_ALGORITHM
if:
KeyBuilder
,
Signature
,
javacardx.crypto.Cipher
,
javacardx.crypto.KeyEncryption
public KeyPair(PublicKey publicKey, PrivateKey privateKey) throws CryptoException
KeyPair
object containing the specified
public key and private key.
Note that this constructor only stores references to the public and
private key components in the generated KeyPair
object. It
does not throw an exception if the key parameter objects are
uninitialized.
publicKey
- the public key.privateKey
- the private key.CryptoException
- with the following reason codes:
CryptoException.ILLEGAL_VALUE
if the
input parameter key objects are mismatched - different
algorithms or different key sizes. Parameter values are
not checked.
CryptoException.NO_SUCH_ALGORITHM
if
the algorithm associated with the specified type, size of
key is not supported.
public final void genKeyPair() throws CryptoException
KeyPair
instance with new key values. The initialized public and private key
objects encapsulated in this instance will then be suitable for use with
the Signature
, Cipher
and
KeyAgreement
objects. An internal secure random number
generator is used during new key pair generation.
Notes:
CryptoException
- with the following reason codes:
CryptoException.ILLEGAL_VALUE
if the
pre-initialized exponent value parameter in the RSA public
key or the pre-initialized p, q, g parameter set in the
DSA public key or the pre-initialized Field, A, B, G and R
parameter set in public EC key is invalid.
javacard.framework.APDU
,
Signature
,
javacardx.crypto.Cipher
,
RSAPublicKey
,
ECKey
,
DSAKey
public PublicKey getPublic()
KeyPair
object.public PrivateKey getPrivate()
KeyPair
object.Copyright © 1998, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms