ndn::security::MakeCertificateOptions Struct Reference

Options to KeyChain::makeCertificate(). More...

#include <ndn-cxx/security/key-chain.hpp>

Collaboration diagram for ndn::security::MakeCertificateOptions:

Public Attributes
time::milliseconds	freshnessPeriod = 1_h
	Certificate packet FreshnessPeriod. More...
name::Component	issuerId = Certificate::DEFAULT_ISSUER_ID
	Certificate name IssuerId component. More...
std::optional< ValidityPeriod >	validity
	Certificate ValidityPeriod. More...
std::optional< uint64_t >	version
	Certificate name version component. More...

Detailed Description

Options to KeyChain::makeCertificate().

Definition at line 41 of file key-chain.hpp.

Member Data Documentation

freshnessPeriod

time::milliseconds ndn::security::MakeCertificateOptions::freshnessPeriod = 1_h

Certificate packet FreshnessPeriod.

As required by the certificate format, this must be positive. Setting this to zero or negative causes std::invalid_argument exception.

Default is 1 hour.

Definition at line 65 of file key-chain.hpp.

issuerId

name::Component ndn::security::MakeCertificateOptions::issuerId = Certificate::DEFAULT_ISSUER_ID

Certificate name IssuerId component.

Default is "NA".

Definition at line 48 of file key-chain.hpp.

validity

std::optional<ValidityPeriod> ndn::security::MakeCertificateOptions::validity

Certificate ValidityPeriod.

It isn't an error to specify a ValidityPeriod that does not include the current time or has zero duration, but the certificate won't be valid.

Default is a ValidityPeriod from now until 365 days later.

Definition at line 75 of file key-chain.hpp.

version

std::optional<uint64_t> ndn::security::MakeCertificateOptions::version

Certificate name version component.

Default is deriving from current timestamp using the logic of Name::appendVersion().

Definition at line 55 of file key-chain.hpp.