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