net.named_data.jndn.security.identity

Class PrivateKeyStorage

java.lang.Object

net.named_data.jndn.security.identity.PrivateKeyStorage

Direct Known Subclasses:

FilePrivateKeyStorage, MemoryPrivateKeyStorage

public abstract class PrivateKeyStorage
extends Object

Constructor Summary

Constructors

Constructor and Description
PrivateKeyStorage()

Method Summary

Modifier and Type	Method and Description
Blob	decrypt(Name keyName, ByteBuffer data) Decrypt data using asymmetric encryption.
abstract Blob	decrypt(Name keyName, ByteBuffer data, boolean isSymmetric) Decrypt data.
abstract void	deleteKeyPair(Name keyName) Delete a pair of asymmetric keys.
abstract boolean	doesKeyExist(Name keyName, KeyClass keyClass) Check if a particular key exists.
Blob	encrypt(Name keyName, ByteBuffer data) Encrypt data using asymmetric encryption.
abstract Blob	encrypt(Name keyName, ByteBuffer data, boolean isSymmetric) Encrypt data.
abstract void	generateKey(Name keyName, KeyParams params) Generate a symmetric key.
abstract void	generateKeyPair(Name keyName, KeyParams params) Generate a pair of asymmetric keys.
abstract PublicKey	getPublicKey(Name keyName) Get the public key
Blob	sign(ByteBuffer data, Name keyName) Fetch the private key for keyName and sign the data using DigestAlgorithm.SHA256, returning a signature Blob.
abstract 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 java.lang.Object

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

Constructor Detail

PrivateKeyStorage

public PrivateKeyStorage()

Method Detail

generateKeyPair

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

Generate a pair of asymmetric keys.

Parameters:

keyName - The name of the key pair.

params - The parameters of the key.

Throws:

SecurityException

deleteKeyPair

public abstract void deleteKeyPair(Name keyName)
                            throws SecurityException

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

Parameters:

keyName - The name of the key pair.

Throws:

SecurityException

getPublicKey

public abstract PublicKey getPublicKey(Name keyName)
                                throws SecurityException

Get the public key

Parameters:

keyName - The name of public key.

Returns:

The public key.

Throws:

SecurityException

sign

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

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

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

sign

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

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

Parameters:

data - Pointer the input byte buffer to sign.

keyName - The name of the signing key.

Returns:

The signature Blob.

Throws:

SecurityException

decrypt

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

Decrypt data.

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

decrypt

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

Decrypt data using asymmetric encryption.

Parameters:

keyName - The name of the decrypting key.

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

Returns:

The decrypted data.

Throws:

SecurityException

encrypt

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

Encrypt data.

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

encrypt

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

Encrypt data using asymmetric encryption.

Parameters:

keyName - The name of the encrypting key.

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

Returns:

The encrypted data.

Throws:

SecurityException

generateKey

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

Generate a symmetric key.

Parameters:

keyName - The name of the key.

params - The parameters of the key.

Throws:

SecurityException

doesKeyExist

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

Check if a particular key exists.

Parameters:

keyName - The name of the key.

keyClass - The class of the key, e.g. KeyClass.PUBLIC, KeyClass.PRIVATE, or KeyClass.SYMMETRIC.

Returns:

True if the key exists, otherwise false.

Throws:

SecurityException