net.named_data.jndn.security

Class SigningInfo

java.lang.Object

net.named_data.jndn.security.SigningInfo

public class SigningInfo
extends Object

A SigningInfo holds the signing parameters passed to the KeyChain. A SigningInfo is invalid if the specified identity/key/certificate does not exist, or the PibIdentity or PibKey instance is not valid.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SigningInfo.SignerType

Constructor Summary

Constructors

Constructor and Description
SigningInfo() Create a SigningInfo with a signerType of NULL (which will cause KeyChain.sign to use the default identity) and an empty signerName, with other default values.
SigningInfo(PibIdentity identity) Create a SigningInfo of type SignerType.ID according to the given PibIdentity.
SigningInfo(PibKey key) Create a SigningInfo of type SignerType.KEY according to the given PibKey.
SigningInfo(SigningInfo.SignerType signerType) Create a SigningInfo with the signerType and an empty signerName, with other default values.
SigningInfo(SigningInfo.SignerType signerType, Name signerName) Create a SigningInfo with the signerType and signerName, with other default values.
SigningInfo(SigningInfo signingInfo) Create a SigningInfo as a copy of the given signingInfo.
SigningInfo(String signingString) Create a SigningInfo from its string representation.

Method Summary

Modifier and Type	Method and Description
DigestAlgorithm	getDigestAlgorithm() Get the digest algorithm for public key operations.
static Name	getDigestSha256Identity() Get the localhost identity which indicates that the signature is generated using SHA-256.
PibIdentity	getPibIdentity() Get the PibIdentity of the signer.
PibKey	getPibKey() Get the PibKey of the signer.
Name	getSignerName() Get the name of signer.
SigningInfo.SignerType	getSignerType() Get the type of the signer.
ValidityPeriod	getValidityPeriod() Get the validity period for the signature info.
SigningInfo	setDigestAlgorithm(DigestAlgorithm digestAlgorithm) Set the digest algorithm for public key operations.
SigningInfo	setPibIdentity(PibIdentity identity) Set this to type SignerType.ID according to the given PibIdentity.
SigningInfo	setPibKey(PibKey key) Set this to type SignerType.KEY according to the given PibKey.
SigningInfo	setSha256Signing() Set this to type SignerType.SHA256, and set the digest algorithm to DigestAlgorithm.SHA256.
SigningInfo	setSigningCertificateName(Name certificateName) Set this to type SignerType.CERT and a certificate with name certificateName.
SigningInfo	setSigningIdentity(Name identityName) Set this to type SignerType.ID and an identity with name identityName.
SigningInfo	setSigningKeyName(Name keyName) Set this to type SignerType.KEY and a key with name keyName.
SigningInfo	setValidityPeriod(ValidityPeriod validityPeriod) Set the validity period for the signature info.
String	toString() Get the string representation of this SigningInfo.

Methods inherited from class java.lang.Object

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

Constructor Detail

SigningInfo

public SigningInfo(SigningInfo.SignerType signerType,
                   Name signerName)

Create a SigningInfo with the signerType and signerName, with other default values. The digest algorithm is set to DigestAlgorithm.SHA256.

Parameters:

signerType - The type of signer.

signerName - The name of signer. The interpretation of the signerName differs based on the signerType. This copies the Name.

SigningInfo

public SigningInfo(SigningInfo.SignerType signerType)

Create a SigningInfo with the signerType and an empty signerName, with other default values. The digest algorithm is set to DigestAlgorithm.SHA256.

Parameters:

signerType - The type of signer.

SigningInfo

public SigningInfo()

Create a SigningInfo with a signerType of NULL (which will cause KeyChain.sign to use the default identity) and an empty signerName, with other default values. The digest algorithm is set to DigestAlgorithm.SHA256.

SigningInfo

public SigningInfo(PibIdentity identity)

Create a SigningInfo of type SignerType.ID according to the given PibIdentity. The digest algorithm is set to DigestAlgorithm.SHA256.

Parameters:

identity - An existing PibIdentity which is not copied, or a null PibIdentity. If this is null then use the default identity, otherwise use identity.getName().

SigningInfo

public SigningInfo(PibKey key)

Create a SigningInfo of type SignerType.KEY according to the given PibKey. The digest algorithm is set to DigestAlgorithm.SHA256.

Parameters:

key - An existing PibKey which is not copied, or a null PibKey. If this is null then use the default key for the identity, otherwise use key.getName().

SigningInfo

public SigningInfo(String signingString)

Create a SigningInfo from its string representation. The digest algorithm is set to DigestAlgorithm.SHA256.

Parameters:

signingString - The representative signing string for the signing method, as follows: Default signing: "" (the empty string). Signing with the default certificate of the default key for the identity with the specified name: `id:/my-identity`. Signing with the default certificate of the key with the specified name: `key:/my-identity/ksk-1`. Signing with the certificate with the specified name: `cert:/my-identity/KEY/ksk-1/ID-CERT/%FD%01`. Signing with sha256 digest: `id:/localhost/identity/digest-sha256` (the value returned by getDigestSha256Identity()).

Throws:

IllegalArgumentException - if the signingString format is invalid.

SigningInfo

public SigningInfo(SigningInfo signingInfo)

Create a SigningInfo as a copy of the given signingInfo. (This takes a pointer to the given signingInfo PibIdentity and PibKey without copying.)

Parameters:

signingInfo - The SigningInfo to copy.

Method Detail

setSigningIdentity

public final SigningInfo setSigningIdentity(Name identityName)

Set this to type SignerType.ID and an identity with name identityName. This does not change the digest algorithm.

Parameters:

identityName - The name of the identity. This copies the Name.

Returns:

This SigningInfo.

setSigningKeyName

public final SigningInfo setSigningKeyName(Name keyName)

Set this to type SignerType.KEY and a key with name keyName. This does not change the digest algorithm.

Parameters:

keyName - The name of the key. This copies the Name.

Returns:

This SigningInfo.

setSigningCertificateName

public final SigningInfo setSigningCertificateName(Name certificateName)

Set this to type SignerType.CERT and a certificate with name certificateName. This does not change the digest algorithm.

Parameters:

certificateName - The name of the certificate. This copies the Name.

Returns:

This SigningInfo.

setSha256Signing

public final SigningInfo setSha256Signing()

Set this to type SignerType.SHA256, and set the digest algorithm to DigestAlgorithm.SHA256.

Returns:

This SigningInfo.

setPibIdentity

public final SigningInfo setPibIdentity(PibIdentity identity)

Set this to type SignerType.ID according to the given PibIdentity. This does not change the digest algorithm.

Parameters:

identity - An existing PibIdentity which is not copied, or a null PibIdentity. If this is null then use the default identity, otherwise use identity.getName().

Returns:

This SigningInfo.

setPibKey

public final SigningInfo setPibKey(PibKey key)

Set this to type SignerType.KEY according to the given PibKey. This does not change the digest algorithm.

Parameters:

key - An existing PibKey which is not copied, or a null PibKey. If this is null then use the default key for the identity, otherwise use key.getName().

Returns:

This SigningInfo.

getSignerType

public final SigningInfo.SignerType getSignerType()

Get the type of the signer.

Returns:

The type of the signer

getSignerName

public final Name getSignerName()

Get the name of signer.

Returns:

The name of signer. The interpretation differs based on the signerType.

getPibIdentity

public final PibIdentity getPibIdentity()

Get the PibIdentity of the signer.

Returns:

The PibIdentity handler of the signer, or null if getSignerName() should be used to find the identity.

Throws:

AssertionError - if the signer type is not SignerType.ID.

getPibKey

public final PibKey getPibKey()

Get the PibKey of the signer.

Returns:

The PibKey handler of the signer, or null if getSignerName() should be used to find the key.

Throws:

AssertionError - if the signer type is not SignerType.KEY.

setDigestAlgorithm

public final SigningInfo setDigestAlgorithm(DigestAlgorithm digestAlgorithm)

Set the digest algorithm for public key operations.

Parameters:

digestAlgorithm - The digest algorithm.

Returns:

This SigningInfo.

getDigestAlgorithm

public final DigestAlgorithm getDigestAlgorithm()

Get the digest algorithm for public key operations.

Returns:

The digest algorithm.

setValidityPeriod

public final SigningInfo setValidityPeriod(ValidityPeriod validityPeriod)

Set the validity period for the signature info. Note that the equivalent ndn-cxx method uses a semi-prepared SignatureInfo, but this method only uses the ValidityPeriod from the SignatureInfo.

Parameters:

validityPeriod - The validity period, which is copied.

Returns:

This SigningInfo.

getValidityPeriod

public final ValidityPeriod getValidityPeriod()

Get the validity period for the signature info. Note that the equivalent ndn-cxx method uses a semi-prepared SignatureInfo, but this method only uses the ValidityPeriod from the SignatureInfo.

Returns:

The validity period.

toString

public String toString()

Get the string representation of this SigningInfo.

Overrides:

toString in class Object

Returns:

The string representation.

getDigestSha256Identity

public static Name getDigestSha256Identity()

Get the localhost identity which indicates that the signature is generated using SHA-256.

Returns:

A new Name of the SHA-256 identity.