2 * Copyright (c) 2018, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
36 #ifndef TRUST_ROUTER_MON_REQ_H
37 #define TRUST_ROUTER_MON_REQ_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>
53 typedef struct mon_req MON_REQ;
54 typedef struct mon_resp MON_RESP;
56 typedef enum mon_cmd MON_CMD;
57 typedef enum mon_resp_code MON_RESP_CODE;
59 typedef struct mon_opt MON_OPT;
60 typedef enum mon_opt_type MON_OPT_TYPE;
62 typedef enum mon_rc MON_RC;
64 typedef struct mons_instance MONS_INSTANCE;
65 typedef struct monc_instance MONC_INSTANCE;
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 *);
71 /* Struct and enum definitions */
74 MON_ERROR, /* generic error */
75 MON_BADARG, /* problem with the arguments */
76 MON_NOMEM, /* out of memory */
77 MON_NOPARSE, /* parsing failed */
86 /* These should be explicitly numbered because they form part of the public API */
89 MON_RESP_ERROR=1, // generic error
97 OPT_TYPE_SHOW_VERSION,
101 OPT_TYPE_SHOW_UPTIME,
102 OPT_TYPE_SHOW_TID_REQ_COUNT,
103 OPT_TYPE_SHOW_TID_REQ_ERR_COUNT,
104 OPT_TYPE_SHOW_TID_REQ_PENDING,
106 // Dynamic trust router state
107 OPT_TYPE_SHOW_ROUTES,
109 OPT_TYPE_SHOW_COMMUNITIES,
110 OPT_TYPE_SHOW_REALMS,
111 OPT_TYPE_SHOW_RP_CLIENTS
129 /* Monitoring server instance */
130 struct mons_instance {
131 const char *hostname;
133 TR_GSS_NAMES *authorized_gss_names;
136 MONS_REQ_FUNC *req_handler;
137 MONS_AUTH_FUNC *auth_handler;
140 GArray *pids; /* PIDs of active mons processes */
143 /* Client instance */
144 struct monc_instance {
145 TR_GSSC_INSTANCE *gssc;
150 const char *mon_cmd_to_string(MON_CMD cmd);
151 MON_CMD mon_cmd_from_string(const char *s);
152 const char *mon_opt_type_to_string(MON_OPT_TYPE opt_type);
153 MON_OPT_TYPE mon_opt_type_from_string(const char *s);
156 MON_REQ *mon_req_new(TALLOC_CTX *mem_ctx, MON_CMD cmd);
157 void mon_req_free(MON_REQ *req);
158 MON_RC mon_req_add_option(MON_REQ *req, MON_OPT_TYPE opt_type);
159 size_t mon_req_opt_count(MON_REQ *req);
160 MON_OPT *mon_req_opt_index(MON_REQ *req, size_t index);
162 /* mon_req_encode.c */
163 json_t *mon_req_encode(MON_REQ *req);
165 /* mon_req_decode.c */
166 MON_REQ *mon_req_decode(TALLOC_CTX *mem_ctx, json_t *req_json);
167 MON_REQ *mon_req_parse(TALLOC_CTX *mem_ctx, const char *input);
170 MON_RESP *mon_resp_new(TALLOC_CTX *mem_ctx, MON_RESP_CODE code, const char *msg, json_t *payload);
171 void mon_resp_free(MON_RESP *resp);
172 int mon_resp_set_message(MON_RESP *resp, const char *new_msg);
173 void mon_resp_set_payload(MON_RESP *resp, json_t *new_payload);
175 /* mon_resp_encode.c */
176 json_t *mon_resp_encode(MON_RESP *resp);
178 /* mon_resp_decode.c */
179 MON_RESP * mon_resp_decode(TALLOC_CTX *mem_ctx, json_t *resp_json);
182 MONS_INSTANCE *mons_new(TALLOC_CTX *mem_ctx);
183 int mons_get_listener(MONS_INSTANCE *mons, MONS_REQ_FUNC *req_handler, MONS_AUTH_FUNC *auth_handler, const char *hostname,
184 unsigned int port, void *cookie, int *fd_out, size_t max_fd);
185 int mons_accept(MONS_INSTANCE *mons, int listen);
188 MONC_INSTANCE *monc_new(TALLOC_CTX *mem_ctx);
189 void monc_free(MONC_INSTANCE *monc);
190 DH *monc_get_dh(MONC_INSTANCE *inst);
191 DH *monc_set_dh(MONC_INSTANCE *inst, DH *dh);
192 int monc_open_connection(MONC_INSTANCE *monc, const char *server, unsigned int port);
193 MON_RESP *monc_send_request(TALLOC_CTX *mem_ctx, MONC_INSTANCE *monc, MON_REQ *req);
195 #endif //TRUST_ROUTER_MON_REQ_H