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    :  get_next_tag_timeout_for_client
 258  *
 259  * Description :  Figures out when the next temporarily enabled tag
 260  *                for the client will have timed out.
 261  *
 262  * Parameters  :
 263  *          1  :  client_address = Address of the client
 264  *
 265  * Returns     :  Lowest timeout in seconds
 266  *
 267  *********************************************************************/
 268 time_t get_next_tag_timeout_for_client(const char *client_address)
 269 {
 270    struct client_specific_tag *enabled_tags;
 271    time_t next_timeout = 0;
 272    const time_t now = time(NULL);
 273
 274    privoxy_mutex_lock(&client_tags_mutex);
 275
 276    enabled_tags = get_tags_for_client(client_address);
 277    while (enabled_tags != NULL)
 278    {
 279       log_error(LOG_LEVEL_CGI, "Evaluating tag '%s' for client %s. End of life %d",
 280          enabled_tags->name, client_address, enabled_tags->end_of_life);
 281       if (enabled_tags->end_of_life)
 282       {
 283           time_t time_left = enabled_tags->end_of_life - now;
 284           /* Add a second to make sure the tag will have expired */
 285           time_left++;
 286           log_error(LOG_LEVEL_CGI, "%d > %d?", next_timeout, time_left);
 287           if (next_timeout == 0 || next_timeout > time_left)
 288           {
 289              next_timeout = time_left;
 290           }
 291        }
 292        enabled_tags = enabled_tags->next;
 293    }
 294
 295    privoxy_mutex_unlock(&client_tags_mutex);
 296
 297    log_error(LOG_LEVEL_CGI, "Next timeout in %d seconds", next_timeout);
 298
 299    return next_timeout;
 300
 301 }
 302
 303 /*********************************************************************
 304  *
 305  * Function    :  add_tag_for_client
 306  *
 307  * Description :  Adds the tag for the client.
 308  *
 309  * Parameters  :
 310  *          1  :  client_address = Address of the client
 311  *          2  :  tag = The tag to add.
 312  *          3  :  time_to_live = 0, or the number of seconds
 313  *                               the tag remains activated.
 314  *
 315  * Returns     :  void
 316  *
 317  *********************************************************************/
 318 static void add_tag_for_client(const char *client_address,
 319    const char *tag, const time_t time_to_live)
 320 {
 321    struct requested_tags *clients_with_tags;
 322    struct client_specific_tag *enabled_tags;
 323
 324    validate_requested_tags();
 325
 326    if (requested_tags == NULL)
 327    {
 328       /* XXX: Code duplication. */
 329       requested_tags = zalloc_or_die(sizeof(struct requested_tags));
 330       requested_tags->client = strdup_or_die(client_address);
 331       requested_tags->tags = zalloc_or_die(sizeof(struct client_specific_tag));
 332       requested_tags->tags->name = strdup_or_die(tag);
 333       requested_tags->tags->end_of_life = time_to_live ?
 334          (time(NULL) + time_to_live) : 0;
 335
 336       validate_requested_tags();
 337       return;
 338    }
 339    else
 340    {
 341       clients_with_tags = requested_tags;
 342       while (clients_with_tags->next != NULL)
 343       {
 344          if (!strcmp(clients_with_tags->client, client_address))
 345          {
 346             break;
 347          }
 348          clients_with_tags = clients_with_tags->next;
 349       }
 350       if (strcmp(clients_with_tags->client, client_address))
 351       {
 352          /* Client does not have tags yet, add new structure */
 353          clients_with_tags->next = zalloc_or_die(sizeof(struct requested_tags));
 354          clients_with_tags->next->prev = clients_with_tags;
 355          clients_with_tags = clients_with_tags->next;
 356          clients_with_tags->client = strdup_or_die(client_address);
 357          clients_with_tags->tags = zalloc_or_die(sizeof(struct client_specific_tag));
 358          clients_with_tags->tags->name = strdup_or_die(tag);
 359          clients_with_tags->tags->end_of_life = time_to_live ?
 360             (time(NULL) + time_to_live) : 0;
 361
 362          validate_requested_tags();
 363
 364          return;
 365       }
 366    }
 367
 368    enabled_tags = clients_with_tags->tags;
 369    while (enabled_tags != NULL)
 370    {
 371       if (enabled_tags->next == NULL)
 372       {
 373          enabled_tags->next = zalloc_or_die(sizeof(struct client_specific_tag));
 374          enabled_tags->next->name = strdup_or_die(tag);
 375          clients_with_tags->tags->end_of_life = time_to_live ?
 376             (time(NULL) + time_to_live) : 0;
 377          enabled_tags->next->prev = enabled_tags;
 378          break;
 379       }
 380       enabled_tags = enabled_tags->next;
 381    }
 382
 383    validate_requested_tags();
 384 }
 385
 386
 387 /*********************************************************************
 388  *
 389  * Function    :  remove_tag_for_client
 390  *
 391  * Description :  Removes the tag for the client.
 392  *
 393  * Parameters  :
 394  *          1  :  client_address = Address of the client
 395  *          2  :  tag = The tag to remove.
 396  *
 397  * Returns     :  void
 398  *
 399  *********************************************************************/
 400 static void remove_tag_for_client(const char *client_address, const char *tag)
 401 {
 402    struct requested_tags *clients_with_tags;
 403    struct client_specific_tag *enabled_tags;
 404
 405    validate_requested_tags();
 406
 407    clients_with_tags = requested_tags;
 408    while (clients_with_tags != NULL && clients_with_tags->client != NULL)
 409    {
 410       if (!strcmp(clients_with_tags->client, client_address))
 411       {
 412          break;
 413       }
 414       clients_with_tags = clients_with_tags->next;
 415    }
 416
 417    assert(clients_with_tags != NULL);
 418    if (clients_with_tags == NULL)
 419    {
 420       log_error(LOG_LEVEL_ERROR,
 421          "Tried to remove tag %s for tag-less client %s",
 422          tag, client_address);
 423    }
 424    enabled_tags = clients_with_tags->tags;
 425    while (enabled_tags != NULL)
 426    {
 427       if (!strcmp(enabled_tags->name, tag))
 428       {
 429          if (enabled_tags->next != NULL)
 430          {
 431             enabled_tags->next->prev = enabled_tags->prev;
 432             if (enabled_tags == clients_with_tags->tags)
 433             {
 434                /* Tag is first in line */
 435                clients_with_tags->tags = enabled_tags->next;
 436             }
 437          }
 438          if (enabled_tags->prev != NULL)
 439          {
 440             /* Tag has preceding tag */
 441             enabled_tags->prev->next = enabled_tags->next;
 442          }
 443          if (enabled_tags->prev == NULL && enabled_tags->next == NULL)
 444          {
 445             /* Tag is the only one */
 446             if (clients_with_tags->next != NULL)
 447             {
 448                /* Client has following client */
 449                clients_with_tags->next->prev = clients_with_tags->prev;
 450             }
 451             if (clients_with_tags->prev != NULL)
 452             {
 453                /* Client has preceding client */
 454                clients_with_tags->prev->next = clients_with_tags->next;
 455             }
 456             freez(clients_with_tags->client);
 457             if (clients_with_tags == requested_tags)
 458             {
 459                /* Removing last tag */
 460                freez(requested_tags);
 461                clients_with_tags = requested_tags;
 462             }
 463             else
 464             {
 465                freez(clients_with_tags);
 466             }
 467          }
 468          freez(enabled_tags->name);
 469          freez(enabled_tags);
 470          break;
 471       }
 472
 473       enabled_tags = enabled_tags->next;
 474    }
 475
 476    validate_requested_tags();
 477
 478 }
 479
 480
 481 /*********************************************************************
 482  *
 483  * Function    :  client_has_requested_tag
 484  *
 485  * Description :  Checks whether or not the given client requested
 486  *                the tag.
 487  *
 488  * Parameters  :
 489  *          1  :  client_address = Address of the client
 490  *          2  :  tag = Tag to check.
 491  *
 492  * Returns     :  TRUE or FALSE.
 493  *
 494  *********************************************************************/
 495 int client_has_requested_tag(const char *client_address, const char *tag)
 496 {
 497    struct client_specific_tag *enabled_tags;
 498
 499    enabled_tags = get_tags_for_client(client_address);
 500
 501    while (enabled_tags != NULL)
 502    {
 503       if (!strcmp(enabled_tags->name, tag))
 504       {
 505          return TRUE;
 506       }
 507       enabled_tags = enabled_tags->next;
 508    }
 509
 510    return FALSE;
 511
 512 }
 513
 514 /*********************************************************************
 515  *
 516  * Function    :  enable_client_specific_tag
 517  *
 518  * Description :  Enables 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 enable
 523  *          3  :  time_to_live = If not 0, the number of seconds the
 524  *                               tag should stay enabled.
 525  *
 526  * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY or JB_ERR_PARSE.
 527  *
 528  *********************************************************************/
 529 jb_err enable_client_specific_tag(struct client_state *csp,
 530    const char *tag_name, const time_t time_to_live)
 531 {
 532    struct client_tag_spec *tag;
 533
 534    privoxy_mutex_lock(&client_tags_mutex);
 535
 536    tag = get_client_specific_tag(csp->config->client_tags, tag_name);
 537    if (tag == NULL)
 538    {
 539       privoxy_mutex_unlock(&client_tags_mutex);
 540       return JB_ERR_PARSE;
 541    }
 542
 543    if (client_has_requested_tag(csp->client_address, tag_name))
 544    {
 545       log_error(LOG_LEVEL_ERROR,
 546          "Tag '%s' already enabled for client '%s'", tag->name, csp->client_address);
 547    }
 548    else
 549    {
 550       add_tag_for_client(csp->client_address, tag_name, time_to_live);
 551       log_error(LOG_LEVEL_INFO,
 552          "Tag '%s' enabled for client '%s'. TTL: %d.",
 553          tag->name, csp->client_address, time_to_live);
 554    }
 555
 556    privoxy_mutex_unlock(&client_tags_mutex);
 557
 558    return JB_ERR_OK;
 559
 560 }
 561
 562 /*********************************************************************
 563  *
 564  * Function    :  disable_client_specific_tag
 565  *
 566  * Description :  Disables a client-specific-tag for the client
 567  *
 568  * Parameters  :
 569  *          1  :  csp = Current client state (buffers, headers, etc...)
 570  *          2  :  tag_name = The name of the tag to disable
 571  *
 572  * Returns     :  JB_ERR_OK on success, JB_ERR_MEMORY or JB_ERR_PARSE.
 573  *
 574  *********************************************************************/
 575 jb_err disable_client_specific_tag(struct client_state *csp, const char *tag_name)
 576 {
 577    struct client_tag_spec *tag;
 578
 579    privoxy_mutex_lock(&client_tags_mutex);
 580
 581    tag = get_client_specific_tag(csp->config->client_tags, tag_name);
 582    if (tag == NULL)
 583    {
 584       privoxy_mutex_unlock(&client_tags_mutex);
 585       return JB_ERR_PARSE;
 586    }
 587
 588    if (client_has_requested_tag(csp->client_address, tag_name))
 589    {
 590       remove_tag_for_client(csp->client_address, tag_name);
 591       log_error(LOG_LEVEL_INFO,
 592          "Tag '%s' disabled for client '%s'", tag->name, csp->client_address);
 593    }
 594    else
 595    {
 596       log_error(LOG_LEVEL_ERROR,
 597          "Tag '%s' currently not set for client '%s'",
 598          tag->name, csp->client_address);
 599    }
 600
 601    privoxy_mutex_unlock(&client_tags_mutex);
 602    return JB_ERR_OK;
 603
 604 }
 605
 606
 607 /*********************************************************************
 608  *
 609  * Function    :  client_tag_match
 610  *
 611  * Description :  Compare a client tag against a client tag pattern.
 612  *
 613  * Parameters  :
 614  *          1  :  pattern = a TAG pattern
 615  *          2  :  tag = Client tag to match
 616  *
 617  * Returns     :  Nonzero if the tag matches the pattern, else 0.
 618  *
 619  *********************************************************************/
 620 int client_tag_match(const struct pattern_spec *pattern,
 621                      const struct list *tags)
 622 {
 623    struct list_entry *tag;
 624
 625    if (!(pattern->flags & PATTERN_SPEC_CLIENT_TAG_PATTERN))
 626    {
 627       /*
 628        * It's not a client pattern and thus shouldn't
 629        * be matched against client tags.
 630        */
 631       return 0;
 632    }
 633
 634    assert(tags);
 635
 636    for (tag = tags->first; tag != NULL; tag = tag->next)
 637    {
 638       if (0 == regexec(pattern->pattern.tag_regex, tag->str, 0, NULL, 0))
 639       {
 640          return 1;
 641       }
 642    }
 643
 644    return 0;
 645
 646 }
 647
 648
 649 /*********************************************************************
 650  *
 651  * Function    :  set_client_address
 652  *
 653  * Description :  Sets the client address that will be used to enable,
 654  *                disable, or apply client tags.
 655  *
 656  * Parameters  :
 657  *          1  :  csp = Current client state (buffers, headers, etc...)
 658  *          2  :  headers = Client headers
 659  *
 660  * Returns     :  void.
 661  *
 662  *********************************************************************/
 663 void set_client_address(struct client_state *csp, const struct list *headers)
 664 {
 665    if (csp->config->trust_x_forwarded_for)
 666    {
 667       const char *client_address;
 668
 669       client_address = get_header_value(headers, "X-Forwarded-For:");
 670       if (client_address != NULL)
 671       {
 672          csp->client_address = strdup_or_die(client_address);
 673          log_error(LOG_LEVEL_HEADER,
 674             "Got client address %s from X-Forwarded-For header",
 675             csp->client_address);
 676       }
 677    }
 678
 679    if (csp->client_address == NULL)
 680    {
 681       csp->client_address = strdup_or_die(csp->ip_addr_str);
 682    }
 683 }
 684
 685 #else
 686 #error Compiling client-tags.c without FEATURE_CLIENT_TAGS
 687 #endif /* def FEATURE_CLIENT_TAGS */