HttpsServer.cpp 14.9 KB
Newer Older
1
2
3
4
5
6
7
8
/*
 * HttpsServer.cpp
 *
 *  Created on: 25.05.2018
 *      Author: Micha Mueller
 */

#include "HttpsServer.h"
9
#include "timestamp.h"
10

11
#include <iostream>
12
13
#include <memory>
#include <functional>
14
#include <string>
15

16
#include <boost/property_tree/ptree.hpp>
Alessio Netti's avatar
Alessio Netti committed
17
#include <boost/property_tree/json_parser.hpp>
Micha Mueller's avatar
Micha Mueller committed
18
19
#include <boost/algorithm/string/split.hpp>

20
21
#define LOGH(sev) LOG(sev) << "HttpsServer: "

22
23
HttpsServer::requestHandler::requestHandler(HttpsServer& httpsServer) :	_httpsServer(httpsServer) {}

24
void HttpsServer::requestHandler::operator()(server::request const &request, server::connection_ptr connection) {
25
	//first log some info about client
26
27
28
	server::string_type ip = source(request);
	unsigned int port = request.source_port;

29
	LOGH(info) << ip << ":" << port << " connected";
30

31
	//set appropriate default value to connection status
Micha Mueller's avatar
Micha Mueller committed
32
33
34
	connection->set_status(server::connection::internal_server_error);

	std::ostringstream data;
35
36

	boost::network::uri::uri uri("https://" + request.destination);
Micha Mueller's avatar
Micha Mueller committed
37
	server::string_type method = request.method;
38
39
40
41
42
	server::string_type path = uri.path();
	server::string_type query = uri.query();

	std::string response = "";
	std::string auth_value = "";
43
	bool json = false;
44
45
	std::vector<std::string> pathStrs;
	std::vector<std::pair<std::string, std::string>> queries;
46

Micha Mueller's avatar
Micha Mueller committed
47
48
	//first check if request is supported at all
	if (method != "GET" && method != "PUT") {
49
		LOGH(warning) << "Unsupported " << method << " request was made";
Micha Mueller's avatar
Micha Mueller committed
50
		connection->set_status(server::connection::not_supported);
51
52
		goto error;
	}
53

54
	LOGH(info) << method << " request of " << request.destination << " was made";
Micha Mueller's avatar
Micha Mueller committed
55

56
57
58
59
60
61
62
63
	//do some string processing
	//split path into its hierarchical parts
	if (path.size() >= 2) {
		if (path[0] == '/') {
			path.erase(0,1);
		}
		if (path[path.size() -1] == '/') {
			path.erase(path.size() -1);
Micha Mueller's avatar
Micha Mueller committed
64
		}
65

66
67
68
69
		boost::split(pathStrs, path, boost::is_any_of("/"), boost::token_compress_off);
	}

	//split query part into the individual queries (key-value pairs)
Micha Mueller's avatar
Micha Mueller committed
70
71
	{	//do not remove the enclosing brackets
		//need to encapsulate this code block to keep queryStrs local
Micha Mueller's avatar
Micha Mueller committed
72
73
74
75
		std::vector<std::string> queryStrs;
		boost::split(queryStrs, query, boost::is_any_of(";"), boost::token_compress_on);
		for(auto& key : queryStrs) {
			size_t pos = key.find("=");
76
			if (pos != std::string::npos) {
Micha Mueller's avatar
Micha Mueller committed
77
78
79
80
				std::string value;
				value = key.substr(pos+1);
				key.erase(pos);
				queries.push_back(std::make_pair(key, value));
81
82
			}
		}
83
84
	}
	//finished string processing
85

86
	for (auto& p : queries) {
87
		//authkey is required in every case
88
89
		if (p.first == "authkey") {
			auth_value = p.second;
90
91
92
93
		} else if (p.first == "json") {
			if (stoi(p.second) > 0) {
				json = true;
			}
94
		}
95
	}
96

97
	if (pathStrs.size() < 1) {
98
		LOGH(warning) << "Received malformed request: No first path part";
99
100
101
102
103
104
105
106
		connection->set_status(server::connection::bad_request);
		goto error;
	}

	//select code depending on request
	if (method == "GET") {
		if (pathStrs[0] == "help") {
			response = "dcdbpusher RESTful API cheatsheet:\n"
107
					   " -GET:  /help     This help message\n"
Alessio Netti's avatar
Alessio Netti committed
108
109
                       "        /analytics/help\n"
                       "                  An help message for data analytics commands\n"
110
111
112
113
114
115
116
117
118
119
120
					   "        /plugins  List of currently loaded plugins (Discovery)\n"
					   "        /[plugin]/sensors\n"
					   "                  List of currently running sensors which belong\n"
					   "                  to the specified plugin (Discovery)\n"
					   "        /[plugin]/[sensor]/avg?interval=[timeInSec]\n"
					   "                  Average of last sensor readings from the last\n"
					   "                  [interval] seconds or of all cached readings\n"
					   "                  if no interval is given\n"
					   " -PUT:  /[plugin]/[start|stop|reload]\n"
					   "                  Start/stop the sensors of the plugin or\n"
					   "                  reload the plugin configuration\n"
Alessio Netti's avatar
Alessio Netti committed
121
122
123
124
125
					   "\n";
					   //"All resources have to be prepended by host:port and need at\n"
					   //"least the query ?authkey=[token] at the end. Multiple queries\n"
					   //"need to be separated by semicolons(';')\n";
            response += _httpsServer._manager->restCheatSheet;
Micha Mueller's avatar
Micha Mueller committed
126
		} else {
127
128
129
130
			//first check permission
			if (!_httpsServer.check_authkey(auth_value, permission::GETReq)) {
				LOGH(warning) << "Provided authentication token has insufficient permissions";
				connection->set_status(server::connection::unauthorized);
131
132
				goto error;
			}
133

Alessio Netti's avatar
Alessio Netti committed
134
135
136
			//Managing REST GET commands to the data analytics framework
			if(pathStrs[0] == "analytics") {
				try {
Alessio Netti's avatar
Alessio Netti committed
137
138
139
					restResponse_t reply = _httpsServer._manager->REST(pathStrs, queries, method, _httpsServer._io);
					data << reply.data;
					response = reply.response;
Alessio Netti's avatar
Alessio Netti committed
140
141
142
143
144
145
146
147
148
149
150
151
152
				} catch(const std::invalid_argument &e) {
					LOGH(warning) << e.what();
					connection->set_status(server::connection::bad_request);
					goto error;
				} catch(const std::domain_error &e) {
					response = e.what();
					connection->set_status(server::connection::not_found);
				} catch(const std::exception &e) {
					LOGH(warning) << e.what();
					connection->set_status(server::connection::internal_server_error);
					goto error;
				}
			} else if (pathStrs[0] == "plugins") {
153
154
155
156
157
158
				if (json) {
					boost::property_tree::ptree root, plugins;
					for(auto& p : _httpsServer._plugins) {
						plugins.put(p.id, "");
					}
					root.add_child("plugins", plugins);
Alessio Netti's avatar
Alessio Netti committed
159
					boost::property_tree::write_json(data, root, true);
160
161
162
				} else {
					for(auto& p : _httpsServer._plugins) {
						data << p.id << "\n";
163
164
					}
				}
165
			} else {
166
167
168
				//do some prior checks
				if (pathStrs.size() < 2) {
					LOGH(warning) << "Received malformed request: No second path part";
Micha Mueller's avatar
Micha Mueller committed
169
					connection->set_status(server::connection::bad_request);
170
171
					goto error;
				}
172

173
174
175
				if (pathStrs[1] == "sensors") {
					response = "Plugin not found!";
					connection->set_status(server::connection::not_found);
176

177
178
179
180
					for(auto& p : _httpsServer._plugins) {
						if (p.id == pathStrs[0]) {
							if (json) {
								boost::property_tree::ptree root, sensors;
181

182
183
184
185
186
187
188
189
								for(auto g : p.configurator->getSensorGroups()) {
									boost::property_tree::ptree group;
									for(auto s : g->getSensors()) {
										group.put(s->getName(), s->getMqtt());
									}
									sensors.add_child(g->getGroupName(), group);
								}
								root.add_child(p.id, sensors);
Alessio Netti's avatar
Alessio Netti committed
190
								boost::property_tree::write_json(data, root, true);
191
192
193
194
195
196
197
198
199
200
201
							} else {
								for(auto g : p.configurator->getSensorGroups()) {
									for(auto s : g->getSensors()) {
										data << g->getGroupName() << "." << s->getName() << " " << s->getMqtt() << "\n";
									}
								}
							}
							response = "";
							connection->set_status(server::connection::ok);
							break;
						}
Micha Mueller's avatar
Micha Mueller committed
202
					}
203
				} else {
204

205
206
207
208
209
					if (pathStrs.size() < 3) {
						LOGH(warning) << "Received malformed request: No third path part";
						connection->set_status(server::connection::bad_request);
						goto error;
					}
210

211
212
213
214
215
					if (pathStrs[2] != "avg") {
						LOGH(warning) << "Unknown action " << pathStrs[2] << " requested";
						connection->set_status(server::connection::not_supported);
						goto error;
					}
216

217
218
219
					std::string sensor = pathStrs[1];
					std::string action = pathStrs[2];
					uint64_t time = 0;
220

221
222
223
224
225
226
					for (auto& p : queries) {
						if (p.first == "interval") {
							time = getTimestamp();
							time -= S_TO_NS(std::stoul(p.second));
						}
					}
227

228
					//process actual request
Alessio Netti's avatar
Alessio Netti committed
229
					bool found = false;
230
231
					response = "Plugin not found!";
					connection->set_status(server::connection::not_found);
232

233
234
235
					for(auto& p : _httpsServer._plugins) {
						if (p.id == pathStrs[0]) {
							response = "Sensor not found!";
Michael Ott's avatar
Michael Ott committed
236
237
							for(const auto& g : p.configurator->getSensorGroups()) {
								for(const auto& s : g->getSensors()) {
238
									if (s->getName() == sensor) {
Alessio Netti's avatar
Alessio Netti committed
239
										found = true;
Michael Ott's avatar
Michael Ott committed
240
										response = pathStrs[0] + "::" + sensor + _httpsServer.calcAvg(*s, time);
241
242
243
										connection->set_status(server::connection::ok);
										break;
									}
244
245
246
								}
							}
						}
247
					}
Alessio Netti's avatar
Alessio Netti committed
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

					if(!found) {
						for(auto& p : _httpsServer._manager->getPlugins())
							if (p.id == pathStrs[0]) {
								response = "Sensor not found!";
								for(const auto& a : p.configurator->getAnalyzers())
									if(a->getStreaming())
										for(const auto& u : a->getUnits())
											for (const auto& s : u->getBaseOutputs())
												if (s->getName() == sensor) {
													found = true;
													response = pathStrs[0] + "::" + sensor + _httpsServer.calcAvg(*s, time);
													connection->set_status(server::connection::ok);
													break;
												}
							}
					}
265
266
267
268
				}
			}
		}
	} else if (method == "PUT") {
269

270
271
		//first check permission
		if (!_httpsServer.check_authkey(auth_value, permission::PUTReq)) {
272
			LOGH(warning) << "Provided authentication token has insufficient permissions";
273
274
275
			connection->set_status(server::connection::unauthorized);
			goto error;
		}
276

Alessio Netti's avatar
Alessio Netti committed
277
278
279
280
281
282
283
284
		//Managing REST PUT commands to the data analytics framework
		if(pathStrs[0] == "analytics") {
			if( pathStrs.back() == "reload" ) {
				_httpsServer._mqttPusher->halt();
				// Wait until MQTTPusher is paused in order to reload plugins
				while (!_httpsServer._mqttPusher->isHalted()) { sleep(1); }
			}
			try {
Alessio Netti's avatar
Alessio Netti committed
285
286
287
				restResponse_t reply = _httpsServer._manager->REST(pathStrs, queries, method, _httpsServer._io);
				data << reply.data;
				response = reply.response;
Alessio Netti's avatar
Alessio Netti committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
			} catch(const std::invalid_argument &e) {
				LOGH(warning) << e.what();
				connection->set_status(server::connection::bad_request);
				goto error;
			} catch(const std::domain_error &e) {
				response = e.what();
				connection->set_status(server::connection::not_found);
			} catch(const std::exception &e) {
				response = e.what();
				connection->set_status(server::connection::internal_server_error);
			}
			// Continue MQTTPusher when a reload was performed
			if( pathStrs.back() == "reload" )
				_httpsServer._mqttPusher->cont();
		} else {

			if (pathStrs.size() < 2) {
				LOGH(warning) << "Received malformed request: No second path part";
				connection->set_status(server::connection::bad_request);
				goto error;
			}
309

Alessio Netti's avatar
Alessio Netti committed
310
			std::string action = pathStrs[1];
311

Alessio Netti's avatar
Alessio Netti committed
312
313
314
			//process actual request
			response = "Plugin not found!";
			connection->set_status(server::connection::not_found);
315

Alessio Netti's avatar
Alessio Netti committed
316
317
318
319
320
321
322
323
324
325
			//switch code depending on selected action
			if (action == "start") {
				for (auto &p : _httpsServer._plugins) {
					if (p.id == pathStrs[0]) {
						for (const auto &g : p.configurator->getSensorGroups()) {
							g->start();
						}
						response = "Plugin " + pathStrs[0] + ": Sensors started";
						connection->set_status(server::connection::ok);
						break;
326
					}
327
				}
Alessio Netti's avatar
Alessio Netti committed
328
329
330
331
332
333
334
335
336
			} else if (action == "stop") {
				for (auto &p : _httpsServer._plugins) {
					if (p.id == pathStrs[0]) {
						for (const auto &g : p.configurator->getSensorGroups()) {
							g->stop();
						}
						response = "Plugin " + pathStrs[0] + ": Sensors stopped";
						connection->set_status(server::connection::ok);
						break;
337
					}
338
				}
Alessio Netti's avatar
Alessio Netti committed
339
340
341
342
343
344
345
346
347
348
			} else if (action == "reload") {
				for (auto &p : _httpsServer._plugins) {
					if (p.id == pathStrs[0]) {
						//before modifying the plugin we need to ensure that we have exclusive access
						//therefore pause the only other concurrent user (MQTTPusher)
						_httpsServer._mqttPusher->halt();
						//wait until MQTTPusher is paused
						while (!_httpsServer._mqttPusher->isHalted()) {
							sleep(1);
						}
349

Alessio Netti's avatar
Alessio Netti committed
350
351
352
353
354
355
356
						if (p.configurator->reReadConfig()) {
							response = "Plugin " + pathStrs[0] + ": Configuration reloaded";
							connection->set_status(server::connection::ok);
						} else {
							response = "Plugin " + pathStrs[0] + ": Could not reload configuration";
							connection->set_status(server::connection::internal_server_error);
						}
357

Alessio Netti's avatar
Alessio Netti committed
358
359
360
361
						for (const auto &g : p.configurator->getSensorGroups()) {
							g->init(_httpsServer._io);
							g->start();
						}
362

Alessio Netti's avatar
Alessio Netti committed
363
364
365
366
						//continue MQTTPusher
						_httpsServer._mqttPusher->cont();
						break;
					}
367
				}
Alessio Netti's avatar
Alessio Netti committed
368
369
370
371
			} else {
				LOGH(warning) << "Unknown action " << pathStrs[1] << " requested";
				connection->set_status(server::connection::not_supported);
				goto error;
372
			}
373

Alessio Netti's avatar
Alessio Netti committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
			//Updating the SensorNavigator on plugin changes
			QueryEngine &qEngine = QueryEngine::getInstance();
			std::shared_ptr <SensorNavigator> navigator = std::make_shared<SensorNavigator>();
			vector <std::string> names, topics;
			for (const auto &p : _httpsServer._plugins)
				for (const auto &g : p.configurator->getSensorGroups())
					for (const auto &s : g->getSensors()) {
						names.push_back(s->getName());
						topics.push_back(s->getMqtt());
					}
			navigator->buildTree(qEngine.getSensorHierarchy(), &names, &topics);
			qEngine.setNavigator(navigator);
			qEngine.triggerUpdate();
		}
388
389
	}

390
	LOGH(info) << "Responding: " << response;
391
392
393
394
395
	data << response << std::endl;

	//jump right here if an error was encountered.
	//An empty response will be send while the connections status should be set to an appropriate error state
	error:
396
	server::response_header headers[] = { {"Connection", "close"}, {"Content-Type", "text/plain"} };
397
398
399
400
401
	connection->set_headers(boost::make_iterator_range(headers, headers + 2));
	connection->write(data.str());
}

void HttpsServer::requestHandler::log(const server::string_type& message) {
402
	LOGH(error) << message;
403
}
404

Alessio Netti's avatar
Alessio Netti committed
405
406
HttpsServer::HttpsServer(restAPISettings_t restAPISettings, pluginVector_t& plugins, MQTTPusher* mqttPusher, AnalyticsManager* manager, boost::asio::io_service& io) :
		_plugins(plugins), _mqttPusher(mqttPusher), _manager(manager), _io(io), _handler(*this) {
407

408
409
410
	std::shared_ptr<asio::ssl::context> ctx = std::make_shared<asio::ssl::context>(asio::ssl::context::sslv23);
	ctx->set_options(asio::ssl::context::default_workarounds | asio::ssl::context::no_sslv3 | asio::ssl::context::single_dh_use);

411
	// Set certificate, private key and DH parameters
412
	//ctx->set_password_callback(HttpsServer::password_callback);
413
414
415
	ctx->use_certificate_chain_file(restAPISettings.certificate);
	ctx->use_private_key_file(restAPISettings.privateKey, asio::ssl::context::pem);
	ctx->use_tmp_dh_file(restAPISettings.dhFile);
416

417
	server::options options(_handler);
418
	_server = new server(options.address(restAPISettings.restHost).port(restAPISettings.restPort).context(ctx));
419
420
421
422
423
424
}

HttpsServer::~HttpsServer() {
	delete _server;
}

Micha Mueller's avatar
Micha Mueller committed
425
std::string HttpsServer::calcAvg(SensorBase& s, uint64_t time) {
426
	int64_t avg = 0;
427
	const reading_t * const cache = s.getCache();
428
429

	unsigned count = 0;
Micha Mueller's avatar
Micha Mueller committed
430
	for(unsigned i = 0; i < s.getCacheSize(); i++) {
431
432
433
434
435
436
437
438
439
440
441
		if (cache[i].timestamp > time) {
			avg += cache[i].value;
			count++;
		}
	}
	if (count > 0)
		avg /= count;

	return " Average of last " + std::to_string(count) + " values is " + std::to_string(avg);
}

442
443
444
445
446
447
448
449
bool HttpsServer::check_authkey(const std::string& authkey, permission requiredPerm) {
	authkeyMap_t::iterator it = _authkeys.find(authkey);
	if (it != _authkeys.end()) {
		return it->second[requiredPerm];
	}
	return false;
}

450
451
452
453
454
/*
std::string HttpsServer::password_callback(std::size_t max_length, asio::ssl::context_base::password_purpose purpose) {
    return std::string("pwd");
}
*/