net.named_data.jndn.security.identity

Class MemoryPrivateKeyStorage

java.lang.Object

net.named_data.jndn.security.identity.PrivateKeyStorage

net.named_data.jndn.security.identity.MemoryPrivateKeyStorage

public class MemoryPrivateKeyStorage
extends PrivateKeyStorage

Constructor Summary

Constructors

Constructor and Description
MemoryPrivateKeyStorage()

Method Summary

Methods

Modifier and Type	Method and Description
Blob	decrypt(Name keyName, ByteBuffer data, boolean isSymmetric) Decrypt data.
void	deleteKeyPair(Name keyName) Delete a pair of asymmetric keys.
boolean	doesKeyExist(Name keyName, KeyClass keyClass) Check if a particular key exists.
Blob	encrypt(Name keyName, ByteBuffer data, boolean isSymmetric) Encrypt data.
void	generateKey(Name keyName, KeyParams params) Generate a symmetric key.
void	generateKeyPair(Name keyName, KeyParams params) Generate a pair of asymmetric keys.
PublicKey	getPublicKey(Name keyName) Get the public key
void	setKeyPairForKeyName(Name keyName, ByteBuffer publicKeyDer, ByteBuffer privateKeyDer) Deprecated. Use setKeyPairForKeyName(keyName, KeyType.RSA, publicKeyDer, privateKeyDer).
void	setKeyPairForKeyName(Name keyName, KeyType keyType, ByteBuffer publicKeyDer, ByteBuffer privateKeyDer) Set the public and private key for the keyName.
void	setPrivateKeyForKeyName(Name keyName, KeyType keyType, ByteBuffer privateKeyDer) Set the private key for the keyName.
void	setPublicKeyForKeyName(Name keyName, KeyType keyType, ByteBuffer publicKeyDer) Set the public key for the keyName.
Blob	sign(ByteBuffer data, Name keyName, DigestAlgorithm digestAlgorithm) Fetch the private key for keyName and sign the data, returning a signature Blob.

Methods inherited from class net.named_data.jndn.security.identity.PrivateKeyStorage

decrypt, encrypt, sign

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryPrivateKeyStorage

public MemoryPrivateKeyStorage()

Method Detail

setPublicKeyForKeyName

public final void setPublicKeyForKeyName(Name keyName,
                          KeyType keyType,
                          ByteBuffer publicKeyDer)
                                  throws SecurityException

Set the public key for the keyName.

Parameters:

keyName - The key name.

keyType - The KeyType, such as KeyType.RSA.

publicKeyDer - The public key DER byte buffer.

Throws:

SecurityException - if can't decode the key DER.

setPrivateKeyForKeyName

public final void setPrivateKeyForKeyName(Name keyName,
                           KeyType keyType,
                           ByteBuffer privateKeyDer)
                                   throws SecurityException

Set the private key for the keyName.

Parameters:

keyName - The key name.

keyType - The KeyType, such as KeyType.RSA.

privateKeyDer - The private key DER byte buffer.

Throws:

SecurityException - if can't decode the key DER.

setKeyPairForKeyName

public final void setKeyPairForKeyName(Name keyName,
                        KeyType keyType,
                        ByteBuffer publicKeyDer,
                        ByteBuffer privateKeyDer)
                                throws SecurityException

Set the public and private key for the keyName.

Parameters:

keyName - The key name.

keyType - The KeyType, such as KeyType.RSA.

publicKeyDer - The public key DER byte buffer.

privateKeyDer - The private key DER byte buffer.

Throws:

SecurityException - if can't decode the key DER.

setKeyPairForKeyName

public final void setKeyPairForKeyName(Name keyName,
                        ByteBuffer publicKeyDer,
                        ByteBuffer privateKeyDer)
                                throws SecurityException

Deprecated. Use setKeyPairForKeyName(keyName, KeyType.RSA, publicKeyDer, privateKeyDer).

Parameters:

keyName - The key name.

publicKeyDer - The public key DER byte buffer.

privateKeyDer - The private key DER byte buffer.

Throws:

SecurityException - if can't decode the key DER.

generateKeyPair

public void generateKeyPair(Name keyName,
                   KeyParams params)
                     throws SecurityException

Generate a pair of asymmetric keys.

Specified by:

generateKeyPair in class PrivateKeyStorage

Parameters:

keyName - The name of the key pair.

params - The parameters of the key.

Throws:

SecurityException

deleteKeyPair

public void deleteKeyPair(Name keyName)
                   throws SecurityException

Delete a pair of asymmetric keys. If the key doesn't exist, do nothing.

Specified by:

deleteKeyPair in class PrivateKeyStorage

Parameters:

keyName - The name of the key pair.

Throws:

SecurityException

getPublicKey

public PublicKey getPublicKey(Name keyName)
                       throws SecurityException

Get the public key

Specified by:

getPublicKey in class PrivateKeyStorage

Parameters:

keyName - The name of public key.

Returns:

The public key.

Throws:

SecurityException

sign

public Blob sign(ByteBuffer data,
        Name keyName,
        DigestAlgorithm digestAlgorithm)
          throws SecurityException

Fetch the private key for keyName and sign the data, returning a signature Blob.

Specified by:

sign in class PrivateKeyStorage

Parameters:

data - Pointer the input byte buffer to sign.

keyName - The name of the signing key.

digestAlgorithm - the digest algorithm.

Returns:

The signature Blob.

Throws:

SecurityException

decrypt

public Blob decrypt(Name keyName,
           ByteBuffer data,
           boolean isSymmetric)
             throws SecurityException

Decrypt data.

Specified by:

decrypt in class PrivateKeyStorage

Parameters:

keyName - The name of the decrypting key.

data - The byte buffer to be decrypted, from its position to its limit.

isSymmetric - If true symmetric encryption is used, otherwise asymmetric encryption is used.

Returns:

The decrypted data.

Throws:

SecurityException

encrypt

public Blob encrypt(Name keyName,
           ByteBuffer data,
           boolean isSymmetric)
             throws SecurityException

Encrypt data.

Specified by:

encrypt in class PrivateKeyStorage

Parameters:

keyName - The name of the encrypting key.

data - The byte buffer to be encrypted, from its position to its limit.

isSymmetric - If true symmetric encryption is used, otherwise asymmetric encryption is used.

Returns:

The encrypted data.

Throws:

SecurityException

generateKey

public void generateKey(Name keyName,
               KeyParams params)
                 throws SecurityException

Generate a symmetric key.

Specified by:

generateKey in class PrivateKeyStorage

Parameters:

keyName - The name of the key.

params - The parameters of the key.

Throws:

SecurityException

doesKeyExist

public boolean doesKeyExist(Name keyName,
                   KeyClass keyClass)
                     throws SecurityException

Check if a particular key exists.

Specified by:

doesKeyExist in class PrivateKeyStorage

Parameters:

keyName - The name of the key.

keyClass - The class of the key, e.g. KEY_CLASS_PUBLIC, KEY_CLASS_PRIVATE, or KEY_CLASS_SYMMETRIC.

Returns:

True if the key exists, otherwise false.

Throws:

SecurityException