net.named_data.jndn.security.identity

Class AndroidSqlite3IdentityStorage

java.lang.Object

net.named_data.jndn.security.identity.IdentityStorage

net.named_data.jndn.security.identity.Sqlite3IdentityStorageBase

net.named_data.jndn.security.identity.AndroidSqlite3IdentityStorage

public class AndroidSqlite3IdentityStorage
extends Sqlite3IdentityStorageBase

AndroidSqlite3IdentityStorage extends IdentityStorage to implement basic storage of identity, public keys and certificates using the android.database.sqlite API.

Field Summary

Fields inherited from class net.named_data.jndn.security.identity.Sqlite3IdentityStorageBase

INIT_CERT_TABLE1, INIT_CERT_TABLE2, INIT_CERT_TABLE3, INIT_ID_TABLE1, INIT_ID_TABLE2, INIT_KEY_TABLE1, INIT_KEY_TABLE2, INIT_TPM_INFO_TABLE, SELECT_doesCertificateExist, SELECT_doesIdentityExist, SELECT_doesKeyExist, SELECT_getAllCertificateNamesOfKey_default_false, SELECT_getAllCertificateNamesOfKey_default_true, SELECT_getAllIdentities_default_false, SELECT_getAllIdentities_default_true, SELECT_getAllKeyNamesOfIdentity_default_false, SELECT_getAllKeyNamesOfIdentity_default_true, SELECT_getCertificate, SELECT_getDefaultCertificateNameForKey, SELECT_getDefaultIdentity, SELECT_getDefaultKeyNameForIdentity, SELECT_getKey, SELECT_getTpmLocator, SELECT_MASTER_CERT_TABLE, SELECT_MASTER_ID_TABLE, SELECT_MASTER_KEY_TABLE, SELECT_MASTER_TPM_INFO_TABLE, WHERE_deleteCertificateInfo, WHERE_deleteIdentityInfo, WHERE_deletePublicKeyInfo, WHERE_setDefaultCertificateNameForKey_reset, WHERE_setDefaultCertificateNameForKey_set, WHERE_setDefaultIdentity_reset, WHERE_setDefaultIdentity_set, WHERE_setDefaultKeyNameForIdentity_reset, WHERE_setDefaultKeyNameForIdentity_set, WHERE_updateKeyStatus

Constructor Summary

Constructors

Constructor and Description
AndroidSqlite3IdentityStorage(String databaseFilePath) Create a new AndroidSqlite3IdentityStorage to use the given full path of the SQLite3 file.

Method Summary

Modifier and Type	Method and Description
void	addCertificate(IdentityCertificate certificate) Add a certificate to the identity storage.
void	addIdentity(Name identityName) Add a new identity.
void	addKey(Name keyName, KeyType keyType, Blob publicKeyDer) Add a public key to the identity storage.
void	deleteCertificateInfo(Name certificateName) Delete a certificate.
void	deleteIdentityInfo(Name identityName) Delete an identity and related public keys and certificates.
void	deletePublicKeyInfo(Name keyName) Delete a public key and related certificates.
boolean	doesCertificateExist(Name certificateName) Check if the specified certificate already exists.
boolean	doesIdentityExist(Name identityName) Check if the specified identity already exists.
boolean	doesKeyExist(Name keyName) Check if the specified key already exists.
void	getAllCertificateNamesOfKey(Name keyName, ArrayList nameList, boolean isDefault) Append all the certificate names of a particular key name to the nameList.
void	getAllIdentities(ArrayList nameList, boolean isDefault) Append all the identity names to the nameList.
void	getAllKeyNamesOfIdentity(Name identityName, ArrayList nameList, boolean isDefault) Append all the key names of a particular identity to the nameList.
IdentityCertificate	getCertificate(Name certificateName) Get a certificate from the identity storage.
Name	getDefaultCertificateNameForKey(Name keyName) Get the default certificate name for the specified key.
static String	getDefaultFilePath(File filesRoot) Get the default database file path based on the files root.
static String	getDefaultFilePath(String filesRoot) Get the default database file path based on the files root.
Name	getDefaultIdentity() Get the default identity.
Name	getDefaultKeyNameForIdentity(Name identityName) Get the default key name for the specified identity.
Blob	getKey(Name keyName) Get the public key DER blob from the identity storage.
String	getTpmLocator() Get the TPM locator associated with this storage.
boolean	revokeIdentity() Revoke the identity.
void	setDefaultCertificateNameForKey(Name keyName, Name certificateName) Set the default key name for the specified identity.
void	setDefaultIdentity(Name identityName) Set the default identity.
void	setDefaultKeyNameForIdentity(Name keyName, Name identityNameCheck) Set a key as the default key of an identity.
protected void	updateKeyStatus(Name keyName, boolean isActive) In table Key, set 'active' to isActive for the keyName.

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

activateKey, checkSetDefaultKeyNameForIdentity, deactivateKey

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

getDefaultCertificate, getDefaultCertificateNameForIdentity, getNewKeyName, setDefaultKeyNameForIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidSqlite3IdentityStorage

public AndroidSqlite3IdentityStorage(String databaseFilePath)

Create a new AndroidSqlite3IdentityStorage to use the given full path of the SQLite3 file. This constructor takes the full path instead of just a directory to be more flexible. You can get the default file path from an Android files directory with getDefaultFilePath(context.getFilesDir()).

Parameters:

databaseFilePath - The path of the SQLite file.

Method Detail

getDefaultFilePath

public static String getDefaultFilePath(File filesRoot)

Get the default database file path based on the files root. This creates the directory of the default database if it doesn't exist. For example if filesRoot is "/data/data/org.example/files", this returns "/data/data/org.example/files/.ndn/ndnsec-public-info.db".

Parameters:

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

Returns:

The default file path.

getDefaultFilePath

public static String getDefaultFilePath(String filesRoot)

Get the default database file path based on the files root. This creates the directory of the default database if it doesn't exist.

Parameters:

filesRoot - The root file directory.

Returns:

The default file path.

doesIdentityExist

public final boolean doesIdentityExist(Name identityName)
                                throws SecurityException

Check if the specified identity already exists.

Specified by:

doesIdentityExist in class IdentityStorage

Parameters:

identityName - The identity name.

Returns:

True if the identity exists, otherwise false.

Throws:

SecurityException

addIdentity

public final void addIdentity(Name identityName)
                       throws SecurityException

Add a new identity. Do nothing if the identity already exists.

Specified by:

addIdentity in class IdentityStorage

Parameters:

identityName - The identity name to be added.

Throws:

SecurityException

revokeIdentity

public final boolean revokeIdentity()

Revoke the identity.

Specified by:

revokeIdentity in class IdentityStorage

Returns:

True if the identity was revoked, false if not.

doesKeyExist

public final boolean doesKeyExist(Name keyName)
                           throws SecurityException

Check if the specified key already exists.

Specified by:

doesKeyExist in class IdentityStorage

Parameters:

keyName - The name of the key.

Returns:

true if the key exists, otherwise false.

Throws:

SecurityException

addKey

public final void addKey(Name keyName,
                         KeyType keyType,
                         Blob publicKeyDer)
                  throws SecurityException

Add a public key to the identity storage. Also call addIdentity to ensure that the identityName for the key exists. However, if the key already exists, do nothing.

Specified by:

addKey in class IdentityStorage

Parameters:

keyName - The name of the public key to be added.

keyType - Type of the public key to be added.

publicKeyDer - A blob of the public key DER to be added.

Throws:

SecurityException

getKey

public final Blob getKey(Name keyName)
                  throws SecurityException

Get the public key DER blob from the identity storage.

Specified by:

getKey in class IdentityStorage

Parameters:

keyName - The name of the requested public key.

Returns:

The DER Blob.

Throws:

SecurityException - if the key doesn't exist.

updateKeyStatus

protected void updateKeyStatus(Name keyName,
                               boolean isActive)
                        throws SecurityException

In table Key, set 'active' to isActive for the keyName.

Specified by:

updateKeyStatus in class Sqlite3IdentityStorageBase

Parameters:

keyName - The name of the key.

isActive - The value for the 'active' field.

Throws:

SecurityException

doesCertificateExist

public final boolean doesCertificateExist(Name certificateName)
                                   throws SecurityException

Check if the specified certificate already exists.

Specified by:

doesCertificateExist in class IdentityStorage

Parameters:

certificateName - The name of the certificate.

Returns:

True if the certificate exists, otherwise false.

Throws:

SecurityException

addCertificate

public final void addCertificate(IdentityCertificate certificate)
                          throws SecurityException

Add a certificate to the identity storage. Also call addKey to ensure that the certificate key exists. If the certificate is already installed, don't replace it.

Specified by:

addCertificate in class IdentityStorage

Parameters:

certificate - The certificate to be added. This makes a copy of the certificate.

Throws:

SecurityException

getCertificate

public final IdentityCertificate getCertificate(Name certificateName)
                                         throws SecurityException

Get a certificate from the identity storage.

Specified by:

getCertificate in class IdentityStorage

Parameters:

certificateName - The name of the requested certificate.

Returns:

The requested certificate.

Throws:

SecurityException - if the certificate doesn't exist.

getTpmLocator

public final String getTpmLocator()
                           throws SecurityException

Get the TPM locator associated with this storage.

Specified by:

getTpmLocator in class IdentityStorage

Returns:

The TPM locator.

Throws:

SecurityException - if the TPM locator doesn't exist.

getDefaultIdentity

public final Name getDefaultIdentity()
                              throws SecurityException

Get the default identity.

Specified by:

getDefaultIdentity in class IdentityStorage

Returns:

The name of default identity.

Throws:

SecurityException - if the default identity is not set.

getDefaultKeyNameForIdentity

public final Name getDefaultKeyNameForIdentity(Name identityName)
                                        throws SecurityException

Get the default key name for the specified identity.

Specified by:

getDefaultKeyNameForIdentity in class IdentityStorage

Parameters:

identityName - The identity name.

Returns:

The default key name.

Throws:

SecurityException - if the default key name for the identity is not set.

getDefaultCertificateNameForKey

public final Name getDefaultCertificateNameForKey(Name keyName)
                                           throws SecurityException

Get the default certificate name for the specified key.

Specified by:

getDefaultCertificateNameForKey in class IdentityStorage

Parameters:

keyName - The key name.

Returns:

The default certificate name.

Throws:

SecurityException - if the default certificate name for the key name is not set.

getAllIdentities

public void getAllIdentities(ArrayList nameList,
                             boolean isDefault)
                      throws SecurityException

Append all the identity names to the nameList.

Specified by:

getAllIdentities in class IdentityStorage

Parameters:

nameList - Append result names to nameList.

isDefault - If true, add only the default identity name. If false, add only the non-default identity names.

Throws:

SecurityException

getAllKeyNamesOfIdentity

public void getAllKeyNamesOfIdentity(Name identityName,
                                     ArrayList nameList,
                                     boolean isDefault)
                              throws SecurityException

Append all the key names of a particular identity to the nameList.

Specified by:

getAllKeyNamesOfIdentity in class IdentityStorage

Parameters:

identityName - The identity name to search for.

nameList - Append result names to nameList.

isDefault - If true, add only the default key name. If false, add only the non-default key names.

Throws:

SecurityException

getAllCertificateNamesOfKey

public void getAllCertificateNamesOfKey(Name keyName,
                                        ArrayList nameList,
                                        boolean isDefault)
                                 throws SecurityException

Append all the certificate names of a particular key name to the nameList.

Specified by:

getAllCertificateNamesOfKey in class IdentityStorage

Parameters:

keyName - The key name to search for.

nameList - Append result names to nameList.

isDefault - If true, add only the default key name. If false, add only the non-default key names.

Throws:

SecurityException

setDefaultIdentity

public final void setDefaultIdentity(Name identityName)
                              throws SecurityException

Set the default identity. If the identityName does not exist, then clear the default identity so that getDefaultIdentity() throws an exception.

Specified by:

setDefaultIdentity in class IdentityStorage

Parameters:

identityName - The default identity name.

Throws:

SecurityException

setDefaultKeyNameForIdentity

public final void setDefaultKeyNameForIdentity(Name keyName,
                                               Name identityNameCheck)
                                        throws SecurityException

Set a key as the default key of an identity. The identity name is inferred from keyName.

Specified by:

setDefaultKeyNameForIdentity in class IdentityStorage

Parameters:

keyName - The name of the key.

identityNameCheck - The identity name to check that the keyName contains the same identity name. If an empty name, it is ignored.

Throws:

SecurityException

setDefaultCertificateNameForKey

public final void setDefaultCertificateNameForKey(Name keyName,
                                                  Name certificateName)
                                           throws SecurityException

Set the default key name for the specified identity.

Specified by:

setDefaultCertificateNameForKey in class IdentityStorage

Parameters:

keyName - The key name.

certificateName - The certificate name.

Throws:

SecurityException

deleteCertificateInfo

public void deleteCertificateInfo(Name certificateName)
                           throws SecurityException

Delete a certificate.

Specified by:

deleteCertificateInfo in class IdentityStorage

Parameters:

certificateName - The certificate name.

Throws:

SecurityException

deletePublicKeyInfo

public void deletePublicKeyInfo(Name keyName)
                         throws SecurityException

Delete a public key and related certificates.

Specified by:

deletePublicKeyInfo in class IdentityStorage

Parameters:

keyName - The key name.

Throws:

SecurityException

deleteIdentityInfo

public void deleteIdentityInfo(Name identityName)
                        throws SecurityException

Delete an identity and related public keys and certificates.

Specified by:

deleteIdentityInfo in class IdentityStorage

Parameters:

identityName - The identity name.

Throws:

SecurityException