net.named_data.jndn.security.pib

Class Pib

java.lang.Object

net.named_data.jndn.security.pib.Pib

public class Pib
extends Object

In general, a PIB (Public Information Base) stores the public portion of a user's cryptography keys. The format and location of stored information is indicated by the PIB locator. A PIB is designed to work with a TPM (Trusted Platform Module) which stores private keys. There is a one-to-one association between a PIB and a TPM, and therefore the TPM locator is recorded by the PIB to enforce this association and prevent one from operating on mismatched PIB and TPM. Information in the PIB is organized in a hierarchy of Identity-Key-Certificate. At the top level, this Pib class provides access to identities, and allows setting a default identity. Properties of an identity (such as PibKey objects) can be accessed after obtaining a PibIdentity object. (Likewise, CertificateV2 objects can be obtained from a PibKey object.) Note: A Pib instance is created and managed only by the KeyChain, and is returned by the KeyChain getPib() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pib.Error A Pib.Error extends Exception and represents a semantic error in PIB processing.

Constructor Summary

Constructors

Constructor and Description
Pib(String scheme, String location, PibImpl pibImpl)

Method Summary

Modifier and Type	Method and Description
PibIdentity	addIdentity_(Name identityName) Add an identity with name identityName.
PibIdentity	getDefaultIdentity() Get the default identity.
PibIdentityContainer	getIdentities_() Get the PibIdentityContainer.
PibIdentity	getIdentity(Name identityName) Get the identity with name identityName.
String	getPibLocator() Get the PIB locator.
String	getScheme() Get the scheme of the PIB locator.
String	getTpmLocator() Get the TPM Locator.
void	removeIdentity_(Name identityName) Remove the identity with name identityName, and its related keys and certificates.
void	reset_() Reset the content in the PIB, including a reset of the TPM locator.
PibIdentity	setDefaultIdentity_(Name identityName) Set the identity with name identityName as the default identity.
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

Pib

public Pib(String scheme,
           String location,
           PibImpl pibImpl)
    throws PibImpl.Error

Throws:

PibImpl.Error

Method Detail

getScheme

public final String getScheme()

Get the scheme of the PIB locator.

Returns:

The scheme string.

getPibLocator

public final String getPibLocator()

Get the PIB locator.

Returns:

The PIB locator.

setTpmLocator

public final void setTpmLocator(String tpmLocator)
                         throws PibImpl.Error

Set the corresponding TPM information to tpmLocator. If the tpmLocator is different from the existing one, the PIB will be reset. Otherwise, nothing will be changed.

Throws:

PibImpl.Error

getTpmLocator

public final String getTpmLocator()
                           throws Pib.Error,
                                  PibImpl.Error

Get the TPM Locator.

Throws:

Pib.Error - if the TPM locator is empty.

PibImpl.Error

getIdentity

public final PibIdentity getIdentity(Name identityName)
                              throws PibImpl.Error,
                                     Pib.Error

Get the identity with name identityName.

Parameters:

identityName - The name of the identity.

Returns:

The PibIdentity object.

Throws:

Pib.Error - if the identity does not exist.

PibImpl.Error

getDefaultIdentity

public final PibIdentity getDefaultIdentity()
                                     throws PibImpl.Error,
                                            Pib.Error

Get the default identity.

Returns:

The PibIdentity object.

Throws:

Pib.Error - if there is no default identity.

PibImpl.Error

reset_

public final void reset_()
                  throws PibImpl.Error

Reset the content in the PIB, including a reset of the TPM locator. This should only be called by KeyChain.

Throws:

PibImpl.Error

addIdentity_

public final PibIdentity addIdentity_(Name identityName)
                               throws PibImpl.Error,
                                      Pib.Error

Add an identity with name identityName. Create the identity if it does not exist. This should only be called by KeyChain.

Parameters:

identityName - The name of the identity, which is copied.

Returns:

The PibIdentity object.

Throws:

PibImpl.Error

Pib.Error

removeIdentity_

public final void removeIdentity_(Name identityName)
                           throws PibImpl.Error

Remove the identity with name identityName, 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. This should only be called by KeyChain.

Parameters:

identityName - The name of the identity.

Throws:

PibImpl.Error

setDefaultIdentity_

public final PibIdentity setDefaultIdentity_(Name identityName)
                                      throws PibImpl.Error,
                                             Pib.Error

Set the identity with name identityName as the default identity. Create the identity if it does not exist. This should only be called by KeyChain.

Parameters:

identityName - The name of the identity.

Returns:

The PibIdentity object of the default identity.

Throws:

PibImpl.Error

Pib.Error

getIdentities_

public final PibIdentityContainer getIdentities_()

Get the PibIdentityContainer. This should only be called by KeyChain.