Kea 2.7.0
http_control_socket.cc
Go to the documentation of this file.
1// Copyright (C) 2018-2024 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
9
10#include <config.h>
11
13#include <asiolink/io_service.h>
14#include <asiolink/tls_socket.h>
16#include <config/timeouts.h>
17#include <http/client.h>
19#include <http/response_json.h>
21
22using namespace std;
23using namespace isc::asiolink;
24using namespace isc::config;
25using namespace isc::data;
26using namespace isc::http;
27
28namespace isc {
29namespace netconf {
30
35
39
41HttpControlSocket::configGet(const string& service) {
42 if (service == "ca") {
43 return (sendCommand(createCommand("config-get")));
44 } else {
45 return (sendCommand(createCommand("config-get", service)));
46 }
47}
48
50HttpControlSocket::configTest(ElementPtr config, const string& service) {
51 if (service == "ca") {
52 return (sendCommand(createCommand("config-test", config)));
53 } else {
54 return (sendCommand(createCommand("config-test", config, service)));
55 }
56}
57
59HttpControlSocket::configSet(ElementPtr config, const string& service) {
60 if (service == "ca") {
61 return (sendCommand(createCommand("config-set", config)));
62 } else {
63 return (sendCommand(createCommand("config-set", config, service)));
64 }
65}
66
68HttpControlSocket::sendCommand(ConstElementPtr command) {
70 request.reset(new PostHttpRequestJson(HttpRequest::Method::HTTP_POST,
71 "/",
72 HttpVersion(1, 1)));
73 request->setBodyAsJson(command);
74 try {
75 request->finalize();
76 } catch (exception const& ex) {
77 isc_throw(ControlSocketError, "failed to create request: "
78 << ex.what());
79 }
80
81 IOServicePtr io_service(new IOService());
82 HttpClient client(io_service, false);
83 boost::system::error_code received_ec;
84 string receive_errmsg;
86
87 client.asyncSendRequest(getUrl(), TlsContextPtr(), request, response,
88 [&io_service, &received_ec, &receive_errmsg]
89 (const boost::system::error_code& ec,
90 const HttpResponsePtr&, const string& errmsg) {
91 // Capture error code and message.
92 received_ec = ec;
93 receive_errmsg = errmsg;
94 // Got the IO service so stop IO service.
95 // This causes to stop IO service when
96 // all handlers have been invoked.
97 io_service->stopWork();
98 },
100
101 // Perform this synchronously.
102 io_service->run();
103
104 client.stop();
105 io_service->stopAndPoll();
106
107 if (received_ec) {
108 // Got an error code.
109 isc_throw(ControlSocketError, "communication error (code): "
110 << received_ec.message());
111 }
112
113 if (!receive_errmsg.empty()) {
114 // Got an error message.
115 isc_throw(ControlSocketError, "communication error (message): "
116 << receive_errmsg);
117 }
118
119 if (!response) {
120 // Failed to get the answer.
121 isc_throw(ControlSocketError, "empty response");
122 }
123
124 try {
125 return (response->getBodyAsJson());
126 } catch (exception const& ex) {
127 isc_throw(ControlSocketError, "unparsable response: " << ex.what());
128 }
129}
130
131} // namespace netconf
132} // namespace isc
HTTP client class.
Definition client.h:86
Represents HTTP response with JSON content.
Represents HTTP POST request with JSON body.
Base class for control socket communication.
const isc::http::Url getUrl() const
Returns the HTTP server URL.
Class for control socket communication over HTTP socket.
data::ConstElementPtr configTest(data::ElementPtr config, const std::string &service) override final
Test configuration.
data::ConstElementPtr configSet(data::ElementPtr config, const std::string &service) override final
Set configuration.
data::ConstElementPtr configGet(const std::string &service) override final
Get configuration.
HttpControlSocket(CfgControlSocketPtr ctrl_sock)
Constructor.
This file contains several functions and constants that are used for handling commands and responses ...
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
Contains declarations for HTTP control socket communication.
ConstElementPtr createCommand(const std::string &command)
Creates a standard command message with no argument (of the form { "command": "my_command" })
constexpr long TIMEOUT_AGENT_FORWARD_COMMAND
Timeout for the Control Agent to forward command to a Kea server, e.g.
Definition timeouts.h:31
boost::shared_ptr< const Element > ConstElementPtr
Definition data.h:29
boost::shared_ptr< Element > ElementPtr
Definition data.h:28
boost::shared_ptr< PostHttpRequestJson > PostHttpRequestJsonPtr
Pointer to PostHttpRequestJson.
boost::shared_ptr< HttpResponseJson > HttpResponseJsonPtr
Pointer to the HttpResponseJson object.
boost::shared_ptr< HttpResponse > HttpResponsePtr
Pointer to the HttpResponse object.
Definition response.h:81
std::shared_ptr< HttpControlSocket > HttpControlSocketPtr
Type definition for the pointer to the HttpControlSocket.
std::shared_ptr< ControlSocketBase > ControlSocketBasePtr
Type definition for the pointer to the ControlSocketBase.
ControlSocketBasePtr createControlSocket< CfgControlSocket::Type::HTTP >(CfgControlSocketPtr ctrl_sock)
Factory template specialization for http control sockets.
std::shared_ptr< CfgControlSocket > CfgControlSocketPtr
Defines a pointer for CfgControlSocket instances.
Defines the logger used by the top-level component of kea-lfc.
HTTP request/response timeout value.
Definition client.h:89
HTTP protocol version.
Definition http_types.h:14