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 #include <glib.h>
  41
  42 #include <tr_name_internal.h>
  43 #include <trust_router/tr_constraint.h>
  44 #include <trust_router/tid.h>
  45 #include <trust_router/trp.h>
  46
  47 #define TR_MAX_FILTER_SPECS 8
  48
  49 /* Filter actions */
  50 typedef enum tr_filter_action {
  51   TR_FILTER_ACTION_REJECT = 0,
  52   TR_FILTER_ACTION_ACCEPT,
  53   TR_FILTER_ACTION_UNKNOWN
  54 } TR_FILTER_ACTION;
  55
  56 /* Match codes */
  57 #define TR_FILTER_MATCH 0
  58 #define TR_FILTER_NO_MATCH 1
  59
  60 /* Filter types */
  61 typedef enum {
  62   TR_FILTER_TYPE_TID_INBOUND = 0,
  63   TR_FILTER_TYPE_TRP_INBOUND,
  64   TR_FILTER_TYPE_TRP_OUTBOUND,
  65   TR_FILTER_TYPE_UNKNOWN
  66 } TR_FILTER_TYPE;
  67
  68 typedef struct tr_fspec {
  69   TR_NAME *field;
  70   GPtrArray *match;
  71 } TR_FSPEC;
  72
  73 typedef struct tr_fspec_iter {
  74   TR_FSPEC *fspec;
  75   guint ii;
  76 } TR_FSPEC_ITER;
  77
  78 typedef struct tr_fline {
  79   TR_FILTER_ACTION action;
  80   TR_FSPEC *specs[TR_MAX_FILTER_SPECS];
  81   TR_CONSTRAINT *realm_cons;
  82   TR_CONSTRAINT *domain_cons;
  83 } TR_FLINE;
  84
  85 typedef struct tr_filter {
  86   TR_FILTER_TYPE type;
  87   GPtrArray *lines;
  88 } TR_FILTER;
  89
  90 typedef struct tr_filter_iter {
  91   TR_FILTER *filter;
  92   guint ii;
  93 } TR_FILTER_ITER;
  94
  95 typedef struct tr_filter_set TR_FILTER_SET;
  96 struct tr_filter_set {
  97   TR_FILTER *this;
  98   TR_FILTER_SET *next;
  99 };
 100
 101 /**
 102  * Structure to hold information needed to filter different targets.
 103  */
 104 typedef struct tr_filter_target {
 105   /* An inforec also needs realm and community information */
 106   TRP_INFOREC *trp_inforec;
 107   TRP_UPD *trp_upd;
 108
 109   /* a TID request has all the data it needs to be filtered */
 110   TID_REQ *tid_req;
 111 } TR_FILTER_TARGET;
 112
 113 TR_FILTER_SET *tr_filter_set_new(TALLOC_CTX *mem_ctx);
 114 void tr_filter_set_free(TR_FILTER_SET *fs);
 115 int tr_filter_set_add(TR_FILTER_SET *set, TR_FILTER *new);
 116 TR_FILTER *tr_filter_set_get(TR_FILTER_SET *set, TR_FILTER_TYPE type);
 117
 118 TR_FILTER *tr_filter_new(TALLOC_CTX *mem_ctx);
 119 void tr_filter_free(TR_FILTER *filt);
 120
 121 void tr_filter_set_type(TR_FILTER *filt, TR_FILTER_TYPE type);
 122 TR_FILTER_TYPE tr_filter_get_type(TR_FILTER *filt);
 123 TR_FLINE *tr_filter_add_line(TR_FILTER *filt, TR_FLINE *line);
 124
 125 TR_FLINE *tr_fline_new(TALLOC_CTX *mem_ctx);
 126
 127 void tr_fline_free(TR_FLINE *fline);
 128
 129 TR_FSPEC *tr_fspec_new(TALLOC_CTX *mem_ctx);
 130
 131 void tr_fspec_free(TR_FSPEC *fspec);
 132
 133 TR_NAME *tr_fspec_add_match(TR_FSPEC *fspec, TR_NAME *match);
 134
 135 int tr_fspec_matches(TR_FSPEC *fspec, TR_FILTER_TYPE ftype, TR_FILTER_TARGET *target);
 136
 137 TR_FILTER_ITER *tr_filter_iter_new(TALLOC_CTX *mem_ctx);
 138 void tr_filter_iter_free(TR_FILTER_ITER *iter);
 139 TR_FLINE *tr_filter_iter_first(TR_FILTER_ITER *iter, TR_FILTER *filter);
 140 TR_FLINE *tr_filter_iter_next(TR_FILTER_ITER *iter);
 141
 142 TR_FSPEC_ITER *tr_fspec_iter_new(TALLOC_CTX *mem_ctx);
 143 void tr_fspec_iter_free(TR_FSPEC_ITER *iter);
 144 TR_NAME *tr_fspec_iter_first(TR_FSPEC_ITER *iter, TR_FSPEC *fspec);
 145 TR_NAME *tr_fspec_iter_next(TR_FSPEC_ITER *iter);
 146
 147 /*In tr_constraint.c and exported, but not really a public symbol; needed by tr_filter.c and by tr_constraint.c*/
 148 int TR_EXPORT tr_prefix_wildcard_match(const char *str, const char *wc_str);
 149
 150 int tr_filter_apply(TR_FILTER_TARGET *target, TR_FILTER *filt, TR_CONSTRAINT_SET **constraints, TR_FILTER_ACTION *out_action);
 151 void tr_filter_target_free(TR_FILTER_TARGET *target);
 152 TR_FILTER_TARGET *tr_filter_target_tid_req(TALLOC_CTX *mem_ctx, TID_REQ *req);
 153 TR_FILTER_TARGET *tr_filter_target_trp_inforec(TALLOC_CTX *mem_ctx, TRP_UPD *upd, TRP_INFOREC *inforec);
 154
 155 TR_CONSTRAINT_SET *tr_constraint_set_from_fline(TR_FLINE *fline);
 156
 157 int tr_filter_validate(TR_FILTER *filt);
 158 int tr_filter_validate_spec_field(TR_FILTER_TYPE ftype, TR_FSPEC *fspec);
 159 const char *tr_filter_type_to_string(TR_FILTER_TYPE ftype);
 160 TR_FILTER_TYPE tr_filter_type_from_string(const char *s);
 161
 162 /* tr_filter_encoders.c */
 163 json_t *tr_filter_set_to_json(TR_FILTER_SET *filter_set);
 164
 165 #endif