include/mon_internal.h

   1 /*
   2  * Copyright (c) 2018, 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
  36 #ifndef TRUST_ROUTER_MON_REQ_H
  37 #define TRUST_ROUTER_MON_REQ_H
  38
  39 #include <talloc.h>
  40 #include <stdint.h>
  41 #include <jansson.h>
  42 #include <gmodule.h>
  43 #include <gssapi.h>
  44 #include <trust_router/tid.h>
  45 #include <trp_internal.h>
  46 #include <tr_gss_names.h>
  47 #include <tr_gss_client.h>
  48 #include <tr_name_internal.h>
  49 #include <trust_router/tr_dh.h>
  50 #include <mon.h>
  51
  52 /* Typedefs */
  53 typedef struct mon_req MON_REQ;
  54 typedef struct mon_resp MON_RESP;
  55
  56 typedef enum mon_cmd MON_CMD;
  57 typedef enum mon_resp_code MON_RESP_CODE;
  58
  59 typedef struct mon_opt MON_OPT;
  60 typedef enum mon_opt_type MON_OPT_TYPE;
  61
  62 typedef enum mon_rc MON_RC;
  63
  64 typedef struct mons_instance MONS_INSTANCE;
  65 typedef struct monc_instance MONC_INSTANCE;
  66
  67 typedef int (MONS_REQ_FUNC)(MONS_INSTANCE *, MON_REQ *, MON_RESP *, void *);
  68 typedef int (MONS_AUTH_FUNC)(gss_name_t client_name, TR_NAME *display_name, void *cookie);
  69 typedef int (MONC_RESP_FUNC)(MONS_INSTANCE *, MON_REQ *, MON_RESP *, void *);
  70
  71 /* Struct and enum definitions */
  72 enum mon_rc {
  73   MON_SUCCESS=0,
  74   MON_ERROR, /* generic error */
  75   MON_BADARG, /* problem with the arguments */
  76   MON_NOMEM, /* out of memory */
  77   MON_NOPARSE, /* parsing failed */
  78 };
  79
  80 enum mon_cmd {
  81   MON_CMD_UNKNOWN=0,
  82   MON_CMD_RECONFIGURE,
  83   MON_CMD_SHOW
  84 };
  85
  86 /* These should be explicitly numbered because they form part of the public API */
  87 enum mon_resp_code {
  88   MON_RESP_SUCCESS=0,
  89   MON_RESP_ERROR=1, // generic error
  90 };
  91
  92 enum mon_opt_type {
  93   OPT_TYPE_UNKNOWN=0,
  94
  95   // System information
  96   OPT_TYPE_SHOW_VERSION,
  97   OPT_TYPE_SHOW_SERIAL,
  98
  99   // System statistics
 100   OPT_TYPE_SHOW_UPTIME,
 101   OPT_TYPE_SHOW_TID_REQ_COUNT,
 102   OPT_TYPE_SHOW_TID_REQ_PENDING,
 103
 104   // Dynamic trust router state
 105   OPT_TYPE_SHOW_ROUTES,
 106   OPT_TYPE_SHOW_COMMUNITIES
 107 };
 108
 109 struct mon_opt {
 110   MON_OPT_TYPE type;
 111 };
 112
 113 struct mon_req {
 114   MON_CMD command;
 115   GArray *options;
 116 };
 117
 118 struct mon_resp {
 119   MON_RESP_CODE code;
 120   TR_NAME *message;
 121   json_t *payload;
 122 };
 123
 124 /* Monitoring server instance */
 125 struct mons_instance {
 126   const char *hostname;
 127   unsigned int port;
 128   TR_GSS_NAMES *authorized_gss_names;
 129   TIDS_INSTANCE *tids;
 130   TRPS_INSTANCE *trps;
 131   MONS_REQ_FUNC *req_handler;
 132   MONS_AUTH_FUNC *auth_handler;
 133   void *cookie;
 134 };
 135
 136 /* Client instance */
 137 struct monc_instance {
 138   TR_GSSC_INSTANCE *gssc;
 139 };
 140
 141 /* Prototypes */
 142 /* tr_mon.c */
 143 const char *mon_cmd_to_string(MON_CMD cmd);
 144 MON_CMD mon_cmd_from_string(const char *s);
 145 const char *mon_opt_type_to_string(MON_OPT_TYPE opt_type);
 146 MON_OPT_TYPE mon_opt_type_from_string(const char *s);
 147
 148 /* mon_req.c */
 149 MON_REQ *mon_req_new(TALLOC_CTX *mem_ctx, MON_CMD cmd);
 150 void mon_req_free(MON_REQ *req);
 151 MON_RC mon_req_add_option(MON_REQ *req, MON_OPT_TYPE opt_type);
 152 size_t mon_req_opt_count(MON_REQ *req);
 153 MON_OPT *mon_req_opt_index(MON_REQ *req, size_t index);
 154
 155 /* mon_req_encode.c */
 156 json_t *mon_req_encode(MON_REQ *req);
 157
 158 /* mon_req_decode.c */
 159 MON_REQ *mon_req_decode(TALLOC_CTX *mem_ctx, json_t *req_json);
 160 MON_REQ *mon_req_parse(TALLOC_CTX *mem_ctx, const char *input);
 161
 162 /* mon_resp.c */
 163 MON_RESP *mon_resp_new(TALLOC_CTX *mem_ctx, MON_RESP_CODE code, const char *msg, json_t *payload);
 164 void mon_resp_free(MON_RESP *resp);
 165
 166 /* mon_resp_encode.c */
 167 json_t *mon_resp_encode(MON_RESP *resp);
 168
 169 /* mon_resp_decode.c */
 170 MON_RESP * mon_resp_decode(TALLOC_CTX *mem_ctx, json_t *resp_json);
 171
 172 /* mons.c */
 173 MONS_INSTANCE *mons_new(TALLOC_CTX *mem_ctx);
 174 int mons_get_listener(MONS_INSTANCE *mons, MONS_REQ_FUNC *req_handler, MONS_AUTH_FUNC *auth_handler, const char *hostname,
 175                       unsigned int port, void *cookie, int *fd_out, size_t max_fd);
 176 int mons_accept(MONS_INSTANCE *mons, int listen);
 177
 178 /* monc.c */
 179 MONC_INSTANCE *monc_new(TALLOC_CTX *mem_ctx);
 180 void monc_free(MONC_INSTANCE *monc);
 181 DH *monc_get_dh(MONC_INSTANCE *inst);
 182 DH *monc_set_dh(MONC_INSTANCE *inst, DH *dh);
 183 int monc_open_connection(MONC_INSTANCE *monc, const char *server, unsigned int port);
 184 MON_RESP *monc_send_request(TALLOC_CTX *mem_ctx, MONC_INSTANCE *monc, MON_REQ *req);
 185
 186 #endif //TRUST_ROUTER_MON_REQ_H