File: webhook.hh

package info (click to toggle)
weakforced 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,040 kB
  • sloc: cpp: 20,397; python: 2,002; sh: 700; makefile: 432
file content (515 lines) | stat: -rw-r--r-- 15,056 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
/*
 * This file is part of PowerDNS or weakforced.
 * Copyright -- PowerDNS.COM B.V. and its contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 3 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * In addition, for the avoidance of any doubt, permission is granted to
 * link this program with OpenSSL and to (re)distribute the binaries
 * produced as the result of such linking.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#pragma once
#include <mutex>
#include <curl/curl.h>
#include <condition_variable>
#include "json11.hpp"
#include "dolog.hh"
#include "minicurl.hh"
#include "prometheus.hh"
#include <queue>

using WHConfigMap = std::map<std::string, std::string>;
using WHEvents = std::vector<std::string>;
// Key = event name, value is a pair of config key vectors -
// first is mandatory, second is optional
using WHEventConfig = std::pair<std::vector<std::string>, std::vector<std::string>>;
using WHEventTypes = std::map<std::string, WHEventConfig>;

class WebHook {
public:
  WebHook(unsigned int wh_id, const WHEvents& wh_events, bool wh_active, const WHConfigMap& wh_config_keys) :
    id(wh_id), active(wh_active), config_keys(wh_config_keys) {
    addEvents(wh_events);
  }
  WebHook(unsigned int wh_id, bool wh_active, const WHConfigMap& wh_config_keys, const std::string& wh_name) :
    id(wh_id), active(wh_active), config_keys(wh_config_keys), name(wh_name)  {
  }
  virtual ~WebHook() {}
  virtual bool operator==(const WebHook& rhs)
  {
    return id == rhs.getID();
  }
  unsigned int getID() const { return id; }
  const std::string getName() const { return name; }
  bool hasName() const {
    if (name.compare("") == 0)
      return false;
    else
      return true;
  }
  WHEvents getEventNames() const
  {
    WHEvents ret_events;
    for (auto& i : event_names) {
      ret_events.push_back(i.first);
    }
    return ret_events;
  }
  bool validEventName(const std::string& event_name) const
  {
    for (auto& i : event_names) {
      if (i.first.compare(event_name) == 0)
	return true;
    }
    return false;
  }
  const WHEvents& getEvents() const
  {
    std::lock_guard<std::mutex> lock(mutex);
    return events;
  }
  std::string getEventsStr() const 
  {
    std::lock_guard<std::mutex> lock(mutex);
    std::stringstream ss;
    for (auto& i : events) {
      ss << i << " ";
    }
    return ss.str();
  }
  const WHEvents& setEvents(const WHEvents& new_events)
  {
    std::lock_guard<std::mutex> lock(mutex);
    events = new_events;
    return events;
  }
  const WHEvents& addEvents(const WHEvents& new_events)
  {
    for (auto& i : new_events) {
      addEvent(i);
    }
    return events;
  }
  const WHEvents& addEvent(const std::string& event_name)
  {
    std::lock_guard<std::mutex> lock(mutex);
    if (validEventName(event_name)) {
      bool duplicate = false;
      for (auto& i : events) {
	if (i.compare(event_name) == 0) {
	  duplicate = true;
	  break;
	}
      }
      if (!duplicate)
	events.push_back(event_name);
    }
    return events;
  }
  const WHEvents& deleteEvents(const WHEvents& new_events)
  {
    for (auto& i : new_events) {
      deleteEvent(i);
    }
    return events;
  }
  const WHEvents& deleteEvent(const std::string& event_name)
  {
    std::lock_guard<std::mutex> lock(mutex);
    for (auto i=events.begin(); i!=events.end(); ) {
      if (i->compare(event_name) == 0) {
	i = events.erase(i);
	break;
      }
      else
	++i;
    }
    return events;
  }
  // returns true if config is OK
  virtual bool validateConfig(std::string& error_msg) const
  {
    std::lock_guard<std::mutex> lock(mutex);
    if (event_names.begin() == event_names.end()) {
      error_msg = "No events registered";
      return false;
    }
    // go through the configured events and ensure we have the right
    // mandatory config keys
    for (auto& ev : event_names ) {
      std::vector<std::string> man_cfg = ev.second.first;

      for (auto& cf : man_cfg) {
	if (config_keys.find(cf) == config_keys.end()) {
	  error_msg = "Missing mandatory configuration key: " + cf;
	  return false;
	}
      }
    }
    return true;
  }  
  const WHEventConfig& getConfigForEvent(std::string event_name) const
  {
    std::lock_guard<std::mutex> lock(mutex);
    static const WHEventConfig null_config;

    if (validEventName(event_name)) {
      for (auto& i : event_names) {
	if (i.first.compare(event_name) == 0)
	  return i.second;
      }
    }
    return null_config;
  }
  const WHConfigMap& getConfigKeys() const
  {
    std::lock_guard<std::mutex> lock(mutex);
    return config_keys;
  }
  bool hasConfigKey(const std::string& key) const {
    std::lock_guard<std::mutex> lock(mutex);
    auto i = config_keys.find(key);
    if (i != config_keys.end())
      return true;
    return false;
  }
  std::string getConfigKey(const std::string& key) const {
    std::lock_guard<std::mutex> lock(mutex);
    auto i = config_keys.find(key);
    if (i != config_keys.end())
      return i->second;
    else
      return "";
  }
  const WHConfigMap& setConfigKeys(const WHConfigMap& new_cfg)
  {
    std::lock_guard<std::mutex> lock(mutex);
    config_keys = new_cfg;
    return config_keys;
  }
  const WHConfigMap& addConfigKeys(const WHConfigMap& new_cfg)
  {
    std::lock_guard<std::mutex> lock(mutex);
    for (const auto& i : new_cfg) {
      config_keys.insert(std::make_pair(i.first, i.second));
    }
    return config_keys;
  }
  const WHConfigMap& addConfigKey(const std::string& key, const std::string& val)
  {
    std::lock_guard<std::mutex> lock(mutex);
    config_keys.insert(std::make_pair(key, val));
    return config_keys;
  }
  const WHConfigMap& deleteConfigKey(const std::string& key)
  {
    std::lock_guard<std::mutex> lock(mutex);
    config_keys.erase(key);
    return config_keys;
  }
  bool isActive() const
  {
    std::lock_guard<std::mutex> lock(mutex);
    return active;
  }
  void setActive(bool isActive)
  {
    std::lock_guard<std::mutex> lock(mutex);
    active = isActive;
  }
  void toString(std::string& out) const
  {
    std::lock_guard<std::mutex> lock(mutex);
    json11::Json my_object = to_json();
    my_object.dump(out);
  }
  std::string toString() const
  {
    std::string out;
    toString(out);
    return out;
  }
  virtual json11::Json to_json() const
  {
    std::lock_guard<std::mutex> lock(mutex);
    json11::Json::array jevents;
    json11::Json my_object = json11::Json::object {
      { "id", (int)id },
      { "events", events },
      { "config", config_keys }
    };
    return my_object;
  }
  virtual void incSuccess() const
  {
    num_success++;
    incPrometheusWebhookMetric(id, true, false);
  }
  unsigned int getSuccess() const
  {
    return num_success;
  }
  virtual void incFailed() const
  {
    num_failed++;
    incPrometheusWebhookMetric(id, false, false);
  }
  unsigned int getFailed() const
  {
    return num_failed;
  }
protected:
  unsigned int id;
  std::vector<std::string> events;
  bool active;
  WHConfigMap config_keys;
  mutable std::atomic<unsigned int> num_success{0};
  mutable std::atomic<unsigned int> num_failed{0};
  mutable std::mutex mutex;
  const WHEventTypes event_names = { { "report", {{ "url" }, {"secret", "basic-auth"}}},
				     { "allow", {{ "url" }, {"secret", "allow_filter", "basic-auth"}}},
				     { "reset", {{ "url" }, {"secret", "basic-auth"}}},
				     { "addbl", {{ "url" }, {"secret", "basic-auth"}}},
				     { "delbl", {{ "url" }, {"secret", "basic-auth"}}},
				     { "expirebl", {{ "url" }, {"secret", "basic-auth"}}},
				     { "addwl", {{ "url" }, {"secret", "basic-auth"}}},
				     { "delwl", {{ "url" }, {"secret", "basic-auth"}}},
				     { "expirewl", {{ "url" }, {"secret", "basic-auth"}}}
  };
  const std::string name;
};

class CustomWebHook : public WebHook {
public:
  CustomWebHook(unsigned int wh_id, const std::string& wh_name, bool wh_active,
		const WHConfigMap& wh_config_keys) : WebHook(wh_id, wh_active, wh_config_keys, wh_name)  {
  }
  ~CustomWebHook() {}
  bool operator==(const WebHook& rhs) override
  {
    return ((id == rhs.getID()) && (name.compare(rhs.getName()) == 0));
  }
    // returns true if config is OK
  bool validateConfig(std::string& error_msg) const override
  {
    std::lock_guard<std::mutex> lock(mutex);
    if (config_keys.find("url") == config_keys.end()) {
	  error_msg = "Missing mandatory configuration key: url";
	  return false;
    }
    return true;
  }
  void incSuccess() const override
  {
    num_success++;
    incPrometheusWebhookMetric(id, true, true);
  }
  void incFailed() const override
  {
    num_failed++;
    incPrometheusWebhookMetric(id, false, true);
  }
  json11::Json to_json() const override
  {
    std::lock_guard<std::mutex> lock(mutex);
    json11::Json::array jevents;
    json11::Json my_object = json11::Json::object {
      { "id", (int)id },
      { "name", name },
      { "config", config_keys }
    };
    return my_object;
  }
};

class WebHookDB
{
public:
  WebHookDB():id(0)
  {
  }
  unsigned int getNewID() const { return ++id; }
  bool addWebHook(const WebHook& hook, std::string&error_msg)
  {
    std::lock_guard<std::mutex> lock(mutex);
    bool retval = true;
    
    if (hook.validateConfig(error_msg)) {
      for (const auto& i : webhooks) {
	if (i->getID() == hook.getID()) {
	  error_msg = "Registering webhook failed: id=" + std::to_string(hook.getID()) + " is already registered";
	  retval = false;
	}
      }
      if (retval == true) {
	if (hook.hasName()) {
	  infolog("Registering custom webhook id=%d name=%s to url (%s)",
		  hook.getID(), hook.getName(),  hook.getConfigKey("url"));
	  webhooks.push_back(std::make_shared<CustomWebHook>(hook.getID(), hook.getName(), hook.isActive(), hook.getConfigKeys()));
          addPrometheusWebhookMetric(id, hook.getConfigKey("url"), true);
	}
	else {
	  infolog("Registering webhook id=%d for events [%s] to url (%s)",
		  hook.getID(), hook.getEventsStr(), hook.getConfigKey("url"));
	  webhooks.push_back(std::make_shared<WebHook>(hook.getID(), hook.getEvents(), hook.isActive(), hook.getConfigKeys()));
          addPrometheusWebhookMetric(id, hook.getConfigKey("url"), false);
	}
      }
    }
    return retval;
  }
  bool deleteWebHook(unsigned int wh_id)
  {
    std::lock_guard<std::mutex> lock(mutex);
    bool retval = false;
    for (auto i = webhooks.begin(); i!=webhooks.end(); ) {
      if ((*i)->getID() == wh_id) {
	i = webhooks.erase(i);
	retval = true;
	break;
      }
      else
	++i;
    }
    return retval;
  }
  std::weak_ptr<WebHook> getWebHook(unsigned int wh_id)
  {
    std::lock_guard<std::mutex> lock(mutex);
    for (auto i = webhooks.begin(); i!=webhooks.end(); ++i) {
      if ((*i)->getID() == wh_id)
	return *i;
    }
    return std::weak_ptr<WebHook>();
  }
  std::weak_ptr<WebHook> getWebHook(const std::string& wh_name)
  {
    std::lock_guard<std::mutex> lock(mutex);
    for (auto i = webhooks.begin(); i!=webhooks.end(); ++i) {
      if ((*i)->getName().compare(wh_name) == 0)
	return *i;
    }
    return std::weak_ptr<WebHook>();
  }
  const std::vector<std::weak_ptr<const WebHook>> getWebHooks() const
  {
    std::lock_guard<std::mutex> lock(mutex);
    std::vector<std::weak_ptr<const WebHook>> retvec;
    
    for (const auto& i : webhooks)
      retvec.push_back(i);
    
    return retvec;
  }
  const std::vector<std::weak_ptr<const WebHook>> getWebHooksForEvent(const std::string& event_name) const
  {
    std::lock_guard<std::mutex> lock(mutex);
    std::vector<std::weak_ptr<const WebHook>> retvec;
    
    for (const auto& i : webhooks) {
      for (const auto& ev : i->getEvents()) {
	if (ev.compare(event_name) == 0) {
	  retvec.push_back(i);
	}
      }
    }
    return retvec;
  }
  void toString(std::string& out) const
  {
    std::lock_guard<std::mutex> lock(mutex);
    json11::Json::array jarray;

    for (auto& i : webhooks) {
      jarray.push_back(i->to_json());
    }
    json11::Json my_array = json11::Json(jarray);
    my_array.dump(out);
  }
  std::string toString() const
  {
    std::string out;
    toString(out);
    return out;
  }
private:
  mutable std::atomic<unsigned int> id;
  std::vector<std::shared_ptr<WebHook>> webhooks;
  mutable std::mutex mutex;
};

struct CurlConnection {
  CurlConnection()
  {
  }
  std::mutex 	cmutex;
  MiniCurlMulti	mcurl;
};

using CurlConns = std::vector<std::shared_ptr<CurlConnection>>;

#define MAX_HOOK_CONN 10
#define NUM_WEBHOOK_THREADS 5
#define QUEUE_SIZE 50000
#define DEFAULT_TIMEOUT_SECS 2

struct WebHookQueueItem
{
  std::string event_name;
  std::shared_ptr<const WebHook> hook;
  std::shared_ptr<std::string> hook_data_p;
};

class WebHookRunner
{
public:
  WebHookRunner();
  void setNumThreads(unsigned int new_num_threads);
  void setMaxConns(unsigned int max_conns);
  void setMaxQueueSize(unsigned int max_queue);
  void setTimeout(uint64_t timeout_seconds);
  void disablePeerVerification() { verify_peer = false; }
  void disableHostVerification() { verify_host = false; }
  void setCACertBundleFile(const std::string& file) { caCertBundleFile = file; }
  void setClientCertAndKey(const std::string& certfile,
                           const std::string& keyfile)
                           { clientCertFile = certfile; clientKeyFile = keyfile; }
  // synchronously run the ping command for the hook
  bool pingHook(std::shared_ptr<const WebHook> hook, std::string error_msg);
  // asynchronously run the hook with the supplied data
  void runHook(const std::string& event_name, std::shared_ptr<const WebHook> hook, const std::string& hook_data);
  void runHook(const std::string& event_name, std::shared_ptr<const WebHook> hook, const json11::Json& json_data);
  void startThreads();
protected:
  void _runHookThread(unsigned int num_conns);
  void _addHook(const std::string& event_name, std::shared_ptr<const WebHook> hook, const std::string& hook_data, MiniCurlMulti& mcurl);
  bool _runHooks(const std::vector<WebHookQueueItem>& events,
                 MiniCurlMulti& mcurl);
  std::string ExpandURL(const std::string&& url);
  std::string ExpandURL(const std::string& url);
private:
  std::queue<WebHookQueueItem> queue;
  std::mutex queue_mutex;
  std::condition_variable cv;
  unsigned int max_queue_size = QUEUE_SIZE;
  unsigned int max_hook_conns = MAX_HOOK_CONN;
  unsigned int num_threads = NUM_WEBHOOK_THREADS;
  uint64_t timeout_secs = DEFAULT_TIMEOUT_SECS;
  bool verify_peer = true;
  bool verify_host = true;
  std::string caCertBundleFile;
  std::string clientCertFile;
  std::string clientKeyFile;
};