include/tr_filter.h

   1 /*
   2  * Copyright (c) 2012, 2013, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef TR_FILTER_H
  36 #define TR_FILTER_H
  37
  38 #include <talloc.h>
  39 #include <jansson.h>
  40
  41 #include <tr_name_internal.h>
  42 #include <trust_router/tr_constraint.h>
  43 #include <trust_router/tid.h>
  44 #include <trust_router/trp.h>
  45
  46 #define TR_MAX_FILTERS  5
  47 #define TR_MAX_FILTER_LINES 8
  48 #define TR_MAX_FILTER_SPECS 8
  49 #define TR_MAX_FILTER_SPEC_MATCHES 64
  50
  51 /* Filter actions */
  52 typedef enum tr_filter_action {
  53   TR_FILTER_ACTION_REJECT = 0,
  54   TR_FILTER_ACTION_ACCEPT,
  55   TR_FILTER_ACTION_UNKNOWN
  56 } TR_FILTER_ACTION;
  57
  58 /* Match codes */
  59 #define TR_FILTER_MATCH 0
  60 #define TR_FILTER_NO_MATCH 1
  61
  62 /* Filter types */
  63 typedef enum {
  64   TR_FILTER_TYPE_TID_INBOUND = 0,
  65   TR_FILTER_TYPE_TRP_INBOUND,
  66   TR_FILTER_TYPE_TRP_OUTBOUND,
  67   TR_FILTER_TYPE_UNKNOWN
  68 } TR_FILTER_TYPE;
  69
  70 typedef struct tr_fspec {
  71   TR_NAME *field;
  72   TR_NAME *match[TR_MAX_FILTER_SPEC_MATCHES];
  73 } TR_FSPEC;
  74
  75 typedef struct tr_fline {
  76   TR_FILTER_ACTION action;
  77   TR_FSPEC *specs[TR_MAX_FILTER_SPECS];
  78   TR_CONSTRAINT *realm_cons;
  79   TR_CONSTRAINT *domain_cons;
  80 } TR_FLINE;
  81
  82 typedef struct tr_filter {
  83   TR_FILTER_TYPE type;
  84   TR_FLINE *lines[TR_MAX_FILTER_LINES];
  85 } TR_FILTER;
  86
  87
  88 typedef struct tr_filter_set TR_FILTER_SET;
  89 struct tr_filter_set {
  90   TR_FILTER *this;
  91   TR_FILTER_SET *next;
  92 };
  93
  94 /**
  95  * Structure to hold information needed to filter different targets.
  96  */
  97 typedef struct tr_filter_target {
  98   /* An inforec also needs realm and community information */
  99   TRP_INFOREC *trp_inforec;
 100   TRP_UPD *trp_upd;
 101
 102   /* a TID request has all the data it needs to be filtered */
 103   TID_REQ *tid_req;
 104 } TR_FILTER_TARGET;
 105
 106 TR_FILTER_SET *tr_filter_set_new(TALLOC_CTX *mem_ctx);
 107 void tr_filter_set_free(TR_FILTER_SET *fs);
 108 int tr_filter_set_add(TR_FILTER_SET *set, TR_FILTER *new);
 109 TR_FILTER *tr_filter_set_get(TR_FILTER_SET *set, TR_FILTER_TYPE type);
 110
 111 TR_FILTER *tr_filter_new(TALLOC_CTX *mem_ctx);
 112
 113 void tr_filter_free(TR_FILTER *filt);
 114
 115 void tr_filter_set_type(TR_FILTER *filt, TR_FILTER_TYPE type);
 116
 117 TR_FILTER_TYPE tr_filter_get_type(TR_FILTER *filt);
 118
 119 TR_FLINE *tr_fline_new(TALLOC_CTX *mem_ctx);
 120
 121 void tr_fline_free(TR_FLINE *fline);
 122
 123 TR_FSPEC *tr_fspec_new(TALLOC_CTX *mem_ctx);
 124
 125 void tr_fspec_free(TR_FSPEC *fspec);
 126
 127 void tr_fspec_add_match(TR_FSPEC *fspec, TR_NAME *match);
 128
 129 int tr_fspec_matches(TR_FSPEC *fspec, TR_FILTER_TYPE ftype, TR_FILTER_TARGET *target);
 130
 131
 132 /*In tr_constraint.c and exported, but not really a public symbol; needed by tr_filter.c and by tr_constraint.c*/
 133 int TR_EXPORT tr_prefix_wildcard_match(const char *str, const char *wc_str);
 134
 135 int tr_filter_apply(TR_FILTER_TARGET *target, TR_FILTER *filt, TR_CONSTRAINT_SET **constraints, TR_FILTER_ACTION *out_action);
 136 void tr_filter_target_free(TR_FILTER_TARGET *target);
 137 TR_FILTER_TARGET *tr_filter_target_tid_req(TALLOC_CTX *mem_ctx, TID_REQ *req);
 138 TR_FILTER_TARGET *tr_filter_target_trp_inforec(TALLOC_CTX *mem_ctx, TRP_UPD *upd, TRP_INFOREC *inforec);
 139
 140 TR_CONSTRAINT_SET *tr_constraint_set_from_fline(TR_FLINE *fline);
 141
 142 int tr_filter_validate(TR_FILTER *filt);
 143 int tr_filter_validate_spec_field(TR_FILTER_TYPE ftype, TR_FSPEC *fspec);
 144 const char *tr_filter_type_to_string(TR_FILTER_TYPE ftype);
 145 TR_FILTER_TYPE tr_filter_type_from_string(const char *s);
 146
 147 /* tr_filter_encoders.c */
 148 json_t *tr_filter_set_to_json(TR_FILTER_SET *filter_set);
 149
 150 #endif