include/trust_router/tid.h

   1 /*
   2  * Copyright (c) 2012, 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 <arpa/inet.h>
  39 #include <openssl/dh.h>
  40
  41 #include <trust_router/tr_name.h>
  42 #include <trust_router/tr_versioning.h>
  43
  44 #include <gssapi.h>
  45
  46 #define TID_PORT        12309
  47
  48 typedef enum tid_rc {
  49   TID_SUCCESS = 0,
  50   TID_ERROR
  51 } TID_RC;
  52
  53 typedef struct tid_srvr_blk {
  54   struct tid_srvr_blk *next;
  55   struct in_addr aaa_server_addr;
  56   TR_NAME *key_name;
  57   DH *aaa_server_dh;            /* AAA server's public dh information */
  58 } TID_SRVR_BLK;
  59
  60 typedef struct _tr_constraint_set  TR_CONSTRAINT_SET;
  61
  62 typedef struct tid_resp {
  63   TID_RC result;
  64   TR_NAME *err_msg;
  65   TR_NAME *rp_realm;
  66   TR_NAME *realm;
  67   TR_NAME *comm;
  68   TR_CONSTRAINT_SET *cons;
  69   TR_NAME *orig_coi;
  70   TID_SRVR_BLK *servers;        /* Linked list of servers */
  71   /* TBD -- Trust Path Used */
  72 } TID_RESP;
  73
  74 typedef struct tidc_instance TIDC_INSTANCE;
  75 typedef struct tids_instance TIDS_INSTANCE;
  76 typedef struct tid_req TID_REQ;
  77 typedef struct json_t json_t;
  78
  79 typedef void (TIDC_RESP_FUNC)(TIDC_INSTANCE *, TID_REQ *, TID_RESP *, void *);
  80
  81 struct tid_req {
  82   struct tid_req *next_req;
  83   int resp_sent;
  84   int conn;
  85   gss_ctx_id_t gssctx;
  86   int resp_rcvd;
  87   TR_NAME *rp_realm;
  88   TR_NAME *realm;
  89   TR_NAME *comm;
  90   TR_CONSTRAINT_SET *cons;
  91   TR_NAME *orig_coi;
  92   DH *tidc_dh;                  /* Client's public dh information */
  93   TIDC_RESP_FUNC *resp_func;
  94   void *cookie;
  95   json_t *json_references; /** References to objects dereferenced on request destruction*/
  96 };
  97
  98 struct tidc_instance {
  99   TID_REQ *req_list;
 100   // TBD -- Do we still need a separate private key */
 101   // char *priv_key;
 102   // int priv_len;
 103   DH *client_dh;                        /* Client's DH struct with priv and pub keys */
 104 };
 105
 106 typedef int (TIDS_REQ_FUNC)(TIDS_INSTANCE *, TID_REQ *, TID_RESP **, void *);
 107 typedef int (tids_auth_func)(gss_name_t client_name, TR_NAME *display_name, void *cookie);
 108
 109
 110 struct tids_instance {
 111   int req_count;
 112   char *priv_key;
 113   char *ipaddr;
 114   const char *hostname;
 115   TIDS_REQ_FUNC *req_handler;
 116   tids_auth_func *auth_handler;
 117   void *cookie;
 118 };
 119
 120 /* Utility functions for TID_REQ structures, in tid/tid_req.c */
 121 TR_EXPORT TID_REQ *tid_req_new(void);
 122 TR_EXPORT TID_REQ *tid_req_get_next_req(TID_REQ *req);
 123 void tid_req_set_next_req(TID_REQ *req, TID_REQ *next_req);
 124 TR_EXPORT int tid_req_get_resp_sent(TID_REQ *req);
 125 void tid_req_set_resp_sent(TID_REQ *req, int resp_sent);
 126 TR_EXPORT int tid_req_get_conn(TID_REQ *req);
 127 void tid_req_set_conn(TID_REQ *req, int conn);
 128 TR_EXPORT gss_ctx_id_t tid_req_get_gssctx(TID_REQ *req);
 129 void tid_req_set_gssctx(TID_REQ *req, gss_ctx_id_t gssctx);
 130 TR_EXPORT int tid_req_get_resp_rcvd(TID_REQ *req);
 131 void tid_req_set_resp_rcvd(TID_REQ *req, int resp_rcvd);
 132 TR_EXPORT TR_NAME *tid_req_get_rp_realm(TID_REQ *req);
 133 void tid_req_set_rp_realm(TID_REQ *req, TR_NAME *rp_realm);
 134 TR_EXPORT TR_NAME *tid_req_get_realm(TID_REQ *req);
 135 void tid_req_set_realm(TID_REQ *req, TR_NAME *realm);
 136 TR_EXPORT TR_NAME *tid_req_get_comm(TID_REQ *req);
 137 void tid_req_set_comm(TID_REQ *req, TR_NAME *comm);
 138 TR_EXPORT TR_NAME *tid_req_get_orig_coi(TID_REQ *req);
 139 void tid_req_set_rp_orig_coi(TID_REQ *req, TR_NAME *orig_coi);
 140 TR_EXPORT TIDC_RESP_FUNC *tid_req_get_resp_func(TID_REQ *req);
 141 void tid_req_set_resp_func(TID_REQ *req, TIDC_RESP_FUNC *resp_func);
 142 TR_EXPORT void *tid_req_get_cookie(TID_REQ *req);
 143 void tid_req_set_cookie(TID_REQ *req, void *cookie);
 144 TR_EXPORT TID_REQ *tid_dup_req (TID_REQ *orig_req);
 145
 146 /** Decrement a reference to #json when this tid_req is cleaned up. A
 147     new reference is not created; in effect the caller is handing a
 148     reference they already hold to the TID_REQ.*/
 149 void tid_req_cleanup_json(TID_REQ *, json_t *json);
 150 #define tid_req_free free
 151
 152 /* Utility functions for TID_RESP structure, in tid/tid_resp.c */
 153 TR_EXPORT TID_RC tid_resp_get_result(TID_RESP *resp);
 154 void tid_resp_set_result(TID_RESP *resp, TID_RC result);
 155 TR_EXPORT TR_NAME *tid_resp_get_err_msg(TID_RESP *resp);
 156 void tid_resp_set_err_msg(TID_RESP *resp, TR_NAME *err_msg);
 157 TR_EXPORT TR_NAME *tid_resp_get_rp_realm(TID_RESP *resp);
 158 void tid_resp_set_rp_realm(TID_RESP *resp, TR_NAME *rp_realm);
 159 TR_EXPORT TR_NAME *tid_resp_get_realm(TID_RESP *resp);
 160 void tid_resp_set_realm(TID_RESP *resp, TR_NAME *realm);
 161 TR_EXPORT TR_NAME *tid_resp_get_comm(TID_RESP *resp);
 162 void tid_resp_set_comm(TID_RESP *resp, TR_NAME *comm);
 163 TR_EXPORT TR_NAME *tid_resp_get_orig_coi(TID_RESP *resp);
 164 void tid_resp_set_orig_coi(TID_RESP *resp, TR_NAME *orig_coi);
 165 TR_EXPORT TID_SRVR_BLK *tid_resp_get_servers(TID_RESP *resp);
 166 void tid_resp_set_servers(TID_RESP *resp, TID_SRVR_BLK *servers);
 167 // TBD -- add function to add/remove items from linked list of servers?
 168
 169 /* TID Client functions, in tid/tidc.c */
 170 TR_EXPORT TIDC_INSTANCE *tidc_create (void);
 171 TR_EXPORT int tidc_open_connection (TIDC_INSTANCE *tidc, char *server, unsigned int port, gss_ctx_id_t *gssctx);
 172 TR_EXPORT int tidc_send_request (TIDC_INSTANCE *tidc, int conn, gss_ctx_id_t gssctx, char *rp_realm, char *realm, char *coi, TIDC_RESP_FUNC *resp_handler, void *cookie);
 173 TR_EXPORT int tidc_fwd_request (TIDC_INSTANCE *tidc, TID_REQ *req, TIDC_RESP_FUNC *resp_handler, void *cookie);
 174 TR_EXPORT void tidc_destroy (TIDC_INSTANCE *tidc);
 175
 176 /* TID Server functions, in tid/tids.c */
 177 TR_EXPORT TIDS_INSTANCE *tids_create (void);
 178 TR_EXPORT int tids_start (TIDS_INSTANCE *tids, TIDS_REQ_FUNC *req_handler,
 179                           tids_auth_func *auth_handler, const char *hostname,
 180                           unsigned int port, void *cookie);
 181 TR_EXPORT int tids_send_response (TIDS_INSTANCE *tids, TID_REQ *req, TID_RESP *resp);
 182 TR_EXPORT int tids_send_err_response (TIDS_INSTANCE *tids, TID_REQ *req, const char *err_msg);
 183 TR_EXPORT void tids_destroy (TIDS_INSTANCE *tids);
 184
 185 #endif