|
NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
|
API Documentation |
|
|
NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
|
API Documentation |
Namespaces | |
| validator_config | |
Classes | |
| class | AdditionalDescription |
| Abstraction of AdditionalDescription. More... | |
| class | CertContainerInterface |
| class | Certificate |
| The certificate following the certificate format naming convention. More... | |
| class | CertificateBundleFetcher |
| Fetch certificate bundle from the network. More... | |
| class | CertificateCache |
| Represents a container for verified certificates. More... | |
| class | CertificateFetcher |
| Interface used by the validator to fetch missing certificates. More... | |
| class | CertificateFetcherDirectFetch |
| Extends CertificateFetcherFromNetwork to fetch certificates from the incoming face of the packet. More... | |
| class | CertificateFetcherFromNetwork |
| Fetch missing keys from the network. More... | |
| class | CertificateFetcherOffline |
| Certificate fetcher realization that does not fetch keys (always offline) More... | |
| class | CertificateRequest |
| Request for a certificate, associated with the number of attempts. More... | |
| class | CertificateStorage |
| Storage for trusted anchors, verified certificate cache, and unverified certificate cache. More... | |
| class | DataValidationState |
| Validation state for a data packet. More... | |
| class | DynamicTrustAnchorGroup |
| Dynamic trust anchor group. More... | |
| class | InterestValidationState |
| Validation state for an interest packet. More... | |
| class | KeyChain |
| The interface of signing key management. More... | |
| class | StaticTrustAnchorGroup |
| Static trust anchor group. More... | |
| class | TrustAnchorContainer |
| represents a container for trust anchors. More... | |
| class | TrustAnchorGroup |
| A group of trust anchors. More... | |
| class | ValidationError |
| Validation error code and optional detailed error message. More... | |
| class | ValidationPolicy |
| Abstraction that implements validation policy for Data and Interest packets. More... | |
| class | ValidationPolicyAcceptAll |
| A validator policy that accepts any signature of data and interest packets. More... | |
| class | ValidationPolicyCommandInterest |
| Validation policy for stop-and-wait command Interests. More... | |
| class | ValidationPolicySimpleHierarchy |
| Validation policy for a simple hierarchical trust model. More... | |
| class | ValidationState |
| Validation state. More... | |
| class | Validator |
| Interface for validating data and interest packets. More... | |
| class | ValidatorNull |
| Validator with "accept-all" policy and offline certificate fetcher. More... | |
Typedefs | |
| typedef function< void(const Data &data)> | DataValidationSuccessCallback |
| Callback to report a successful Data validation. More... | |
| typedef function< void(const Data &data, const ValidationError &error)> | DataValidationFailureCallback |
| Callback to report a failed Data validation. More... | |
| typedef function< void(const Interest &interest)> | InterestValidationSuccessCallback |
| Callback to report a successful Interest validation. More... | |
| typedef function< void(const Interest &interest, const ValidationError &error)> | InterestValidationFailureCallback |
| Callback to report a failed Interest validation. More... | |
Functions | |
| Name | constructKeyName (const Name &identity, const name::Component &keyId) |
| Construct key name based on the appropriate naming conventions. More... | |
| bool | isValidKeyName (const Name &keyName) |
Check if keyName follow the naming conventions for the key name. More... | |
| Name | extractIdentityFromKeyName (const Name &keyName) |
Extract identity namespace from the key name keyName. More... | |
| NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (AdditionalDescription) | |
| std::ostream & | operator<< (std::ostream &os, const AdditionalDescription &desc) |
| NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (AdditionalDescription) | |
| std::ostream & | operator<< (std::ostream &os, const Certificate &cert) |
| Name | extractIdentityFromCertName (const Name &certName) |
Extract identity namespace from the certificate name certName. More... | |
| Name | extractKeyNameFromCertName (const Name &certName) |
Extract key name from the certificate name certName. More... | |
| static std::tuple< std::string, std::string > | parseLocatorUri (const std::string &uri) |
| std::ostream & | operator<< (std::ostream &os, ValidationError::Code code) |
| std::ostream & | operator<< (std::ostream &os, const ValidationError &error) |
| static Name | getKeyLocatorName (const SignatureInfo &si, ValidationState &state) |
| Name | getKeyLocatorName (const Data &data, ValidationState &state) |
| extract KeyLocator.Name from Data More... | |
| Name | getKeyLocatorName (const Interest &interest, ValidationState &state) |
| extract KeyLocator.Name from signed Interest More... | |
| security::v2::Validator & | getAcceptAllValidator () |
Variables | |
| WireEncodable< AdditionalDescription > | |
| WireEncodableWithEncodingBuffer< AdditionalDescription > | |
| WireDecodable< AdditionalDescription > | |
| static const size_t | KEY_OFFSET = 0 |
| static const size_t | VALUE_OFFSET = 1 |
| ndn security v2 | CertificateBundleFetcher |
| ndn security v2 | CertificateCache |
| ndn security v2 CertificateFetcher | FromNetwork |
| ndn security v2 | CertificateFetcher |
| WireEncodable< Certificate > | |
| WireDecodable< Certificate > | |
| ndn security v2 | KeyChain |
| ndn security v2 | TrustAnchorGroup |
| ndn security v2 | ValidationState |
| ndn security v2 | Validator |
| typedef function<void(const Data& data)> ndn::security::v2::DataValidationSuccessCallback |
Callback to report a successful Data validation.
Definition at line 37 of file validation-callback.hpp.
| typedef function<void(const Data& data, const ValidationError& error)> ndn::security::v2::DataValidationFailureCallback |
Callback to report a failed Data validation.
Definition at line 42 of file validation-callback.hpp.
| typedef function<void(const Interest& interest)> ndn::security::v2::InterestValidationSuccessCallback |
Callback to report a successful Interest validation.
Definition at line 47 of file validation-callback.hpp.
| typedef function<void(const Interest& interest, const ValidationError& error)> ndn::security::v2::InterestValidationFailureCallback |
Callback to report a failed Interest validation.
Definition at line 52 of file validation-callback.hpp.
| Name ndn::security::v2::constructKeyName | ( | const Name & | identity, |
| const name::Component & | keyId | ||
| ) |
Construct key name based on the appropriate naming conventions.
Definition at line 143 of file key.cpp.
References ndn::Name::append(), and ndn::security::v2::Certificate::KEY_COMPONENT.
Referenced by ndn::security::tpm::BackEnd::constructAsymmetricKeyName(), and ndn::security::tpm::BackEnd::createKey().
| bool ndn::security::v2::isValidKeyName | ( | const Name & | keyName | ) |
Check if keyName follow the naming conventions for the key name.
Definition at line 153 of file key.cpp.
References ndn::Name::get(), ndn::security::v2::Certificate::KEY_COMPONENT, ndn::security::v2::Certificate::MIN_KEY_NAME_LENGTH, and ndn::Name::size().
Referenced by extractIdentityFromKeyName().
Extract identity namespace from the key name keyName.
Definition at line 160 of file key.cpp.
References ndn::Name::getPrefix(), isValidKeyName(), ndn::security::v2::Certificate::MIN_KEY_NAME_LENGTH, NDN_THROW, and ndn::Name::toUri().
Referenced by ndn::security::pib::KeyContainer::add(), ndn::security::v2::validator_config::NameRelationChecker::checkNames(), ndn::security::pib::KeyContainer::get(), ndn::security::pib::PibMemory::getKeysOfIdentity(), ndn::security::pib::KeyContainer::remove(), and ndn::security::pib::PibMemory::removeKey().
| ndn::security::v2::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS | ( | AdditionalDescription | ) |
| std::ostream & ndn::security::v2::operator<< | ( | std::ostream & | os, |
| const AdditionalDescription & | desc | ||
| ) |
Definition at line 166 of file additional-description.cpp.
References ndn::make_ostream_joiner().
| ndn::security::v2::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS | ( | AdditionalDescription | ) |
| std::ostream & ndn::security::v2::operator<< | ( | std::ostream & | os, |
| const Certificate & | cert | ||
| ) |
Definition at line 138 of file certificate.cpp.
References ndn::tlv::AdditionalDescription, ndn::security::transform::base64Encode(), ndn::Signature::getKeyLocator(), ndn::security::v2::Certificate::getKeyName(), ndn::Data::getName(), ndn::security::ValidityPeriod::getPeriod(), ndn::security::v2::Certificate::getPublicKey(), ndn::Data::getSignature(), ndn::Signature::getSignatureInfo(), ndn::Signature::getType(), ndn::SignatureInfo::getTypeSpecificTlv(), ndn::security::v2::Certificate::getValidityPeriod(), ndn::Signature::hasKeyLocator(), ndn::tlv::Name, ndn::security::transform::streamSink(), and ndn::time::toIsoString().
Extract identity namespace from the certificate name certName.
Definition at line 185 of file certificate.cpp.
References ndn::Name::getPrefix(), ndn::security::v2::Certificate::isValidName(), ndn::security::v2::Certificate::KEY_COMPONENT_OFFSET, NDN_THROW, and ndn::Name::toUri().
Extract key name from the certificate name certName.
Definition at line 196 of file certificate.cpp.
References ndn::Name::getPrefix(), ndn::security::v2::Certificate::isValidName(), ndn::security::v2::Certificate::KEY_ID_OFFSET, NDN_THROW, and ndn::Name::toUri().
Referenced by ndn::security::pib::CertificateContainer::get(), ndn::security::pib::PibMemory::getCertificatesOfKey(), ndn::security::pib::CertificateContainer::remove(), and ndn::security::pib::PibMemory::removeCertificate().
|
inlinestatic |
Definition at line 497 of file key-chain.cpp.
| std::ostream & ndn::security::v2::operator<< | ( | std::ostream & | os, |
| ValidationError::Code | code | ||
| ) |
Definition at line 30 of file validation-error.cpp.
References ndn::to_underlying().
| std::ostream & ndn::security::v2::operator<< | ( | std::ostream & | os, |
| const ValidationError & | error | ||
| ) |
Definition at line 67 of file validation-error.cpp.
References ndn::security::v2::ValidationError::getCode(), and ndn::security::v2::ValidationError::getInfo().
|
static |
Definition at line 64 of file validation-policy.cpp.
References ndn::tlv::DigestSha256, ndn::security::v2::ValidationState::fail(), ndn::security::SigningInfo::getDigestSha256Identity(), ndn::SignatureInfo::getKeyLocator(), ndn::KeyLocator::getName(), ndn::SignatureInfo::getSignatureType(), ndn::KeyLocator::getType(), ndn::SignatureInfo::hasKeyLocator(), ns3::ndn::Name, and ndn::tlv::Name.
Referenced by ndn::security::v2::ValidationPolicySimpleHierarchy::checkPolicy(), nfd::CommandAuthenticatorValidationPolicy::checkPolicy(), ndn::security::v2::validator_config::ValidationPolicyConfig::checkPolicy(), and getKeyLocatorName().
| Name ndn::security::v2::getKeyLocatorName | ( | const Data & | data, |
| ValidationState & | state | ||
| ) |
extract KeyLocator.Name from Data
Data must contain a KeyLocator of Name type. Otherwise, state.fail is invoked with INVALID_KEY_LOCATOR error.
Definition at line 85 of file validation-policy.cpp.
References getKeyLocatorName(), ndn::Data::getSignature(), and ndn::Signature::getSignatureInfo().
| Name ndn::security::v2::getKeyLocatorName | ( | const Interest & | interest, |
| ValidationState & | state | ||
| ) |
extract KeyLocator.Name from signed Interest
Interest must have SignatureInfo and contain a KeyLocator of Name type. Otherwise, state.fail is invoked with INVALID_KEY_LOCATOR error.
Definition at line 91 of file validation-policy.cpp.
References ndn::security::v2::ValidationState::fail(), getKeyLocatorName(), ndn::Interest::getName(), ndn::security::v2::ValidationError::INVALID_KEY_LOCATOR, ndn::signed_interest::MIN_SIZE, ns3::ndn::Name, ndn::signed_interest::POS_SIG_INFO, and ndn::SignatureInfo::wireDecode().
| security::v2::Validator & ndn::security::v2::getAcceptAllValidator | ( | ) |
Definition at line 36 of file validator-null.cpp.
| ndn::security::v2::WireEncodable< AdditionalDescription > |
Definition at line 1 of file additional-description.cpp.
| ndn::security::v2::WireEncodableWithEncodingBuffer< AdditionalDescription > |
Definition at line 1 of file additional-description.cpp.
| ndn::security::v2::WireDecodable< AdditionalDescription > |
Definition at line 1 of file additional-description.cpp.
|
static |
Definition at line 38 of file additional-description.cpp.
Referenced by ndn::security::v2::AdditionalDescription::wireDecode().
|
static |
Definition at line 39 of file additional-description.cpp.
Referenced by ndn::security::v2::AdditionalDescription::wireDecode().
| ndn security v2 ndn::security::v2::CertificateBundleFetcher |
Definition at line 30 of file certificate-bundle-fetcher.cpp.
| ndn security v2 ndn::security::v2::CertificateCache |
Definition at line 29 of file certificate-cache.cpp.
| ndn security v2 CertificateFetcher ndn::security::v2::FromNetwork |
Definition at line 30 of file certificate-fetcher-from-network.cpp.
| ndn security v2 ndn::security::v2::CertificateFetcher |
Definition at line 29 of file certificate-fetcher.cpp.
| ndn::security::v2::WireEncodable< Certificate > |
Definition at line 1 of file certificate.cpp.
| ndn::security::v2::WireDecodable< Certificate > |
Definition at line 1 of file certificate.cpp.
| ndn security v2 ndn::security::v2::KeyChain |
Definition at line 68 of file key-chain.cpp.
Referenced by ns3::ndn::StackHelper::getKeyChain().
| ndn security v2 ndn::security::v2::TrustAnchorGroup |
Definition at line 35 of file trust-anchor-group.cpp.
| ndn security v2 ndn::security::v2::ValidationState |
Definition at line 31 of file validation-state.cpp.
| ndn security v2 ndn::security::v2::Validator |
Definition at line 32 of file validator.cpp.
1.8.18