net.named_data.jndn.security

Class SafeBag

java.lang.Object

net.named_data.jndn.security.SafeBag

public class SafeBag
extends Object

A SafeBag represents a container for sensitive related information such as a certificate and private key.

Constructor Summary

Constructors

Constructor and Description
SafeBag(Blob input) Create a SafeBag by decoding the input as an NDN-TLV SafeBag.
SafeBag(ByteBuffer input) Create a SafeBag by decoding the input as an NDN-TLV SafeBag.
SafeBag(Data certificate, Blob privateKeyBag) Create a SafeBag with the given certificate and private key.
SafeBag(Name keyName, Blob privateKeyBag, Blob publicKeyEncoding) Create a SafeBag with given private key and a new self-signed certificate for the given public key, using DigestAlgorithm.SHA256 to sign it.
SafeBag(Name keyName, Blob privateKeyBag, Blob publicKeyEncoding, ByteBuffer password) Create a SafeBag with given private key and a new self-signed certificate for the given public key, using DigestAlgorithm.SHA256 to sign it.
SafeBag(Name keyName, Blob privateKeyBag, Blob publicKeyEncoding, ByteBuffer password, DigestAlgorithm digestAlgorithm) Create a SafeBag with given private key and a new self-signed certificate for the given public key.
SafeBag(Name keyName, Blob privateKeyBag, Blob publicKeyEncoding, ByteBuffer password, DigestAlgorithm digestAlgorithm, WireFormat wireFormat) Create a SafeBag with given private key and a new self-signed certificate for the given public key.

Method Summary

Modifier and Type	Method and Description
Data	getCertificate() Get the certificate data packet.
Blob	getPrivateKeyBag() Get the encoded private key.
void	wireDecode(Blob input) Decode the input as an NDN-TLV SafeBag and update this object.
void	wireDecode(ByteBuffer input) Decode the input as an NDN-TLV SafeBag and update this object.
Blob	wireEncode() Encode this as an NDN-TLV SafeBag.

Methods inherited from class java.lang.Object

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

Constructor Detail

SafeBag

public SafeBag(Data certificate,
               Blob privateKeyBag)

Create a SafeBag with the given certificate and private key.

Parameters:

certificate - The certificate data packet. This copies the object.

privateKeyBag - The encoded private key. If encrypted, this is a PKCS #8 EncryptedPrivateKeyInfo. If not encrypted, this is an unencrypted PKCS #8 PrivateKeyInfo.

SafeBag

public SafeBag(Name keyName,
               Blob privateKeyBag,
               Blob publicKeyEncoding,
               ByteBuffer password,
               DigestAlgorithm digestAlgorithm,
               WireFormat wireFormat)
        throws TpmBackEnd.Error,
               Pib.Error

Create a SafeBag with given private key and a new self-signed certificate for the given public key.

Parameters:

keyName - The name of the public key. The certificate name will be {keyName}/self/{version} where the version is based on the current time. This copies the Name.

privateKeyBag - The encoded private key. If encrypted, this is a PKCS #8 EncryptedPrivateKeyInfo. If not encrypted, this is an unencrypted PKCS #8 PrivateKeyInfo.

publicKeyEncoding - The encoded public key for the certificate.

password - The password for decrypting the private key in order to sign the self-signed certificate, which should have characters in the range of 1 to 127. If the password is supplied, use it to decrypt the PKCS #8 EncryptedPrivateKeyInfo. If the password is null, privateKeyBag is an unencrypted PKCS #8 PrivateKeyInfo.

digestAlgorithm - The digest algorithm for signing the self-signed certificate.

wireFormat - A WireFormat object used to encode the self-signed certificate in order to sign it.

Throws:

TpmBackEnd.Error

Pib.Error

SafeBag

public SafeBag(Name keyName,
               Blob privateKeyBag,
               Blob publicKeyEncoding,
               ByteBuffer password,
               DigestAlgorithm digestAlgorithm)
        throws TpmBackEnd.Error,
               Pib.Error

Create a SafeBag with given private key and a new self-signed certificate for the given public key. Use getDefaultWireFormat() to encode the self-signed certificate in order to sign it.

Parameters:

keyName - The name of the public key. The certificate name will be {keyName}/self/{version} where the version is based on the current time. This copies the Name.

privateKeyBag - The encoded private key. If encrypted, this is a PKCS #8 EncryptedPrivateKeyInfo. If not encrypted, this is an unencrypted PKCS #8 PrivateKeyInfo.

publicKeyEncoding - The encoded public key for the certificate.

password - The password for decrypting the private key in order to sign the self-signed certificate, which should have characters in the range of 1 to 127. If the password is supplied, use it to decrypt the PKCS #8 EncryptedPrivateKeyInfo. If the password is null, privateKeyBag is an unencrypted PKCS #8 PrivateKeyInfo.

digestAlgorithm - The digest algorithm for signing the self-signed certificate.

Throws:

TpmBackEnd.Error

Pib.Error

SafeBag

public SafeBag(Name keyName,
               Blob privateKeyBag,
               Blob publicKeyEncoding,
               ByteBuffer password)
        throws TpmBackEnd.Error,
               Pib.Error

Create a SafeBag with given private key and a new self-signed certificate for the given public key, using DigestAlgorithm.SHA256 to sign it. Use getDefaultWireFormat() to encode the self-signed certificate in order to sign it.

Parameters:

keyName - The name of the public key. The certificate name will be {keyName}/self/{version} where the version is based on the current time. This copies the Name.

privateKeyBag - The encoded private key. If encrypted, this is a PKCS #8 EncryptedPrivateKeyInfo. If not encrypted, this is an unencrypted PKCS #8 PrivateKeyInfo.

publicKeyEncoding - The encoded public key for the certificate.

password - The password for decrypting the private key in order to sign the self-signed certificate, which should have characters in the range of 1 to 127. If the password is supplied, use it to decrypt the PKCS #8 EncryptedPrivateKeyInfo. If the password is null, privateKeyBag is an unencrypted PKCS #8 PrivateKeyInfo.

Throws:

TpmBackEnd.Error

Pib.Error

SafeBag

public SafeBag(Name keyName,
               Blob privateKeyBag,
               Blob publicKeyEncoding)
        throws TpmBackEnd.Error,
               Pib.Error

Create a SafeBag with given private key and a new self-signed certificate for the given public key, using DigestAlgorithm.SHA256 to sign it. Use getDefaultWireFormat() to encode the self-signed certificate in order to sign it.

Parameters:

keyName - The name of the public key. The certificate name will be {keyName}/self/{version} where the version is based on the current time. This copies the Name.

privateKeyBag - The encoded private key, as an unencrypted PKCS #8 PrivateKeyInfo.

publicKeyEncoding - The encoded public key for the certificate.

Throws:

TpmBackEnd.Error

Pib.Error

SafeBag

public SafeBag(ByteBuffer input)
        throws EncodingException

Create a SafeBag by decoding the input as an NDN-TLV SafeBag.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

SafeBag

public SafeBag(Blob input)
        throws EncodingException

Create a SafeBag by decoding the input as an NDN-TLV SafeBag.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

Method Detail

getCertificate

public final Data getCertificate()

Get the certificate data packet.

Returns:

The certificate as a Data packet. If you need to process it as a certificate object then you must create a new CertificateV2(data).

getPrivateKeyBag

public final Blob getPrivateKeyBag()

Get the encoded private key.

Returns:

The encoded private key. If encrypted, this is a PKCS #8 EncryptedPrivateKeyInfo. If not encrypted, this is an unencrypted PKCS #8 PrivateKeyInfo.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input as an NDN-TLV SafeBag and update this object.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input as an NDN-TLV SafeBag and update this object.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireEncode

public final Blob wireEncode()

Encode this as an NDN-TLV SafeBag.

Returns:

The encoded byte array as a Blob.