include/trp_internal.h

   1 /*
   2  * Copyright (c) 2016, 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 TRP_INTERNAL_H
  36 #define TRP_INTERNAL_H
  37
  38 #include <jansson.h>
  39 #include <pthread.h>
  40 #include <talloc.h>
  41 #include <time.h>
  42
  43 #include <gsscon.h>
  44 #include <tr_mq.h>
  45 #include <tr_msg.h>
  46 #include <trp_peer.h>
  47 #include <trp_ptable.h>
  48 #include <trp_route.h>
  49 #include <trp_rtable.h>
  50 #include <tr_apc.h>
  51 #include <tr_comm.h>
  52 #include <trust_router/trp.h>
  53
  54 /* what clock do we use with clock_gettime() ? */
  55 #define TRP_CLOCK CLOCK_MONOTONIC
  56
  57 /* info records */
  58 /* TRP update record types */
  59 typedef struct trp_inforec_route {
  60   TR_NAME *trust_router;
  61   TR_NAME *next_hop;
  62   unsigned int next_hop_port;
  63   unsigned int metric;
  64   unsigned int interval;
  65 } TRP_INFOREC_ROUTE;
  66
  67 typedef struct trp_inforec_comm {
  68   TR_COMM_TYPE comm_type;
  69   TR_REALM_ROLE role;
  70   TR_APC *apcs;
  71   TR_NAME *owner_realm;
  72   TR_NAME *owner_contact;
  73   time_t expiration_interval; /* Minutes to key expiration; only valid for an APC */
  74   json_t *provenance;
  75   unsigned int interval;
  76 } TRP_INFOREC_COMM;
  77
  78 typedef union trp_inforec_data {
  79   TRP_INFOREC_ROUTE *route;
  80   TRP_INFOREC_COMM *comm;
  81 } TRP_INFOREC_DATA;
  82
  83 struct trp_inforec {
  84   TRP_INFOREC *next;
  85   TRP_INFOREC_TYPE type;
  86   TRP_INFOREC_DATA *data; /* contains pointer to one of the record types */
  87 };
  88
  89 struct trp_update {
  90   TR_NAME *realm;
  91   TR_NAME *comm;
  92   TRP_INFOREC *records;
  93   TR_NAME *peer; /* who did this update come from? */
  94 };
  95
  96 struct trp_req {
  97   TR_NAME *comm;
  98   TR_NAME *realm;
  99   TR_NAME *peer; /* who did this req come from? */
 100 };
 101
 102
 103 typedef struct trps_instance TRPS_INSTANCE;
 104
 105 typedef enum trp_connection_status {
 106   TRP_CONNECTION_CLOSED=0,
 107   TRP_CONNECTION_DOWN,
 108   TRP_CONNECTION_AUTHORIZING,
 109   TRP_CONNECTION_UP,
 110   TRP_CONNECTION_UNKNOWN,
 111 } TRP_CONNECTION_STATUS;
 112
 113 typedef struct trp_connection TRP_CONNECTION;
 114 struct trp_connection {
 115   pthread_mutex_t mutex; /* protects status attribute */
 116   TRP_CONNECTION *next;
 117   pthread_t *thread; /* thread servicing this connection */
 118   int fd;
 119   TR_NAME *gssname; /* the gss service name we presented for passive auth */
 120   TR_NAME *peer; /* gssname of incoming peer */
 121   gss_ctx_id_t *gssctx;
 122   TRP_CONNECTION_STATUS status;
 123   void (*status_change_cb)(TRP_CONNECTION *conn, void *cookie);
 124   void *status_change_cookie;
 125 };
 126
 127 typedef TRP_RC (*TRPS_MSG_FUNC)(TRPS_INSTANCE *, TRP_CONNECTION *, TR_MSG *);
 128 typedef void (*TRP_RESP_FUNC)();
 129 /*typedef int (*TRP_AUTH_FUNC)(gss_name_t client_name, TR_NAME *display_name, void *cookie);*/
 130 typedef client_cb_fn TRP_AUTH_FUNC;
 131
 132 /* function to look up comm/realm entries */
 133 typedef TRP_ROUTE *(TRP_LOOKUP_FUNC)(TR_NAME *, TR_NAME *, void *);
 134
 135
 136 /* TRP Client Instance Data */
 137 typedef struct trpc_instance TRPC_INSTANCE;
 138 struct trpc_instance {
 139   TRPC_INSTANCE *next;
 140   TR_NAME *gssname;
 141   char *server;
 142   unsigned int port;
 143   TRP_CONNECTION *conn;
 144   TR_MQ *mq; /* msgs from master to trpc */
 145   int shutting_down; /* 0 unless the TRPC is in the shutdown process */
 146 };
 147
 148 /* TRP Server Instance Data */
 149 struct trps_instance {
 150   char *hostname;
 151   unsigned int port;
 152   TRP_AUTH_FUNC auth_handler;
 153   TRPS_MSG_FUNC msg_handler;
 154   void *cookie;
 155   TRP_CONNECTION *conn; /* connections from peers */
 156   TRPC_INSTANCE *trpc; /* connections to peers */
 157   TR_MQ *mq; /* incoming message queue */
 158   TRP_PTABLE *ptable; /* peer table */
 159   TRP_RTABLE *rtable; /* route table */
 160   TR_COMM_TABLE *ctable; /* community table */
 161   struct timeval connect_interval; /* interval between connection refreshes */
 162   struct timeval update_interval; /* interval between scheduled updates */
 163   struct timeval sweep_interval; /* interval between route table sweeps */
 164 };
 165
 166 typedef enum trp_update_type {
 167   TRP_UPDATE_SCHEDULED=0,
 168   TRP_UPDATE_TRIGGERED,
 169   TRP_UPDATE_REQUESTED
 170 } TRP_UPDATE_TYPE;
 171
 172 TRP_CONNECTION *trp_connection_new(TALLOC_CTX *mem_ctx);
 173 void trp_connection_free(TRP_CONNECTION *conn);
 174 void trp_connection_close(TRP_CONNECTION *conn);
 175 int trp_connection_lock(TRP_CONNECTION *conn);
 176 int trp_connection_unlock(TRP_CONNECTION *conn);
 177 int trp_connection_get_fd(TRP_CONNECTION *conn);
 178 void trp_connection_set_fd(TRP_CONNECTION *conn, int fd);
 179 TR_NAME *trp_connection_get_peer(TRP_CONNECTION *conn);
 180 TR_NAME *trp_connection_get_gssname(TRP_CONNECTION *conn);
 181 void trp_connection_set_gssname(TRP_CONNECTION *conn, TR_NAME *gssname);
 182 gss_ctx_id_t *trp_connection_get_gssctx(TRP_CONNECTION *conn);
 183 void trp_connection_set_gssctx(TRP_CONNECTION *conn, gss_ctx_id_t *gssctx);
 184 TRP_CONNECTION_STATUS trp_connection_get_status(TRP_CONNECTION *conn);
 185 pthread_t *trp_connection_get_thread(TRP_CONNECTION *conn);
 186 void trp_connection_set_thread(TRP_CONNECTION *conn, pthread_t *thread);
 187 TRP_CONNECTION *trp_connection_get_next(TRP_CONNECTION *conn);
 188 TRP_CONNECTION *trp_connection_remove(TRP_CONNECTION *conn, TRP_CONNECTION *remove);
 189 void trp_connection_append(TRP_CONNECTION *conn, TRP_CONNECTION *new);
 190 int trp_connection_auth(TRP_CONNECTION *conn, TRP_AUTH_FUNC auth_callback, void *callback_data);
 191 TRP_CONNECTION *trp_connection_accept(TALLOC_CTX *mem_ctx, int listen, TR_NAME *gss_servicename);
 192 TRP_RC trp_connection_initiate(TRP_CONNECTION *conn, char *server, unsigned int port);
 193
 194 TRPC_INSTANCE *trpc_new (TALLOC_CTX *mem_ctx);
 195 void trpc_free (TRPC_INSTANCE *trpc);
 196 TRP_CONNECTION *trpc_get_conn(TRPC_INSTANCE *trpc);
 197 void trpc_set_conn(TRPC_INSTANCE *trpc, TRP_CONNECTION *conn);
 198 TRPC_INSTANCE *trpc_get_next(TRPC_INSTANCE *trpc);
 199 void trpc_set_next(TRPC_INSTANCE *trpc, TRPC_INSTANCE *next);
 200 TRPC_INSTANCE *trpc_remove(TRPC_INSTANCE *trpc, TRPC_INSTANCE *remove);
 201 void trpc_append(TRPC_INSTANCE *trpc, TRPC_INSTANCE *new);
 202 char *trpc_get_server(TRPC_INSTANCE *trpc);
 203 void trpc_set_server(TRPC_INSTANCE *trpc, char *server);
 204 TR_NAME *trpc_get_gssname(TRPC_INSTANCE *trpc);
 205 void trpc_set_gssname(TRPC_INSTANCE *trpc, TR_NAME *gssname);
 206 unsigned int trpc_get_port(TRPC_INSTANCE *trpc);
 207 void trpc_set_port(TRPC_INSTANCE *trpc, unsigned int port);
 208 TRP_CONNECTION_STATUS trpc_get_status(TRPC_INSTANCE *trpc);
 209 TR_MQ *trpc_get_mq(TRPC_INSTANCE *trpc);
 210 void trpc_set_mq(TRPC_INSTANCE *trpc, TR_MQ *mq);
 211 void trpc_mq_add(TRPC_INSTANCE *trpc, TR_MQ_MSG *msg);
 212 TR_MQ_MSG *trpc_mq_pop(TRPC_INSTANCE *trpc, struct timespec *ts_abort);
 213 void trpc_mq_clear(TRPC_INSTANCE *trpc);
 214 void trpc_master_mq_add(TRPC_INSTANCE *trpc, TR_MQ_MSG *msg);
 215 TR_MQ_MSG *trpc_master_mq_pop(TRPC_INSTANCE *trpc);
 216 TRP_RC trpc_connect(TRPC_INSTANCE *trpc);
 217 TRP_RC trpc_send_msg(TRPC_INSTANCE *trpc, const char *msg_content);
 218
 219 TRPS_INSTANCE *trps_new (TALLOC_CTX *mem_ctx);
 220 void trps_free (TRPS_INSTANCE *trps);
 221 void trps_set_ctable(TRPS_INSTANCE *trps, TR_COMM_TABLE *comm);
 222 void trps_set_ptable(TRPS_INSTANCE *trps, TRP_PTABLE *ptable);
 223 void trps_set_peer_status_callback(TRPS_INSTANCE *trps, void (*cb)(TRP_PEER *, void *), void *cookie);
 224 TR_NAME *trps_dup_label(TRPS_INSTANCE *trps);
 225 TRP_RC trps_init_rtable(TRPS_INSTANCE *trps);
 226 void trps_clear_rtable(TRPS_INSTANCE *trps);
 227 void trps_set_connect_interval(TRPS_INSTANCE *trps, unsigned int interval);
 228 unsigned int trps_get_connect_interval(TRPS_INSTANCE *trps);
 229 void trps_set_update_interval(TRPS_INSTANCE *trps, unsigned int interval);
 230 unsigned int trps_get_update_interval(TRPS_INSTANCE *trps);
 231 void trps_set_sweep_interval(TRPS_INSTANCE *trps, unsigned int interval);
 232 unsigned int trps_get_sweep_interval(TRPS_INSTANCE *trps);
 233 TRPC_INSTANCE *trps_find_trpc(TRPS_INSTANCE *trps, TRP_PEER *peer);
 234 TRP_RC trps_send_msg (TRPS_INSTANCE *trps, TRP_PEER *peer, const char *msg);
 235 void trps_add_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *new);
 236 void trps_remove_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *remove);
 237 void trps_add_trpc(TRPS_INSTANCE *trps, TRPC_INSTANCE *trpc);
 238 void trps_remove_trpc(TRPS_INSTANCE *trps, TRPC_INSTANCE *remove);
 239 int trps_get_listener(TRPS_INSTANCE *trps,
 240                       TRPS_MSG_FUNC msg_handler,
 241                       TRP_AUTH_FUNC auth_handler,
 242                       const char *hostname,
 243                       unsigned int port,
 244                       void *cookie,
 245                       int *fd_out,
 246                       size_t max_fd);
 247 TR_MQ_MSG *trps_mq_pop(TRPS_INSTANCE *trps);
 248 void trps_mq_add(TRPS_INSTANCE *trps, TR_MQ_MSG *msg);
 249 TRP_RC trps_authorize_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *conn);
 250 void trps_handle_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *conn);
 251 TRP_RC trps_update_active_routes(TRPS_INSTANCE *trps);
 252 TRP_RC trps_handle_tr_msg(TRPS_INSTANCE *trps, TR_MSG *tr_msg);
 253 TRP_ROUTE *trps_get_route(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm, TR_NAME *peer);
 254 TRP_ROUTE *trps_get_selected_route(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm);
 255 TR_NAME *trps_get_next_hop(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm);
 256 TRP_RC trps_sweep_routes(TRPS_INSTANCE *trps);
 257 TRP_RC trps_sweep_ctable(TRPS_INSTANCE *trps);
 258 TRP_RC trps_add_route(TRPS_INSTANCE *trps, TRP_ROUTE *route);
 259 TRP_RC trps_add_peer(TRPS_INSTANCE *trps, TRP_PEER *peer);
 260 TRP_PEER *trps_get_peer_by_gssname(TRPS_INSTANCE *trps, TR_NAME *gssname);
 261 TRP_PEER *trps_get_peer_by_servicename(TRPS_INSTANCE *trps, TR_NAME *servicename);
 262 TRP_RC trps_update(TRPS_INSTANCE *trps, TRP_UPDATE_TYPE type);
 263 int trps_peer_connected(TRPS_INSTANCE *trps, TRP_PEER *peer);
 264 TRP_RC trps_wildcard_route_req(TRPS_INSTANCE *trps, TR_NAME *peer_gssname);
 265
 266 TRP_INFOREC *trp_inforec_new(TALLOC_CTX *mem_ctx, TRP_INFOREC_TYPE type);
 267 void trp_inforec_free(TRP_INFOREC *rec);
 268 TRP_INFOREC *trp_inforec_get_next(TRP_INFOREC *rec);
 269 void trp_inforec_set_next(TRP_INFOREC *rec, TRP_INFOREC *next_rec);
 270 TRP_INFOREC_TYPE trp_inforec_get_type(TRP_INFOREC *rec);
 271 void trp_inforec_set_type(TRP_INFOREC *rec, TRP_INFOREC_TYPE type);
 272 TR_NAME *trp_inforec_get_comm(TRP_INFOREC *rec);
 273 TR_NAME *trp_inforec_dup_comm(TRP_INFOREC *rec);
 274 TRP_RC trp_inforec_set_comm(TRP_INFOREC *rec, TR_NAME *comm);
 275 TR_NAME *trp_inforec_get_realm(TRP_INFOREC *rec);
 276 TR_NAME *trp_inforec_dup_realm(TRP_INFOREC *rec);
 277 TRP_RC trp_inforec_set_realm(TRP_INFOREC *rec, TR_NAME *realm);
 278 TR_NAME *trp_inforec_get_trust_router(TRP_INFOREC *rec);
 279 TR_NAME *trp_inforec_dup_trust_router(TRP_INFOREC *rec);
 280 TRP_RC trp_inforec_set_trust_router(TRP_INFOREC *rec, TR_NAME *trust_router);
 281 TR_NAME *trp_inforec_get_next_hop(TRP_INFOREC *rec);
 282 TR_NAME *trp_inforec_dup_next_hop(TRP_INFOREC *rec);
 283 TRP_RC trp_inforec_set_next_hop(TRP_INFOREC *rec, TR_NAME *next_hop);
 284 unsigned int trp_inforec_get_metric(TRP_INFOREC *rec);
 285 TRP_RC trp_inforec_set_metric(TRP_INFOREC *rec, unsigned int metric);
 286 unsigned int trp_inforec_get_interval(TRP_INFOREC *rec);
 287 TRP_RC trp_inforec_set_interval(TRP_INFOREC *rec, unsigned int interval);
 288 TR_NAME *trp_inforec_get_owner_realm(TRP_INFOREC *rec);
 289 TRP_RC trp_inforec_set_owner_realm(TRP_INFOREC *rec, TR_NAME *name);
 290 TR_NAME *trp_inforec_get_owner_contact(TRP_INFOREC *rec);
 291 TRP_RC trp_inforec_set_owner_contact(TRP_INFOREC *rec, TR_NAME *name);
 292 json_t *trp_inforec_get_provenance(TRP_INFOREC *rec);
 293 TRP_RC trp_inforec_set_provenance(TRP_INFOREC *rec, json_t *prov);
 294 TRP_INFOREC_TYPE trp_inforec_type_from_string(const char *s);
 295 const char *trp_inforec_type_to_string(TRP_INFOREC_TYPE msgtype);
 296 time_t trp_inforec_get_exp_interval(TRP_INFOREC *rec);
 297 TRP_RC trp_inforec_set_exp_interval(TRP_INFOREC *rec, time_t expint);
 298 TR_COMM_TYPE trp_inforec_get_comm_type(TRP_INFOREC *rec);
 299 TRP_RC trp_inforec_set_comm_type(TRP_INFOREC *rec, TR_COMM_TYPE type);
 300 TR_REALM_ROLE trp_inforec_get_role(TRP_INFOREC *rec);
 301 TRP_RC trp_inforec_set_role(TRP_INFOREC *rec, TR_REALM_ROLE role);
 302 TR_APC *trp_inforec_get_apcs(TRP_INFOREC *rec);
 303 TRP_RC trp_inforec_set_apcs(TRP_INFOREC *rec, TR_APC *apcs);
 304 TR_NAME *trp_inforec_dup_origin(TRP_INFOREC *rec);
 305
 306 #endif /* TRP_INTERNAL_H */