Merge 0f03f63 into b0b3898

Author: jimklimov

NEWS.adoc

@@ -104,6 +104,16 @@ https://github.com/networkupstools/nut/milestone/12
      characters. Now it is evaluated at `configure` time (to check that the
      characters may be used), and if not -- during `nut_stdint.h` parsing to
      fit known `int`/`long`/`long long` types. [#3300]
+   * Added new API methods and defined bitmap values for `libupsclient`
+     C binding to query and report SSL capabilities of the current library
+     build (none, OpenSSL, Mozilla NSS): `upscli_ssl_caps_descr()` and
+     `upscli_ssl_caps()`. Updated common NUT clients to report this info
+     in their detailed help banners. Done similarly for `upsd`. The NIT
+     (NUT Integration Test) suite piggy-backs on this to add run-time
+     dependent tests of SSL capability. Added `upscli_set_debug_level()`
+     and `upscli_set_debug_level()` methods to facilitate NUT debugging
+     for clients built with shared NUT private libraries. [issues #3328,
+     #1771, #2800, PR #3330]
 
  - NUT for Windows specific updates:
    * Revised detection of (relative) paths to program and configuration files
@@ -302,6 +312,11 @@ https://github.com/networkupstools/nut/milestone/12
      or Windows `HANDLE`'s at a time, and moving on to another chunk.
      The system-provided value can be further limited by `NUT_SYSMAXCONN_LIMIT`
      environment variable (e.g. in tests). [#3302]
+   * Extended processing of `CERTREQUEST` setting to handle numeric or specific
+     string values, to match both ways of reading ambiguous documentation.
+     Added `configure --with-ssl-client-validation` toggle to expose the
+     macro previously meant to be passed via `make` command line. [PR #3330,
+     but beware issue #3329]
 
  - `upsdrvctl` tool updates:
    * Make use of `setproctag()` and `getproctag()` to report parent/child

UPGRADING.adoc

@@ -35,6 +35,10 @@ Changes from 2.8.4 to 2.8.5
   library files to deliver with the packages (formally versioned and
   named by NUT release semantic version triplet). [issue #2800]
 
+- Related to the above, `libupsclient` will remove the exported symbol for
+  `nut_debug_level` variable in a later NUT release, and now introduces the
+  `upscli_set_debug_level()` and `upscli_get_debug_level()` methods. [PR #3330]
+
 - For ages, most recipes for building NUT had customized the `sysconfdir` to
   be `/etc/nut`, which is not exactly the *system* configuration directory.
   This is finally deprecated, with new `--with-confdir` configuration option
@@ -99,6 +103,10 @@ Changes from 2.8.4 to 2.8.5
   use `upsdrvquery_NOSIGPIPE=0` to disable neutering of the signal inside
   the API itself. [PR #3277]
 
+- Added new API methods and defined bitmap values for `libupsclient` C binding
+  to query and report SSL capabilities of the library build (none, OpenSSL,
+  Mozilla NSS): `upscli_ssl_caps_descr()` and `upscli_ssl_caps()`. [PR #33xx]
+
 - Fixed man page naming for `nutdrv_siemens-sitop(.8)` (dash vs. underscore)
   to match the driver program name. Packaging recipes may have to be updated.
   Follow-up from slightly botched renaming in original contribution. [PR #545]

appveyor.yml

@@ -63,7 +63,7 @@ install:
 # versions of packages.
   - cmd: |
         REM Prerequisites for NUT per https://github.com/networkupstools/nut/blob/master/docs/config-prereqs.txt :
-        C:\msys64\usr\bin\bash -lc "date -u; pacman --noconfirm -S --needed base-devel mingw-w64-x86_64-toolchain autoconf-wrapper automake-wrapper libtool mingw-w64-x86_64-libltdl gcc ccache mingw-w64-x86_64-ccache git aspell aspell-en python mingw-w64-x86_64-python-pygments mingw-w64-x86_64-winpthreads-git mingw-w64-x86_64-libusb mingw-w64-x86_64-libusb-compat-git mingw-w64-x86_64-neon libneon-devel mingw-w64-x86_64-libgd mingw-w64-x86_64-cppunit"
+        C:\msys64\usr\bin\bash -lc "date -u; pacman --noconfirm -S --needed base-devel mingw-w64-x86_64-toolchain autoconf-wrapper automake-wrapper libtool mingw-w64-x86_64-libltdl gcc ccache mingw-w64-x86_64-ccache git aspell aspell-en python mingw-w64-x86_64-python-pygments mingw-w64-x86_64-winpthreads-git mingw-w64-x86_64-libusb mingw-w64-x86_64-libusb-compat-git mingw-w64-x86_64-neon libneon-devel mingw-w64-x86_64-libgd mingw-w64-x86_64-cppunit mingw-w64-x86_64-nss mingw-w64-x86_64-openssl"
         REM SKIP mingw-w64-x86_64-libmodbus-git : we custom-build one with USB support
         REM SKIP for now NUT-Monitor prereqs (runtime Python would require somilar modules; need to fix localization builds like "fr.po"): gettext mingw-w64-x86_64-python-pyqt6
 

clients/Makefile.am

@@ -166,8 +166,13 @@ upsstats_cgi_LDADD = $(LDADD_CLIENT) $(top_builddir)/common/libcommonstrjson.la
 # not LDADD... why?
 libupsclient_la_SOURCES = upsclient.c upsclient.h
 # NOTE: The library does not require libcommonversion.la
+if ENABLE_SHARED_PRIVATE_LIBS
+libupsclient_la_LIBADD = \
+	$(top_builddir)/common/libnutprivate-@NUT_SOURCE_GITREV_SEMVER_UNDERSCORES@-common-client.la
+else !ENABLE_SHARED_PRIVATE_LIBS
 libupsclient_la_LIBADD = \
 	$(top_builddir)/common/libcommonclient.la
+endif !ENABLE_SHARED_PRIVATE_LIBS
 if HAVE_WINDOWS_SOCKETS
   libupsclient_la_LIBADD += -lws2_32
 endif HAVE_WINDOWS_SOCKETS
@@ -181,6 +186,15 @@ endif WITH_SSL
 # object .so names would differ)
 
 # libupsclient version information
+# NOTE: with libnutprivate*common* builds dynamically linked into the same
+# program (a typical in-tree NUT client, not typical for out-of-tree third
+# party clients) we can end up with two copies of libcommon symbols present
+# in each library. It's recommended to explicitly call upscli_set_debug_level()
+# instead of ambiguously manipulating the nut_debug_level variable by name.
+# TOTHINK: Un-export nut_debug_level from this library to avoid ambiguity
+# for the run-time dynamic linker resolution? For now the shared-library
+# builds are "exotic", but it makes sense to deprecate this export in a
+# future release.
 libupsclient_la_LDFLAGS = -version-info 7:0:0
 libupsclient_la_LDFLAGS += -export-symbols-regex '^(upscli_|nut_debug_level)'
 #|s_upsdebug|fatalx|fatal_with_errno|xcalloc|xbasename|print_banner_once)'

clients/upsc.c

@@ -2,7 +2,7 @@
 
    Copyright (C) 1999  Russell Kroll <rkroll@exploits.org>
    Copyright (C) 2012  Arnaud Quette <arnaud.quette@free.fr>
-   Copyright (C) 2020-2025  Jim Klimov <jimklimov+nut@gmail.com>
+   Copyright (C) 2020-2026  Jim Klimov <jimklimov+nut@gmail.com>
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -48,14 +48,14 @@ static void fatalx_error_json_simple(int msg_is_simple, const char *msg) {
 	if (output_json) {
 		if (msg_is_simple) {
 			/* Caller knows there is nothing to escape here, pass through */
-			printf("{\"error\": \"%s\"}\n", msg);
+			printf("{\"error\": \"%s\"}\n", NUT_STRARG(msg));
 		} else {
 			printf("{\"error\": \"");
 			json_print_esc(msg);
 			printf("\"}\n");
 		}
 	}
-	fatalx(EXIT_FAILURE, "Error: %s", msg);
+	fatalx(EXIT_FAILURE, "Error: %s", NUT_STRARG(msg));
 }
 
 static void usage(const char *prog)
@@ -91,6 +91,7 @@ static void usage(const char *prog)
 	printf("  -h         - display this help text\n");
 
 	nut_report_config_flags();
+	upscli_report_build_details();
 
 	printf("\n%s", suggest_doc_links(prog, NULL));
 }
@@ -168,6 +169,8 @@ static void list_vars(void)
 		int	msg_is_simple = 1;
 
 		/* check for an old upsd */
+		upsdebugx(1, "%s: got code %d, upserror %d",
+			__func__, ret, upscli_upserror(ups));
 		if (upscli_upserror(ups) == UPSCLI_ERR_UNKCOMMAND) {
 			msg = "upsd is too old to support this query";
 		} else {
@@ -177,14 +180,14 @@ static void list_vars(void)
 
 		if (output_json) {
 			if (msg_is_simple) {
-				printf("  \"error\": \"%s\"\n}\n", msg);
+				printf("  \"error\": \"%s\"\n}\n", NUT_STRARG(msg));
 			} else {
 				printf("  \"error\": \"");
 				json_print_esc(msg);
 				printf("\"\n}\n");
 			}
 		}
-		fatalx(EXIT_FAILURE, "Error: %s", msg);
+		fatalx(EXIT_FAILURE, "Error: %s", NUT_STRARG(msg));
 	}
 
 	while (upscli_list_next(ups, numq, query, &numa, &answer) == 1) {
@@ -237,6 +240,8 @@ static void list_upses(int verbose)
 		int	msg_is_simple = 1;
 
 		/* check for an old upsd */
+		upsdebugx(1, "%s: got code %d, upserror %d",
+			__func__, ret, upscli_upserror(ups));
 		if (upscli_upserror(ups) == UPSCLI_ERR_UNKCOMMAND) {
 			msg = "upsd is too old to support this query";
 		} else {
@@ -394,6 +399,7 @@ int main(int argc, char **argv)
 	s = getenv("NUT_DEBUG_LEVEL");
 	if (s && str_to_int(s, &i, 10) && i > 0) {
 		nut_debug_level = i;
+		upscli_set_debug_level(nut_debug_level);
 	}
 	upsdebugx(1, "Starting NUT client: %s", prog);