clients/authconf.{c,h}, docs: further refactor with upscli_normalize_auth_section_parts() which we can share and expose [#3329]

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>

Author: jimklimov

clients/authconf.c

@@ -292,6 +292,115 @@ static void authconf_err(const char *errmsg)
 	upslogx(LOG_ERR, "Error in parseconf(authconf): %s", errmsg);
 }
 
+int upscli_normalize_auth_section_parts(
+	char **out_normalized_sect_name,
+	char **p_sect_user,
+	int  *out_fixed_sect_user,
+	char **p_sect_host,
+	char **p_sect_port)
+{
+	char	*sect_user = NULL, *sect_host = NULL, *sect_port = NULL;
+
+	/* All p_* args must be non-NULL pointers to `char *` string variables
+	 * which may be freed and re-allocated to return normalized values
+	 * (original strings may themselves be NULL).
+	 * The out_* values are optional and may be NULL if you do not want
+	 * those data points returned.
+	 */
+	if (!p_sect_user || !p_sect_host || !p_sect_port) {
+		upslogx(LOG_ERR, "upscli_normalize_auth_section_parts: NULL pointer-to-string argument provided");
+		return -1;
+	}
+
+	/* No changes imposed here */
+	sect_user = *p_sect_user;
+
+	sect_host = *p_sect_host;
+	if (!sect_host || !*sect_host) {
+		sect_host = xstrdup("localhost");
+		if (!sect_host) goto failed;
+	}
+
+	sect_port = *p_sect_port;
+	if (sect_port && *sect_port) {
+		/* As port is a string, resolve it (if not a number,
+		 * try to get one via "services" naming database) */
+		char	*p = sect_port;
+		int	is_numeric = 1;
+
+		while (*p) {
+			if (!isdigit((unsigned char)*p)) {
+				is_numeric = 0;
+				break;
+			}
+			p++;
+		}
+
+		if (!is_numeric) {
+			struct servent	*se = getservbyname(sect_port, "tcp");
+
+			if (se) {
+				char	portbuf[16];
+				if (snprintf(portbuf, sizeof(portbuf), "%u", ntohs(se->s_port) < 1)) {
+					upsdebugx(1, "%s: Failed to construct port number from service name", __func__);
+					goto failed;
+				}
+				sect_port = xstrdup(portbuf);
+				if (!sect_port) goto failed;
+			}	/* else resolution failed, keep original string */
+		}
+	} else {
+		char	portbuf[16];
+		if (snprintf(portbuf, sizeof(portbuf), "%u", NUT_PORT) < 1) {
+			upsdebugx(1, "%s: Failed to construct default port number", __func__);
+			goto failed;
+		}
+		sect_port = xstrdup(portbuf);
+		if (!sect_port) goto failed;
+	}
+
+	/* Only now that we (almost) do not expect failures, we can
+	 * consistently populate caller's output variables (if any) */
+	if (out_normalized_sect_name) {
+		char	normalized_sect_name_buf[LARGEBUF];
+
+		if (snprintf(normalized_sect_name_buf, sizeof(normalized_sect_name_buf), "%s@%s:%s",
+			sect_user ? sect_user : "",
+			sect_host,
+			sect_port) > 0
+		) {
+			free(*out_normalized_sect_name);
+			*out_normalized_sect_name = xstrdup(normalized_sect_name_buf);
+		} else {
+			upsdebugx(1, "%s: Failed to reconstruct normalized section header", __func__);
+			goto failed;
+		}
+	}
+
+	if (out_fixed_sect_user)
+		*out_fixed_sect_user = (sect_user && *sect_user);
+
+	/* Different pointers? */
+	if (*p_sect_host != sect_host) {
+		free(*p_sect_host);
+		*p_sect_host = sect_host;
+	}
+
+	if (*p_sect_port != sect_port) {
+		free(*p_sect_port);
+		*p_sect_port = sect_port;
+	}
+
+	return 0;
+
+failed:
+	free(sect_user);
+	free(sect_host);
+	free(sect_port);
+
+	return -1;
+}
+
 int upscli_split_auth_section(const char *sect_name,
 	char **normalized_sect_name,
 	char **normalized_sect_user,
@@ -352,69 +461,16 @@ int upscli_split_auth_section(const char *sect_name,
 	}
 
 	if (colon && colon[1]) {
-		/* As port is a string, resolve it (if not a number,
-		 * try to get one via "services" naming database) */
-		const char	*p = colon + 1;
-		int	is_numeric = 1;
-
-		while (*p) {
-			if (!isdigit((unsigned char)*p)) {
-				is_numeric = 0;
-				break;
-			}
-			p++;
-		}
-
-		if (is_numeric) {
-			sect_port = xstrdup(colon + 1);
-		} else {
-			struct servent	*se = getservbyname(colon + 1, "tcp");
-
-			if (se) {
-				char	portbuf[16];
-				snprintf(portbuf, sizeof(portbuf), "%u", ntohs(se->s_port));
-				sect_port = xstrdup(portbuf);
-			} else {
-				/* Resolution failed, fall back to original string */
-				sect_port = xstrdup(colon + 1);
-			}
-		}
-
+		/* May get re-normalized below */
+		sect_port = xstrdup(colon + 1);
 		if (!sect_port) goto failed;
 	}
 
-	if (!sect_host || !*sect_host) {
-		free(sect_host);
-		sect_host = xstrdup("localhost");
-		if (!sect_host) goto failed;
-	}
-
-	if (!sect_port || !*sect_port) {
-		free(sect_port);
-		sect_port = xcalloc(6, sizeof(char));
-		if (!sect_port) goto failed;
-		if (snprintf(sect_port, 6, "%u", NUT_PORT) < 1) {
-			upsdebugx(1, "%s: Failed to construct default port number", __func__);
-			goto failed;
-		}
-	}
-
-	/* Only now that we (almost) do not expect failures, we can
-	 * consistently populate caller's output variables (if any) */
-	if (normalized_sect_name) {
-		char	normalized_sect_name_buf[LARGEBUF];
-
-		if (snprintf(normalized_sect_name_buf, sizeof(normalized_sect_name_buf), "%s@%s:%s",
-			sect_user ? sect_user : "",
-			sect_host,
-			sect_port) > 0
-		) {
-			*normalized_sect_name = xstrdup(normalized_sect_name_buf);
-		} else {
-			upsdebugx(1, "%s: Failed to reconstruct normalized section header from '%s'", __func__, sect_name);
-			goto failed;
-		}
-	}
+	if (upscli_normalize_auth_section_parts(
+			normalized_sect_name,
+			&sect_user, &fixed_sect_user,
+			&sect_host, &sect_port) < 0
+	) goto failed;
 
 	if (out_fixed_sect_user)
 		*out_fixed_sect_user = fixed_sect_user;

clients/authconf.h

@@ -52,6 +52,19 @@ void upscli_free_authconf_list(void);
  */
 int upscli_read_authconf(const char *filename, int fatal_errors);
 
+/** All p_* args must be non-NULL pointers to `char *` string variables
+ * which may be freed and re-allocated to return normalized values
+ * (original strings may themselves be NULL).
+ * The out_* values are optional and may be NULL if you do not want
+ * those data points returned.
+ */
+int upscli_normalize_auth_section_parts(
+	char **out_normalized_sect_name,
+	char **p_sect_user,
+	int  *out_fixed_sect_user,
+	char **p_sect_host,
+	char **p_sect_port);
+
 /** Take raw sect_name as input (e.g. a user-written string from config files).
  * Normalize it by splitting into user, host, and port components (populating absent values).
  * Return normalized components and reconstructed section name in output parameters (if not NULL),

docs/man/Makefile.am

@@ -757,6 +757,7 @@ INST_MAN_DEV_API_PAGES = \
 	upscli_upserror.$(MAN_SECTION_API) \
 	upscli_upslog_set_debug_level.$(MAN_SECTION_API) \
 	upscli_get_authconf_list.$(MAN_SECTION_API) \
+	upscli_normalize_auth_section_parts.$(MAN_SECTION_API) \
 	upscli_split_auth_section.$(MAN_SECTION_API) \
 	upscli_free_authconf_list.$(MAN_SECTION_API) \
 	upscli_read_authconf.$(MAN_SECTION_API) \
@@ -831,6 +832,9 @@ upscli_sendline_timeout_may_disconnect.$(MAN_SECTION_API): upscli_sendline.$(MAN
 upscli_tryconnect.$(MAN_SECTION_API): upscli_connect.$(MAN_SECTION_API)
 	touch $@
 
+upscli_normalize_auth_section_parts.$(MAN_SECTION_API): upscli_get_authconf_list.$(MAN_SECTION_API)
+	touch $@
+
 upscli_split_auth_section.$(MAN_SECTION_API): upscli_get_authconf_list.$(MAN_SECTION_API)
 	touch $@
 
@@ -988,6 +992,9 @@ upscli_sendline_timeout.html upscli_sendline_timeout_may_disconnect.html: upscli
 upscli_tryconnect.html: upscli_connect.html
 	test -n '$?' -a -s '$@' && rm -f $@ && ln -s $? $@
 
+upscli_normalize_auth_section_parts.html: upscli_get_authconf_list.html
+	test -n '$?' -a -s '$@' && rm -f $@ && ln -s $? $@
+
 upscli_split_auth_section.html: upscli_get_authconf_list.html
 	test -n '$?' -a -s '$@' && rm -f $@ && ln -s $? $@
 

docs/man/upscli_find_authconf.txt

@@ -4,7 +4,8 @@ UPSCLI_FIND_AUTHCONF(3)
 NAME
 ----
 
-upscli_find_authconf, upscli_split_auth_section, upscli_free_authconf - Find,
+upscli_find_authconf, upscli_normalize_auth_section_parts,
+upscli_split_auth_section, upscli_free_authconf - Find,
 parse name, and free authentication configuration items
 
 SYNOPSIS
@@ -13,7 +14,17 @@ SYNOPSIS
 ------
 	#include <authconf.h>
 
-	upscli_authconf_t *upscli_find_authconf(const char *user, const char *host, const char *port);
+	upscli_authconf_t *upscli_find_authconf(
+		const char *user,
+		const char *host,
+		const char *port);
+
+	int upscli_normalize_auth_section_parts(
+		char **out_normalized_sect_name,
+		char **p_sect_user,
+		int  *out_fixed_sect_user,
+		char **p_sect_host,
+		char **p_sect_port);
 
 	int upscli_split_auth_section(const char *sect_name,
 		char **normalized_sect_name,
@@ -43,11 +54,15 @@ inherited from the global defaults.
 
 The "*upscli_split_auth_section()*" function splits a `sect_name` which may be
 from a user-typed configuration file into user, host and port sections, and
-normalizes the values (e.g. a `NULL` 'host' becomes `localhost`, a missing
-'port' is defaulted to `NUT_PORT` defined at build configuration time, e.g.
-'3493' by default, and a non-numeric string 'port' is resolved in the naming
-database of the current operating environment).  Resulting normalized values
-are returned to caller using pointers provided in the arguments (if not `NULL`).
+with "*upscli_normalize_auth_section_parts()*" normalizes the values (e.g. a
+`NULL` 'host' becomes `localhost`, a missing 'port' is defaulted to `NUT_PORT`
+defined at build configuration time, e.g. '3493' by default, and a non-numeric
+string 'port' is resolved in the naming database of the current operating
+environment). The resulting normalized values are returned to caller using
+pointers provided in the arguments (if not `NULL` in case of
+"*upscli_split_auth_section()*", must be not `NULL` in case of
+"*upscli_normalize_auth_section_parts()*").
+
 A 'normalized_sect_name' can be also constructed and returned, so that varying
 but ultimately identical definitions of the section titles (e.g. `[@localhost]`
 and `[@localhost:3493]` can be conflated when parsing configuration files or