NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
validation-error.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2020 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
23 
24 #include <ostream>
25 
26 namespace ndn {
27 namespace security {
28 inline namespace v2 {
29 
30 std::ostream&
31 operator<<(std::ostream& os, ValidationError::Code code)
32 {
33  switch (code) {
34  case ValidationError::Code::NO_ERROR:
35  return os << "No error";
36  case ValidationError::Code::INVALID_SIGNATURE:
37  return os << "Invalid signature";
38  case ValidationError::Code::NO_SIGNATURE:
39  return os << "Missing signature";
40  case ValidationError::Code::CANNOT_RETRIEVE_CERT:
41  return os << "Cannot retrieve certificate";
42  case ValidationError::Code::EXPIRED_CERT:
43  return os << "Certificate expired";
44  case ValidationError::Code::LOOP_DETECTED:
45  return os << "Loop detected in certification chain";
46  case ValidationError::Code::MALFORMED_CERT:
47  return os << "Malformed certificate";
48  case ValidationError::Code::EXCEEDED_DEPTH_LIMIT:
49  return os << "Exceeded validation depth limit";
50  case ValidationError::Code::INVALID_KEY_LOCATOR:
51  return os << "Key locator violates validation policy";
52  case ValidationError::Code::POLICY_ERROR:
53  return os << "Validation policy error";
54  case ValidationError::Code::IMPLEMENTATION_ERROR:
55  return os << "Internal implementation error";
56  case ValidationError::Code::USER_MIN:
57  break;
58  }
59  if (code >= ValidationError::Code::USER_MIN) {
60  return os << "Custom error code " << to_underlying(code);
61  }
62  else {
63  return os << "Unrecognized error code " << to_underlying(code);
64  }
65 }
66 
67 std::ostream&
68 operator<<(std::ostream& os, const ValidationError& error)
69 {
70  os << static_cast<ValidationError::Code>(error.getCode());
71  if (!error.getInfo().empty()) {
72  os << " (" << error.getInfo() << ")";
73  }
74  return os;
75 }
76 
77 } // inline namespace v2
78 } // namespace security
79 } // namespace ndn
Copyright (c) 2011-2015 Regents of the University of California.
Code
Known validation error codes.
const std::string & getInfo() const
std::ostream & operator<<(std::ostream &os, const AdditionalDescription &desc)
NDN_CXX_NODISCARD constexpr std::underlying_type_t< T > to_underlying(T val) noexcept
Definition: backports.hpp:125
Validation error code and optional detailed error message.