2 * Copyright (c) 2012-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.
38 #include <tr_config.h>
39 #include <tr_cfgwatch.h>
44 * If the key does not exist in the src object, returns success but does fill in *dest.
46 * @param src JSON object to pull a value from
47 * @param key key to pull
48 * @param dest (output) pointer to an allocated integer
49 * @return TR_CFG_SUCCESS or an error code
51 static TR_CFG_RC tr_cfg_parse_boolean(json_t *src, const char *key, int *dest)
55 /* Validate parameters */
56 if ((src == NULL) || (key == NULL) || (dest == NULL))
57 return TR_CFG_BAD_PARAMS;
59 /* See if we have a value for this key; do nothing if not */
60 jtmp = json_object_get(src, key);
62 if (json_is_boolean(jtmp)) {
63 *dest = json_boolean_value(jtmp);
65 tr_debug("tr_cfg_parse_unsigned: Parsing error, %s is not a boolean.", key);
66 return TR_CFG_NOPARSE;
70 return TR_CFG_SUCCESS;
74 * Parse a signed integer
76 * If the key does not exist in the src object, returns success but does fill in *dest.
78 * @param src JSON object to pull a value from
79 * @param key key to pull
80 * @param dest (output) pointer to an allocated integer
81 * @return TR_CFG_SUCCESS or an error code
83 static TR_CFG_RC tr_cfg_parse_integer(json_t *src, const char *key, int *dest)
87 /* Validate parameters */
88 if ((src == NULL) || (key == NULL) || (dest == NULL))
89 return TR_CFG_BAD_PARAMS;
91 /* See if we have a value for this key; do nothing if not */
92 jtmp = json_object_get(src, key);
94 if (json_is_number(jtmp)) {
95 *dest = (int) json_integer_value(jtmp);
97 tr_debug("tr_cfg_parse_unsigned: Parsing error, %s is not a number.", key);
98 return TR_CFG_NOPARSE;
102 return TR_CFG_SUCCESS;
106 * Parse an unsigned integer
108 * If the key does not exist in the src object, returns success but does fill in *dest.
110 * @param src JSON object to pull a value from
111 * @param key key to pull
112 * @param dest (output) pointer to an allocated unsigned integer
113 * @return TR_CFG_SUCCESS or an error code
115 static TR_CFG_RC tr_cfg_parse_unsigned(json_t *src, const char *key, unsigned int *dest)
119 /* Validate parameters */
120 if ((src == NULL) || (key == NULL) || (dest == NULL))
121 return TR_CFG_BAD_PARAMS;
123 /* See if we have a value for this key; do nothing if not */
124 jtmp = json_object_get(src, key);
126 if (json_is_number(jtmp)) {
127 *dest = (unsigned int) json_integer_value(jtmp);
129 tr_debug("tr_cfg_parse_unsigned: Parsing error, %s is not a number.", key);
130 return TR_CFG_NOPARSE;
134 return TR_CFG_SUCCESS;
140 * If the key does not exist in the src object, returns success but does not allocate
141 * a return value in dest. Nulls the destination pointer if there is no return value.
143 * Return value is allocated in talloc's NULL context and must be freed with talloc_free()
144 * or put into a non-NULL context with talloc_steal()
146 * @param src JSON object to pull a value from
147 * @param key key to pull
148 * @param dest (output) pointer to a pointer that will hold the newly allocated return value
149 * @return TR_CFG_SUCCESS or an error code
151 static TR_CFG_RC tr_cfg_parse_string(json_t *src, const char *key, const char **dest)
155 /* Validate parameters */
156 if ((src == NULL) || (key == NULL) || (dest == NULL))
157 return TR_CFG_BAD_PARAMS;
159 /* See if we have a value for this key; do nothing if not */
160 jtmp = json_object_get(src, key);
162 *dest = NULL; /* No return value, null this out */
164 if (json_is_string(jtmp)) {
165 *dest = talloc_strdup(NULL, json_string_value(jtmp));
167 tr_debug("tr_cfg_parse_string: Parsing error, %s is not a string.", key);
168 return TR_CFG_NOPARSE;
172 return TR_CFG_SUCCESS;
176 * Set default values for settings that have them
178 * @param cfg configuration structure to fill in, not null
180 static void set_defaults(TR_CFG_INTERNAL *cfg)
182 cfg->max_tree_depth = TR_DEFAULT_MAX_TREE_DEPTH;
183 cfg->tids_port = TR_DEFAULT_TIDS_PORT;
184 cfg->trps_port = TR_DEFAULT_TRPS_PORT;
185 cfg->mons_port = TR_DEFAULT_MONITORING_PORT;
186 cfg->cfg_poll_interval = TR_CFGWATCH_DEFAULT_POLL;
187 cfg->cfg_settling_time = TR_CFGWATCH_DEFAULT_SETTLE;
188 cfg->trp_connect_interval = TR_DEFAULT_TRP_CONNECT_INTERVAL;
189 cfg->trp_sweep_interval = TR_DEFAULT_TRP_SWEEP_INTERVAL;
190 cfg->trp_update_interval = TR_DEFAULT_TRP_UPDATE_INTERVAL;
191 cfg->tid_req_timeout = TR_DEFAULT_TID_REQ_TIMEOUT;
192 cfg->tid_resp_numer = TR_DEFAULT_TID_RESP_NUMER;
193 cfg->tid_resp_denom = TR_DEFAULT_TID_RESP_DENOM;
194 cfg->log_threshold = TR_DEFAULT_LOG_THRESHOLD;
195 cfg->console_threshold = TR_DEFAULT_CONSOLE_THRESHOLD;
196 cfg->monitoring_credentials = NULL;
199 /* Helper that checks return value of a parse fn and returns if it failed */
200 #define NOPARSE_UNLESS(x) \
202 if ((x) != TR_CFG_SUCCESS) \
203 return TR_CFG_NOPARSE; \
206 static TR_CFG_RC tr_cfg_parse_monitoring(TR_CFG *trc, json_t *jmon)
208 int enabled = 1; /* assume we are enabled unless we are told not to be */
210 NOPARSE_UNLESS(tr_cfg_parse_boolean(jmon, "enabled", &enabled));
212 NOPARSE_UNLESS(tr_cfg_parse_integer(jmon, "port", &(trc->internal->mons_port)));
213 NOPARSE_UNLESS(tr_cfg_parse_gss_names(trc->internal,
214 json_object_get(jmon, "authorized_credentials"),
215 &(trc->internal->monitoring_credentials)));
218 return TR_CFG_SUCCESS;
222 * Parse internal configuration JSON
224 * @param trc configuration structure to fill in
225 * @param jint internal configuration JSON object
226 * @return TR_CFG_SUCCESS or an error code
228 TR_CFG_RC tr_cfg_parse_internal(TR_CFG *trc, json_t *jint)
231 const char *s = NULL;
233 if ((!trc) || (!jint))
234 return TR_CFG_BAD_PARAMS;
236 /* If we don't yet have an internal config, allocate one and set defaults. If it
237 * already exists, do not disturb existing settings. */
238 if (NULL == trc->internal) {
239 if (NULL == (trc->internal = talloc_zero(trc, TR_CFG_INTERNAL)))
241 set_defaults(trc->internal); /* Install defaults for any unspecified settings */
244 NOPARSE_UNLESS(tr_cfg_parse_string(jint, "hostname", &(trc->internal->hostname)));
245 talloc_steal(trc->internal, trc->internal->hostname);
247 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "max_tree_depth", &(trc->internal->max_tree_depth)));
248 NOPARSE_UNLESS(tr_cfg_parse_integer(jint, "tids_port", &(trc->internal->tids_port)));
249 NOPARSE_UNLESS(tr_cfg_parse_integer(jint, "trps_port", &(trc->internal->trps_port)));
250 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "cfg_poll_interval", &(trc->internal->cfg_poll_interval)));
251 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "cfg_settling_time", &(trc->internal->cfg_settling_time)));
252 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trp_connect_interval", &(trc->internal->trp_connect_interval)));
253 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trp_sweep_interval", &(trc->internal->trp_sweep_interval)));
254 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "trp_update_interval", &(trc->internal->trp_update_interval)));
255 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tid_request_timeout", &(trc->internal->tid_req_timeout)));
256 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tid_response_numerator", &(trc->internal->tid_resp_numer)));
257 NOPARSE_UNLESS(tr_cfg_parse_unsigned(jint, "tid_response_denominator", &(trc->internal->tid_resp_denom)));
259 /* Parse the logging section */
260 if (NULL != (jtmp = json_object_get(jint, "logging"))) {
261 NOPARSE_UNLESS(tr_cfg_parse_string(jtmp, "log_threshold", &s));
263 trc->internal->log_threshold = str2sev(s);
264 talloc_free((void *) s);
267 NOPARSE_UNLESS(tr_cfg_parse_string(jtmp, "console_threshold", &s));
269 trc->internal->console_threshold = str2sev(s);
270 talloc_free((void *) s);
274 /* Parse the monitoring section */
275 if (NULL != (jtmp = json_object_get(jint, "monitoring"))) {
276 NOPARSE_UNLESS(tr_cfg_parse_monitoring(trc, jtmp));
279 tr_debug("tr_cfg_parse_internal: Internal config parsed.");
280 return TR_CFG_SUCCESS;