client-tags.c

   1 /*********************************************************************
   2  *
   3  * File        :  $Source: /cvsroot/ijbswa/current/client-tags.c,v $
   4  *
   5  * Purpose     :  Functions related to client-specific tags.
   6  *
   7  * Copyright   :  Copyright (C) 2016 Fabian Keil <fk@fabiankeil.de>
   8  *
   9  *                This program is free software; you can redistribute it
  10  *                and/or modify it under the terms of the GNU General
  11  *                Public License as published by the Free Software
  12  *                Foundation; either version 2 of the License, or (at
  13  *                your option) any later version.
  14  *
  15  *                This program is distributed in the hope that it will
  16  *                be useful, but WITHOUT ANY WARRANTY; without even the
  17  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  18  *                PARTICULAR PURPOSE.  See the GNU General Public
  19  *                License for more details.
  20  *
  21  *                The GNU General Public License should be included with
  22  *                this file.  If not, you can view it at
  23  *                http://www.gnu.org/copyleft/gpl.html
  24  *                or write to the Free Software Foundation, Inc., 59
  25  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  26  *
  27  **********************************************************************/
  28
  29 #include "config.h"
  30
  31 #ifdef FEATURE_CLIENT_TAGS
  32
  33 #include <stdio.h>
  34 #include <sys/types.h>
  35 #include <stdlib.h>
  36 #include <ctype.h>
  37 #include <string.h>
  38 #include <assert.h>
  39
  40 #include "project.h"
  41 #include "list.h"
  42 #include "jcc.h"
  43 #include "miscutil.h"
  44 #include "errlog.h"
  45 #include "parsers.h"
  46
  47 struct client_specific_tag
  48 {
  49    char *name;
  50
  51    time_t end_of_life;
  52
  53    struct client_specific_tag *next;
  54    struct client_specific_tag *prev;
  55 };
  56
  57 /**
  58  * This struct represents tags that have been requested by clients
  59  */
  60 struct requested_tags
  61 {
  62    char *client; /**< The IP address of the client that requested the tag */
  63
  64    /**< List of tags the client requested .... */
  65    struct client_specific_tag *tags;
  66
  67    struct requested_tags *next;
  68    struct requested_tags *prev;
  69 };
  70
  71 struct requested_tags *requested_tags;
  72 static void remove_tag_for_client(const char *client_address, const char *tag);
  73
  74 /*********************************************************************
  75  *
  76  * Function    :  validate_tag_list
  77  *
  78  * Description :  Validates the given tag list
  79  *
  80  * Parameters  :
  81  *          1  :  enabled_tags = The tags to validate
  82  *
  83  * Returns     :  void
  84  *
  85  *********************************************************************/
  86 static void validate_tag_list(struct client_specific_tag *enabled_tags)
  87 {
  88    while (enabled_tags != NULL)
  89    {
  90       if (enabled_tags->name == NULL)
  91       {
  92          assert(enabled_tags->name != NULL);
  93          log_error(LOG_LEVEL_FATAL, "validate_tag_list(): Tag without name detected");
  94       }
  95       if (enabled_tags->next != NULL)
  96       {
  97          if (enabled_tags->next->prev != enabled_tags)
  98          {
  99             assert(enabled_tags->next->prev == enabled_tags);
 100             log_error(LOG_LEVEL_FATAL, "validate_tag_list(): Invalid backlink detected");
 101          }
 102       }
 103       enabled_tags = enabled_tags->next;
 104    }
 105 }
 106
 107 /*********************************************************************
 108  *
 109  * Function    :  validate_requested_tags
 110  *
 111  * Description :  Validates the requested_tags list
 112  *
 113  * Parameters  : N/A
 114  *
 115  * Returns     :  void
 116  *
 117  *********************************************************************/
 118 static jb_err validate_requested_tags()
 119 {
 120    struct requested_tags *requested_tag;
 121
 122    for (requested_tag = requested_tags; requested_tag != NULL;
 123         requested_tag = requested_tag->next)
 124    {
 125       if (requested_tag->client == NULL)
 126       {
 127          assert(requested_tag->client != NULL);
 128          log_error(LOG_LEVEL_FATAL, "validate_tag_list(): Client not registered");
 129       }
 130       validate_tag_list(requested_tag->tags);
 131       if (requested_tag->next != NULL)
 132       {
 133          if (requested_tag->next->prev != requested_tag)
 134          {
 135             assert(requested_tag->next->prev == requested_tag);
 136             log_error(LOG_LEVEL_FATAL, "validate_requested_tags(): Invalid backlink detected");
 137          }
 138       }
 139    }
 140
 141    return TRUE;
 142 }
 143
 144
 145 /*********************************************************************
 146  *
 147  * Function    :  get_client_specific_tag
 148  *
 149  * Description :  Returns the data for a client-specific-tag specified
 150  *                by name.
 151  *
 152  * Parameters  :
 153  *          1  :  tag_list = The tag list to check
 154  *          2  :  name =     The tag name to look up
 155  *
 156  * Returns     :  Pointer to tag structure or NULL on error.
 157  *
 158  *********************************************************************/
 159 static struct client_tag_spec *get_client_specific_tag(
 160    struct client_tag_spec *tag_list, const char *name)
 161 {
 162    struct client_tag_spec *tag;
 163
 164    for (tag = tag_list; tag != NULL; tag = tag->next)
 165    {
 166       if (tag->name != NULL && !strcmp(tag->name, name))
 167       {
 168          return tag;
 169       }
 170    }
 171
 172    log_error(LOG_LEVEL_ERROR, "No such tag: '%s'", name);
 173
 174    return NULL;
 175
 176 }
 177
 178
 179 /*********************************************************************
 180  *
 181  * Function    :  get_tags_for_client
 182  *
 183  * Description :  Returns the list of tags the client opted-in.
 184  *
 185  * Parameters  :
 186  *          1  :  client_address = Address of the client
 187  *
 188  * Returns     :  Pointer to tag structure or NULL on error.
 189  *
 190  *********************************************************************/
 191 static struct client_specific_tag *get_tags_for_client(const char *client_address)
 192 {
 193    struct requested_tags *requested_tag;
 194
 195    for (requested_tag = requested_tags; requested_tag != NULL;
 196         requested_tag = requested_tag->next)
 197    {
 198       if (!strcmp(requested_tag->client, client_address))
 199       {
 200          return requested_tag->tags;
 201       }
 202    }
 203
 204    return NULL;
 205 }
 206
 207
 208 /*********************************************************************
 209  *
 210  * Function    :  get_tag_list_for_client
 211  *
 212  * Description :  Provides a list of tag names the client opted-in.
 213  *                Other tag attributes are not part of the list.
 214  *
 215  * Parameters  :
 216  *          1  :  tag_list = The list to fill in.
 217  *          2  :  client_address = Address of the client
 218  *
 219  * Returns     :  Pointer to tag list.
 220  *
 221  *********************************************************************/
 222 void get_tag_list_for_client(struct list *tag_list,
 223                              const char *client_address)
 224 {
 225    struct client_specific_tag *enabled_tags;
 226    const time_t now = time(NULL);
 227
 228    privoxy_mutex_lock(&client_tags_mutex);
 229
 230    enabled_tags = get_tags_for_client(client_address);
 231    while (enabled_tags != NULL)
 232    {
 233       if (enabled_tags->end_of_life && (enabled_tags->end_of_life < now))
 234       {
 235          struct client_specific_tag *next_tag = enabled_tags->next;
 236          log_error(LOG_LEVEL_INFO,
 237             "Tag '%s' for client %s expired %u seconds ago. Deleting it.",
 238             enabled_tags->name, client_address,
 239             (now - enabled_tags->end_of_life));
 240          remove_tag_for_client(client_address, enabled_tags->name);
 241          enabled_tags = next_tag;
 242          continue;
 243       }
 244       else
 245       {
 246          enlist(tag_list, enabled_tags->name);
 247       }
 248       enabled_tags = enabled_tags->next;
 249    }
 250
 251    privoxy_mutex_unlock(&client_tags_mutex);
 252 }
 253
 254
 255 /*********************************************************************
 256  *
 257  * Function    :  add_tag_for_client
 258  *
 259  * Description :  Adds the tag for the client.
 260  *
 261  * Parameters  :
 262  *          1  :  client_address = Address of the client
 263  *          2  :  tag = The tag to add.
 264  *          3  :  time_to_live = 0, or the number of seconds
 265  *                               the tag remains activated.
 266  *
 267  * Returns     :  void
 268  *
 269  *********************************************************************/
 270 static void add_tag_for_client(const char *client_address,
 271    const char *tag, const time_t time_to_live)
 272 {
 273    struct requested_tags *clients_with_tags;
 274    struct client_specific_tag *enabled_tags;
 275
 276    validate_requested_tags();
 277
 278    if (requested_tags == NULL)
 279    {
 280       /* XXX: Code duplication. */
 281       requested_tags = zalloc_or_die(sizeof(struct requested_tags));
 282       requested_tags->client = strdup_or_die(client_address);
 283       requested_tags->tags = zalloc_or_die(sizeof(struct client_specific_tag));
 284       requested_tags->tags->name = strdup_or_die(tag);
 285       requested_tags->tags->end_of_life = time_to_live ?
 286          (time(NULL) + time_to_live) : 0;
 287
 288       validate_requested_tags();
 289       return;
 290    }
 291    else
 292    {
 293       clients_with_tags = requested_tags;
 294       while (clients_with_tags->next != NULL)
 295       {
 296          if (!strcmp(clients_with_tags->client, client_address))
 297          {
 298             break;
 299          }
 300          clients_with_tags = clients_with_tags->next;
 301       }
 302       if (strcmp(clients_with_tags->client, client_address))
 303       {
 304          /* Client does not have tags yet, add new structure */
 305          clients_with_tags->next = zalloc_or_die(sizeof(struct requested_tags));
 306          clients_with_tags->next->prev = clients_with_tags;
 307          clients_with_tags = clients_with_tags->next;
 308          clients_with_tags->client = strdup_or_die(client_address);
 309          clients_with_tags->tags = zalloc_or_die(sizeof(struct client_specific_tag));
 310          clients_with_tags->tags->name = strdup_or_die(tag);
 311          clients_with_tags->tags->end_of_life = time_to_live ?
 312             (time(NULL) + time_to_live) : 0;
 313
 314          validate_requested_tags();
 315
 316          return;
 317       }
 318    }
 319
 320    enabled_tags = clients_with_tags->tags;
 321    while (enabled_tags != NULL)
 322    {
 323       if (enabled_tags->next == NULL)
 324       {
 325          enabled_tags->next = zalloc_or_die(sizeof(struct client_specific_tag));
 326          enabled_tags->next->name = strdup_or_die(tag);
 327          clients_with_tags->tags->end_of_life = time_to_live ?
 328             (time(NULL) + time_to_live) : 0;
 329          enabled_tags->next->prev = enabled_tags;
 330          break;
 331       }
 332       enabled_tags = enabled_tags->next;
 333    }
 334
 335    validate_requested_tags();
 336 }
 337
 338
 339 /*********************************************************************
 340  *
 341  * Function    :  remove_tag_for_client
 342  *
 343  * Description :  Removes the tag for the client.
 344  *
 345  * Parameters  :
 346  *          1  :  client_address = Address of the client
 347  *          2  :  tag = The tag to remove.
 348  *
 349  * Returns     :  void
 350  *
 351  *********************************************************************/
 352 static void remove_tag_for_client(const char *client_address, const char *tag)
 353 {
 354    struct requested_tags *clients_with_tags;
 355    struct client_specific_tag *enabled_tags;
 356
 357    validate_requested_tags();
 358
 359    clients_with_tags = requested_tags;
 360    while (clients_with_tags != NULL && clients_with_tags->client != NULL)
 361    {
 362       if (!strcmp(clients_with_tags->client, client_address))
 363       {
 364          break;
 365       }
 366       clients_with_tags = clients_with_tags->next;
 367    }
 368
 369    assert(clients_with_tags != NULL);
 370    if (clients_with_tags == NULL)
 371    {
 372       log_error(LOG_LEVEL_ERROR,
 373          "Tried to remove tag %s for tag-less client %s",
 374          tag, client_address);
 375    }
 376    enabled_tags = clients_with_tags->tags;
 377    while (enabled_tags != NULL)
 378    {
 379       if (!strcmp(enabled_tags->name, tag))
 380       {
 381          if (enabled_tags->next != NULL)
 382          {
 383             enabled_tags->next->prev = enabled_tags->prev;
 384             if (enabled_tags == clients_with_tags->tags)
 385             {
 386                /* Tag is first in line */
 387                clients_with_tags->tags = enabled_tags->next;
 388             }
 389          }
 390          if (enabled_tags->prev != NULL)
 391          {
 392             /* Tag has preceding tag */
 393             enabled_tags->prev->next = enabled_tags->next;
 394          }
 395          if (enabled_tags->prev == NULL && enabled_tags->next == NULL)
 396          {
 397             /* Tag is the only one */
 398             if (clients_with_tags->next != NULL)
 399             {
 400                /* Client has following client */
 401                clients_with_tags->next->prev = clients_with_tags->prev;
 402             }
 403             if (clients_with_tags->prev != NULL)
 404             {
 405                /* Client has preceding client */
 406                clients_with_tags->prev->next = clients_with_tags->next;
 407             }
 408             freez(clients_with_tags->client);
 409             if (clients_with_tags == requested_tags)
 410             {
 411                /* Removing last tag */
 412                freez(requested_tags);
 413                clients_with_tags = requested_tags;
 414             }
 415             else
 416             {
 417                freez(clients_with_tags);
 418             }
 419          }
 420          freez(enabled_tags->name);
 421          freez(enabled_tags);
 422          break;
 423       }
 424
 425       enabled_tags = enabled_tags->next;
 426    }
 427
 428    validate_requested_tags();
 429
 430 }
 431
 432
 433 /*********************************************************************
 434  *
 435  * Function    :  client_has_requested_tag
 436  *
 437  * Description :  Checks whether or not the given client requested
 438  *                the tag.
 439  *
 440  * Parameters  :
 441  *          1  :  client_address = Address of the client
 442  *          2  :  tag = Tag to check.
 443  *
 444  * Returns     :  TRUE or FALSE.
 445  *
 446  *********************************************************************/
 447 int client_has_requested_tag(const char *client_address, const char *tag)
 448 {
 449    struct client_specific_tag *enabled_tags;
 450
 451    enabled_tags = get_tags_for_client(client_address);
 452
 453    while (enabled_tags != NULL)
 454    {
 455       if (!strcmp(enabled_tags->name, tag))
 456       {
 457          return TRUE;
 458       }
 459       enabled_tags = enabled_tags->next;
 460    }
 461
 462    return FALSE;
 463
 464 }
 465
 466 /*********************************************************************
 467  *
 468  * Function    :  enable_client_specific_tag
 469  *
 470  * Description :  Enables a client-specific-tag for the client
 471  *
 472  * Parameters  :
 473  *          1  :  csp = Current client state (buffers, headers, etc...)
 474  *          2  :  tag_name = The name of the tag to enable
 475  *          3  :  time_to_live = If not 0, the number of seconds the
 476  *                               tag should stay enabled.
 477  *
 478  * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY or JB_ERR_PARSE.
 479  *
 480  *********************************************************************/
 481 jb_err enable_client_specific_tag(struct client_state *csp,
 482    const char *tag_name, const time_t time_to_live)
 483 {
 484    struct client_tag_spec *tag;
 485
 486    privoxy_mutex_lock(&client_tags_mutex);
 487
 488    tag = get_client_specific_tag(csp->config->client_tags, tag_name);
 489    if (tag == NULL)
 490    {
 491       privoxy_mutex_unlock(&client_tags_mutex);
 492       return JB_ERR_PARSE;
 493    }
 494
 495    if (client_has_requested_tag(csp->client_address, tag_name))
 496    {
 497       log_error(LOG_LEVEL_ERROR,
 498          "Tag '%s' already enabled for client '%s'", tag->name, csp->client_address);
 499    }
 500    else
 501    {
 502       add_tag_for_client(csp->client_address, tag_name, time_to_live);
 503       log_error(LOG_LEVEL_INFO,
 504          "Tag '%s' enabled for client '%s'. TTL: %d.",
 505          tag->name, csp->client_address, time_to_live);
 506    }
 507
 508    privoxy_mutex_unlock(&client_tags_mutex);
 509
 510    return JB_ERR_OK;
 511
 512 }
 513
 514 /*********************************************************************
 515  *
 516  * Function    :  disable_client_specific_tag
 517  *
 518  * Description :  Disables a client-specific-tag for the client
 519  *
 520  * Parameters  :
 521  *          1  :  csp = Current client state (buffers, headers, etc...)
 522  *          2  :  tag_name = The name of the tag to disable
 523  *
 524  * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY or JB_ERR_PARSE.
 525  *
 526  *********************************************************************/
 527 jb_err disable_client_specific_tag(struct client_state *csp, const char *tag_name)
 528 {
 529    struct client_tag_spec *tag;
 530
 531    privoxy_mutex_lock(&client_tags_mutex);
 532
 533    tag = get_client_specific_tag(csp->config->client_tags, tag_name);
 534    if (tag == NULL)
 535    {
 536       privoxy_mutex_unlock(&client_tags_mutex);
 537       return JB_ERR_PARSE;
 538    }
 539
 540    if (client_has_requested_tag(csp->client_address, tag_name))
 541    {
 542       remove_tag_for_client(csp->client_address, tag_name);
 543       log_error(LOG_LEVEL_INFO,
 544          "Tag '%s' disabled for client '%s'", tag->name, csp->client_address);
 545    }
 546    else
 547    {
 548       log_error(LOG_LEVEL_ERROR,
 549          "Tag '%s' currently not set for client '%s'",
 550          tag->name, csp->client_address);
 551    }
 552
 553    privoxy_mutex_unlock(&client_tags_mutex);
 554    return JB_ERR_OK;
 555
 556 }
 557
 558
 559 /*********************************************************************
 560  *
 561  * Function    :  client_tag_match
 562  *
 563  * Description :  Compare a client tag against a client tag pattern.
 564  *
 565  * Parameters  :
 566  *          1  :  pattern = a TAG pattern
 567  *          2  :  tag = Client tag to match
 568  *
 569  * Returns     :  Nonzero if the tag matches the pattern, else 0.
 570  *
 571  *********************************************************************/
 572 int client_tag_match(const struct pattern_spec *pattern,
 573                      const struct list *tags)
 574 {
 575    struct list_entry *tag;
 576
 577    if (!(pattern->flags & PATTERN_SPEC_CLIENT_TAG_PATTERN))
 578    {
 579       /*
 580        * It's not a client pattern and thus shouldn't
 581        * be matched against client tags.
 582        */
 583       return 0;
 584    }
 585
 586    assert(tags);
 587
 588    for (tag = tags->first; tag != NULL; tag = tag->next)
 589    {
 590       if (0 == regexec(pattern->pattern.tag_regex, tag->str, 0, NULL, 0))
 591       {
 592          return 1;
 593       }
 594    }
 595
 596    return 0;
 597
 598 }
 599
 600
 601 /*********************************************************************
 602  *
 603  * Function    :  set_client_address
 604  *
 605  * Description :  Sets the client address that will be used to enable,
 606  *                disable, or apply client tags.
 607  *
 608  * Parameters  :
 609  *          1  :  csp = Current client state (buffers, headers, etc...)
 610  *          2  :  headers = Client headers
 611  *
 612  * Returns     :  void.
 613  *
 614  *********************************************************************/
 615 void set_client_address(struct client_state *csp, const struct list *headers)
 616 {
 617    if (csp->config->trust_x_forwarded_for)
 618    {
 619       const char *client_address;
 620
 621       client_address = get_header_value(headers, "X-Forwarded-For:");
 622       if (client_address != NULL)
 623       {
 624          csp->client_address = strdup_or_die(client_address);
 625          log_error(LOG_LEVEL_HEADER,
 626             "Got client address %s from X-Forwarded-For header",
 627             csp->client_address);
 628       }
 629    }
 630
 631    if (csp->client_address == NULL)
 632    {
 633       csp->client_address = strdup_or_die(csp->ip_addr_str);
 634    }
 635 }
 636
 637 #else
 638 #error Compiling client-tags.c without FEATURE_CLIENT_TAGS
 639 #endif /* def FEATURE_CLIENT_TAGS */