net.named_data.jndn.security.tpm

Class TpmPrivateKey

java.lang.Object

net.named_data.jndn.security.tpm.TpmPrivateKey

public class TpmPrivateKey
extends Object

A TpmPrivateKey holds an in-memory private key and provides cryptographic operations such as for signing by the in-memory TPM.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TpmPrivateKey.Error A TpmPrivateKey.Error extends Exception and represents an error in private key processing.

Constructor Summary

Constructors

Constructor and Description
TpmPrivateKey() Create an uninitialized TpmPrivateKey.

Method Summary

Modifier and Type	Method and Description
Blob	decrypt(ByteBuffer cipherText) Call the main decrypt where algorithmType is RsaOaep.
Blob	decrypt(ByteBuffer cipherText, EncryptAlgorithmType algorithmType) Decrypt the cipherText using this private key according the encryption algorithmType.
Blob	derivePublicKey() Get the encoded public key for this private key.
static TpmPrivateKey	generatePrivateKey(KeyParams keyParams) Generate a key pair according to keyParams and return a new TpmPrivateKey with the private key.
void	loadEncryptedPkcs8(ByteBuffer encoding, ByteBuffer password) Load the encrypted private key from a buffer with the PKCS #8 encoding of the EncryptedPrivateKeyInfo.
void	loadPkcs1(ByteBuffer encoding) Load the unencrypted private key from a buffer with the PKCS #1 encoding.
void	loadPkcs1(ByteBuffer encoding, KeyType keyType) Load the unencrypted private key from a buffer with the PKCS #1 encoding.
void	loadPkcs8(ByteBuffer encoding) Load the unencrypted private key from a buffer with the PKCS #8 encoding.
void	loadPkcs8(ByteBuffer encoding, KeyType keyType) Load the unencrypted private key from a buffer with the PKCS #8 encoding.
Blob	sign(ByteBuffer data, DigestAlgorithm digestAlgorithm) Sign the data with this private key, returning a signature Blob.
Blob	toEncryptedPkcs8(ByteBuffer password) Get the encoded encrypted private key in PKCS #8.
Blob	toPkcs1() Get the encoded unencrypted private key in PKCS #1.
Blob	toPkcs8() Get the encoded unencrypted private key in PKCS #8.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TpmPrivateKey

public TpmPrivateKey()

Create an uninitialized TpmPrivateKey. You must call a load method to initialize it, such as loadPkcs1.

Method Detail

loadPkcs1

public final void loadPkcs1(ByteBuffer encoding,
                            KeyType keyType)
                     throws TpmPrivateKey.Error

Load the unencrypted private key from a buffer with the PKCS #1 encoding. This replaces any existing private key in this object.

Parameters:

encoding - The byte buffer with the private key encoding.

keyType - The KeyType, such as KeyType.RSA. If null, then partially decode the private key to determine the key type.

Throws:

TpmPrivateKey.Error - for errors decoding the key.

loadPkcs1

public final void loadPkcs1(ByteBuffer encoding)
                     throws TpmPrivateKey.Error

Load the unencrypted private key from a buffer with the PKCS #1 encoding. This replaces any existing private key in this object. This partially decodes the private key to determine the key type.

Parameters:

encoding - The byte buffer with the private key encoding.

Throws:

TpmPrivateKey.Error - for errors decoding the key.

loadPkcs8

public final void loadPkcs8(ByteBuffer encoding,
                            KeyType keyType)
                     throws TpmPrivateKey.Error

Load the unencrypted private key from a buffer with the PKCS #8 encoding. This replaces any existing private key in this object.

Parameters:

encoding - The byte buffer with the private key encoding.

keyType - The KeyType, such as KeyType.RSA. If null, then partially decode the private key to determine the key type.

Throws:

TpmPrivateKey.Error - for errors decoding the key.

loadPkcs8

public final void loadPkcs8(ByteBuffer encoding)
                     throws TpmPrivateKey.Error

Load the unencrypted private key from a buffer with the PKCS #8 encoding. This replaces any existing private key in this object. This partially decodes the private key to determine the key type.

Parameters:

encoding - The byte buffer with the private key encoding.

Throws:

TpmPrivateKey.Error - for errors decoding the key.

loadEncryptedPkcs8

public final void loadEncryptedPkcs8(ByteBuffer encoding,
                                     ByteBuffer password)
                              throws TpmPrivateKey.Error

Load the encrypted private key from a buffer with the PKCS #8 encoding of the EncryptedPrivateKeyInfo. This replaces any existing private key in this object. This partially decodes the private key to determine the key type.

Parameters:

encoding - The byte buffer with the private key encoding.

password - The password for decrypting the private key, which should have characters in the range of 1 to 127.

Throws:

TpmPrivateKey.Error - for errors decoding or decrypting the key.

derivePublicKey

public final Blob derivePublicKey()
                           throws TpmPrivateKey.Error

Get the encoded public key for this private key.

Returns:

The public key encoding Blob.

Throws:

TpmPrivateKey.Error - if no private key is loaded, or error converting to a public key.

decrypt

public final Blob decrypt(ByteBuffer cipherText,
                          EncryptAlgorithmType algorithmType)
                   throws TpmPrivateKey.Error

Decrypt the cipherText using this private key according the encryption algorithmType. Only RSA encryption is supported for now.

Parameters:

cipherText - The cipher text byte buffer.

algorithmType - This decrypts according to algorithmType.

Returns:

The decrypted data.

Throws:

TpmPrivateKey.Error - if the private key is not loaded, if decryption is not supported for this key type, or for error decrypting.

decrypt

public final Blob decrypt(ByteBuffer cipherText)
                   throws TpmPrivateKey.Error

Call the main decrypt where algorithmType is RsaOaep.

Throws:

TpmPrivateKey.Error

sign

public final Blob sign(ByteBuffer data,
                       DigestAlgorithm digestAlgorithm)
                throws TpmPrivateKey.Error

Sign the data with this private key, returning a signature Blob.

Parameters:

data - The input byte buffer.

digestAlgorithm - the digest algorithm.

Returns:

The signature Blob, or an isNull Blob if this private key is not initialized.

Throws:

TpmPrivateKey.Error - for unrecognized digestAlgorithm or an error in signing.

toPkcs1

public final Blob toPkcs1()
                   throws TpmPrivateKey.Error

Get the encoded unencrypted private key in PKCS #1.

Returns:

The private key encoding Blob.

Throws:

TpmPrivateKey.Error - if no private key is loaded, or error encoding.

toPkcs8

public final Blob toPkcs8()
                   throws TpmPrivateKey.Error

Get the encoded unencrypted private key in PKCS #8.

Returns:

The private key encoding Blob.

Throws:

TpmPrivateKey.Error - if no private key is loaded, or error encoding.

toEncryptedPkcs8

public final Blob toEncryptedPkcs8(ByteBuffer password)
                            throws TpmPrivateKey.Error

Get the encoded encrypted private key in PKCS #8.

Parameters:

password - The password for encrypting the private key, which should have characters in the range of 1 to 127.

Returns:

The encoding Blob of the EncryptedPrivateKeyInfo.

Throws:

TpmPrivateKey.Error - if no private key is loaded, or error encoding.

generatePrivateKey

public static TpmPrivateKey generatePrivateKey(KeyParams keyParams)
                                        throws IllegalArgumentException,
                                               TpmPrivateKey.Error

Generate a key pair according to keyParams and return a new TpmPrivateKey with the private key. You can get the public key with derivePublicKey.

Parameters:

keyParams - The parameters of the key.

Returns:

A new TpmPrivateKey.

Throws:

IllegalArgumentException - if the key type is not supported.

TpmPrivateKey.Error - for an invalid key size, or an error generating.