net.named_data.jndn.security.identity

Class FilePrivateKeyStorage

java.lang.Object

net.named_data.jndn.security.identity.PrivateKeyStorage

net.named_data.jndn.security.identity.FilePrivateKeyStorage

public class FilePrivateKeyStorage
extends PrivateKeyStorage

FilePrivateKeyStorage extends PrivateKeyStorage to implement private key storage using files.

Constructor Summary

Constructors

Constructor and Description
FilePrivateKeyStorage() Create a new FilePrivateKeyStorage to connect to the default directory in System.getProperty("user.home").
FilePrivateKeyStorage(String keyStoreDirectoryPath) Create a new FilePrivateKeyStorage to connect to the given directory.

Method Summary

Modifier and Type	Method and Description
Blob	decrypt(Name keyName, ByteBuffer data, boolean isSymmetric) Decrypt data.
void	deleteKey(Name keyName) Delete a key by name; checks all KeyClass types
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.
static String	getDefaultDirecoryPath(File filesRoot) Get the default directory path for private keys based on the files root.
static String	getDefaultDirecoryPath(String filesRoot) Get the default directory path for private keys based on the files root.
PublicKey	getPublicKey(Name keyName) Get the public key
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

FilePrivateKeyStorage

public FilePrivateKeyStorage()

Create a new FilePrivateKeyStorage to connect to the default directory in System.getProperty("user.home").

FilePrivateKeyStorage

public FilePrivateKeyStorage(String keyStoreDirectoryPath)

Create a new FilePrivateKeyStorage to connect to the given directory.

Parameters:

keyStoreDirectoryPath - The full path of the directory holding the private key data. This creates the directory if it doesn't exist. For example, you can get the default directory path from an Android files directory with getDefaultDirecoryPath(context.getFilesDir())

Method Detail

getDefaultDirecoryPath

public static String getDefaultDirecoryPath(File filesRoot)

Get the default directory path for private keys based on the files root. For example if filesRoot is "/data/data/org.example/files", this returns "/data/data/org.example/files/.ndn/ndnsec-tpm-file".

Parameters:

filesRoot - The root file directory. An Android app can use context.getFilesDir()

Returns:

The default directory path.

getDefaultDirecoryPath

public static String getDefaultDirecoryPath(String filesRoot)

Get the default directory path for private keys based on the files root.

Parameters:

filesRoot - The root file directory.

Returns:

The default directory path.

generateKeyPair

public final 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 final 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 final 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 final 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 final 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 final 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

deleteKey

public final void deleteKey(Name keyName)
                     throws SecurityException

Delete a key by name; checks all KeyClass types

Parameters:

keyName -

Throws:

SecurityException

doesKeyExist

public final 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. KeyClass.PUBLIC, KeyClass.PRIVATE, or KeyClass.SYMMETRIC.

Returns:

True if the key exists, otherwise false.

Throws:

SecurityException