From 82b721d7d28c40a2c9f0ba4310a5017d216f0ec3 Mon Sep 17 00:00:00 2001 From: Jon Shallow Date: Wed, 7 Aug 2024 10:34:23 +0100 Subject: [PATCH] coap-server.c: Replace SERVER_CAN_PROXY with COAP_PROXY_SUPPORT Make use of the new coap_defines.h file. --- coap_config.h.contiki | 5 +++ coap_config.h.riot | 9 ++++++ coap_config.h.windows | 7 ++++ examples/Makefile.am | 5 --- examples/coap-server.c | 53 ++++++++++++++----------------- examples/riot/pkg_libcoap/Kconfig | 12 +++++++ win32/libcoap.vcxproj | 27 ++++++++++------ 7 files changed, 74 insertions(+), 44 deletions(-) diff --git a/coap_config.h.contiki b/coap_config.h.contiki index 472e8af1c5..44d1d500a8 100644 --- a/coap_config.h.contiki +++ b/coap_config.h.contiki @@ -18,6 +18,11 @@ /* Define to 1 if libcoap supports server mode code. */ #define COAP_SERVER_SUPPORT 1 +#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT +/* Define to 1 if libcoap supports proxy code. */ +#define COAP_PROXY_SUPPORT 1 +#endif /* COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT */ + /* Define to 1 if the system has small stack size. */ #define COAP_CONSTRAINED_STACK 1 diff --git a/coap_config.h.riot b/coap_config.h.riot index 30c0557d9a..eda295ecae 100644 --- a/coap_config.h.riot +++ b/coap_config.h.riot @@ -121,6 +121,15 @@ #endif /* COAP_SERVER_SUPPORT */ #endif /* CONFIG_LIBCOAP_SERVER_SUPPORT */ +#ifdef CONFIG_LIBCOAP_PROXY_SUPPORT +#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT +#ifndef COAP_PROXY_SUPPORT +/* Define to 1 if the library has proxy code support. */ +#define COAP_PROXY_SUPPORT 1 +#endif /* COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT */ +#endif /* COAP_PROXY_SUPPORT */ +#endif /* CONFIG_LIBCOAP_PROXY_SUPPORT */ + #ifdef CONFIG_LIBCOAP_ASYNC_SUPPORT #ifndef COAP_ASYNC_SUPPORT /* Define to 1 to build with support for async separate responses. */ diff --git a/coap_config.h.windows b/coap_config.h.windows index bc0529c465..4f843f08e7 100644 --- a/coap_config.h.windows +++ b/coap_config.h.windows @@ -108,6 +108,13 @@ #define COAP_SERVER_SUPPORT 1 #endif +#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT +#ifndef COAP_PROXY_SUPPORT +/* Define if libcoap supports proxy code. */ +#define COAP_PROXY_SUPPORT 1 +#endif +#endif /* COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT */ + #ifndef COAP_WITH_OBSERVE_PERSIST /* Define to build support for persisting observes. */ #define COAP_WITH_OBSERVE_PERSIST 0 diff --git a/examples/Makefile.am b/examples/Makefile.am index 48d7b24fc0..d4684164b7 100644 --- a/examples/Makefile.am +++ b/examples/Makefile.am @@ -56,11 +56,6 @@ if BUILD_ADD_DEFAULT_NAMES noinst_PROGRAMS += coap-server coap-rd endif # BUILD_ADD_DEFAULT_NAMES -if ! HAVE_CLIENT_SUPPORT -coap_server_CPPFLAGS=-DSERVER_CAN_PROXY=0 -coap_server@LIBCOAP_DTLS_LIB_EXTENSION_NAME@_CPPFLAGS=-DSERVER_CAN_PROXY=0 -endif # ! HAVE_CLIENT_SUPPORT - endif # HAVE_SERVER_SUPPORT coap_client_SOURCES = coap-client.c diff --git a/examples/coap-server.c b/examples/coap-server.c index f226dba9d3..8cb926a6bf 100644 --- a/examples/coap-server.c +++ b/examples/coap-server.c @@ -54,18 +54,11 @@ strndup(const char *s1, size_t n) { #include #endif -/* - * SERVER_CAN_PROXY=0 can be set by build system if - * "./configure --disable-client-mode" is used. - */ -#ifndef SERVER_CAN_PROXY -#define SERVER_CAN_PROXY 1 -#endif - /* Need to refresh time once per sec */ #define COAP_RESOURCE_CHECK_TIME 1 #include +#include #ifndef min #define min(a,b) ((a) < (b) ? (a) : (b)) @@ -624,7 +617,7 @@ hnd_put_example_data(coap_resource_t *resource, } } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT #define MAX_USER 128 /* Maximum length of a user name (i.e., PSK * identity) in bytes. */ @@ -682,7 +675,7 @@ hnd_reverse_proxy_uri(coap_resource_t *resource, /* Leave response code as is */ } -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ typedef struct dynamic_resource_t { coap_string_t *uri_path; @@ -1052,7 +1045,7 @@ hnd_put_post_unknown(coap_resource_t *resource COAP_UNUSED, hnd_put_post(r, session, request, query, response); } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT static int proxy_event_handler(coap_session_t *session COAP_UNUSED, coap_event_t event) { @@ -1120,13 +1113,13 @@ proxy_nack_handler(coap_session_t *session COAP_UNUSED, return; } -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ static void init_resources(coap_context_t *ctx) { coap_resource_t *r; -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT if (reverse_proxy.entry_count) { /* Create a reverse proxy resource to handle PUTs */ r = coap_resource_unknown_init2(hnd_reverse_proxy_uri, @@ -1143,7 +1136,7 @@ init_resources(coap_context_t *ctx) { coap_register_response_handler(ctx, reverse_response_handler); coap_register_nack_handler(ctx, proxy_nack_handler); } else { -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ r = coap_resource_init(NULL, COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT); coap_register_request_handler(r, COAP_REQUEST_GET, hnd_get_index); @@ -1198,7 +1191,7 @@ init_resources(coap_context_t *ctx) { coap_add_attr(r, coap_make_str_const("title"), coap_make_str_const("\"Example Data\""), 0); coap_add_resource(ctx, r); -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT } if (proxy_host_name_count) { r = coap_resource_proxy_uri_init2(hnd_forward_proxy_uri, proxy_host_name_count, @@ -1208,7 +1201,7 @@ init_resources(coap_context_t *ctx) { coap_register_response_handler(ctx, reverse_response_handler); coap_register_nack_handler(ctx, proxy_nack_handler); } -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ } static int @@ -1522,7 +1515,7 @@ fill_keystore(coap_context_t *ctx) { } } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT static void proxy_dtls_setup(coap_context_t *ctx, coap_proxy_server_list_t *proxy_info) { size_t i; @@ -1553,7 +1546,7 @@ proxy_dtls_setup(coap_context_t *ctx, coap_proxy_server_list_t *proxy_info) { */ } } -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ static void @@ -1813,7 +1806,7 @@ get_context(const char *node, const char *port) { return ctx; } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT static int cmdline_proxy(char *arg) { char *host_start = strchr(arg, ','); @@ -1912,7 +1905,7 @@ cmdline_read_user(char *arg, unsigned char **buf, size_t maxlen) { /* 0 length Identity is valid */ return len; } -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ static FILE *oscore_seq_num_fp = NULL; static const char *oscore_conf_file = NULL; @@ -2386,13 +2379,13 @@ main(int argc, char **argv) { fprintf(stderr, "Reverse Proxy support not available as libcoap proxy code not enabled\n"); goto failed; } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT if (!cmdline_reverse_proxy(optarg)) { fprintf(stderr, "Reverse Proxy error specifying upstream address\n"); goto failed; } block_mode |= COAP_BLOCK_SINGLE_BODY; -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ break; case 'g' : group = optarg; @@ -2460,13 +2453,13 @@ main(int argc, char **argv) { fprintf(stderr, "Proxy support not available as libcoap proxy code not enabled\n"); goto failed; } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT if (!cmdline_proxy(optarg)) { fprintf(stderr, "error specifying proxy address or host names\n"); goto failed; } block_mode |= COAP_BLOCK_SINGLE_BODY; -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ break; case 'q': tls_engine_conf = optarg; @@ -2501,9 +2494,9 @@ main(int argc, char **argv) { fprintf(stderr, "Proxy support not available as libcoap proxy code not enabled\n"); goto failed; } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT user_length = cmdline_read_user(optarg, &user, MAX_USER); -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ break; case 'U': if (!cmdline_unix(optarg)) { @@ -2581,14 +2574,14 @@ main(int argc, char **argv) { if (get_oscore_conf(ctx) == NULL) goto failed; } -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT if (reverse_proxy.entry_count) { proxy_dtls_setup(ctx, &reverse_proxy); } if (forward_proxy.entry_count) { proxy_dtls_setup(ctx, &forward_proxy); } -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ if (extended_token_size > COAP_TOKEN_DEFAULT_MAX) coap_context_set_max_token_size(ctx, extended_token_size); @@ -2742,14 +2735,14 @@ main(int argc, char **argv) { } free(dynamic_entry); release_resource_data(NULL, example_data_value); -#if SERVER_CAN_PROXY +#if COAP_PROXY_SUPPORT free(reverse_proxy.entry); free(forward_proxy.entry); #if defined(_WIN32) && !defined(__MINGW32__) #pragma warning( disable : 4090 ) #endif coap_free(proxy_host_name_list); -#endif /* SERVER_CAN_PROXY */ +#endif /* COAP_PROXY_SUPPORT */ if (oscore_seq_num_fp) fclose(oscore_seq_num_fp); diff --git a/examples/riot/pkg_libcoap/Kconfig b/examples/riot/pkg_libcoap/Kconfig index 09c0be673d..a033b7faed 100644 --- a/examples/riot/pkg_libcoap/Kconfig +++ b/examples/riot/pkg_libcoap/Kconfig @@ -220,6 +220,18 @@ config LIBCOAP_MAX_LG_SRCVS endif # LIBCOAP_SERVER_SUPPORT +config LIBCOAP_PROXY_SUPPORT + bool "Enable Proxy functionality within CoAP" + depends on LIBCOAP_CLIENT_SUPPORT && LIBCOAP_SERVER_SUPPORT + default n + help + Enable Proxy functionality (ability to receive requests, pass + them to an upstream server and send back responses to client) + for CoAP. + + If this option is disabled, redundant CoAP proxy only code is + removed. + config LIBCOAP_MAX_LG_XMITS int "Max number of large transmits supported" default 2 if LIBCOAP_SERVER_SUPPORT diff --git a/win32/libcoap.vcxproj b/win32/libcoap.vcxproj index 4da735e3f6..ce643c6037 100644 --- a/win32/libcoap.vcxproj +++ b/win32/libcoap.vcxproj @@ -388,7 +388,8 @@ TYPE %(FullPath) >> "$(IntDir)$(TargetName).def" copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -431,7 +432,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -471,7 +473,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -496,7 +499,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -519,7 +523,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -564,7 +569,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -606,7 +612,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -634,7 +641,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows @@ -658,7 +666,8 @@ copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h copy /Y ..\coap_config.h.windows ..\coap_config.h -copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\$(LibCoAPIncludeDir)\coap.h.windows ..\$(LibCoAPIncludeDir)\coap.h +copy /Y ..\coap_config.h.windows ..\$(LibCoAPIncludeDir)\coap_defines.h Copying config files for windows