net.named_data.jndn.security.identity

Class IdentityStorage

java.lang.Object

net.named_data.jndn.security.identity.IdentityStorage

Direct Known Subclasses:

MemoryIdentityStorage, Sqlite3IdentityStorageBase

public abstract class IdentityStorage
extends Object

IdentityStorage is a base class for the storage of identity, public keys and certificates. Private keys are stored in PrivateKeyStorage. This is an abstract base class. A subclass must implement the methods.

Constructor Summary

Constructors

Constructor and Description
IdentityStorage()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	activateKey(Name keyName) Activate a key.
abstract void	addCertificate(IdentityCertificate certificate) Add a certificate to the identity storage.
abstract void	addIdentity(Name identityName) Add a new identity.
abstract void	addKey(Name keyName, KeyType keyType, Blob publicKeyDer) Add a public key to the identity storage.
abstract void	deactivateKey(Name keyName) Deactivate a key.
abstract void	deleteCertificateInfo(Name certificateName) Delete a certificate.
abstract void	deleteIdentityInfo(Name identity) Delete an identity and related public keys and certificates.
abstract void	deletePublicKeyInfo(Name keyName) Delete a public key and related certificates.
abstract boolean	doesCertificateExist(Name certificateName) Check if the specified certificate already exists.
abstract boolean	doesIdentityExist(Name identityName) Check if the specified identity already exists.
abstract boolean	doesKeyExist(Name keyName) Check if the specified key already exists.
abstract void	getAllCertificateNamesOfKey(Name keyName, ArrayList nameList, boolean isDefault) Append all the certificate names of a particular key name to the nameList.
abstract void	getAllIdentities(ArrayList nameList, boolean isDefault) Append all the identity names to the nameList.
abstract void	getAllKeyNamesOfIdentity(Name identityName, ArrayList nameList, boolean isDefault) Append all the key names of a particular identity to the nameList.
abstract IdentityCertificate	getCertificate(Name certificateName) Get a certificate from the identity storage.
IdentityCertificate	getDefaultCertificate() Get the certificate of the default identity.
Name	getDefaultCertificateNameForIdentity(Name identityName) Get the default certificate name for the specified identity.
abstract Name	getDefaultCertificateNameForKey(Name keyName) Get the default certificate name for the specified key.
abstract Name	getDefaultIdentity() Get the default identity.
abstract Name	getDefaultKeyNameForIdentity(Name identityName) Get the default key name for the specified identity.
abstract Blob	getKey(Name keyName) Get the public key DER blob from the identity storage.
Name	getNewKeyName(Name identityName, boolean useKsk) Generate a name for a new key belonging to the identity.
abstract String	getTpmLocator() Get the TPM locator associated with this storage.
abstract boolean	revokeIdentity() Revoke the identity.
abstract void	setDefaultCertificateNameForKey(Name keyName, Name certificateName) Set the default key name for the specified identity.
abstract void	setDefaultIdentity(Name identityName) Set the default identity.
void	setDefaultKeyNameForIdentity(Name keyName) Set the default key name for the specified identity.
abstract void	setDefaultKeyNameForIdentity(Name keyName, Name identityNameCheck) Set a key as the default key of an identity.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityStorage

public IdentityStorage()

Method Detail

doesIdentityExist

public abstract boolean doesIdentityExist(Name identityName)
                                   throws SecurityException

Check if the specified identity already exists.

Parameters:

identityName - The identity name.

Returns:

True if the identity exists, otherwise false.

Throws:

SecurityException

addIdentity

public abstract void addIdentity(Name identityName)
                          throws SecurityException

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

Parameters:

identityName - The identity name to be added.

Throws:

SecurityException

revokeIdentity

public abstract boolean revokeIdentity()
                                throws SecurityException

Revoke the identity.

Returns:

True if the identity was revoked, false if not.

Throws:

SecurityException

getNewKeyName

public final Name getNewKeyName(Name identityName,
                 boolean useKsk)
                         throws SecurityException

Generate a name for a new key belonging to the identity.

Parameters:

identityName - The identity name.

useKsk - If true, generate a KSK name, otherwise a DSK name.

Returns:

The generated key name.

Throws:

SecurityException

doesKeyExist

public abstract boolean doesKeyExist(Name keyName)
                              throws SecurityException

Check if the specified key already exists.

Parameters:

keyName - The name of the key.

Returns:

true if the key exists, otherwise false.

Throws:

SecurityException

addKey

public abstract 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.

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 abstract Blob getKey(Name keyName)
                     throws SecurityException

Get the public key DER blob from the identity storage.

Parameters:

keyName - The name of the requested public key.

Returns:

The DER Blob.

Throws:

SecurityException - if the key doesn't exist.

activateKey

public abstract void activateKey(Name keyName)
                          throws SecurityException

Activate a key. If a key is marked as inactive, its private part will not be used in packet signing.

Parameters:

keyName - The name of the key.

Throws:

SecurityException

deactivateKey

public abstract void deactivateKey(Name keyName)
                            throws SecurityException

Deactivate a key. If a key is marked as inactive, its private part will not be used in packet signing.

Parameters:

keyName - The name of the key.

Throws:

SecurityException

doesCertificateExist

public abstract boolean doesCertificateExist(Name certificateName)
                                      throws SecurityException

Check if the specified certificate already exists.

Parameters:

certificateName - The name of the certificate.

Returns:

True if the certificate exists, otherwise false.

Throws:

SecurityException

addCertificate

public abstract 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.

Parameters:

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

Throws:

SecurityException

getCertificate

public abstract IdentityCertificate getCertificate(Name certificateName)
                                            throws SecurityException

Get a certificate from the identity storage.

Parameters:

certificateName - The name of the requested certificate.

Returns:

The requested certificate.

Throws:

SecurityException - if the certificate doesn't exist.

getTpmLocator

public abstract String getTpmLocator()
                              throws SecurityException

Get the TPM locator associated with this storage.

Returns:

The TPM locator.

Throws:

SecurityException - if the TPM locator doesn't exist.

getDefaultIdentity

public abstract Name getDefaultIdentity()
                                 throws SecurityException

Get the default identity.

Returns:

The name of default identity.

Throws:

SecurityException - if the default identity is not set.

getDefaultKeyNameForIdentity

public abstract Name getDefaultKeyNameForIdentity(Name identityName)
                                           throws SecurityException

Get the default key name for the specified identity.

Parameters:

identityName - The identity name.

Returns:

The default key name.

Throws:

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

getDefaultCertificateNameForIdentity

public final Name getDefaultCertificateNameForIdentity(Name identityName)
                                                throws SecurityException

Get the default certificate name for the specified identity.

Parameters:

identityName - The identity name.

Returns:

The default certificate name.

Throws:

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

getDefaultCertificateNameForKey

public abstract Name getDefaultCertificateNameForKey(Name keyName)
                                              throws SecurityException

Get the default certificate name for the specified key.

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 abstract void getAllIdentities(ArrayList nameList,
                    boolean isDefault)
                               throws SecurityException

Append all the identity names to the nameList.

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 abstract void getAllKeyNamesOfIdentity(Name identityName,
                            ArrayList nameList,
                            boolean isDefault)
                                       throws SecurityException

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

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 abstract void getAllCertificateNamesOfKey(Name keyName,
                               ArrayList nameList,
                               boolean isDefault)
                                          throws SecurityException

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

Parameters:

keyName - The key name to search for.

nameList - Append result names to nameList.

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

Throws:

SecurityException

setDefaultIdentity

public abstract 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.

Parameters:

identityName - The default identity name.

Throws:

SecurityException

setDefaultKeyNameForIdentity

public abstract 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.

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

setDefaultKeyNameForIdentity

public final void setDefaultKeyNameForIdentity(Name keyName)
                                        throws SecurityException

Set the default key name for the specified identity.

Parameters:

keyName - The key name.

Throws:

SecurityException

setDefaultCertificateNameForKey

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

Set the default key name for the specified identity.

Parameters:

keyName - The key name.

certificateName - The certificate name.

Throws:

SecurityException

getDefaultCertificate

public final IdentityCertificate getDefaultCertificate()
                                                throws SecurityException

Get the certificate of the default identity.

Returns:

The requested certificate. If not found, return null.

Throws:

SecurityException

deleteCertificateInfo

public abstract void deleteCertificateInfo(Name certificateName)
                                    throws SecurityException

Delete a certificate.

Parameters:

certificateName - The certificate name.

Throws:

SecurityException

deletePublicKeyInfo

public abstract void deletePublicKeyInfo(Name keyName)
                                  throws SecurityException

Delete a public key and related certificates.

Parameters:

keyName - The key name.

Throws:

SecurityException

deleteIdentityInfo

public abstract void deleteIdentityInfo(Name identity)
                                 throws SecurityException

Delete an identity and related public keys and certificates.

Parameters:

identity - The identity name.

Throws:

SecurityException