X-Git-Url: http://www.project-moonshot.org/gitweb/?p=trust_router.git;a=blobdiff_plain;f=include%2Ftrp_internal.h;h=a52edb8af004af63efcafe7e5242b6b0229ccf1b;hp=d951012f209ca57a85e7678a3927875428d8222a;hb=d3d9b0eb4b1718cad404236d589fff2f16de2c37;hpb=1a5de28486a067715ad2357bfa0a0f11318b9597 diff --git a/include/trp_internal.h b/include/trp_internal.h index d951012..a52edb8 100644 --- a/include/trp_internal.h +++ b/include/trp_internal.h @@ -1,55 +1,268 @@ +/* + * Copyright (c) 2016, JANET(UK) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of JANET(UK) nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + #ifndef TRP_INTERNAL_H #define TRP_INTERNAL_H +#include +#include #include +#include #include -#include +#include +#include +#include +#include +#include +#include +#include +#include #include -/* info records */ -typedef enum trp_inforec_type { - TRP_INFOREC_TYPE_UNKNOWN=0, /* conveniently, JSON parser returns 0 if a non-integer number is specified */ - TRP_INFOREC_TYPE_ROUTE, - TRP_INFOREC_TYPE_COMMUNITY, /* not yet implemented (2016-06-14) */ -} TRP_INFOREC_TYPE; +/* what clock do we use with clock_gettime() ? */ +#define TRP_CLOCK CLOCK_MONOTONIC +/* info records */ /* TRP update record types */ typedef struct trp_inforec_route { - TR_NAME *comm; - TR_NAME *realm; TR_NAME *trust_router; + TR_NAME *next_hop; + unsigned int next_hop_port; unsigned int metric; unsigned int interval; } TRP_INFOREC_ROUTE; -/* TODO: define struct trp_msg_info_community */ +typedef struct trp_inforec_comm { + TR_COMM_TYPE comm_type; + TR_REALM_ROLE role; + TR_APC *apcs; + TR_NAME *owner_realm; + TR_NAME *owner_contact; + time_t expiration_interval; /* Minutes to key expiration; only valid for an APC */ + json_t *provenance; + unsigned int interval; +} TRP_INFOREC_COMM; typedef union trp_inforec_data { TRP_INFOREC_ROUTE *route; - /* TRP_INFOREC_COMM *comm; */ + TRP_INFOREC_COMM *comm; } TRP_INFOREC_DATA; -typedef struct trp_inforec TRP_INFOREC; struct trp_inforec { TRP_INFOREC *next; TRP_INFOREC_TYPE type; - TRP_INFOREC_DATA data; /* contains pointer to one of the record types */ + TRP_INFOREC_DATA *data; /* contains pointer to one of the record types */ }; struct trp_update { + TR_NAME *realm; + TR_NAME *comm; TRP_INFOREC *records; + TR_NAME *peer; /* who did this update come from? */ }; struct trp_req { TR_NAME *comm; TR_NAME *realm; + TR_NAME *peer; /* who did this req come from? */ +}; + + +typedef struct trps_instance TRPS_INSTANCE; + +typedef enum trp_connection_status { + TRP_CONNECTION_CLOSED=0, + TRP_CONNECTION_DOWN, + TRP_CONNECTION_AUTHORIZING, + TRP_CONNECTION_UP, + TRP_CONNECTION_UNKNOWN, +} TRP_CONNECTION_STATUS; + +typedef struct trp_connection TRP_CONNECTION; +struct trp_connection { + pthread_mutex_t mutex; /* protects status attribute */ + TRP_CONNECTION *next; + pthread_t *thread; /* thread servicing this connection */ + int fd; + TR_NAME *gssname; /* the gss service name we presented for passive auth */ + TR_NAME *peer; /* gssname of incoming peer */ + gss_ctx_id_t *gssctx; + TRP_CONNECTION_STATUS status; + void (*status_change_cb)(TRP_CONNECTION *conn, void *cookie); + void *status_change_cookie; +}; + +typedef TRP_RC (*TRPS_MSG_FUNC)(TRPS_INSTANCE *, TRP_CONNECTION *, TR_MSG *); +typedef void (*TRP_RESP_FUNC)(); +/*typedef int (*TRP_AUTH_FUNC)(gss_name_t client_name, TR_NAME *display_name, void *cookie);*/ +typedef client_cb_fn TRP_AUTH_FUNC; + +/* function to look up comm/realm entries */ +typedef TRP_ROUTE *(TRP_LOOKUP_FUNC)(TR_NAME *, TR_NAME *, void *); + + +/* TRP Client Instance Data */ +typedef struct trpc_instance TRPC_INSTANCE; +struct trpc_instance { + TRPC_INSTANCE *next; + TR_NAME *gssname; + char *server; + unsigned int port; + TRP_CONNECTION *conn; + TR_MQ *mq; /* msgs from master to trpc */ + int shutting_down; /* 0 unless the TRPC is in the shutdown process */ +}; + +/* TRP Server Instance Data */ +struct trps_instance { + char *hostname; + unsigned int port; + TRP_AUTH_FUNC auth_handler; + TRPS_MSG_FUNC msg_handler; + void *cookie; + TRP_CONNECTION *conn; /* connections from peers */ + TRPC_INSTANCE *trpc; /* connections to peers */ + TR_MQ *mq; /* incoming message queue */ + TRP_PTABLE *ptable; /* peer table */ + TRP_RTABLE *rtable; /* route table */ + TR_COMM_TABLE *ctable; /* community table */ + struct timeval connect_interval; /* interval between connection refreshes */ + struct timeval update_interval; /* interval between scheduled updates */ + struct timeval sweep_interval; /* interval between route table sweeps */ }; -TRP_UPD *trp_upd_new(TALLOC_CTX *mem_ctx); -void trp_upd_free(TRP_UPD *update); -TRP_INFOREC *trp_upd_get_inforec(TRP_UPD *upd); -void trp_upd_set_inforec(TRP_UPD *upd, TRP_INFOREC *rec); +typedef enum trp_update_type { + TRP_UPDATE_SCHEDULED=0, + TRP_UPDATE_TRIGGERED, + TRP_UPDATE_REQUESTED +} TRP_UPDATE_TYPE; + +TRP_CONNECTION *trp_connection_new(TALLOC_CTX *mem_ctx); +void trp_connection_free(TRP_CONNECTION *conn); +void trp_connection_close(TRP_CONNECTION *conn); +int trp_connection_lock(TRP_CONNECTION *conn); +int trp_connection_unlock(TRP_CONNECTION *conn); +int trp_connection_get_fd(TRP_CONNECTION *conn); +void trp_connection_set_fd(TRP_CONNECTION *conn, int fd); +TR_NAME *trp_connection_get_peer(TRP_CONNECTION *conn); +TR_NAME *trp_connection_get_gssname(TRP_CONNECTION *conn); +void trp_connection_set_gssname(TRP_CONNECTION *conn, TR_NAME *gssname); +gss_ctx_id_t *trp_connection_get_gssctx(TRP_CONNECTION *conn); +void trp_connection_set_gssctx(TRP_CONNECTION *conn, gss_ctx_id_t *gssctx); +TRP_CONNECTION_STATUS trp_connection_get_status(TRP_CONNECTION *conn); +pthread_t *trp_connection_get_thread(TRP_CONNECTION *conn); +void trp_connection_set_thread(TRP_CONNECTION *conn, pthread_t *thread); +TRP_CONNECTION *trp_connection_get_next(TRP_CONNECTION *conn); +TRP_CONNECTION *trp_connection_remove(TRP_CONNECTION *conn, TRP_CONNECTION *remove); +void trp_connection_append(TRP_CONNECTION *conn, TRP_CONNECTION *new); +int trp_connection_auth(TRP_CONNECTION *conn, TRP_AUTH_FUNC auth_callback, void *callback_data); +TRP_CONNECTION *trp_connection_accept(TALLOC_CTX *mem_ctx, int listen, TR_NAME *gss_servicename); +TRP_RC trp_connection_initiate(TRP_CONNECTION *conn, char *server, unsigned int port); + +TRPC_INSTANCE *trpc_new (TALLOC_CTX *mem_ctx); +void trpc_free (TRPC_INSTANCE *trpc); +TRP_CONNECTION *trpc_get_conn(TRPC_INSTANCE *trpc); +void trpc_set_conn(TRPC_INSTANCE *trpc, TRP_CONNECTION *conn); +TRPC_INSTANCE *trpc_get_next(TRPC_INSTANCE *trpc); +void trpc_set_next(TRPC_INSTANCE *trpc, TRPC_INSTANCE *next); +TRPC_INSTANCE *trpc_remove(TRPC_INSTANCE *trpc, TRPC_INSTANCE *remove); +void trpc_append(TRPC_INSTANCE *trpc, TRPC_INSTANCE *new); +char *trpc_get_server(TRPC_INSTANCE *trpc); +void trpc_set_server(TRPC_INSTANCE *trpc, char *server); +TR_NAME *trpc_get_gssname(TRPC_INSTANCE *trpc); +void trpc_set_gssname(TRPC_INSTANCE *trpc, TR_NAME *gssname); +unsigned int trpc_get_port(TRPC_INSTANCE *trpc); +void trpc_set_port(TRPC_INSTANCE *trpc, unsigned int port); +TRP_CONNECTION_STATUS trpc_get_status(TRPC_INSTANCE *trpc); +TR_MQ *trpc_get_mq(TRPC_INSTANCE *trpc); +void trpc_set_mq(TRPC_INSTANCE *trpc, TR_MQ *mq); +void trpc_mq_add(TRPC_INSTANCE *trpc, TR_MQ_MSG *msg); +TR_MQ_MSG *trpc_mq_pop(TRPC_INSTANCE *trpc, struct timespec *ts_abort); +void trpc_mq_clear(TRPC_INSTANCE *trpc); +void trpc_master_mq_add(TRPC_INSTANCE *trpc, TR_MQ_MSG *msg); +TR_MQ_MSG *trpc_master_mq_pop(TRPC_INSTANCE *trpc); +TRP_RC trpc_connect(TRPC_INSTANCE *trpc); +TRP_RC trpc_send_msg(TRPC_INSTANCE *trpc, const char *msg_content); + +TRPS_INSTANCE *trps_new (TALLOC_CTX *mem_ctx); +void trps_free (TRPS_INSTANCE *trps); +void trps_set_ctable(TRPS_INSTANCE *trps, TR_COMM_TABLE *comm); +void trps_set_ptable(TRPS_INSTANCE *trps, TRP_PTABLE *ptable); +void trps_set_peer_status_callback(TRPS_INSTANCE *trps, void (*cb)(TRP_PEER *, void *), void *cookie); +TR_NAME *trps_dup_label(TRPS_INSTANCE *trps); +TRP_RC trps_init_rtable(TRPS_INSTANCE *trps); +void trps_clear_rtable(TRPS_INSTANCE *trps); +void trps_set_connect_interval(TRPS_INSTANCE *trps, unsigned int interval); +unsigned int trps_get_connect_interval(TRPS_INSTANCE *trps); +void trps_set_update_interval(TRPS_INSTANCE *trps, unsigned int interval); +unsigned int trps_get_update_interval(TRPS_INSTANCE *trps); +void trps_set_sweep_interval(TRPS_INSTANCE *trps, unsigned int interval); +unsigned int trps_get_sweep_interval(TRPS_INSTANCE *trps); +TRPC_INSTANCE *trps_find_trpc(TRPS_INSTANCE *trps, TRP_PEER *peer); +TRP_RC trps_send_msg (TRPS_INSTANCE *trps, TRP_PEER *peer, const char *msg); +void trps_add_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *new); +void trps_remove_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *remove); +void trps_add_trpc(TRPS_INSTANCE *trps, TRPC_INSTANCE *trpc); +void trps_remove_trpc(TRPS_INSTANCE *trps, TRPC_INSTANCE *remove); +int trps_get_listener(TRPS_INSTANCE *trps, + TRPS_MSG_FUNC msg_handler, + TRP_AUTH_FUNC auth_handler, + const char *hostname, + unsigned int port, + void *cookie, + int *fd_out, + size_t max_fd); +TR_MQ_MSG *trps_mq_pop(TRPS_INSTANCE *trps); +void trps_mq_add(TRPS_INSTANCE *trps, TR_MQ_MSG *msg); +TRP_RC trps_authorize_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *conn); +void trps_handle_connection(TRPS_INSTANCE *trps, TRP_CONNECTION *conn); +TRP_RC trps_update_active_routes(TRPS_INSTANCE *trps); +TRP_RC trps_handle_tr_msg(TRPS_INSTANCE *trps, TR_MSG *tr_msg); +TRP_ROUTE *trps_get_route(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm, TR_NAME *peer); +TRP_ROUTE *trps_get_selected_route(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm); +TR_NAME *trps_get_next_hop(TRPS_INSTANCE *trps, TR_NAME *comm, TR_NAME *realm); +TRP_RC trps_sweep_routes(TRPS_INSTANCE *trps); +TRP_RC trps_sweep_ctable(TRPS_INSTANCE *trps); +TRP_RC trps_add_route(TRPS_INSTANCE *trps, TRP_ROUTE *route); +TRP_RC trps_add_peer(TRPS_INSTANCE *trps, TRP_PEER *peer); +TRP_PEER *trps_get_peer_by_gssname(TRPS_INSTANCE *trps, TR_NAME *gssname); +TRP_PEER *trps_get_peer_by_servicename(TRPS_INSTANCE *trps, TR_NAME *servicename); +TRP_RC trps_update(TRPS_INSTANCE *trps, TRP_UPDATE_TYPE type); +int trps_peer_connected(TRPS_INSTANCE *trps, TRP_PEER *peer); +TRP_RC trps_wildcard_route_req(TRPS_INSTANCE *trps, TR_NAME *peer_gssname); + TRP_INFOREC *trp_inforec_new(TALLOC_CTX *mem_ctx, TRP_INFOREC_TYPE type); void trp_inforec_free(TRP_INFOREC *rec); TRP_INFOREC *trp_inforec_get_next(TRP_INFOREC *rec); @@ -57,87 +270,37 @@ void trp_inforec_set_next(TRP_INFOREC *rec, TRP_INFOREC *next_rec); TRP_INFOREC_TYPE trp_inforec_get_type(TRP_INFOREC *rec); void trp_inforec_set_type(TRP_INFOREC *rec, TRP_INFOREC_TYPE type); TR_NAME *trp_inforec_get_comm(TRP_INFOREC *rec); +TR_NAME *trp_inforec_dup_comm(TRP_INFOREC *rec); TRP_RC trp_inforec_set_comm(TRP_INFOREC *rec, TR_NAME *comm); TR_NAME *trp_inforec_get_realm(TRP_INFOREC *rec); +TR_NAME *trp_inforec_dup_realm(TRP_INFOREC *rec); TRP_RC trp_inforec_set_realm(TRP_INFOREC *rec, TR_NAME *realm); TR_NAME *trp_inforec_get_trust_router(TRP_INFOREC *rec); +TR_NAME *trp_inforec_dup_trust_router(TRP_INFOREC *rec); TRP_RC trp_inforec_set_trust_router(TRP_INFOREC *rec, TR_NAME *trust_router); +TR_NAME *trp_inforec_get_next_hop(TRP_INFOREC *rec); +TR_NAME *trp_inforec_dup_next_hop(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_next_hop(TRP_INFOREC *rec, TR_NAME *next_hop); unsigned int trp_inforec_get_metric(TRP_INFOREC *rec); TRP_RC trp_inforec_set_metric(TRP_INFOREC *rec, unsigned int metric); unsigned int trp_inforec_get_interval(TRP_INFOREC *rec); TRP_RC trp_inforec_set_interval(TRP_INFOREC *rec, unsigned int interval); +TR_NAME *trp_inforec_get_owner_realm(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_owner_realm(TRP_INFOREC *rec, TR_NAME *name); +TR_NAME *trp_inforec_get_owner_contact(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_owner_contact(TRP_INFOREC *rec, TR_NAME *name); +json_t *trp_inforec_get_provenance(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_provenance(TRP_INFOREC *rec, json_t *prov); TRP_INFOREC_TYPE trp_inforec_type_from_string(const char *s); const char *trp_inforec_type_to_string(TRP_INFOREC_TYPE msgtype); - - -TRP_REQ *trp_req_new(TALLOC_CTX *mem_ctx); -void trp_req_free(TRP_REQ *req); -TR_NAME *trp_req_get_comm(TRP_REQ *req); -void trp_req_set_comm(TRP_REQ *req, TR_NAME *comm); -TR_NAME *trp_req_get_realm(TRP_REQ *req); -void trp_req_set_realm(TRP_REQ *req, TR_NAME *realm); - -typedef struct trps_instance TRPS_INSTANCE; - -typedef int (TRPS_REQ_FUNC)(); -typedef void (TRPS_RESP_FUNC)(); -typedef int (trps_auth_func)(gss_name_t client_name, TR_NAME *display_name, void *cookie); - - -/* encapsulate a gss context and its connection file handle */ -typedef struct trps_connection { - int conn; - gss_ctx_id_t *gssctx; -} TRPS_CONNECTION; - -/* a collection of the above */ -#define TRPS_CONNECTIONS_MAX 10 -typedef struct trps_connection_set { - TRPS_CONNECTION *conn[TRPS_CONNECTIONS_MAX]; - unsigned int nconn; -} TRPS_CONNECTION_SET; - -/* TRP Client Instance Data */ -typedef struct trpc_instance { - DH *client_dh; /* Client's DH struct with priv and pub keys */ -} TRPC_INSTANCE; - -/* TRP Server Instance Data */ -struct trps_instance { - char *hostname; - unsigned int port; - TRPS_REQ_FUNC *req_handler; - trps_auth_func *auth_handler; - void *cookie; - struct tr_rp_client *rp_gss; /* Client matching GSS name, TBD -- FIX ME (??) */ - TRPS_CONNECTION_SET *connections; /* active GSS connections */ -}; - -typedef enum { - TRPS_ERR_OK=0, /* success */ - TRPS_ERR_NOMEM, /* allocation problem */ - TRPS_ERR_MAX_CONN, /* out of connections */ - TRPS_ERR_UNKNOWN /* catch-all */ -} TRPS_ERR; - -/* prototypes */ - -/* these should probably be static? */ -TRPS_CONNECTION *trps_connection_new(TALLOC_CTX *mem_ctx); -TRPS_CONNECTION_SET *trps_connection_set_new(TALLOC_CTX *mem_ctx); -TRPS_ERR trps_connection_set_add(TRPS_CONNECTION_SET *tcs, TRPS_CONNECTION *new_conn); -TRPS_ERR trps_connection_set_del(TRPS_CONNECTION_SET *tcs, TRPS_CONNECTION *conn); -unsigned int trps_connection_set_len(TRPS_CONNECTION_SET *tcs); - -TRPC_INSTANCE *trpc_create (TALLOC_CTX *mem_ctx); -void trpc_destroy (TRPC_INSTANCE *trpc); -int trpc_open_connection (TRPC_INSTANCE *trpc, char *server, unsigned int port, gss_ctx_id_t *gssctx); -int trpc_send_msg (TRPC_INSTANCE *trpc, int conn, gss_ctx_id_t gssctx, const char *msg_content, - int *resp_handler(), void *cookie); - -TRPS_INSTANCE *trps_create (TALLOC_CTX *mem_ctx); -void trps_destroy (TRPS_INSTANCE *trps); -int trps_send_msg (TRPS_INSTANCE *trps, int conn, gss_ctx_id_t gssctx, const char *msg_content); -int trps_accept(TRPS_INSTANCE *trps, int listen); +time_t trp_inforec_get_exp_interval(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_exp_interval(TRP_INFOREC *rec, time_t expint); +TR_COMM_TYPE trp_inforec_get_comm_type(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_comm_type(TRP_INFOREC *rec, TR_COMM_TYPE type); +TR_REALM_ROLE trp_inforec_get_role(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_role(TRP_INFOREC *rec, TR_REALM_ROLE role); +TR_APC *trp_inforec_get_apcs(TRP_INFOREC *rec); +TRP_RC trp_inforec_set_apcs(TRP_INFOREC *rec, TR_APC *apcs); +TR_NAME *trp_inforec_dup_origin(TRP_INFOREC *rec); #endif /* TRP_INTERNAL_H */