net.named_data.jndn.security.pib

Class PibKey

java.lang.Object

net.named_data.jndn.security.pib.PibKey

public class PibKey
extends Object

The PibKey class provides access to a key at the second level in the PIB's Identity-Key-Certificate hierarchy. A PibKey object has a Name (identity + "KEY" + keyId), and contains one or more CertificateV2 objects, one of which is set as the default certificate of this key. A certificate can be directly accessed by getting a CertificateV2 object.

Constructor Summary

Constructors

Constructor and Description
PibKey(PibKeyImpl impl) Create a PibKey which uses the impl backend implementation.

Method Summary

Modifier and Type	Method and Description
void	addCertificate_(CertificateV2 certificate) Add the certificate.
static Name	constructKeyName(Name identityName, Name.Component keyId) Construct a key name based on the appropriate naming conventions.
static Name	extractIdentityFromKeyName(Name keyName) Extract the identity namespace from keyName.
CertificateV2	getCertificate(Name certificateName) Get the certificate with name certificateName.
PibCertificateContainer	getCertificates_() Get the PibCertificateContainer in the PibKeyImpl.
CertificateV2	getDefaultCertificate() Get the default certificate for this Key.
Name	getIdentityName() Get the name of the identity this key belongs to.
KeyType	getKeyType() Get the key type.
Name	getName()
Blob	getPublicKey() Get the public key encoding.
static boolean	isValidKeyName(Name keyName) Check if keyName follows the naming conventions for a key name.
void	removeCertificate_(Name certificateName) Remove the certificate with name certificateName.
CertificateV2	setDefaultCertificate_(CertificateV2 certificate) Add the certificate and set it as the default certificate of the key.
CertificateV2	setDefaultCertificate_(Name certificateName) Set the existing certificate with name certificateName as the default certificate.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibKey

public PibKey(PibKeyImpl impl)

Create a PibKey which uses the impl backend implementation. This constructor should only be called by PibKeyContainer.

Method Detail

getName

public final Name getName()

getIdentityName

public final Name getIdentityName()

Get the name of the identity this key belongs to.

Returns:

The name of the identity. You must not modify the Key object. If you need to modify it, make a copy.

Throws:

AssertionError - if the backend implementation instance is invalid.

getKeyType

public final KeyType getKeyType()

Get the key type.

Returns:

The key type.

Throws:

AssertionError - if the backend implementation instance is invalid.

getPublicKey

public final Blob getPublicKey()

Get the public key encoding.

Returns:

The public key encoding.

Throws:

AssertionError - if the backend implementation instance is invalid.

getCertificate

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

Get the certificate with name certificateName.

Parameters:

certificateName - The name of the certificate.

Returns:

A copy of the CertificateV2 object.

Throws:

AssertionError - if certificateName does not match the key name, or if the backend implementation instance is invalid.

Pib.Error - if the certificate does not exist.

PibImpl.Error

getDefaultCertificate

public final CertificateV2 getDefaultCertificate()
                                          throws Pib.Error,
                                                 PibImpl.Error

Get the default certificate for this Key.

Returns:

A copy of the default certificate.

Throws:

AssertionError - if the backend implementation instance is invalid.

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

PibImpl.Error

constructKeyName

public static Name constructKeyName(Name identityName,
                                    Name.Component keyId)

Construct a key name based on the appropriate naming conventions.

Parameters:

identityName - The name of the identity.

keyId - The key ID name component.

Returns:

The constructed name as a new Name.

isValidKeyName

public static boolean isValidKeyName(Name keyName)

Check if keyName follows the naming conventions for a key name.

Parameters:

keyName - The name of the key.

Returns:

True if keyName follows the naming conventions, otherwise false.

extractIdentityFromKeyName

public static Name extractIdentityFromKeyName(Name keyName)

Extract the identity namespace from keyName.

Parameters:

keyName - The name of the key.

Returns:

The identity name as a new Name.

addCertificate_

public final void addCertificate_(CertificateV2 certificate)
                           throws CertificateV2.Error,
                                  PibImpl.Error

Add the certificate. If a certificate with the same name (without implicit digest) already exists, then overwrite the certificate. If no default certificate for the key has been set, then set the added certificate as default for the key. This should only be called by KeyChain.

Parameters:

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

Throws:

IllegalArgumentException - if the name of the certificate does not match the key name.

CertificateV2.Error

PibImpl.Error

removeCertificate_

public final void removeCertificate_(Name certificateName)
                              throws PibImpl.Error

Remove the certificate with name certificateName. If the certificate does not exist, do nothing. This should only be called by KeyChain.

Parameters:

certificateName - The name of the certificate.

Throws:

IllegalArgumentException - if certificateName does not match the key name.

PibImpl.Error

setDefaultCertificate_

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

Set the existing certificate with name certificateName as the default certificate. This should only be called by KeyChain.

Parameters:

certificateName - The name of the certificate.

Returns:

The default certificate.

Throws:

IllegalArgumentException - if certificateName does not match the key name

Pib.Error - if the certificate does not exist.

PibImpl.Error

setDefaultCertificate_

public final CertificateV2 setDefaultCertificate_(CertificateV2 certificate)
                                           throws CertificateV2.Error,
                                                  PibImpl.Error,
                                                  Pib.Error

Add the certificate and set it as the default certificate of the key. If a certificate with the same name (without implicit digest) already exists, then overwrite the certificate. This should only be called by KeyChain.

Parameters:

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

Returns:

The default certificate.

Throws:

IllegalArgumentException - if the name of the certificate does not match the key name.

CertificateV2.Error

PibImpl.Error

Pib.Error

getCertificates_

public final PibCertificateContainer getCertificates_()

Get the PibCertificateContainer in the PibKeyImpl. This should only be called by KeyChain.

Returns:

The PibCertificateContainer.