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