blob: 945c16d49d1db073c28ef31585f0d7831875a1cf [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -08002/*
Alexander Afanasyev4c9a3d52017-01-03 17:45:19 -08003 * Copyright (c) 2013-2017 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * 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.
Alexander Afanasyeve289b532014-02-09 22:14:44 -080020 */
21
Junxiao Shi7357ef22016-09-07 02:39:37 +000022#include "controller.hpp"
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080023#include "face.hpp"
24#include "security/v2/key-chain.hpp"
25#include "security/validator-null.hpp"
26#include "util/segment-fetcher.hpp"
27
28#include <boost/lexical_cast.hpp>
Alexander Afanasyeve289b532014-02-09 22:14:44 -080029
30namespace ndn {
31namespace nfd {
32
Junxiao Shi034c1882016-06-24 18:06:51 +000033using ndn::util::SegmentFetcher;
34
Junxiao Shib1990df2015-11-05 00:14:44 +000035const uint32_t Controller::ERROR_TIMEOUT = 10060; // WinSock ESAETIMEDOUT
36const uint32_t Controller::ERROR_NACK = 10800; // 10000 + TLV-TYPE of Nack header
Junxiao Shi0f3f0b42016-07-14 13:26:37 +000037const uint32_t Controller::ERROR_VALIDATION = 10021; // 10000 + TLS1_ALERT_DECRYPTION_FAILED
Junxiao Shi5de006b2014-10-26 20:20:52 -070038const uint32_t Controller::ERROR_SERVER = 500;
39const uint32_t Controller::ERROR_LBOUND = 400;
40
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080041Controller::Controller(Face& face, KeyChain& keyChain, security::v2::Validator& validator)
Junxiao Shi70911652014-08-12 10:14:24 -070042 : m_face(face)
43 , m_keyChain(keyChain)
Junxiao Shi0f3f0b42016-07-14 13:26:37 +000044 , m_validator(validator)
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080045 , m_signer(keyChain)
Junxiao Shi70911652014-08-12 10:14:24 -070046{
47}
48
49void
50Controller::startCommand(const shared_ptr<ControlCommand>& command,
51 const ControlParameters& parameters,
Junxiao Shi600f7112016-07-16 11:57:18 +000052 const CommandSucceedCallback& onSuccess1,
53 const CommandFailCallback& onFailure1,
Junxiao Shi5de006b2014-10-26 20:20:52 -070054 const CommandOptions& options)
55{
Junxiao Shi600f7112016-07-16 11:57:18 +000056 const CommandSucceedCallback& onSuccess = onSuccess1 ?
57 onSuccess1 : [] (const ControlParameters&) {};
58 const CommandFailCallback& onFailure = onFailure1 ?
Junxiao Shie7c7f152016-08-20 22:36:22 +000059 onFailure1 : [] (const ControlResponse&) {};
Junxiao Shi600f7112016-07-16 11:57:18 +000060
Junxiao Shi5de006b2014-10-26 20:20:52 -070061 Name requestName = command->getRequestName(options.getPrefix(), parameters);
Alexander Afanasyev80782e02017-01-04 13:16:54 -080062 Interest interest = m_signer.makeCommandInterest(requestName, options.getSigningInfo());
Junxiao Shi5de006b2014-10-26 20:20:52 -070063 interest.setInterestLifetime(options.getTimeout());
Junxiao Shi5de006b2014-10-26 20:20:52 -070064
65 m_face.expressInterest(interest,
Junxiao Shie7c7f152016-08-20 22:36:22 +000066 [=] (const Interest&, const Data& data) {
67 this->processCommandResponse(data, command, onSuccess, onFailure);
68 },
69 [=] (const Interest&, const lp::Nack&) {
70 onFailure(ControlResponse(Controller::ERROR_NACK, "network Nack received"));
71 },
72 [=] (const Interest&) {
73 onFailure(ControlResponse(Controller::ERROR_TIMEOUT, "request timed out"));
74 });
Junxiao Shi5de006b2014-10-26 20:20:52 -070075}
76
77void
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070078Controller::processCommandResponse(const Data& data,
79 const shared_ptr<ControlCommand>& command,
80 const CommandSucceedCallback& onSuccess,
81 const CommandFailCallback& onFailure)
82{
Junxiao Shi54f727d2016-08-08 20:29:11 +000083 m_validator.validate(data,
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080084 [=] (const Data& data) {
85 this->processValidatedCommandResponse(data, command, onSuccess, onFailure);
Junxiao Shi54f727d2016-08-08 20:29:11 +000086 },
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080087 [=] (const Data& data, const security::v2::ValidationError& error) {
88 onFailure(ControlResponse(ERROR_VALIDATION, boost::lexical_cast<std::string>(error)));
Junxiao Shi54f727d2016-08-08 20:29:11 +000089 }
90 );
91}
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070092
Junxiao Shi54f727d2016-08-08 20:29:11 +000093void
94Controller::processValidatedCommandResponse(const Data& data,
95 const shared_ptr<ControlCommand>& command,
96 const CommandSucceedCallback& onSuccess,
97 const CommandFailCallback& onFailure)
98{
Junxiao Shi7b6b79d2014-03-26 20:59:35 -070099 ControlResponse response;
100 try {
101 response.wireDecode(data.getContent().blockFromValue());
102 }
Junxiao Shi600f7112016-07-16 11:57:18 +0000103 catch (const tlv::Error& e) {
Junxiao Shie7c7f152016-08-20 22:36:22 +0000104 onFailure(ControlResponse(ERROR_SERVER, e.what()));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700105 return;
106 }
107
108 uint32_t code = response.getCode();
Junxiao Shi5de006b2014-10-26 20:20:52 -0700109 if (code >= ERROR_LBOUND) {
Junxiao Shie7c7f152016-08-20 22:36:22 +0000110 onFailure(response);
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700111 return;
112 }
113
114 ControlParameters parameters;
115 try {
116 parameters.wireDecode(response.getBody());
117 }
Junxiao Shi600f7112016-07-16 11:57:18 +0000118 catch (const tlv::Error& e) {
Junxiao Shie7c7f152016-08-20 22:36:22 +0000119 onFailure(ControlResponse(ERROR_SERVER, e.what()));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700120 return;
121 }
122
123 try {
124 command->validateResponse(parameters);
125 }
Junxiao Shi600f7112016-07-16 11:57:18 +0000126 catch (const ControlCommand::ArgumentError& e) {
Junxiao Shie7c7f152016-08-20 22:36:22 +0000127 onFailure(ControlResponse(ERROR_SERVER, e.what()));
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700128 return;
129 }
130
Junxiao Shi600f7112016-07-16 11:57:18 +0000131 onSuccess(parameters);
Junxiao Shi7b6b79d2014-03-26 20:59:35 -0700132}
133
Junxiao Shi034c1882016-06-24 18:06:51 +0000134void
135Controller::fetchDataset(const Name& prefix,
136 const std::function<void(const ConstBufferPtr&)>& processResponse,
Junxiao Shie7c7f152016-08-20 22:36:22 +0000137 const DatasetFailCallback& onFailure,
Junxiao Shi034c1882016-06-24 18:06:51 +0000138 const CommandOptions& options)
139{
140 Interest baseInterest(prefix);
141 baseInterest.setInterestLifetime(options.getTimeout());
142
143 SegmentFetcher::fetch(m_face, baseInterest, m_validator, processResponse,
144 bind(&Controller::processDatasetFetchError, this, onFailure, _1, _2));
145}
146
147void
Junxiao Shie7c7f152016-08-20 22:36:22 +0000148Controller::processDatasetFetchError(const DatasetFailCallback& onFailure,
Junxiao Shi034c1882016-06-24 18:06:51 +0000149 uint32_t code, std::string msg)
150{
151 switch (static_cast<SegmentFetcher::ErrorCode>(code)) {
152 // It's intentional to cast as SegmentFetcher::ErrorCode, and to not have a 'default' clause.
153 // This forces the switch statement to handle every defined SegmentFetcher::ErrorCode,
154 // and breaks compilation if it does not.
155 case SegmentFetcher::ErrorCode::INTEREST_TIMEOUT:
156 onFailure(ERROR_TIMEOUT, msg);
157 break;
158 case SegmentFetcher::ErrorCode::DATA_HAS_NO_SEGMENT:
159 onFailure(ERROR_SERVER, msg);
160 break;
161 case SegmentFetcher::ErrorCode::SEGMENT_VALIDATION_FAIL:
Junxiao Shi0f3f0b42016-07-14 13:26:37 +0000162 /// \todo When SegmentFetcher exposes validator error code, Controller::ERROR_VALIDATION
163 /// should be replaced with a range that corresponds to validator error codes.
164 onFailure(ERROR_VALIDATION, msg);
Junxiao Shi034c1882016-06-24 18:06:51 +0000165 break;
166 case SegmentFetcher::ErrorCode::NACK_ERROR:
167 onFailure(ERROR_NACK, msg);
168 break;
169 }
170}
171
Alexander Afanasyeve289b532014-02-09 22:14:44 -0800172} // namespace nfd
173} // namespace ndn