blob: 7ed800555e488b6f9e4732c6a02c0b1c313059c9 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013-2018 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
* ndn-cxx library is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received copies of the GNU General Public License and GNU Lesser
* General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
* <http://www.gnu.org/licenses/>.
*
* See AUTHORS.md for complete list of ndn-cxx authors and contributors.
*/
#include "controller.hpp"
#include "face.hpp"
#include "security/v2/key-chain.hpp"
#include "security/validator-null.hpp"
#include "util/segment-fetcher.hpp"
#include <boost/lexical_cast.hpp>
namespace ndn {
namespace nfd {
using ndn::util::SegmentFetcher;
const uint32_t Controller::ERROR_TIMEOUT = 10060; // WinSock ESAETIMEDOUT
const uint32_t Controller::ERROR_NACK = 10800; // 10000 + TLV-TYPE of Nack header
const uint32_t Controller::ERROR_VALIDATION = 10021; // 10000 + TLS1_ALERT_DECRYPTION_FAILED
const uint32_t Controller::ERROR_SERVER = 500;
const uint32_t Controller::ERROR_LBOUND = 400;
Controller::Controller(Face& face, KeyChain& keyChain, security::v2::Validator& validator)
: m_face(face)
, m_keyChain(keyChain)
, m_validator(validator)
, m_signer(keyChain)
{
}
void
Controller::startCommand(const shared_ptr<ControlCommand>& command,
const ControlParameters& parameters,
const CommandSucceedCallback& onSuccess1,
const CommandFailCallback& onFailure1,
const CommandOptions& options)
{
const CommandSucceedCallback& onSuccess = onSuccess1 ?
onSuccess1 : [] (const ControlParameters&) {};
const CommandFailCallback& onFailure = onFailure1 ?
onFailure1 : [] (const ControlResponse&) {};
Name requestName = command->getRequestName(options.getPrefix(), parameters);
Interest interest = m_signer.makeCommandInterest(requestName, options.getSigningInfo());
interest.setInterestLifetime(options.getTimeout());
m_face.expressInterest(interest,
[=] (const Interest&, const Data& data) {
this->processCommandResponse(data, command, onSuccess, onFailure);
},
[=] (const Interest&, const lp::Nack&) {
onFailure(ControlResponse(Controller::ERROR_NACK, "network Nack received"));
},
[=] (const Interest&) {
onFailure(ControlResponse(Controller::ERROR_TIMEOUT, "request timed out"));
});
}
void
Controller::processCommandResponse(const Data& data,
const shared_ptr<ControlCommand>& command,
const CommandSucceedCallback& onSuccess,
const CommandFailCallback& onFailure)
{
m_validator.validate(data,
[=] (const Data& data) {
this->processValidatedCommandResponse(data, command, onSuccess, onFailure);
},
[=] (const Data& data, const security::v2::ValidationError& error) {
onFailure(ControlResponse(ERROR_VALIDATION, boost::lexical_cast<std::string>(error)));
}
);
}
void
Controller::processValidatedCommandResponse(const Data& data,
const shared_ptr<ControlCommand>& command,
const CommandSucceedCallback& onSuccess,
const CommandFailCallback& onFailure)
{
ControlResponse response;
try {
response.wireDecode(data.getContent().blockFromValue());
}
catch (const tlv::Error& e) {
onFailure(ControlResponse(ERROR_SERVER, e.what()));
return;
}
uint32_t code = response.getCode();
if (code >= ERROR_LBOUND) {
onFailure(response);
return;
}
ControlParameters parameters;
try {
parameters.wireDecode(response.getBody());
}
catch (const tlv::Error& e) {
onFailure(ControlResponse(ERROR_SERVER, e.what()));
return;
}
try {
command->validateResponse(parameters);
}
catch (const ControlCommand::ArgumentError& e) {
onFailure(ControlResponse(ERROR_SERVER, e.what()));
return;
}
onSuccess(parameters);
}
void
Controller::fetchDataset(const Name& prefix,
const std::function<void(ConstBufferPtr)>& processResponse,
const DatasetFailCallback& onFailure,
const CommandOptions& options)
{
Interest baseInterest(prefix);
SegmentFetcher::Options fetcherOptions;
fetcherOptions.maxTimeout = options.getTimeout();
auto fetcher = SegmentFetcher::start(m_face, baseInterest, m_validator, fetcherOptions);
fetcher->onComplete.connect(processResponse);
fetcher->onError.connect([=] (uint32_t code, const std::string& msg) {
processDatasetFetchError(onFailure, code, msg);
});
}
void
Controller::processDatasetFetchError(const DatasetFailCallback& onFailure,
uint32_t code, std::string msg)
{
switch (static_cast<SegmentFetcher::ErrorCode>(code)) {
// It's intentional to cast as SegmentFetcher::ErrorCode, and to not have a 'default' clause.
// This forces the switch statement to handle every defined SegmentFetcher::ErrorCode,
// and breaks compilation if it does not.
case SegmentFetcher::ErrorCode::INTEREST_TIMEOUT:
onFailure(ERROR_TIMEOUT, msg);
break;
case SegmentFetcher::ErrorCode::DATA_HAS_NO_SEGMENT:
case SegmentFetcher::ErrorCode::FINALBLOCKID_NOT_SEGMENT:
onFailure(ERROR_SERVER, msg);
break;
case SegmentFetcher::ErrorCode::SEGMENT_VALIDATION_FAIL:
/// \todo When SegmentFetcher exposes validator error code, Controller::ERROR_VALIDATION
/// should be replaced with a range that corresponds to validator error codes.
onFailure(ERROR_VALIDATION, msg);
break;
case SegmentFetcher::ErrorCode::NACK_ERROR:
onFailure(ERROR_NACK, msg);
break;
}
}
} // namespace nfd
} // namespace ndn