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