net.named_data.jndn.encrypt

Class Producer

java.lang.Object

net.named_data.jndn.encrypt.Producer

public class Producer
extends Object

A Producer manages content keys used to encrypt a data packet in the group-based encryption protocol.

Note:

This class is an experimental feature. The API may change.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Producer.OnEncryptedKeys

Constructor Summary

Constructors

Constructor and Description
Producer(Name prefix, Name dataType, Face face, KeyChain keyChain, ProducerDb database) Create a Producer to use the given ProducerDb, Face and other values.
Producer(Name prefix, Name dataType, Face face, KeyChain keyChain, ProducerDb database, int repeatAttempts) Create a Producer to use the given ProducerDb, Face and other values.

Method Summary

Methods

Modifier and Type	Method and Description
Name	createContentKey(double timeSlot, Producer.OnEncryptedKeys onEncryptedKeys) Create the content key.
void	produce(Data data, double timeSlot, Blob content) Encrypt the given content with the content key that covers timeSlot, and update the data packet with the encrypted content and an appropriate data name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Producer

public Producer(Name prefix,
        Name dataType,
        Face face,
        KeyChain keyChain,
        ProducerDb database,
        int repeatAttempts)

Create a Producer to use the given ProducerDb, Face and other values. A producer can produce data with a naming convention: /<prefix>/SAMPLE/<dataType>/[timestamp] The produced data packet is encrypted with a content key, which is stored in the ProducerDb database. A producer also needs to produce data containing a content key encrypted with E-KEYs. A producer can retrieve E-KEYs through the face, and will re-try for at most repeatAttemps times when E-KEY retrieval fails.

Parameters:

prefix - The producer name prefix. This makes a copy of the Name.

dataType - The dataType portion of the producer name. This makes a copy of the Name.

face - The face used to retrieve keys.

keyChain - The keyChain used to sign data packets.

database - The ProducerDb database for storing keys.

repeatAttempts - The maximum retry for retrieving keys.

Producer

public Producer(Name prefix,
        Name dataType,
        Face face,
        KeyChain keyChain,
        ProducerDb database)

Create a Producer to use the given ProducerDb, Face and other values. A producer can produce data with a naming convention: /<prefix>/SAMPLE/<dataType>/[timestamp] The produced data packet is encrypted with a content key, which is stored in the ProducerDb database. A producer also needs to produce data containing a content key encrypted with E-KEYs. A producer can retrieve E-KEYs through the face, and will re-try for at most 3 times when E-KEY retrieval fails.

Parameters:

prefix - The producer name prefix.

dataType - The dataType portion of the producer name.

face - The face used to retrieve keys.

keyChain - The keyChain used to sign data packets.

database - The ProducerDb database for storing keys.

Method Detail

createContentKey

public final Name createContentKey(double timeSlot,
                    Producer.OnEncryptedKeys onEncryptedKeys)
                            throws ProducerDb.Error,
                                   IOException,
                                   SecurityException

Create the content key. This first checks if the content key exists. For an existing content key, this returns the content key name directly. If the key does not exist, this creates one and encrypts it using the corresponding E-KEYs. The encrypted content keys are passed to the onEncryptedKeys callback.

Parameters:

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

onEncryptedKeys - If this creates a content key, then this calls onEncryptedKeys.onEncryptedKeys(keys) where keys is a list of encrypted content key Data packets. If onEncryptedKeys is null, this does not use it.

Returns:

The content key name.

Throws:

ProducerDb.Error

IOException

SecurityException

produce

public final void produce(Data data,
           double timeSlot,
           Blob content)
                   throws ProducerDb.Error,
                          IOException,
                          SecurityException,
                          NoSuchAlgorithmException,
                          NoSuchPaddingException,
                          InvalidKeyException,
                          IllegalBlockSizeException,
                          BadPaddingException,
                          InvalidAlgorithmParameterException,
                          InvalidKeySpecException

Encrypt the given content with the content key that covers timeSlot, and update the data packet with the encrypted content and an appropriate data name.

Parameters:

data - An empty Data object which is updated.

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

content - The content to encrypt.

Throws:

ProducerDb.Error

IOException

SecurityException

NoSuchAlgorithmException

NoSuchPaddingException

InvalidKeyException

IllegalBlockSizeException

BadPaddingException

InvalidAlgorithmParameterException

InvalidKeySpecException