arangodb/arangod/GeneralServer/AcceptorTcp.cpp

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2016 ArangoDB GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Andreas Streichardt
////////////////////////////////////////////////////////////////////////////////

#include "AcceptorTcp.h"

#include "Basics/Common.h"
#include "Basics/Exceptions.h"
#include "Endpoint/ConnectionInfo.h"
#include "Endpoint/EndpointIp.h"
#include "GeneralServer/GeneralServer.h"
#include "GeneralServer/HttpCommTask.h"
#include "Logger/LogMacros.h"
#include "Logger/Logger.h"
#include "Logger/LoggerStream.h"

using namespace arangodb;
using namespace arangodb::rest;

namespace arangodb {
namespace rest {

template <SocketType T>
void AcceptorTcp<T>::open() {
  asio_ns::ip::tcp::resolver resolver(_ctx.io_context);

  std::string hostname = _endpoint->host();
  int portNumber = _endpoint->port();

  asio_ns::ip::tcp::endpoint asioEndpoint;
  asio_ns::error_code ec;
  auto address = asio_ns::ip::address::from_string(hostname, ec);
  if (!ec) {
    asioEndpoint = asio_ns::ip::tcp::endpoint(address, portNumber);
  } else {  // we need to resolve the string containing the ip
    std::unique_ptr<asio_ns::ip::tcp::resolver::query> query;
    if (_endpoint->domain() == AF_INET6) {
      query.reset(new asio_ns::ip::tcp::resolver::query(asio_ns::ip::tcp::v6(), hostname,
                                                        std::to_string(portNumber)));
    } else if (_endpoint->domain() == AF_INET) {
      query.reset(new asio_ns::ip::tcp::resolver::query(asio_ns::ip::tcp::v4(), hostname,
                                                        std::to_string(portNumber)));
    } else {
      THROW_ARANGO_EXCEPTION(TRI_ERROR_IP_ADDRESS_INVALID);
    }

    asio_ns::ip::tcp::resolver::iterator iter = resolver.resolve(*query, ec);
    if (ec) {
      LOG_TOPIC("383bc", ERR, Logger::COMMUNICATION)
          << "unable to to resolve endpoint ' " << _endpoint->specification()
          << "': " << ec.message();
      throw std::runtime_error(ec.message());
    }

    if (asio_ns::ip::tcp::resolver::iterator{} == iter) {
      LOG_TOPIC("05077", ERR, Logger::COMMUNICATION)
          << "unable to to resolve endpoint: endpoint is default constructed";
    }

    asioEndpoint = iter->endpoint();  // function not documented in boost?!
  }
  _acceptor.open(asioEndpoint.protocol());

#ifdef _WIN32
  // on Windows everything is different of course:
  // we need to set SO_EXCLUSIVEADDRUSE to prevent others from binding to our
  // ip/port.
  // https://msdn.microsoft.com/en-us/library/windows/desktop/ms740621(v=vs.85).aspx
  BOOL trueOption = 1;

  if (::setsockopt(_acceptor.native_handle(), SOL_SOCKET, SO_EXCLUSIVEADDRUSE,
                   (char const*)&trueOption, sizeof(BOOL)) != 0) {
    LOG_TOPIC("1bcff", ERR, Logger::COMMUNICATION)
        << "unable to set acceptor socket option: " << WSAGetLastError();
    THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_FAILED,
                                   "unable to set acceptor socket option");
  }
#else
  _acceptor.set_option(asio_ns::ip::tcp::acceptor::reuse_address(
      ((EndpointIp*)_endpoint)->reuseAddress()));
#endif

  _acceptor.bind(asioEndpoint, ec);
  if (ec) {
    LOG_TOPIC("874fa", ERR, Logger::COMMUNICATION)
        << "unable to bind to endpoint '" << _endpoint->specification()
        << "': " << ec.message();
    throw std::runtime_error(ec.message());
  }

  TRI_ASSERT(_endpoint->listenBacklog() > 8);
  _acceptor.listen(_endpoint->listenBacklog(), ec);
  if (ec) {
    LOG_TOPIC("c487e", ERR, Logger::COMMUNICATION)
        << "unable to listen to endpoint '" << _endpoint->specification()
        << ": " << ec.message();
    throw std::runtime_error(ec.message());
  }
  _open = true;
  
  LOG_TOPIC("853a9", DEBUG, arangodb::Logger::COMMUNICATION)
      << "successfully opened acceptor TCP";

  asyncAccept();
}

template <SocketType T>
void AcceptorTcp<T>::close() {
  if (_asioSocket) {
    _asioSocket->timer.cancel();
  }
  if (_open) {
    _acceptor.close();
    if (_asioSocket) {
      asio_ns::error_code ec;
      _asioSocket->shutdown(ec);
    }
  }
  _open = false;
}

template <>
void AcceptorTcp<SocketType::Tcp>::asyncAccept() {
  TRI_ASSERT(!_asioSocket);
  TRI_ASSERT(_endpoint->encryption() == Endpoint::EncryptionType::NONE);

  _asioSocket.reset(new AsioSocket<SocketType::Tcp>(_server.selectIoContext()));
  auto handler = [this](asio_ns::error_code const& ec) {
    if (ec) {
      handleError(ec);
      return;
    }

    // set the endpoint
    ConnectionInfo info;
    info.endpoint = _endpoint->specification();
    info.endpointType = _endpoint->domainType();
    info.encryptionType = _endpoint->encryption();
    info.serverAddress = _endpoint->host();
    info.serverPort = _endpoint->port();

    std::unique_ptr<AsioSocket<SocketType::Tcp>> as = std::move(_asioSocket);
    info.clientAddress = as->peer.address().to_string();
    info.clientPort = as->peer.port();

    LOG_TOPIC("853aa", DEBUG, arangodb::Logger::COMMUNICATION)
        << "accepted connection from " << info.clientAddress << ":" << info.clientPort;

    auto commTask =
        std::make_shared<HttpCommTask<SocketType::Tcp>>(_server, std::move(info),
                                                        std::move(as));
    _server.registerTask(std::move(commTask));
    this->asyncAccept();
  };

  // cppcheck-suppress accessMoved
  _acceptor.async_accept(_asioSocket->socket, _asioSocket->peer, std::move(handler));
}

template <>
void AcceptorTcp<SocketType::Tcp>::performHandshake(std::unique_ptr<AsioSocket<SocketType::Tcp>> proto) {
  TRI_ASSERT(false);  // MSVC requires the implementation to exist
}

template <>
void AcceptorTcp<SocketType::Ssl>::performHandshake(std::unique_ptr<AsioSocket<SocketType::Ssl>> proto) {
  // io_context is single-threaded, no sync needed
  auto* ptr = proto.get();
  proto->timer.expires_from_now(std::chrono::seconds(60));
  proto->timer.async_wait([ptr](asio_ns::error_code const& ec) {
    if (ec) {  // canceled
      return;
    }
    asio_ns::error_code err;
    ptr->shutdown(err);  // ignore error
  });

  auto cb = [this, as = std::move(proto)](asio_ns::error_code const& ec) mutable {
    as->timer.cancel();
    if (ec) {
      LOG_TOPIC("4c6b4", DEBUG, arangodb::Logger::COMMUNICATION)
          << "error during TLS handshake: '" << ec.message() << "'";
      asio_ns::error_code err;
      as->shutdown(err);  // ignore error
      return;
    }

    // set the endpoint
    ConnectionInfo info;
    info.endpoint = _endpoint->specification();
    info.endpointType = _endpoint->domainType();
    info.encryptionType = _endpoint->encryption();
    info.serverAddress = _endpoint->host();
    info.serverPort = _endpoint->port();

    info.clientAddress = as->peer.address().to_string();
    info.clientPort = as->peer.port();

    auto commTask =
        std::make_unique<HttpCommTask<SocketType::Ssl>>(_server, std::move(info),
                                                        std::move(as));
    _server.registerTask(std::move(commTask));
  };
  ptr->handshake(std::move(cb));
}

template <>
void AcceptorTcp<SocketType::Ssl>::asyncAccept() {
  TRI_ASSERT(!_asioSocket);
  TRI_ASSERT(_endpoint->encryption() == Endpoint::EncryptionType::SSL);

  // select the io context for this socket
  auto& ctx = _server.selectIoContext();

  _asioSocket = std::make_unique<AsioSocket<SocketType::Ssl>>(ctx, _server.sslContext());
  auto handler = [this](asio_ns::error_code const& ec) {
    if (ec) {
      handleError(ec);
      return;
    }

    performHandshake(std::move(_asioSocket));
    this->asyncAccept();
  };

  // cppcheck-suppress accessMoved
  _acceptor.async_accept(_asioSocket->socket.lowest_layer(), _asioSocket->peer,
                         std::move(handler));
}
}  // namespace rest
}  // namespace arangodb

template class arangodb::rest::AcceptorTcp<SocketType::Tcp>;
template class arangodb::rest::AcceptorTcp<SocketType::Ssl>;