Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /** |
| 3 | * Copyright (c) 2013-2017 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 | |
| 22 | #include "validator.hpp" |
| 23 | |
| 24 | #include "face.hpp" |
| 25 | #include "security/transform/public-key.hpp" |
| 26 | #include "util/logger.hpp" |
| 27 | |
| 28 | namespace ndn { |
| 29 | namespace security { |
| 30 | namespace v2 { |
| 31 | |
| 32 | NDN_LOG_INIT(ndn.security.v2.Validator); |
| 33 | |
| 34 | #define NDN_LOG_DEBUG_DEPTH(x) NDN_LOG_DEBUG(std::string(state->getDepth() + 1, '>') << " " << x) |
| 35 | #define NDN_LOG_TRACE_DEPTH(x) NDN_LOG_TRACE(std::string(state->getDepth() + 1, '>') << " " << x) |
| 36 | |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 37 | Validator::Validator(unique_ptr<ValidationPolicy> policy, unique_ptr<CertificateFetcher> certFetcher) |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 38 | : m_policy(std::move(policy)) |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 39 | , m_certFetcher(std::move(certFetcher)) |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 40 | , m_maxDepth(25) |
| 41 | { |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 42 | BOOST_ASSERT(m_policy != nullptr); |
| 43 | BOOST_ASSERT(m_certFetcher != nullptr); |
| 44 | m_certFetcher->setCertificateStorage(*this); |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 45 | } |
| 46 | |
| 47 | Validator::~Validator() = default; |
| 48 | |
| 49 | void |
| 50 | Validator::setMaxDepth(size_t depth) |
| 51 | { |
| 52 | m_maxDepth = depth; |
| 53 | } |
| 54 | |
| 55 | size_t |
| 56 | Validator::getMaxDepth() const |
| 57 | { |
| 58 | return m_maxDepth; |
| 59 | } |
| 60 | |
| 61 | void |
| 62 | Validator::validate(const Data& data, |
| 63 | const DataValidationSuccessCallback& successCb, |
| 64 | const DataValidationFailureCallback& failureCb) |
| 65 | { |
| 66 | auto state = make_shared<DataValidationState>(data, successCb, failureCb); |
| 67 | NDN_LOG_DEBUG_DEPTH("Start validating data " << data.getName()); |
| 68 | |
| 69 | m_policy->checkPolicy(data, state, |
| 70 | [this] (const shared_ptr<CertificateRequest>& certRequest, const shared_ptr<ValidationState>& state) { |
| 71 | if (certRequest == nullptr) { |
| 72 | state->bypassValidation(); |
| 73 | } |
| 74 | else { |
| 75 | // need to fetch key and validate it |
| 76 | requestCertificate(certRequest, state); |
| 77 | } |
| 78 | }); |
| 79 | } |
| 80 | |
| 81 | void |
| 82 | Validator::validate(const Interest& interest, |
| 83 | const InterestValidationSuccessCallback& successCb, |
| 84 | const InterestValidationFailureCallback& failureCb) |
| 85 | { |
| 86 | auto state = make_shared<InterestValidationState>(interest, successCb, failureCb); |
| 87 | NDN_LOG_DEBUG_DEPTH("Start validating interest " << interest.getName()); |
| 88 | |
| 89 | m_policy->checkPolicy(interest, state, |
| 90 | [this] (const shared_ptr<CertificateRequest>& certRequest, const shared_ptr<ValidationState>& state) { |
| 91 | if (certRequest == nullptr) { |
| 92 | state->bypassValidation(); |
| 93 | } |
| 94 | else { |
| 95 | // need to fetch key and validate it |
| 96 | requestCertificate(certRequest, state); |
| 97 | } |
| 98 | }); |
| 99 | } |
| 100 | |
| 101 | void |
| 102 | Validator::validate(const Certificate& cert, const shared_ptr<ValidationState>& state) |
| 103 | { |
| 104 | NDN_LOG_DEBUG_DEPTH("Start validating certificate " << cert.getName()); |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 105 | |
| 106 | if (!cert.isValid()) { |
| 107 | return state->fail({ValidationError::Code::EXPIRED_CERT, "Retrieved certificate is not yet valid or expired " |
| 108 | "`" + cert.getName().toUri() + "`"}); |
| 109 | } |
| 110 | |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 111 | m_policy->checkPolicy(cert, state, |
| 112 | [this, cert] (const shared_ptr<CertificateRequest>& certRequest, const shared_ptr<ValidationState>& state) { |
| 113 | if (certRequest == nullptr) { |
| 114 | state->fail({ValidationError::POLICY_ERROR, "Validation policy is not allowed to designate `" + |
| 115 | cert.getName().toUri() + "` as a trust anchor"}); |
| 116 | } |
| 117 | else { |
| 118 | // need to fetch key and validate it |
| 119 | state->addCertificate(cert); |
| 120 | requestCertificate(certRequest, state); |
| 121 | } |
| 122 | }); |
| 123 | } |
| 124 | |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 125 | void |
| 126 | Validator::requestCertificate(const shared_ptr<CertificateRequest>& certRequest, |
| 127 | const shared_ptr<ValidationState>& state) |
| 128 | { |
| 129 | // TODO configurable check for the maximum number of steps |
| 130 | if (state->getDepth() >= m_maxDepth) { |
| 131 | state->fail({ValidationError::Code::EXCEEDED_DEPTH_LIMIT, |
| 132 | "Exceeded validation depth limit (" + to_string(m_maxDepth) + ")"}); |
| 133 | return; |
| 134 | } |
| 135 | |
| 136 | NDN_LOG_DEBUG_DEPTH("Retrieving " << certRequest->m_interest.getName()); |
| 137 | |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 138 | auto cert = findTrustedCert(certRequest->m_interest); |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 139 | if (cert != nullptr) { |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 140 | NDN_LOG_TRACE_DEPTH("Found trusted certificate " << cert->getName()); |
| 141 | |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 142 | cert = state->verifyCertificateChain(*cert); |
| 143 | if (cert != nullptr) { |
| 144 | state->verifyOriginalPacket(*cert); |
| 145 | } |
| 146 | for (auto trustedCert = std::make_move_iterator(state->m_certificateChain.begin()); |
| 147 | trustedCert != std::make_move_iterator(state->m_certificateChain.end()); |
| 148 | ++trustedCert) { |
| 149 | cacheVerifiedCertificate(*trustedCert); |
| 150 | } |
| 151 | return; |
| 152 | } |
| 153 | |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 154 | m_certFetcher->fetch(certRequest, state, [this] (const Certificate& cert, const shared_ptr<ValidationState>& state) { |
| 155 | validate(cert, state); |
| 156 | }); |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | //////////////////////////////////////////////////////////////////////// |
| 160 | // Trust anchor management |
| 161 | //////////////////////////////////////////////////////////////////////// |
| 162 | |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 163 | // to change visibility from protected to public |
| 164 | |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 165 | void |
| 166 | Validator::loadAnchor(const std::string& groupId, Certificate&& cert) |
| 167 | { |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 168 | CertificateStorage::loadAnchor(groupId, std::move(cert)); |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | void |
| 172 | Validator::loadAnchor(const std::string& groupId, const std::string& certfilePath, |
| 173 | time::nanoseconds refreshPeriod, bool isDir) |
| 174 | { |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 175 | CertificateStorage::loadAnchor(groupId, certfilePath, refreshPeriod, isDir); |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 176 | } |
| 177 | |
| 178 | void |
| 179 | Validator::cacheVerifiedCertificate(Certificate&& cert) |
| 180 | { |
Alexander Afanasyev | 7bc10fa | 2017-01-13 16:56:26 -0800 | [diff] [blame] | 181 | CertificateStorage::cacheVerifiedCert(std::move(cert)); |
Alexander Afanasyev | 7e72141 | 2017-01-11 13:36:08 -0800 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | } // namespace v2 |
| 185 | } // namespace security |
| 186 | } // namespace ndn |