2 * Copyright (c) 2016, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
35 #ifndef TRP_INTERNAL_H
36 #define TRP_INTERNAL_H
46 #include <trp_ptable.h>
47 #include <trp_rtable.h>
50 #include <trust_router/trp.h>
52 /* what clock do we use with clock_gettime() ? */
53 #define TRP_CLOCK CLOCK_MONOTONIC
56 /* TRP update record types */
57 typedef struct trp_inforec_route {
58 TR_NAME *trust_router;
60 unsigned int next_hop_port;
62 unsigned int interval;
65 typedef struct trp_inforec_comm {
66 TR_COMM_TYPE comm_type;
70 TR_NAME *owner_contact;
71 time_t expiration_interval; /* Minutes to key expiration; only valid for an APC */
73 unsigned int interval;
76 typedef union trp_inforec_data {
77 TRP_INFOREC_ROUTE *route;
78 TRP_INFOREC_COMM *comm;
83 TRP_INFOREC_TYPE type;
84 TRP_INFOREC_DATA *data; /* contains pointer to one of the record types */
91 TR_NAME *peer; /* who did this update come from? */
97 TR_NAME *peer; /* who did this req come from? */
101 typedef struct trps_instance TRPS_INSTANCE;
103 typedef enum trp_connection_status {
104 TRP_CONNECTION_CLOSED=0,
106 TRP_CONNECTION_AUTHORIZING,
108 TRP_CONNECTION_UNKNOWN,
109 } TRP_CONNECTION_STATUS;
111 typedef struct trp_connection TRP_CONNECTION;
112 struct trp_connection {
113 pthread_mutex_t mutex; /* protects status attribute */
114 TRP_CONNECTION *next;
115 pthread_t *thread; /* thread servicing this connection */
118 TR_NAME *peer; /* TODO: why is there a peer and a gssname? jlr */
119 gss_ctx_id_t *gssctx;
120 TRP_CONNECTION_STATUS status;
121 void (*status_change_cb)(TRP_CONNECTION *conn, void *cookie);
122 void *status_change_cookie;
125 typedef TRP_RC (*TRPS_MSG_FUNC)(TRPS_INSTANCE *, TRP_CONNECTION *, TR_MSG *);
126 typedef void (*TRP_RESP_FUNC)();
127 /*typedef int (*TRP_AUTH_FUNC)(gss_name_t client_name, TR_NAME *display_name, void *cookie);*/
128 typedef client_cb_fn TRP_AUTH_FUNC;
130 /* function to look up comm/realm entries */
131 typedef TRP_ROUTE *(TRP_LOOKUP_FUNC)(TR_NAME *, TR_NAME *, void *);
134 /* TRP Client Instance Data */
135 typedef struct trpc_instance TRPC_INSTANCE;
136 struct trpc_instance {
141 TRP_CONNECTION *conn;
142 TR_MQ *mq; /* msgs from master to trpc */
145 /* TRP Server Instance Data */
146 struct trps_instance {
149 TRP_AUTH_FUNC auth_handler;
150 TRPS_MSG_FUNC msg_handler;
152 TRP_CONNECTION *conn; /* connections from peers */
153 TRPC_INSTANCE *trpc; /* connections to peers */
154 TR_MQ *mq; /* incoming message queue */
155 TRP_PTABLE *ptable; /* peer table */
156 TRP_RTABLE *rtable; /* route table */
157 TR_COMM_TABLE *ctable; /* community table */
158 struct timeval connect_interval; /* interval between connection refreshes */
159 struct timeval update_interval; /* interval between scheduled updates */
160 struct timeval sweep_interval; /* interval between route table sweeps */
163 typedef enum trp_update_type {
164 TRP_UPDATE_SCHEDULED=0,
165 TRP_UPDATE_TRIGGERED,
169 TRP_CONNECTION *trp_connection_new(TALLOC_CTX *mem_ctx);
170 void trp_connection_free(TRP_CONNECTION *conn);
171 void trp_connection_close(TRP_CONNECTION *conn);
172 int trp_connection_lock(TRP_CONNECTION *conn);
173 int trp_connection_unlock(TRP_CONNECTION *conn);
174 int trp_connection_get_fd(TRP_CONNECTION *conn);
175 void trp_connection_set_fd(TRP_CONNECTION *conn, int fd);
176 TR_NAME *trp_connection_get_peer(TRP_CONNECTION *conn);
177 TR_NAME *trp_connection_get_gssname(TRP_CONNECTION *conn);
178 void trp_connection_set_gssname(TRP_CONNECTION *conn, TR_NAME *gssname);
179 gss_ctx_id_t *trp_connection_get_gssctx(TRP_CONNECTION *conn);
180 void trp_connection_set_gssctx(TRP_CONNECTION *conn, gss_ctx_id_t *gssctx);
181 TRP_CONNECTION_STATUS trp_connection_get_status(TRP_CONNECTION *conn);
182 pthread_t *trp_connection_get_thread(TRP_CONNECTION *conn);
183 void trp_connection_set_thread(TRP_CONNECTION *conn, pthread_t *thread);
184 TRP_CONNECTION *trp_connection_get_next(TRP_CONNECTION *conn);
185 TRP_CONNECTION *trp_connection_remove(TRP_CONNECTION *conn, TRP_CONNECTION *remove);
186 void trp_connection_append(TRP_CONNECTION *conn, TRP_CONNECTION *new);
187 int trp_connection_auth(TRP_CONNECTION *conn, TRP_AUTH_FUNC auth_callback, void *callback_data);
188 TRP_CONNECTION *trp_connection_accept(TALLOC_CTX *mem_ctx, int listen, TR_NAME *gssname);
189 TRP_RC trp_connection_initiate(TRP_CONNECTION *conn, char *server, unsigned int port);
191 TRPC_INSTANCE *trpc_new (TALLOC_CTX *mem_ctx);
192 void trpc_free (TRPC_INSTANCE *trpc);
193 TRP_CONNECTION *trpc_get_conn(TRPC_INSTANCE *trpc);
194 void trpc_set_conn(TRPC_INSTANCE *trpc, TRP_CONNECTION *conn);
195 TRPC_INSTANCE *trpc_get_next(TRPC_INSTANCE *trpc);
196 void trpc_set_next(TRPC_INSTANCE *trpc, TRPC_INSTANCE *next);
197 TRPC_INSTANCE *trpc_remove(TRPC_INSTANCE *trpc, TRPC_INSTANCE *remove);
198 void trpc_append(TRPC_INSTANCE *trpc, TRPC_INSTANCE *new);
199 char *trpc_get_server(TRPC_INSTANCE *trpc);
200 void trpc_set_server(TRPC_INSTANCE *trpc, char *server);
201 TR_NAME *trpc_get_gssname(TRPC_INSTANCE *trpc);
202 void trpc_set_gssname(TRPC_INSTANCE *trpc, TR_NAME *gssname);
203 unsigned int trpc_get_port(TRPC_INSTANCE *trpc);
204 void trpc_set_port(TRPC_INSTANCE *trpc, unsigned int port);
205 TRP_CONNECTION_STATUS trpc_get_status(TRPC_INSTANCE *trpc);
206 TR_MQ *trpc_get_mq(TRPC_INSTANCE *trpc);
207 void trpc_set_mq(TRPC_INSTANCE *trpc, TR_MQ *mq);
208 void trpc_mq_add(TRPC_INSTANCE *trpc, TR_MQ_MSG *msg);
209 TR_MQ_MSG *trpc_mq_pop(TRPC_INSTANCE *trpc);
210 void trpc_mq_clear(TRPC_INSTANCE *trpc);
211 void trpc_master_mq_add(TRPC_INSTANCE *trpc, TR_MQ_MSG *msg);
212 TR_MQ_MSG *trpc_master_mq_pop(TRPC_INSTANCE *trpc);
213 TRP_RC trpc_connect(TRPC_INSTANCE *trpc);
214 TRP_RC trpc_send_msg(TRPC_INSTANCE *trpc, const char *msg_content);
216 TRPS_INSTANCE *trps_new (TALLOC_CTX *mem_ctx);
217 void trps_free (TRPS_INSTANCE *trps);
218 void trps_set_ctable(TRPS_INSTANCE *trps, TR_COMM_TABLE *comm);
219 void trps_set_ptable(TRPS_INSTANCE *trps, TRP_PTABLE *ptable);
220 void trps_set_peer_status_callback(TRPS_INSTANCE *trps, void (*cb)(TRP_PEER *, void *), void *cookie);
221 TR_NAME *trps_dup_label(TRPS_INSTANCE *trps);
222 TRP_RC trps_init_rtable(TRPS_INSTANCE *trps);
223 void trps_clear_rtable(TRPS_INSTANCE *trps);
224 void trps_set_connect_interval(TRPS_INSTANCE *trps, unsigned int interval);
225 unsigned int trps_get_connect_interval(TRPS_INSTANCE *trps);
226 void trps_set_update_interval(TRPS_INSTANCE *trps, unsigned int interval);
227 unsigned int trps_get_update_interval(TRPS_INSTANCE *trps);
228 void trps_set_sweep_interval(TRPS_INSTANCE *trps, unsigned int interval);
229 unsigned int trps_get_sweep_interval(TRPS_INSTANCE *trps);
230 TRPC_INSTANCE *trps_find_trpc(TRPS_INSTANCE *trps, TRP_PEER *peer);
231 TRP_RC trps_send_msg (TRPS_INSTANCE *trps, TRP_PEER *peer, const char *msg);
232 void trps_add_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *new);
233 void trps_remove_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *remove);
234 void trps_add_trpc(TRPS_INSTANCE *trps, TRPC_INSTANCE *trpc);
235 void trps_remove_trpc(TRPS_INSTANCE *trps, TRPC_INSTANCE *remove);
236 int trps_get_listener(TRPS_INSTANCE *trps,
237 TRPS_MSG_FUNC msg_handler,
238 TRP_AUTH_FUNC auth_handler,
239 const char *hostname,
244 TR_MQ_MSG *trps_mq_pop(TRPS_INSTANCE *trps);
245 void trps_mq_add(TRPS_INSTANCE *trps, TR_MQ_MSG *msg);
246 TRP_RC trps_authorize_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *conn);
247 void trps_handle_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *conn);
248 TRP_RC trps_update_active_routes(TRPS_INSTANCE *trps);
249 TRP_RC trps_handle_tr_msg(TRPS_INSTANCE *trps, TR_MSG *tr_msg);
250 TRP_ROUTE *trps_get_route(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm, TR_NAME *peer);
251 TRP_ROUTE *trps_get_selected_route(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm);
252 TR_NAME *trps_get_next_hop(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm);
253 TRP_RC trps_sweep_routes(TRPS_INSTANCE *trps);
254 TRP_RC trps_sweep_ctable(TRPS_INSTANCE *trps);
255 TRP_RC trps_add_route(TRPS_INSTANCE *trps, TRP_ROUTE *route);
256 TRP_RC trps_add_peer(TRPS_INSTANCE *trps, TRP_PEER *peer);
257 TRP_PEER *trps_get_peer_by_gssname(TRPS_INSTANCE *trps, TR_NAME *gssname);
258 TRP_PEER *trps_get_peer_by_servicename(TRPS_INSTANCE *trps, TR_NAME *servicename);
259 TRP_RC trps_update(TRPS_INSTANCE *trps, TRP_UPDATE_TYPE type);
260 int trps_peer_connected(TRPS_INSTANCE *trps, TRP_PEER *peer);
261 TRP_RC trps_wildcard_route_req(TRPS_INSTANCE *trps, TR_NAME *peer_gssname);
263 TRP_INFOREC *trp_inforec_new(TALLOC_CTX *mem_ctx, TRP_INFOREC_TYPE type);
264 void trp_inforec_free(TRP_INFOREC *rec);
265 TRP_INFOREC *trp_inforec_get_next(TRP_INFOREC *rec);
266 void trp_inforec_set_next(TRP_INFOREC *rec, TRP_INFOREC *next_rec);
267 TRP_INFOREC_TYPE trp_inforec_get_type(TRP_INFOREC *rec);
268 void trp_inforec_set_type(TRP_INFOREC *rec, TRP_INFOREC_TYPE type);
269 TR_NAME *trp_inforec_get_comm(TRP_INFOREC *rec);
270 TR_NAME *trp_inforec_dup_comm(TRP_INFOREC *rec);
271 TRP_RC trp_inforec_set_comm(TRP_INFOREC *rec, TR_NAME *comm);
272 TR_NAME *trp_inforec_get_realm(TRP_INFOREC *rec);
273 TR_NAME *trp_inforec_dup_realm(TRP_INFOREC *rec);
274 TRP_RC trp_inforec_set_realm(TRP_INFOREC *rec, TR_NAME *realm);
275 TR_NAME *trp_inforec_get_trust_router(TRP_INFOREC *rec);
276 TR_NAME *trp_inforec_dup_trust_router(TRP_INFOREC *rec);
277 TRP_RC trp_inforec_set_trust_router(TRP_INFOREC *rec, TR_NAME *trust_router);
278 TR_NAME *trp_inforec_get_next_hop(TRP_INFOREC *rec);
279 TR_NAME *trp_inforec_dup_next_hop(TRP_INFOREC *rec);
280 TRP_RC trp_inforec_set_next_hop(TRP_INFOREC *rec, TR_NAME *next_hop);
281 unsigned int trp_inforec_get_metric(TRP_INFOREC *rec);
282 TRP_RC trp_inforec_set_metric(TRP_INFOREC *rec, unsigned int metric);
283 unsigned int trp_inforec_get_interval(TRP_INFOREC *rec);
284 TRP_RC trp_inforec_set_interval(TRP_INFOREC *rec, unsigned int interval);
285 TR_NAME *trp_inforec_get_owner_realm(TRP_INFOREC *rec);
286 TRP_RC trp_inforec_set_owner_realm(TRP_INFOREC *rec, TR_NAME *name);
287 TR_NAME *trp_inforec_get_owner_contact(TRP_INFOREC *rec);
288 TRP_RC trp_inforec_set_owner_contact(TRP_INFOREC *rec, TR_NAME *name);
289 json_t *trp_inforec_get_provenance(TRP_INFOREC *rec);
290 TRP_RC trp_inforec_set_provenance(TRP_INFOREC *rec, json_t *prov);
291 TRP_INFOREC_TYPE trp_inforec_type_from_string(const char *s);
292 const char *trp_inforec_type_to_string(TRP_INFOREC_TYPE msgtype);
293 time_t trp_inforec_get_exp_interval(TRP_INFOREC *rec);
294 TRP_RC trp_inforec_set_exp_interval(TRP_INFOREC *rec, time_t expint);
295 TR_COMM_TYPE trp_inforec_get_comm_type(TRP_INFOREC *rec);
296 TRP_RC trp_inforec_set_comm_type(TRP_INFOREC *rec, TR_COMM_TYPE type);
297 TR_REALM_ROLE trp_inforec_get_role(TRP_INFOREC *rec);
298 TRP_RC trp_inforec_set_role(TRP_INFOREC *rec, TR_REALM_ROLE role);
299 TR_APC *trp_inforec_get_apcs(TRP_INFOREC *rec);
300 TRP_RC trp_inforec_set_apcs(TRP_INFOREC *rec, TR_APC *apcs);
301 TR_NAME *trp_inforec_dup_origin(TRP_INFOREC *rec);
303 #endif /* TRP_INTERNAL_H */