net.named_data.jndn.security.pib

Class PibMemory

java.lang.Object

net.named_data.jndn.security.pib.PibImpl

net.named_data.jndn.security.pib.PibMemory

public class PibMemory
extends PibImpl

PibMemory extends PibImpl and is used by the Pib class as an in-memory implementation of a PIB. All the contents in the PIB are stored in memory and have the same lifetime as the PibMemory instance.

Nested Class Summary

Nested classes/interfaces inherited from class net.named_data.jndn.security.pib.PibImpl

PibImpl.Error

Constructor Summary

Constructors

Constructor and Description
PibMemory()

Method Summary

Modifier and Type	Method and Description
void	addCertificate(CertificateV2 certificate) Add the certificate.
void	addIdentity(Name identityName) Add the identity.
void	addKey(Name identityName, Name keyName, ByteBuffer key) Add the key.
void	clearIdentities() Erase all certificates, keys, and identities.
CertificateV2	getCertificate(Name certificateName) Get the certificate with name certificateName.
HashSet<Name>	getCertificatesOfKey(Name keyName) Get a list of certificate names of the key with id keyName.
CertificateV2	getDefaultCertificateOfKey(Name keyName) Get the default certificate for the key with eyName.
Name	getDefaultIdentity() Get the default identity.
Name	getDefaultKeyOfIdentity(Name identityName) Get the name of the default key for the identity with name identityName.
HashSet<Name>	getIdentities() Get the names of all the identities.
Blob	getKeyBits(Name keyName) Get the key bits of a key with name keyName.
HashSet<Name>	getKeysOfIdentity(Name identityName) Get all the key names of the identity with the name identityName.
static String	getScheme()
String	getTpmLocator() Get the TPM Locator.
boolean	hasCertificate(Name certificateName) Check for the existence of a certificate with name certificateName.
boolean	hasIdentity(Name identityName) Check for the existence of an identity.
boolean	hasKey(Name keyName) Check for the existence of a key with keyName.
void	removeCertificate(Name certificateName) Remove the certificate with name certificateName.
void	removeIdentity(Name identityName) Remove the identity and its related keys and certificates.
void	removeKey(Name keyName) Remove the key with keyName and its related certificates.
void	setDefaultCertificateOfKey(Name keyName, Name certificateName) Set the cert with name certificateName as the default for the key with keyName.
void	setDefaultIdentity(Name identityName) Set the identity with the identityName as the default identity.
void	setDefaultKeyOfIdentity(Name identityName, Name keyName) Set the key with keyName as the default key for the identity with name identityName.
void	setTpmLocator(String tpmLocator) Set the corresponding TPM information to tpmLocator.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibMemory

public PibMemory()

Method Detail

getScheme

public static String getScheme()

setTpmLocator

public void setTpmLocator(String tpmLocator)
                   throws PibImpl.Error

Set the corresponding TPM information to tpmLocator. This method does not reset the contents of the PIB.

Specified by:

setTpmLocator in class PibImpl

Parameters:

tpmLocator - The TPM locator string.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

getTpmLocator

public String getTpmLocator()
                     throws PibImpl.Error

Get the TPM Locator.

Specified by:

getTpmLocator in class PibImpl

Returns:

The TPM locator string.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

hasIdentity

public boolean hasIdentity(Name identityName)
                    throws PibImpl.Error

Check for the existence of an identity.

Specified by:

hasIdentity in class PibImpl

Parameters:

identityName - The name of the identity.

Returns:

True if the identity exists, otherwise false.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

addIdentity

public void addIdentity(Name identityName)
                 throws PibImpl.Error

Add the identity. If the identity already exists, do nothing. If no default identity has been set, set the added identity as the default.

Specified by:

addIdentity in class PibImpl

Parameters:

identityName - The name of the identity to add. This copies the name.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

removeIdentity

public void removeIdentity(Name identityName)
                    throws PibImpl.Error

Remove the identity and its related keys and certificates. If the default identity is being removed, no default identity will be selected. If the identity does not exist, do nothing.

Specified by:

removeIdentity in class PibImpl

Parameters:

identityName - The name of the identity to remove.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

clearIdentities

public void clearIdentities()
                     throws PibImpl.Error

Erase all certificates, keys, and identities.

Specified by:

clearIdentities in class PibImpl

Throws:

PibImpl.Error - for a non-semantic (database access) error.

getIdentities

public HashSet<Name> getIdentities()
                            throws PibImpl.Error

Get the names of all the identities.

Specified by:

getIdentities in class PibImpl

Returns:

The set of identity names. The Name objects are fresh copies.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

setDefaultIdentity

public void setDefaultIdentity(Name identityName)
                        throws PibImpl.Error

Set the identity with the identityName as the default identity. If the identity with identityName does not exist, then it will be created.

Specified by:

setDefaultIdentity in class PibImpl

Parameters:

identityName - The name for the default identity. This copies the name.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

getDefaultIdentity

public Name getDefaultIdentity()
                        throws Pib.Error,
                               PibImpl.Error

Get the default identity.

Specified by:

getDefaultIdentity in class PibImpl

Returns:

The name of the default identity, as a fresh copy.

Throws:

Pib.Error - for no default identity.

PibImpl.Error - for a non-semantic (database access) error.

hasKey

public boolean hasKey(Name keyName)
               throws PibImpl.Error

Check for the existence of a key with keyName.

Specified by:

hasKey in class PibImpl

Parameters:

keyName - The name of the key.

Returns:

True if the key exists, otherwise false. Return false if the identity does not exist.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

addKey

public void addKey(Name identityName,
                   Name keyName,
                   ByteBuffer key)
            throws PibImpl.Error

Add the key. If a key with the same name already exists, overwrite the key. If the identity does not exist, it will be created. If no default key for the identity has been set, then set the added key as the default for the identity. If no default identity has been set, identity becomes the default.

Specified by:

addKey in class PibImpl

Parameters:

identityName - The name of the identity that the key belongs to. This copies the name.

keyName - The name of the key. This copies the name.

key - The public key bits. This copies the array.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

removeKey

public void removeKey(Name keyName)
               throws PibImpl.Error

Remove the key with keyName and its related certificates. If the key does not exist, do nothing.

Specified by:

removeKey in class PibImpl

Parameters:

keyName - The name of the key.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

getKeyBits

public Blob getKeyBits(Name keyName)
                throws Pib.Error,
                       PibImpl.Error

Get the key bits of a key with name keyName.

Specified by:

getKeyBits in class PibImpl

Parameters:

keyName - The name of the key.

Returns:

The key bits.

Throws:

Pib.Error - if the key does not exist.

PibImpl.Error - for a non-semantic (database access) error.

getKeysOfIdentity

public HashSet<Name> getKeysOfIdentity(Name identityName)
                                throws PibImpl.Error

Get all the key names of the identity with the name identityName. The returned key names can be used to create a KeyContainer. With a key name and a backend implementation, one can create a Key front end instance.

Specified by:

getKeysOfIdentity in class PibImpl

Parameters:

identityName - The name of the identity.

Returns:

The set of key names. The Name objects are fresh copies. If the identity does not exist, return an empty set.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

setDefaultKeyOfIdentity

public void setDefaultKeyOfIdentity(Name identityName,
                                    Name keyName)
                             throws Pib.Error,
                                    PibImpl.Error

Set the key with keyName as the default key for the identity with name identityName.

Specified by:

setDefaultKeyOfIdentity in class PibImpl

Parameters:

identityName - The name of the identity. This copies the name.

keyName - The name of the key. This copies the name.

Throws:

Pib.Error - if the key does not exist.

PibImpl.Error - for a non-semantic (database access) error.

getDefaultKeyOfIdentity

public Name getDefaultKeyOfIdentity(Name identityName)
                             throws Pib.Error,
                                    PibImpl.Error

Get the name of the default key for the identity with name identityName.

Specified by:

getDefaultKeyOfIdentity in class PibImpl

Parameters:

identityName - The name of the identity.

Returns:

The name of the default key, as a fresh copy.

Throws:

Pib.Error - if there is no default key or if the identity does not exist.

PibImpl.Error - for a non-semantic (database access) error.

hasCertificate

public boolean hasCertificate(Name certificateName)
                       throws PibImpl.Error

Check for the existence of a certificate with name certificateName.

Specified by:

hasCertificate in class PibImpl

Parameters:

certificateName - The name of the certificate.

Returns:

True if the certificate exists, otherwise false.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

addCertificate

public void addCertificate(CertificateV2 certificate)
                    throws PibImpl.Error

Add the certificate. If a certificate with the same name (without implicit digest) already exists, then overwrite the certificate. If the key or identity does not exist, they will be created. If no default certificate for the key has been set, then set the added certificate as the default for the key. If no default key was set for the identity, it will be set as the default key for the identity. If no default identity was selected, the certificate's identity becomes the default.

Specified by:

addCertificate in class PibImpl

Parameters:

certificate - The certificate to add. This copies the object.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

removeCertificate

public void removeCertificate(Name certificateName)
                       throws PibImpl.Error

Remove the certificate with name certificateName. If the certificate does not exist, do nothing.

Specified by:

removeCertificate in class PibImpl

Parameters:

certificateName - The name of the certificate.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

getCertificate

public CertificateV2 getCertificate(Name certificateName)
                             throws Pib.Error,
                                    PibImpl.Error

Get the certificate with name certificateName.

Specified by:

getCertificate in class PibImpl

Parameters:

certificateName - The name of the certificate.

Returns:

A copy of the certificate.

Throws:

Pib.Error - if the certificate does not exist.

PibImpl.Error - for a non-semantic (database access) error.

getCertificatesOfKey

public HashSet<Name> getCertificatesOfKey(Name keyName)
                                   throws PibImpl.Error

Get a list of certificate names of the key with id keyName. The returned certificate names can be used to create a PibCertificateContainer. With a certificate name and a backend implementation, one can obtain the certificate.

Specified by:

getCertificatesOfKey in class PibImpl

Parameters:

keyName - The name of the key.

Returns:

The set of certificate names. The Name objects are fresh copies. If the key does not exist, return an empty set.

Throws:

PibImpl.Error - for a non-semantic (database access) error.

setDefaultCertificateOfKey

public void setDefaultCertificateOfKey(Name keyName,
                                       Name certificateName)
                                throws Pib.Error,
                                       PibImpl.Error

Set the cert with name certificateName as the default for the key with keyName.

Specified by:

setDefaultCertificateOfKey in class PibImpl

Parameters:

keyName - The name of the key.

certificateName - The name of the certificate. This copies the name.

Throws:

Pib.Error - if the certificate with name certificateName does not exist.

PibImpl.Error - for a non-semantic (database access) error.

getDefaultCertificateOfKey

public CertificateV2 getDefaultCertificateOfKey(Name keyName)
                                         throws Pib.Error,
                                                PibImpl.Error

Get the default certificate for the key with eyName.

Specified by:

getDefaultCertificateOfKey in class PibImpl

Parameters:

keyName - The name of the key.

Returns:

A copy of the default certificate.

Throws:

Pib.Error - if the default certificate does not exist.

PibImpl.Error - for a non-semantic (database access) error.