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