Signing parameters passed to KeyChain. More...

#include <ndn-cxx/security/signing-info.hpp>

Classes
class	Error

Public Types
enum	SignerType { SIGNER_TYPE_NULL = 0 , SIGNER_TYPE_ID = 1 , SIGNER_TYPE_KEY = 2 , SIGNER_TYPE_CERT = 3 , SIGNER_TYPE_SHA256 = 4 , SIGNER_TYPE_HMAC = 5 }

Public Member Functions
	SigningInfo (const Identity &identity)
	Construct from a PIB identity. More...

	SigningInfo (const Key &key)
	Construct from a PIB key. More...

	SigningInfo (SignerType signerType=SIGNER_TYPE_NULL, const Name &signerName=Name(), const SignatureInfo &signatureInfo=SignatureInfo())
	Constructor. More...

	SigningInfo (std::string_view signingStr)
	Construct SigningInfo from its string representation. More...

DigestAlgorithm	getDigestAlgorithm () const
	Get the digest algorithm for signing operations. More...

shared_ptr< transform::PrivateKey >	getHmacKey () const

const Identity &	getPibIdentity () const

const Key &	getPibKey () const

const SignatureInfo &	getSignatureInfo () const
	Get a semi-prepared SignatureInfo. More...

SignedInterestFormat	getSignedInterestFormat () const
	Get the signed Interest format. More...

const Name &	getSignerName () const

SignerType	getSignerType () const
	Return the signer type. More...

SigningInfo &	setDigestAlgorithm (const DigestAlgorithm &algorithm)
	Set the digest algorithm for signing operations. More...

SigningInfo &	setPibIdentity (const Identity &identity)
	Set signer as a PIB identity handle `identity`. More...

SigningInfo &	setPibKey (const Key &key)
	Set signer as a PIB key handle `key`. More...

SigningInfo &	setSha256Signing ()
	Set SHA-256 as the signing method. More...

SigningInfo &	setSignatureInfo (const SignatureInfo &signatureInfo)
	Set a semi-prepared SignatureInfo. More...

SigningInfo &	setSignedInterestFormat (SignedInterestFormat signedInterestFormat)
	Set the signed Interest format. More...

SigningInfo &	setSigningCertName (const Name &certificateName)
	Set signer as a certificate with name `certificateName`. More...

SigningInfo &	setSigningHmacKey (std::string_view hmacKey)
	Set signer to a base64-encoded HMAC key. More...

SigningInfo &	setSigningIdentity (const Name &identity)
	Set signer as an identity with name `identity`. More...

SigningInfo &	setSigningKeyName (const Name &keyName)
	Set signer as a key with name `keyName`. More...

Static Public Member Functions
static const Name &	getDigestSha256Identity ()
	A localhost identity to indicate that the signature is generated using SHA-256. More...

static const Name &	getHmacIdentity ()
	A localhost identity to indicate that the signature is generated using an HMAC key. More...

Friends
bool	operator!= (const SigningInfo &lhs, const SigningInfo &rhs)

bool	operator== (const SigningInfo &lhs, const SigningInfo &rhs)

Detailed Description

Signing parameters passed to KeyChain.

A SigningInfo is invalid if the specified identity/key/certificate does not exist, or the PIB Identity or Key instance is not valid.

Definition at line 51 of file signing-info.hpp.

Member Enumeration Documentation

◆ SignerType

enum ndn::security::SigningInfo::SignerType

Enumerator
SIGNER_TYPE_NULL	No signer is specified, use default setting or follow the trust schema.
SIGNER_TYPE_ID	Signer is an identity, use its default key and default certificate.
SIGNER_TYPE_KEY	Signer is a key, use its default certificate.
SIGNER_TYPE_CERT	Signer is a certificate, use it directly.
SIGNER_TYPE_SHA256	Use a SHA-256 digest only, no signer needs to be specified.
SIGNER_TYPE_HMAC	Signer is a HMAC key.

Definition at line 60 of file signing-info.hpp.

Constructor & Destructor Documentation

◆ SigningInfo() [1/4]

ndn::security::SigningInfo::SigningInfo	(	SignerType	signerType = `SIGNER_TYPE_NULL`,
		const Name &	signerName = `Name()`,
		const SignatureInfo &	signatureInfo = `SignatureInfo()`
	)

explicit

Constructor.

Parameters

signerType	The type of signer
signerName	The name of the signer; interpretation differs with the type of signer
signatureInfo	A semi-prepared SignatureInfo that contains all necessary information except SignatureType and KeyLocator. If SignatureType and/or KeyLocator is set, they will be overwritten by KeyChain::sign().

Definition at line 45 of file signing-info.cpp.

◆ SigningInfo() [2/4]

ndn::security::SigningInfo::SigningInfo ( const Identity & identity )

explicit

Construct from a PIB identity.

Definition at line 57 of file signing-info.cpp.

◆ SigningInfo() [3/4]

ndn::security::SigningInfo::SigningInfo ( const Key & key )

explicit

Construct from a PIB key.

Definition at line 63 of file signing-info.cpp.

◆ SigningInfo() [4/4]

ndn::security::SigningInfo::SigningInfo ( std::string_view signingStr )

explicit

Construct SigningInfo from its string representation.

Parameters

signingStr The representative signing string for SigningInfo signing method

Syntax of the representative string is as follows:

default signing: "" (empty string)
sign with the default certificate of the default key of an identity: id:/<my-identity>
sign with the default certificate of a specific key: key:/<my-identity>/ksk-1
sign with a specific certificate: cert:/<my-identity>/KEY/ksk-1/ID-CERT/FD%01
sign with HMAC-SHA-256: hmac-sha256:<base64-encoded-key>
sign with SHA-256 (digest only): id:/localhost/identity/digest-sha256

Definition at line 69 of file signing-info.cpp.

Member Function Documentation

◆ getDigestAlgorithm()

DigestAlgorithm ndn::security::SigningInfo::getDigestAlgorithm ( ) const

inline

Get the digest algorithm for signing operations.

Definition at line 229 of file signing-info.hpp.

◆ getDigestSha256Identity()

const Name & ndn::security::SigningInfo::getDigestSha256Identity ( )

static

A localhost identity to indicate that the signature is generated using SHA-256.

Definition at line 32 of file signing-info.cpp.

◆ getHmacIdentity()

const Name & ndn::security::SigningInfo::getHmacIdentity ( )

static

A localhost identity to indicate that the signature is generated using an HMAC key.

Definition at line 39 of file signing-info.cpp.

◆ getHmacKey()

shared_ptr<transform::PrivateKey> ndn::security::SigningInfo::getHmacKey ( ) const

inline

Definition at line 209 of file signing-info.hpp.

◆ getPibIdentity()

const Identity& ndn::security::SigningInfo::getPibIdentity ( ) const

inline

Precondition: signerType must be SIGNER_TYPE_ID

Returns: The identity handle of signer, or Identity() if getSignerName() should be used to find the identity.

Definition at line 191 of file signing-info.hpp.

◆ getPibKey()

const Key& ndn::security::SigningInfo::getPibKey ( ) const

inline

Precondition: signerType must be SIGNER_TYPE_KEY

Returns: The key handle of signer, or Key() if getSignerName() should be used to find the key.

Definition at line 202 of file signing-info.hpp.

◆ getSignatureInfo()

const SignatureInfo& ndn::security::SigningInfo::getSignatureInfo ( ) const

inline

Get a semi-prepared SignatureInfo.

Definition at line 244 of file signing-info.hpp.

◆ getSignedInterestFormat()

SignedInterestFormat ndn::security::SigningInfo::getSignedInterestFormat ( ) const

inline

Get the signed Interest format.

Note: This is a transitional API to handle the change in signed Interest format and will disappear after a few releases.

Definition at line 267 of file signing-info.hpp.

◆ getSignerName()

const Name& ndn::security::SigningInfo::getSignerName ( ) const

inline

Returns: Name of signer; interpretation differs per signerType.

Definition at line 180 of file signing-info.hpp.

◆ getSignerType()

SignerType ndn::security::SigningInfo::getSignerType ( ) const

inline

Return the signer type.

Definition at line 171 of file signing-info.hpp.

◆ setDigestAlgorithm()

SigningInfo& ndn::security::SigningInfo::setDigestAlgorithm ( const DigestAlgorithm & algorithm )

inline

Set the digest algorithm for signing operations.

Definition at line 219 of file signing-info.hpp.

◆ setPibIdentity()

SigningInfo & ndn::security::SigningInfo::setPibIdentity ( const Identity & identity )

Set signer as a PIB identity handle identity.

Postcondition: Change the signerType to SIGNER_TYPE_ID

Definition at line 161 of file signing-info.cpp.

◆ setPibKey()

SigningInfo & ndn::security::SigningInfo::setPibKey ( const Key & key )

Set signer as a PIB key handle key.

Postcondition: Change the signerType to SIGNER_TYPE_KEY

Definition at line 170 of file signing-info.cpp.

◆ setSha256Signing()

SigningInfo & ndn::security::SigningInfo::setSha256Signing ( )

Set SHA-256 as the signing method.

Postcondition: Reset signerName, also change the signerType to SIGNER_TYPE_SHA256

Definition at line 153 of file signing-info.cpp.

◆ setSignatureInfo()

SigningInfo & ndn::security::SigningInfo::setSignatureInfo ( const SignatureInfo & signatureInfo )

Set a semi-prepared SignatureInfo.

Definition at line 179 of file signing-info.cpp.

◆ setSignedInterestFormat()

SigningInfo& ndn::security::SigningInfo::setSignedInterestFormat ( SignedInterestFormat signedInterestFormat )

inline

Set the signed Interest format.

Note: This is a transitional API to handle the change in signed Interest format and will disappear after a few releases.

Definition at line 255 of file signing-info.hpp.

◆ setSigningCertName()

SigningInfo & ndn::security::SigningInfo::setSigningCertName ( const Name & certificateName )

Set signer as a certificate with name certificateName.

Postcondition: Change the signerType to SIGNER_TYPE_CERT

Definition at line 126 of file signing-info.cpp.

◆ setSigningHmacKey()

SigningInfo & ndn::security::SigningInfo::setSigningHmacKey ( std::string_view hmacKey )

Set signer to a base64-encoded HMAC key.

Postcondition: Change the signerType to SIGNER_TYPE_HMAC

Definition at line 134 of file signing-info.cpp.

◆ setSigningIdentity()

SigningInfo & ndn::security::SigningInfo::setSigningIdentity ( const Name & identity )

Set signer as an identity with name identity.

Postcondition: Change the signerType to SIGNER_TYPE_ID

Definition at line 108 of file signing-info.cpp.

◆ setSigningKeyName()

SigningInfo & ndn::security::SigningInfo::setSigningKeyName ( const Name & keyName )

Set signer as a key with name keyName.

Postcondition: Change the signerType to SIGNER_TYPE_KEY

Definition at line 117 of file signing-info.cpp.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const SigningInfo &	lhs,
		const SigningInfo &	rhs
	)

friend

Definition at line 296 of file signing-info.hpp.

◆ operator==

bool operator==	(	const SigningInfo &	lhs,
		const SigningInfo &	rhs
	)

friend

Definition at line 290 of file signing-info.hpp.

ndn-cxx: NDN C++ library with eXperimental eXtensions 0.8.1-102-g0751bba8 documentation

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ SignerType

Constructor & Destructor Documentation

◆ SigningInfo() [1/4]

◆ SigningInfo() [2/4]

◆ SigningInfo() [3/4]

◆ SigningInfo() [4/4]

Member Function Documentation

◆ getDigestAlgorithm()

◆ getDigestSha256Identity()

◆ getHmacIdentity()

◆ getHmacKey()

◆ getPibIdentity()

◆ getPibKey()

◆ getSignatureInfo()

◆ getSignedInterestFormat()

◆ getSignerName()

◆ getSignerType()

◆ setDigestAlgorithm()

◆ setPibIdentity()

◆ setPibKey()

◆ setSha256Signing()

◆ setSignatureInfo()

◆ setSignedInterestFormat()

◆ setSigningCertName()

◆ setSigningHmacKey()

◆ setSigningIdentity()

◆ setSigningKeyName()

Friends And Related Function Documentation

◆ operator!=

◆ operator==