include/trust_router/tid.h

   1 /*
   2  * Copyright (c) 2012-2014, 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 TID_H
  36 #define TID_H
  37
  38 #include <talloc.h>
  39
  40 #include <arpa/inet.h>
  41 #include <openssl/dh.h>
  42
  43 #include <trust_router/tr_name.h>
  44 #include <trust_router/tr_versioning.h>
  45
  46 #include <gssapi.h>
  47
  48
  49 #define TID_PORT        12309
  50
  51 typedef enum tid_rc {
  52   TID_SUCCESS = 0,
  53   TID_ERROR
  54 } TID_RC;
  55
  56 typedef struct tid_srvr_blk  TID_SRVR_BLK;
  57
  58
  59 typedef struct _tr_constraint_set  TR_CONSTRAINT_SET;
  60 typedef struct _tid_path TID_PATH;
  61
  62 typedef struct tid_resp TID_RESP;
  63
  64 typedef struct tidc_instance TIDC_INSTANCE;
  65 typedef struct tids_instance TIDS_INSTANCE;
  66 typedef struct tid_req TID_REQ;
  67
  68
  69 typedef void (TIDC_RESP_FUNC)(TIDC_INSTANCE *, TID_REQ *, TID_RESP *, void *);
  70
  71
  72
  73 typedef int (TIDS_REQ_FUNC)(TIDS_INSTANCE *, TID_REQ *, TID_RESP *, void *);
  74 typedef int (tids_auth_func)(gss_name_t client_name, TR_NAME *display_name, void *cookie);
  75
  76
  77
  78 /* Utility functions for TID_REQ structures, in tid/tid_req.c */
  79 TR_EXPORT TID_REQ *tid_req_new(void);
  80 TR_EXPORT TID_REQ *tid_req_get_next_req(TID_REQ *req);
  81 void tid_req_set_next_req(TID_REQ *req, TID_REQ *next_req);
  82 TR_EXPORT int tid_req_get_resp_sent(TID_REQ *req);
  83 void tid_req_set_resp_sent(TID_REQ *req, int resp_sent);
  84 TR_EXPORT int tid_req_get_conn(TID_REQ *req);
  85 void tid_req_set_conn(TID_REQ *req, int conn);
  86 TR_EXPORT gss_ctx_id_t tid_req_get_gssctx(TID_REQ *req);
  87 void tid_req_set_gssctx(TID_REQ *req, gss_ctx_id_t gssctx);
  88 TR_EXPORT int tid_req_get_resp_rcvd(TID_REQ *req);
  89 void tid_req_set_resp_rcvd(TID_REQ *req, int resp_rcvd);
  90 TR_EXPORT TR_NAME *tid_req_get_rp_realm(TID_REQ *req);
  91 void tid_req_set_rp_realm(TID_REQ *req, TR_NAME *rp_realm);
  92 TR_EXPORT TR_NAME *tid_req_get_realm(TID_REQ *req);
  93 void tid_req_set_realm(TID_REQ *req, TR_NAME *realm);
  94 TR_EXPORT TR_NAME *tid_req_get_comm(TID_REQ *req);
  95 void tid_req_set_comm(TID_REQ *req, TR_NAME *comm);
  96 TR_EXPORT TR_NAME *tid_req_get_orig_coi(TID_REQ *req);
  97 void tid_req_set_rp_orig_coi(TID_REQ *req, TR_NAME *orig_coi);
  98 TR_EXPORT TIDC_RESP_FUNC *tid_req_get_resp_func(TID_REQ *req);
  99 void tid_req_set_resp_func(TID_REQ *req, TIDC_RESP_FUNC *resp_func);
 100 TR_EXPORT void *tid_req_get_cookie(TID_REQ *req);
 101 void tid_req_set_cookie(TID_REQ *req, void *cookie);
 102 TR_EXPORT TID_REQ *tid_dup_req (TID_REQ *orig_req);
 103 TR_EXPORT void tid_req_free( TID_REQ *req);
 104
 105 /* Utility functions for TID_RESP structure, in tid/tid_resp.c */
 106
 107 TID_RESP *tid_resp_new(TALLOC_CTX *mem_ctx);
 108 void tid_resp_free(TID_RESP *resp);
 109 TID_RESP *tid_resp_dup(TALLOC_CTX *mem_ctx, TID_RESP *resp);
 110 TR_EXPORT int tid_resp_get_result(TID_RESP *resp);
 111 void tid_resp_set_result(TID_RESP *resp, int result);
 112 TR_EXPORT TR_NAME *tid_resp_get_err_msg(TID_RESP *resp);
 113 void tid_resp_set_err_msg(TID_RESP *resp, TR_NAME *err_msg);
 114 TR_EXPORT TR_NAME *tid_resp_get_rp_realm(TID_RESP *resp);
 115 void tid_resp_set_rp_realm(TID_RESP *resp, TR_NAME *rp_realm);
 116 TR_EXPORT TR_NAME *tid_resp_get_realm(TID_RESP *resp);
 117 void tid_resp_set_realm(TID_RESP *resp, TR_NAME *realm);
 118 TR_EXPORT TR_NAME *tid_resp_get_comm(TID_RESP *resp);
 119 void tid_resp_set_comm(TID_RESP *resp, TR_NAME *comm);
 120 TR_EXPORT TR_NAME *tid_resp_get_orig_coi(TID_RESP *resp);
 121 void tid_resp_set_orig_coi(TID_RESP *resp, TR_NAME *orig_coi);
 122 TR_EXPORT TID_SRVR_BLK *tid_resp_get_server(TID_RESP *resp, size_t index);
 123 TR_EXPORT size_t tid_resp_get_num_servers(const TID_RESP *resp);
 124 TR_EXPORT const TID_PATH *tid_resp_get_error_path(const TID_RESP *);
 125
 126 /** Get either the error_path or the path of the first server block for
 127  * a successful response*/
 128 TR_EXPORT const TID_PATH *tid_resp_get_a_path(const TID_RESP *);
 129 /* Server blocks*/
 130 TR_EXPORT void tid_srvr_get_address(const TID_SRVR_BLK *,
 131                                     const struct sockaddr **out_addr, size_t *out_sa_len);
 132 TR_EXPORT DH *tid_srvr_get_dh(TID_SRVR_BLK *);
 133 TR_EXPORT const TR_NAME *tid_srvr_get_key_name(const TID_SRVR_BLK *);
 134 TR_EXPORT const TID_PATH *tid_srvr_get_path(const TID_SRVR_BLK *);
 135 /* Key expiration time is expressed as time since 1970-01-01 00:00:00 UTC */
 136 TR_EXPORT int tid_srvr_get_key_expiration(const TID_SRVR_BLK *, struct timeval *tv_out);
 137
 138 #define tid_resp_servers_foreach(RESP, SERVER, INDEX) \
 139   for (INDEX=0,SERVER=NULL;                                             \
 140        ((INDEX < tid_resp_get_num_servers(RESP))&&(SERVER = tid_resp_get_server(resp, INDEX))); \
 141        INDEX++)
 142
 143
 144 /* TID Client functions, in tid/tidc.c */
 145 TR_EXPORT TIDC_INSTANCE *tidc_create (void);
 146 TR_EXPORT int tidc_open_connection (TIDC_INSTANCE *tidc, const char *server, unsigned int port, gss_ctx_id_t *gssctx);
 147 TR_EXPORT int tidc_send_request (TIDC_INSTANCE *tidc, int conn, gss_ctx_id_t gssctx, const char *rp_realm, const char *realm, const char *coi, TIDC_RESP_FUNC *resp_handler, void *cookie);
 148 TR_EXPORT int tidc_fwd_request (TIDC_INSTANCE *tidc, TID_REQ *req, TIDC_RESP_FUNC *resp_handler, void *cookie);
 149 TR_EXPORT DH *tidc_get_dh(TIDC_INSTANCE *);
 150 TR_EXPORT DH *tidc_set_dh(TIDC_INSTANCE *, DH *);
 151 TR_EXPORT void tidc_destroy(TIDC_INSTANCE *tidc);
 152
 153 /* TID Server functions, in tid/tids.c */
 154 TR_EXPORT TIDS_INSTANCE *tids_create (void);
 155 TR_EXPORT int tids_start (TIDS_INSTANCE *tids, TIDS_REQ_FUNC *req_handler,
 156                           tids_auth_func *auth_handler, const char *hostname,
 157                           unsigned int port, void *cookie);
 158 TR_EXPORT int tids_get_listener (TIDS_INSTANCE *tids, TIDS_REQ_FUNC *req_handler,
 159                                  tids_auth_func *auth_handler, const char *hostname,
 160                                  unsigned int port, void *cookie, int *fd_out, size_t max_fd);
 161 TR_EXPORT int tids_accept(TIDS_INSTANCE *tids, int listen);
 162 TR_EXPORT int tids_send_response (TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp);
 163 TR_EXPORT int tids_send_err_response (TIDS_INSTANCE *tids, TID_REQ *req, const char *err_msg);
 164 TR_EXPORT void tids_destroy (TIDS_INSTANCE *tids);
 165
 166 #endif