blob: 23da04aed6873fbe32cccb0aa50d6d6c4a0d371a [file] [log] [blame]
David Carlier8167f302015-06-01 13:50:06 +02001#include <stdio.h>
2
3#include <common/cfgparse.h>
Willy Tarreau876054d2016-12-21 20:39:16 +01004#include <common/errors.h>
Willy Tarreauf63386a2015-06-01 15:39:50 +02005#include <proto/arg.h>
David Carlier8167f302015-06-01 13:50:06 +02006#include <proto/log.h>
David Carlier608c65a2015-09-25 14:16:30 +01007#include <proto/proto_http.h>
Willy Tarreauf63386a2015-06-01 15:39:50 +02008#include <proto/sample.h>
Willy Tarreaubee9dde2016-12-21 21:25:06 +01009#include <dac.h>
10
11static struct {
12 void *atlasimgptr;
13 char *jsonpath;
14 char *cookiename;
15 size_t cookienamelen;
16 da_atlas_t atlas;
17 da_evidence_id_t useragentid;
18 da_severity_t loglevel;
19 char separator;
20 unsigned char daset:1;
21} global_deviceatlas = {
22 .loglevel = 0,
23 .jsonpath = 0,
24 .cookiename = 0,
25 .cookienamelen = 0,
26 .useragentid = 0,
27 .daset = 0,
28 .separator = '|',
29};
David Carlier8167f302015-06-01 13:50:06 +020030
31static int da_json_file(char **args, int section_type, struct proxy *curpx,
32 struct proxy *defpx, const char *file, int line,
33 char **err)
34{
35 if (*(args[1]) == 0) {
36 memprintf(err, "deviceatlas json file : expects a json path.\n");
37 return -1;
38 }
Willy Tarreaubee9dde2016-12-21 21:25:06 +010039 global_deviceatlas.jsonpath = strdup(args[1]);
David Carlier8167f302015-06-01 13:50:06 +020040 return 0;
41}
42
43static int da_log_level(char **args, int section_type, struct proxy *curpx,
44 struct proxy *defpx, const char *file, int line,
45 char **err)
46{
47 int loglevel;
48 if (*(args[1]) == 0) {
49 memprintf(err, "deviceatlas log level : expects an integer argument.\n");
50 return -1;
51 }
52
53 loglevel = atol(args[1]);
54 if (loglevel < 0 || loglevel > 3) {
55 memprintf(err, "deviceatlas log level : expects a log level between 0 and 3, %s given.\n", args[1]);
56 } else {
Willy Tarreaubee9dde2016-12-21 21:25:06 +010057 global_deviceatlas.loglevel = (da_severity_t)loglevel;
David Carlier8167f302015-06-01 13:50:06 +020058 }
59
60 return 0;
61}
62
63static int da_property_separator(char **args, int section_type, struct proxy *curpx,
64 struct proxy *defpx, const char *file, int line,
65 char **err)
66{
67 if (*(args[1]) == 0) {
68 memprintf(err, "deviceatlas property separator : expects a character argument.\n");
69 return -1;
70 }
Willy Tarreaubee9dde2016-12-21 21:25:06 +010071 global_deviceatlas.separator = *args[1];
David Carlier8167f302015-06-01 13:50:06 +020072 return 0;
73}
74
David Carlier608c65a2015-09-25 14:16:30 +010075static int da_properties_cookie(char **args, int section_type, struct proxy *curpx,
76 struct proxy *defpx, const char *file, int line,
77 char **err)
78{
79 if (*(args[1]) == 0) {
80 memprintf(err, "deviceatlas cookie name : expects a string argument.\n");
81 return -1;
82 } else {
Willy Tarreaubee9dde2016-12-21 21:25:06 +010083 global_deviceatlas.cookiename = strdup(args[1]);
David Carlier608c65a2015-09-25 14:16:30 +010084 }
Willy Tarreaubee9dde2016-12-21 21:25:06 +010085 global_deviceatlas.cookienamelen = strlen(global_deviceatlas.cookiename);
David Carlier608c65a2015-09-25 14:16:30 +010086 return 0;
87}
88
David Carlier8167f302015-06-01 13:50:06 +020089static size_t da_haproxy_read(void *ctx, size_t len, char *buf)
90{
91 return fread(buf, 1, len, ctx);
92}
93
94static da_status_t da_haproxy_seek(void *ctx, off_t off)
95{
96 return fseek(ctx, off, SEEK_SET) != -1 ? DA_OK : DA_SYS;
97}
98
99static void da_haproxy_log(da_severity_t severity, da_status_t status,
100 const char *fmt, va_list args)
101{
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100102 if (global_deviceatlas.loglevel && severity <= global_deviceatlas.loglevel) {
David Carlier8167f302015-06-01 13:50:06 +0200103 char logbuf[256];
104 vsnprintf(logbuf, sizeof(logbuf), fmt, args);
Christopher Faulet767a84b2017-11-24 16:50:31 +0100105 ha_warning("deviceatlas : %s.\n", logbuf);
David Carlier8167f302015-06-01 13:50:06 +0200106 }
107}
108
David Carlier608c65a2015-09-25 14:16:30 +0100109#define DA_COOKIENAME_DEFAULT "DAPROPS"
110
Willy Tarreau876054d2016-12-21 20:39:16 +0100111/*
112 * module init / deinit functions. Returns 0 if OK, or a combination of ERR_*.
113 */
114static int init_deviceatlas(void)
David Carlier8167f302015-06-01 13:50:06 +0200115{
Willy Tarreau876054d2016-12-21 20:39:16 +0100116 int err_code = 0;
117
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100118 if (global_deviceatlas.jsonpath != 0) {
David Carlier8167f302015-06-01 13:50:06 +0200119 FILE *jsonp;
120 da_property_decl_t extraprops[] = {{0, 0}};
121 size_t atlasimglen;
122 da_status_t status;
123
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100124 jsonp = fopen(global_deviceatlas.jsonpath, "r");
David Carlier8167f302015-06-01 13:50:06 +0200125 if (jsonp == 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100126 ha_alert("deviceatlas : '%s' json file has invalid path or is not readable.\n",
127 global_deviceatlas.jsonpath);
Willy Tarreau876054d2016-12-21 20:39:16 +0100128 err_code |= ERR_ALERT | ERR_FATAL;
David Carlier8167f302015-06-01 13:50:06 +0200129 goto out;
130 }
131
132 da_init();
133 da_seterrorfunc(da_haproxy_log);
134 status = da_atlas_compile(jsonp, da_haproxy_read, da_haproxy_seek,
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100135 &global_deviceatlas.atlasimgptr, &atlasimglen);
David Carlier8167f302015-06-01 13:50:06 +0200136 fclose(jsonp);
137 if (status != DA_OK) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100138 ha_alert("deviceatlas : '%s' json file is invalid.\n",
139 global_deviceatlas.jsonpath);
Willy Tarreau876054d2016-12-21 20:39:16 +0100140 err_code |= ERR_ALERT | ERR_FATAL;
David Carlier8167f302015-06-01 13:50:06 +0200141 goto out;
142 }
143
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100144 status = da_atlas_open(&global_deviceatlas.atlas, extraprops,
145 global_deviceatlas.atlasimgptr, atlasimglen);
David Carlier8167f302015-06-01 13:50:06 +0200146
147 if (status != DA_OK) {
Christopher Faulet767a84b2017-11-24 16:50:31 +0100148 ha_alert("deviceatlas : data could not be compiled.\n");
Willy Tarreau876054d2016-12-21 20:39:16 +0100149 err_code |= ERR_ALERT | ERR_FATAL;
David Carlier8167f302015-06-01 13:50:06 +0200150 goto out;
151 }
152
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100153 if (global_deviceatlas.cookiename == 0) {
154 global_deviceatlas.cookiename = strdup(DA_COOKIENAME_DEFAULT);
155 global_deviceatlas.cookienamelen = strlen(global_deviceatlas.cookiename);
David Carlier608c65a2015-09-25 14:16:30 +0100156 }
157
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100158 global_deviceatlas.useragentid = da_atlas_header_evidence_id(&global_deviceatlas.atlas,
David Carlier8167f302015-06-01 13:50:06 +0200159 "user-agent");
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100160 global_deviceatlas.daset = 1;
David Carlier8167f302015-06-01 13:50:06 +0200161
162 fprintf(stdout, "Deviceatlas module loaded.\n");
163 }
164
165out:
Willy Tarreau876054d2016-12-21 20:39:16 +0100166 return err_code;
David Carlier8167f302015-06-01 13:50:06 +0200167}
168
Willy Tarreaub149eed2016-12-21 21:03:49 +0100169static void deinit_deviceatlas(void)
David Carlier8167f302015-06-01 13:50:06 +0200170{
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100171 if (global_deviceatlas.jsonpath != 0) {
172 free(global_deviceatlas.jsonpath);
David Carlier8167f302015-06-01 13:50:06 +0200173 }
174
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100175 if (global_deviceatlas.daset == 1) {
176 free(global_deviceatlas.cookiename);
177 da_atlas_close(&global_deviceatlas.atlas);
178 free(global_deviceatlas.atlasimgptr);
David Carlier8167f302015-06-01 13:50:06 +0200179 }
180
181 da_fini();
182}
183
David Carlier608c65a2015-09-25 14:16:30 +0100184static int da_haproxy(const struct arg *args, struct sample *smp, da_deviceinfo_t *devinfo)
David Carlier8167f302015-06-01 13:50:06 +0200185{
Willy Tarreau83061a82018-07-13 11:56:34 +0200186 struct buffer *tmp;
David Carlier8167f302015-06-01 13:50:06 +0200187 da_propid_t prop, *pprop;
David Carlier8167f302015-06-01 13:50:06 +0200188 da_status_t status;
David Carlier608c65a2015-09-25 14:16:30 +0100189 da_type_t proptype;
190 const char *propname;
David Carlier8167f302015-06-01 13:50:06 +0200191 int i;
192
David Carlier8167f302015-06-01 13:50:06 +0200193 tmp = get_trash_chunk();
194 chunk_reset(tmp);
195
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200196 propname = (const char *) args[0].data.str.area;
David Carlier8167f302015-06-01 13:50:06 +0200197 i = 0;
198
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200199 for (; propname != 0; i ++,
200 propname = (const char *) args[i].data.str.area) {
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100201 status = da_atlas_getpropid(&global_deviceatlas.atlas,
David Carlier8167f302015-06-01 13:50:06 +0200202 propname, &prop);
203 if (status != DA_OK) {
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100204 chunk_appendf(tmp, "%c", global_deviceatlas.separator);
David Carlier8167f302015-06-01 13:50:06 +0200205 continue;
206 }
207 pprop = &prop;
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100208 da_atlas_getproptype(&global_deviceatlas.atlas, *pprop, &proptype);
David Carlier8167f302015-06-01 13:50:06 +0200209
210 switch (proptype) {
211 case DA_TYPE_BOOLEAN: {
212 bool val;
David Carlier608c65a2015-09-25 14:16:30 +0100213 status = da_getpropboolean(devinfo, *pprop, &val);
David Carlier8167f302015-06-01 13:50:06 +0200214 if (status == DA_OK) {
215 chunk_appendf(tmp, "%d", val);
216 }
217 break;
218 }
219 case DA_TYPE_INTEGER:
220 case DA_TYPE_NUMBER: {
221 long val;
David Carlier608c65a2015-09-25 14:16:30 +0100222 status = da_getpropinteger(devinfo, *pprop, &val);
David Carlier8167f302015-06-01 13:50:06 +0200223 if (status == DA_OK) {
224 chunk_appendf(tmp, "%ld", val);
225 }
226 break;
227 }
228 case DA_TYPE_STRING: {
229 const char *val;
David Carlier608c65a2015-09-25 14:16:30 +0100230 status = da_getpropstring(devinfo, *pprop, &val);
David Carlier8167f302015-06-01 13:50:06 +0200231 if (status == DA_OK) {
232 chunk_appendf(tmp, "%s", val);
233 }
234 break;
David Carlier608c65a2015-09-25 14:16:30 +0100235 }
David Carlier8167f302015-06-01 13:50:06 +0200236 default:
237 break;
238 }
239
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100240 chunk_appendf(tmp, "%c", global_deviceatlas.separator);
David Carlier8167f302015-06-01 13:50:06 +0200241 }
242
David Carlier608c65a2015-09-25 14:16:30 +0100243 da_close(devinfo);
David Carlier8167f302015-06-01 13:50:06 +0200244
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200245 if (tmp->data) {
246 --tmp->data;
247 tmp->area[tmp->data] = 0;
David Carlier8167f302015-06-01 13:50:06 +0200248 }
249
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200250 smp->data.u.str.area = tmp->area;
251 smp->data.u.str.data = tmp->data;
David Carlier8167f302015-06-01 13:50:06 +0200252
253 return 1;
254}
255
David Carlier608c65a2015-09-25 14:16:30 +0100256static int da_haproxy_conv(const struct arg *args, struct sample *smp, void *private)
257{
258 da_deviceinfo_t devinfo;
259 da_status_t status;
260 const char *useragent;
261 char useragentbuf[1024] = { 0 };
262 int i;
263
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200264 if (global_deviceatlas.daset == 0 || smp->data.u.str.data == 0) {
David Carlier608c65a2015-09-25 14:16:30 +0100265 return 1;
266 }
267
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200268 i = smp->data.u.str.data > sizeof(useragentbuf) ? sizeof(useragentbuf) : smp->data.u.str.data;
269 memcpy(useragentbuf, smp->data.u.str.area, i - 1);
David Carlier608c65a2015-09-25 14:16:30 +0100270 useragentbuf[i - 1] = 0;
271
272 useragent = (const char *)useragentbuf;
273
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100274 status = da_search(&global_deviceatlas.atlas, &devinfo,
275 global_deviceatlas.useragentid, useragent, 0);
David Carlier608c65a2015-09-25 14:16:30 +0100276
277 return status != DA_OK ? 0 : da_haproxy(args, smp, &devinfo);
278}
279
280#define DA_MAX_HEADERS 24
281
282static int da_haproxy_fetch(const struct arg *args, struct sample *smp, const char *kw, void *private)
283{
284 struct hdr_idx *hidx;
285 struct hdr_ctx hctx;
286 const struct http_msg *hmsg;
287 da_evidence_t ev[DA_MAX_HEADERS];
288 da_deviceinfo_t devinfo;
289 da_status_t status;
290 char vbuf[DA_MAX_HEADERS][1024] = {{ 0 }};
291 int i, nbh = 0;
292
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100293 if (global_deviceatlas.daset == 0) {
David Carlier608c65a2015-09-25 14:16:30 +0100294 return 1;
295 }
296
297 CHECK_HTTP_MESSAGE_FIRST();
298 smp->data.type = SMP_T_STR;
299
300 /**
301 * Here we go through the whole list of headers from start
302 * they will be filtered via the DeviceAtlas API itself
303 */
304 hctx.idx = 0;
305 hidx = &smp->strm->txn->hdr_idx;
306 hmsg = &smp->strm->txn->req;
307
308 while (http_find_next_header(hmsg->chn->buf->p, hidx, &hctx) == 1 &&
309 nbh < DA_MAX_HEADERS) {
310 char *pval;
311 size_t vlen;
312 da_evidence_id_t evid = -1;
313 char hbuf[24] = { 0 };
314
315 /* The HTTP headers used by the DeviceAtlas API are not longer */
David Carlier91a88b02017-11-17 08:47:25 +0000316 if (hctx.del >= sizeof(hbuf) || hctx.del <= 0 || hctx.vlen <= 0) {
David Carlier608c65a2015-09-25 14:16:30 +0100317 continue;
318 }
319
320 vlen = hctx.vlen;
321 memcpy(hbuf, hctx.line, hctx.del);
322 hbuf[hctx.del] = 0;
323 pval = (hctx.line + hctx.val);
324
325 if (strcmp(hbuf, "Accept-Language") == 0) {
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100326 evid = da_atlas_accept_language_evidence_id(&global_deviceatlas.
David Carlier608c65a2015-09-25 14:16:30 +0100327 atlas);
328 } else if (strcmp(hbuf, "Cookie") == 0) {
329 char *p, *eval;
330 int pl;
331
332 eval = pval + hctx.vlen;
333 /**
334 * The cookie value, if it exists, is located between the current header's
335 * value position and the next one
336 */
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100337 if (extract_cookie_value(pval, eval, global_deviceatlas.cookiename,
338 global_deviceatlas.cookienamelen, 1, &p, &pl) == NULL) {
David Carlier608c65a2015-09-25 14:16:30 +0100339 continue;
340 }
341
342 vlen = (size_t)pl;
343 pval = p;
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100344 evid = da_atlas_clientprop_evidence_id(&global_deviceatlas.atlas);
David Carlier608c65a2015-09-25 14:16:30 +0100345 } else {
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100346 evid = da_atlas_header_evidence_id(&global_deviceatlas.atlas,
David Carlier608c65a2015-09-25 14:16:30 +0100347 hbuf);
348 }
349
350 if (evid == -1) {
351 continue;
352 }
353
354 i = vlen > sizeof(vbuf[nbh]) ? sizeof(vbuf[nbh]) : vlen;
355 memcpy(vbuf[nbh], pval, i - 1);
356 vbuf[nbh][i - 1] = 0;
357 ev[nbh].key = evid;
358 ev[nbh].value = vbuf[nbh];
359 ev[nbh].value[vlen] = 0;
360 ++ nbh;
361 }
362
Willy Tarreaubee9dde2016-12-21 21:25:06 +0100363 status = da_searchv(&global_deviceatlas.atlas, &devinfo,
David Carlier608c65a2015-09-25 14:16:30 +0100364 ev, nbh);
365
366 return status != DA_OK ? 0 : da_haproxy(args, smp, &devinfo);
367}
368
Willy Tarreau0d74f772015-06-01 15:42:29 +0200369static struct cfg_kw_list dacfg_kws = {{ }, {
370 { CFG_GLOBAL, "deviceatlas-json-file", da_json_file },
371 { CFG_GLOBAL, "deviceatlas-log-level", da_log_level },
372 { CFG_GLOBAL, "deviceatlas-property-separator", da_property_separator },
David Carlier608c65a2015-09-25 14:16:30 +0100373 { CFG_GLOBAL, "deviceatlas-properties-cookie", da_properties_cookie },
Willy Tarreau0d74f772015-06-01 15:42:29 +0200374 { 0, NULL, NULL },
375}};
376
Willy Tarreauf63386a2015-06-01 15:39:50 +0200377/* Note: must not be declared <const> as its list will be overwritten */
David Carlier608c65a2015-09-25 14:16:30 +0100378static struct sample_fetch_kw_list fetch_kws = {ILH, {
David Carlier840b0242016-03-16 10:09:55 +0000379 { "da-csv-fetch", da_haproxy_fetch, ARG12(1,STR,STR,STR,STR,STR,STR,STR,STR,STR,STR,STR,STR), NULL, SMP_T_STR, SMP_USE_HRQHV },
David Carlier608c65a2015-09-25 14:16:30 +0100380 { NULL, NULL, 0, 0, 0 },
381}};
382
383/* Note: must not be declared <const> as its list will be overwritten */
Willy Tarreauf63386a2015-06-01 15:39:50 +0200384static struct sample_conv_kw_list conv_kws = {ILH, {
David Carlier840b0242016-03-16 10:09:55 +0000385 { "da-csv-conv", da_haproxy_conv, ARG12(1,STR,STR,STR,STR,STR,STR,STR,STR,STR,STR,STR,STR), NULL, SMP_T_STR, SMP_T_STR },
Willy Tarreauf63386a2015-06-01 15:39:50 +0200386 { NULL, NULL, 0, 0, 0 },
387}};
388
389__attribute__((constructor))
390static void __da_init(void)
391{
392 /* register sample fetch and format conversion keywords */
David Carlier608c65a2015-09-25 14:16:30 +0100393 sample_register_fetches(&fetch_kws);
Willy Tarreauf63386a2015-06-01 15:39:50 +0200394 sample_register_convs(&conv_kws);
Willy Tarreau0d74f772015-06-01 15:42:29 +0200395 cfg_register_keywords(&dacfg_kws);
Willy Tarreau3dd483e2016-12-21 18:50:22 +0100396 hap_register_build_opts("Built with DeviceAtlas support.", 0);
Willy Tarreau876054d2016-12-21 20:39:16 +0100397 hap_register_post_check(init_deviceatlas);
Willy Tarreaub149eed2016-12-21 21:03:49 +0100398 hap_register_post_deinit(deinit_deviceatlas);
Willy Tarreauf63386a2015-06-01 15:39:50 +0200399}