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>
52 typedef struct mon_req MON_REQ;
53 typedef struct mon_resp MON_RESP;
55 typedef enum mon_cmd MON_CMD;
56 typedef enum mon_resp_code MON_RESP_CODE;
58 typedef struct mon_opt MON_OPT;
59 typedef enum mon_opt_type MON_OPT_TYPE;
61 typedef enum mon_rc MON_RC;
63 typedef struct mons_instance MONS_INSTANCE;
64 typedef struct monc_instance MONC_INSTANCE;
66 typedef int (MONS_REQ_FUNC)(MONS_INSTANCE *, MON_REQ *, MON_RESP *, void *);
67 typedef int (MONS_AUTH_FUNC)(gss_name_t client_name, TR_NAME *display_name, void *cookie);
68 typedef int (MONC_RESP_FUNC)(MONS_INSTANCE *, MON_REQ *, MON_RESP *, void *);
70 /* Struct and enum definitions */
73 MON_ERROR, /* generic error */
74 MON_BADARG, /* problem with the arguments */
75 MON_NOMEM, /* out of memory */
76 MON_NOPARSE, /* parsing failed */
85 /* These should be explicitly numbered because they form part of the public API */
88 MON_RESP_ERROR=1, // generic error
96 OPT_TYPE_SHOW_VERSION,
97 OPT_TYPE_SHOW_CONFIG_FILES,
100 OPT_TYPE_SHOW_UPTIME,
101 OPT_TYPE_SHOW_TID_REQ_COUNT,
102 OPT_TYPE_SHOW_TID_REQ_ERR_COUNT,
103 OPT_TYPE_SHOW_TID_REQ_PENDING,
105 // Dynamic trust router state
106 OPT_TYPE_SHOW_ROUTES,
108 OPT_TYPE_SHOW_COMMUNITIES,
109 OPT_TYPE_SHOW_REALMS,
110 OPT_TYPE_SHOW_RP_CLIENTS
128 /* Monitoring server instance */
129 struct mons_instance {
130 const char *hostname;
132 TR_GSS_NAMES *authorized_gss_names;
135 MONS_REQ_FUNC *req_handler;
136 MONS_AUTH_FUNC *auth_handler;
139 GArray *pids; /* PIDs of active mons processes */
142 /* Client instance */
143 struct monc_instance {
144 TR_GSSC_INSTANCE *gssc;
149 const char *mon_cmd_to_string(MON_CMD cmd);
150 MON_CMD mon_cmd_from_string(const char *s);
151 const char *mon_opt_type_to_string(MON_OPT_TYPE opt_type);
152 MON_OPT_TYPE mon_opt_type_from_string(const char *s);
155 MON_REQ *mon_req_new(TALLOC_CTX *mem_ctx, MON_CMD cmd);
156 void mon_req_free(MON_REQ *req);
157 MON_RC mon_req_add_option(MON_REQ *req, MON_OPT_TYPE opt_type);
158 size_t mon_req_opt_count(MON_REQ *req);
159 MON_OPT *mon_req_opt_index(MON_REQ *req, size_t index);
161 /* mon_req_encode.c */
162 json_t *mon_req_encode(MON_REQ *req);
164 /* mon_req_decode.c */
165 MON_REQ *mon_req_decode(TALLOC_CTX *mem_ctx, json_t *req_json);
166 MON_REQ *mon_req_parse(TALLOC_CTX *mem_ctx, const char *input);
169 MON_RESP *mon_resp_new(TALLOC_CTX *mem_ctx, MON_RESP_CODE code, const char *msg, json_t *payload);
170 void mon_resp_free(MON_RESP *resp);
171 int mon_resp_set_message(MON_RESP *resp, const char *new_msg);
172 void mon_resp_set_payload(MON_RESP *resp, json_t *new_payload);
174 /* mon_resp_encode.c */
175 json_t *mon_resp_encode(MON_RESP *resp);
177 /* mon_resp_decode.c */
178 MON_RESP * mon_resp_decode(TALLOC_CTX *mem_ctx, json_t *resp_json);
181 MONS_INSTANCE *mons_new(TALLOC_CTX *mem_ctx);
182 int mons_get_listener(MONS_INSTANCE *mons, MONS_REQ_FUNC *req_handler, MONS_AUTH_FUNC *auth_handler, const char *hostname,
183 unsigned int port, void *cookie, int *fd_out, size_t max_fd);
184 int mons_accept(MONS_INSTANCE *mons, int listen);
187 MONC_INSTANCE *monc_new(TALLOC_CTX *mem_ctx);
188 void monc_free(MONC_INSTANCE *monc);
189 int monc_open_connection(MONC_INSTANCE *monc, const char *server, unsigned int port);
190 MON_RESP *monc_send_request(TALLOC_CTX *mem_ctx, MONC_INSTANCE *monc, MON_REQ *req);
192 #endif //TRUST_ROUTER_MON_REQ_H