Classes
class	Base64Decode
	The module to perform Base64 decoding transformation. More...

class	Base64Encode
	The module to perform Base64 encoding transformation. More...

class	BlockCipher
	The module to encrypt data using block cipher. More...

class	BoolSink
	A sink which outputs only one boolean value. More...

class	BufferSource
	A source taking one or more memory buffers as input. More...

class	DigestFilter
	The module to calculate digests. More...

class	Downstream
	The downstream interface of a transformation module. More...

class	Error
	Base class of transformation error. More...

class	HexDecode
	The module to perform hexadecimal decoding transformation. More...

class	HexEncode
	The module to perform hexadecimal encoding transformation. More...

class	PrivateKey
	Abstraction of private key in crypto transformation. More...

class	PublicKey
	Abstraction of public key in crypto transformation. More...

class	SignerFilter
	The module to sign data. More...

class	Sink
	Abstraction of the transformation sink module. More...

class	Source
	Abstraction of the transformation source module. More...

class	StepSource
	A source that can accept input step by step, and can close input explicitly. More...

class	StreamSink
	A sink which directs output to an std::ostream. More...

class	StreamSource
	A source taking an std::istream as input. More...

class	StripSpace
	Strip whitespace characters from a stream. More...

class	Transform
	Abstraction of an intermediate transformation module. More...

class	Upstream
	The upstream interface of a transformation module. More...

class	VerifierFilter
	The module to verify signatures. More...

Typedefs
using	bufferSource = BufferSource

using	stepSource = StepSource

typedef StreamSource	streamSource

Functions
unique_ptr< Transform >	base64Decode (bool expectNewlineEvery64Bytes)

unique_ptr< Transform >	base64Encode (bool needBreak)

unique_ptr< Transform >	blockCipher (BlockCipherAlgorithm algo, CipherOperator op, span< const uint8_t > key, span< const uint8_t > iv)

unique_ptr< Sink >	boolSink (bool &value)

unique_ptr< Transform >	digestFilter (DigestAlgorithm algo)

unique_ptr< Transform >	hexDecode ()

unique_ptr< Transform >	hexEncode (bool useUpperCase)

static int	passwordCallbackWrapper (char buf, int size, int rwflag, void u)

unique_ptr< PrivateKey >	generatePrivateKey (const KeyParams &keyParams)
	Generate a private key according to `keyParams`. More...

unique_ptr< Transform >	signerFilter (DigestAlgorithm algo, const PrivateKey &key)

unique_ptr< Sink >	streamSink (std::ostream &os)

unique_ptr< Transform >	stripSpace (const char *whitespaces=StripSpace::DEFAULT_WHITESPACES)
	constructs a StripSpace transform More...

unique_ptr< Transform >	verifierFilter (DigestAlgorithm algo, const PublicKey &key, span< const uint8_t > sig)

unique_ptr< Transform >	verifierFilter (DigestAlgorithm algo, const PrivateKey &key, span< const uint8_t > sig)

Variables
static const int8_t	C2H []

static const uint8_t	H2CL []

static const uint8_t	H2CU []

Typedef Documentation

◆ bufferSource

using ndn::security::transform::bufferSource = typedef BufferSource

Definition at line 74 of file buffer-source.hpp.

◆ stepSource

using ndn::security::transform::stepSource = typedef StepSource

Definition at line 75 of file step-source.hpp.

◆ streamSource

typedef StreamSource ndn::security::transform::streamSource

Definition at line 62 of file stream-source.hpp.

Function Documentation

◆ base64Decode()

unique_ptr< Transform > ndn::security::transform::base64Decode ( bool expectNewlineEvery64Bytes )

Definition at line 124 of file base64-decode.cpp.

Referenced by ndn::io::loadBuffer(), ndn::security::transform::PrivateKey::loadPkcs1Base64(), ndn::security::transform::PublicKey::loadPkcs8Base64(), ndn::security::transform::PrivateKey::loadPkcs8Base64(), and ndn::security::SigningInfo::setSigningHmacKey().

◆ base64Encode()

unique_ptr< Transform > ndn::security::transform::base64Encode ( bool needBreak )

Definition at line 127 of file base64-encode.cpp.

Referenced by ndn::security::v2::operator<<(), ndn::io::saveBuffer(), ndn::security::transform::PrivateKey::savePkcs1Base64(), ndn::security::transform::PublicKey::savePkcs8Base64(), and ndn::security::transform::PrivateKey::savePkcs8Base64().

◆ blockCipher()

unique_ptr< Transform > ndn::security::transform::blockCipher	(	BlockCipherAlgorithm	algo,
		CipherOperator	op,
		span< const uint8_t >	key,
		span< const uint8_t >	iv
	)

Definition at line 159 of file block-cipher.cpp.

◆ boolSink()

unique_ptr< Sink > ndn::security::transform::boolSink ( bool & value )

Definition at line 51 of file bool-sink.cpp.

Referenced by ndn::security::v2::KeyChain::importSafeBag(), ndn::security::tpm::KeyHandleMem::KeyHandleMem(), and ndn::security::verifySignature().

◆ digestFilter()

unique_ptr< Transform > ndn::security::transform::digestFilter ( DigestAlgorithm algo )

Definition at line 76 of file digest-filter.cpp.

Referenced by ndn::security::tpm::BackEnd::constructAsymmetricKeyName(), ndn::security::transform::PrivateKey::getKeyDigest(), ndn::Interest::isParametersDigestValid(), ndn::security::v2::parseLocatorUri(), ndn::util::Sha256::reset(), ndn::util::Sha256::Sha256(), ndn::security::tpm::BackEndOsx::sign(), ndn::security::tpm::BackEndFile::Impl::toFileName(), and ndn::security::verifyDigest().

◆ hexDecode()

unique_ptr< Transform > ndn::security::transform::hexDecode ( )

Definition at line 115 of file hex-decode.cpp.

Referenced by ndn::fromHex(), ndn::io::loadBuffer(), and ndn::operator""_block().

◆ hexEncode()

unique_ptr< Transform > ndn::security::transform::hexEncode ( bool useUpperCase )

Definition at line 70 of file hex-encode.cpp.

Referenced by ndn::printHex(), ndn::io::saveBuffer(), and ndn::security::tpm::BackEndFile::Impl::toFileName().

◆ passwordCallbackWrapper()

static int ndn::security::transform::passwordCallbackWrapper	(	char *	buf,
		int	size,
		int	rwflag,
		void *	u
	)

inlinestatic

Definition at line 195 of file private-key.cpp.

References nonstd::span_lite::size().

Referenced by ndn::security::transform::PrivateKey::decrypt(), and ndn::security::transform::PrivateKey::loadPkcs8().

◆ generatePrivateKey()

unique_ptr< PrivateKey > ndn::security::transform::generatePrivateKey ( const KeyParams & keyParams )

Generate a private key according to keyParams.

Note: The corresponding public key can be derived from the private key.

Exceptions

std::invalid_argument	the specified key type is not supported
PrivateKey::Error	key generation failed

Definition at line 492 of file private-key.cpp.

References ndn::EC, ndn::KeyParams::getKeyType(), ndn::HMAC, NDN_THROW, and ndn::RSA.

Referenced by ndn::security::tpm::BackEndMem::getScheme(), and ndn::security::tpm::BackEndFile::getScheme().

◆ signerFilter()

unique_ptr< Transform > ndn::security::transform::signerFilter	(	DigestAlgorithm	algo,
		const PrivateKey &	key
	)

Definition at line 83 of file signer-filter.cpp.

Referenced by ndn::security::tpm::KeyHandleMem::KeyHandleMem().

◆ streamSink()

unique_ptr< Sink > ndn::security::transform::streamSink ( std::ostream & os )

Definition at line 53 of file stream-sink.cpp.

◆ stripSpace()

unique_ptr< Transform > ndn::security::transform::stripSpace ( const char * whitespaces = StripSpace::DEFAULT_WHITESPACES )

constructs a StripSpace transform

Parameters

whitespaces characters classified as whitespaces, terminated with null

Definition at line 54 of file strip-space.cpp.

Referenced by ndn::io::loadBuffer().

◆ verifierFilter() [1/2]

unique_ptr< Transform > ndn::security::transform::verifierFilter	(	DigestAlgorithm	algo,
		const PublicKey &	key,
		span< const uint8_t >	sig
	)

Definition at line 127 of file verifier-filter.cpp.

References sig.

Referenced by ndn::security::v2::KeyChain::importSafeBag(), ndn::security::tpm::KeyHandleMem::KeyHandleMem(), and ndn::security::verifySignature().

◆ verifierFilter() [2/2]

unique_ptr< Transform > ndn::security::transform::verifierFilter	(	DigestAlgorithm	algo,
		const PrivateKey &	key,
		span< const uint8_t >	sig
	)

Definition at line 133 of file verifier-filter.cpp.

References sig.

Variable Documentation

◆ C2H

const int8_t ndn::security::transform::C2H[]

static

Initial value:

= {
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
   0,  1,  2,  3,  4,  5,  6,  7,  8,  9, -1, -1, -1, -1, -1, -1, 
  -1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
  -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 
}

Definition at line 29 of file hex-decode.cpp.

◆ H2CL

const uint8_t ndn::security::transform::H2CL[]

static

Initial value:

= {
  '0', '1', '2', '3', '4', '5', '6', '7',
  '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
}

Definition at line 28 of file hex-encode.cpp.

Referenced by ndn::security::transform::HexEncode::HexEncode().

◆ H2CU

const uint8_t ndn::security::transform::H2CU[]

static

Initial value:

= {
  '0', '1', '2', '3', '4', '5', '6', '7',
  '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
}

Definition at line 34 of file hex-encode.cpp.

Referenced by ndn::security::transform::HexEncode::HexEncode().

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ bufferSource

◆ stepSource

◆ streamSource

Function Documentation

◆ base64Decode()

◆ base64Encode()

◆ blockCipher()

◆ boolSink()

◆ digestFilter()

◆ hexDecode()

◆ hexEncode()

◆ passwordCallbackWrapper()

◆ generatePrivateKey()

◆ signerFilter()

◆ streamSink()

◆ stripSpace()

◆ verifierFilter() [1/2]

◆ verifierFilter() [2/2]

Variable Documentation

◆ C2H

◆ H2CL

◆ H2CU