net.named_data.jndn.security

Class CommandInterestSigner

java.lang.Object

net.named_data.jndn.security.CommandInterestPreparer

net.named_data.jndn.security.CommandInterestSigner

public class CommandInterestSigner
extends CommandInterestPreparer

CommandInterestSigner is a helper class to create command interests. This keeps track of a timestamp and generates command interests by adding name components according to the NFD Signed Command Interests protocol. See makeCommandInterest() for details. https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_SIZE
static int	POS_NONCE
static int	POS_SIGNATURE_INFO
static int	POS_SIGNATURE_VALUE
static int	POS_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
CommandInterestSigner(KeyChain keyChain) Create a CommandInterestSigner to use the keyChain to sign.

Method Summary

Modifier and Type	Method and Description
Interest	makeCommandInterest(Name name) Call the main makeCommandInterest where the signing params is the default SigningInfo() and wireFormat is WireFormat.getDefaultWireFormat() .
Interest	makeCommandInterest(Name name, SigningInfo params) Call the main makeCommandInterest where wireFormat is WireFormat.getDefaultWireFormat() .
Interest	makeCommandInterest(Name name, SigningInfo params, WireFormat wireFormat) Append the timestamp and nonce name components to the supplied name, create an Interest object and signs it with the KeyChain given to the constructor.

Methods inherited from class net.named_data.jndn.security.CommandInterestPreparer

prepareCommandInterestName, prepareCommandInterestName, setNowOffsetMilliseconds_

Methods inherited from class java.lang.Object

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

Field Detail

POS_SIGNATURE_VALUE

public static final int POS_SIGNATURE_VALUE

See Also:

Constant Field Values

POS_SIGNATURE_INFO

public static final int POS_SIGNATURE_INFO

See Also:

Constant Field Values

POS_NONCE

public static final int POS_NONCE

See Also:

Constant Field Values

POS_TIMESTAMP

public static final int POS_TIMESTAMP

See Also:

Constant Field Values

MINIMUM_SIZE

public static final int MINIMUM_SIZE

See Also:

Constant Field Values

Constructor Detail

CommandInterestSigner

public CommandInterestSigner(KeyChain keyChain)

Create a CommandInterestSigner to use the keyChain to sign.

Parameters:

keyChain - The KeyChain used to sign.

Method Detail

makeCommandInterest

public final Interest makeCommandInterest(Name name,
                                          SigningInfo params,
                                          WireFormat wireFormat)
                                   throws PibImpl.Error,
                                          KeyChain.Error,
                                          TpmBackEnd.Error

Append the timestamp and nonce name components to the supplied name, create an Interest object and signs it with the KeyChain given to the constructor. This ensures that the timestamp is greater than the timestamp used in the previous call.

Parameters:

name - The Name for the Interest, which is copied.

params - The signing parameters.

wireFormat - A WireFormat object used to encode the SignatureInfo and to encode interest name for signing.

Returns:

A new command Interest object.

Throws:

PibImpl.Error

KeyChain.Error

TpmBackEnd.Error

makeCommandInterest

public final Interest makeCommandInterest(Name name,
                                          SigningInfo params)
                                   throws PibImpl.Error,
                                          KeyChain.Error,
                                          TpmBackEnd.Error

Call the main makeCommandInterest where wireFormat is WireFormat.getDefaultWireFormat() .

Throws:

PibImpl.Error

KeyChain.Error

TpmBackEnd.Error

makeCommandInterest

public final Interest makeCommandInterest(Name name)
                                   throws PibImpl.Error,
                                          KeyChain.Error,
                                          TpmBackEnd.Error

Call the main makeCommandInterest where the signing params is the default SigningInfo() and wireFormat is WireFormat.getDefaultWireFormat() .

Throws:

PibImpl.Error

KeyChain.Error

TpmBackEnd.Error