net: http: service: enhance HTTP service with optional custom socket create

AndreyDodonov-EH · AndreyDodonov-EH · commit 6cf7a0b1ecd3 · 2025-07-09T17:07:45.000+02:00
Update the HTTP service API to allow custom socket creation through a
function pointer in the service descriptor. The existing socket creation
method is retained as a fallback if no custom function is provided.

Signed-off-by: Andrey Dodonov &lt;Andrey.Dodonov@endress.com&gt;
diff --git a/include/zephyr/net/http/service.h b/include/zephyr/net/http/service.h
@@ -69,6 +69,18 @@ struct http_service_runtime_data {
 	int num_clients;
 };
 
+struct http_service_desc;
+
+/** Custom socket creation function type */
+typedef int (*http_socket_create_fn)(const struct http_service_desc *svc, int af, int proto);
+
+/** HTTP service configuration */
+struct http_service_config {
+	/** Custom socket creation for the service if needed */
+	http_socket_create_fn socket_create;
+	/* If any more service-specific configuration is needed, it can be added here. */
+};
+
 struct http_service_desc {
 	const char *host;
 	uint16_t *port;
@@ -80,14 +92,15 @@ struct http_service_desc {
 	struct http_resource_desc *res_begin;
 	struct http_resource_desc *res_end;
 	struct http_resource_detail *res_fallback;
+	const struct http_service_config *config;
 #if defined(CONFIG_NET_SOCKETS_SOCKOPT_TLS)
 	const sec_tag_t *sec_tag_list;
 	size_t sec_tag_list_size;
 #endif
 };
 
 #define __z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,               \
-				_res_fallback, _res_begin, _res_end, ...)                          \
+				_res_fallback, _res_begin, _res_end, _config, ...)                 \
 	BUILD_ASSERT(_concurrent <= CONFIG_HTTP_SERVER_MAX_CLIENTS,                                \
 		     "can't accept more then MAX_CLIENTS");                                        \
 	BUILD_ASSERT(_backlog > 0, "backlog can't be 0");                                          \
@@ -104,6 +117,7 @@ struct http_service_desc {
 		.res_begin = (_res_begin),                                                         \
 		.res_end = (_res_end),                                                             \
 		.res_fallback = (_res_fallback),                                                   \
+		.config = (_config),                                                               \
 		COND_CODE_1(CONFIG_NET_SOCKETS_SOCKOPT_TLS,                                        \
 			    (.sec_tag_list = COND_CODE_0(NUM_VA_ARGS_LESS_1(__VA_ARGS__), (NULL),  \
 							 (GET_ARG_N(1, __VA_ARGS__))),), ())       \
@@ -137,7 +151,33 @@ struct http_service_desc {
 #define HTTP_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail,             \
 				  _res_fallback)                                                   \
 	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,               \
-				_res_fallback, NULL, NULL)
+				_res_fallback, NULL, NULL, NULL)
+
+/**
+ * @brief Define an HTTP service without static resources with custom configuration.
+ *
+ * @note The @p _host parameter is used to specify an IP address either in
+ * IPv4 or IPv6 format a fully-qualified hostname or a virtual host. If left NULL, the listening
+ * port will listen on all addresses.
+ *
+ * @note The @p _port parameter must be non-`NULL`. It points to a location that specifies the port
+ * number to use for the service. If the specified port number is zero, then an ephemeral port
+ * number will be used and the actual port number assigned will be written back to memory. For
+ * ephemeral port numbers, the memory pointed to by @p _port must be writeable.
+ *
+ * @param _name Name of the service.
+ * @param _host IP address or hostname associated with the service.
+ * @param[inout] _port Pointer to port associated with the service.
+ * @param _concurrent Maximum number of concurrent clients. (max. CONFIG_HTTP_SERVER_MAX_CLIENTS)
+ * @param _backlog Maximum number of queued connections. (min. 1)
+ * @param _detail User-defined detail associated with the service.
+ * @param _res_fallback Fallback resource to be served if no other resource matches path
+ * @param _config Pointer to http_service_config structure
+ */
+#define HTTP_SERVICE_DEFINE_EMPTY_CONFIG(_name, _host, _port, _concurrent, _backlog, _detail,      \
+					 _res_fallback, _config)                                   \
+	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,               \
+				_res_fallback, NULL, NULL, _config)
 
 /**
  * @brief Define an HTTPS service without static resources.
@@ -164,7 +204,39 @@ struct http_service_desc {
 #define HTTPS_SERVICE_DEFINE_EMPTY(_name, _host, _port, _concurrent, _backlog, _detail,          \
 				   _res_fallback, _sec_tag_list, _sec_tag_list_size)             \
 	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,             \
-				_res_fallback, NULL, NULL,                                       \
+				_res_fallback, NULL, NULL, NULL,                                 \
+				_sec_tag_list, _sec_tag_list_size);				 \
+	BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS),				 \
+		     "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
+
+/**
+ * @brief Define an HTTPS service without static resources with custom configuration.
+ *
+ * @note The @p _host parameter is used to specify an IP address either in
+ * IPv4 or IPv6 format a fully-qualified hostname or a virtual host. If left NULL, the listening
+ * port will listen on all addresses.
+ *
+ * @note The @p _port parameter must be non-`NULL`. It points to a location that specifies the port
+ * number to use for the service. If the specified port number is zero, then an ephemeral port
+ * number will be used and the actual port number assigned will be written back to memory. For
+ * ephemeral port numbers, the memory pointed to by @p _port must be writeable.
+ *
+ * @param _name Name of the service.
+ * @param _host IP address or hostname associated with the service.
+ * @param[inout] _port Pointer to port associated with the service.
+ * @param _concurrent Maximum number of concurrent clients. (max. CONFIG_HTTP_SERVER_MAX_CLIENTS)
+ * @param _backlog Maximum number of queued connections. (min. 1)
+ * @param _detail User-defined detail associated with the service.
+ * @param _res_fallback Fallback resource to be served if no other resource matches path
+ * @param _config Pointer to http_service_config structure
+ * @param _sec_tag_list TLS security tag list used to setup a HTTPS socket.
+ * @param _sec_tag_list_size TLS security tag list size used to setup a HTTPS socket.
+ */
+#define HTTPS_SERVICE_DEFINE_EMPTY_CONFIG(_name, _host, _port, _concurrent, _backlog, _detail,    \
+					  _res_fallback, _config, _sec_tag_list,                  \
+					  _sec_tag_list_size)                                     \
+	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,             \
+				_res_fallback, NULL, NULL, _config,                              \
 				_sec_tag_list, _sec_tag_list_size);				 \
 	BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS),				 \
 		     "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
@@ -195,7 +267,37 @@ struct http_service_desc {
 	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,               \
 				_res_fallback,                                                     \
 				&_CONCAT(_http_resource_desc_##_name, _list_start)[0],             \
-				&_CONCAT(_http_resource_desc_##_name, _list_end)[0]);
+				&_CONCAT(_http_resource_desc_##_name, _list_end)[0], NULL);
+
+/**
+ * @brief Define an HTTP service with static resources and custom configuration.
+ *
+ * @note The @p _host parameter is used to specify an IP address either in
+ * IPv4 or IPv6 format a fully-qualified hostname or a virtual host. If left NULL, the listening
+ * port will listen on all addresses.
+ *
+ * @note The @p _port parameter must be non-`NULL`. It points to a location that specifies the port
+ * number to use for the service. If the specified port number is zero, then an ephemeral port
+ * number will be used and the actual port number assigned will be written back to memory. For
+ * ephemeral port numbers, the memory pointed to by @p _port must be writeable.
+ *
+ * @param _name Name of the service.
+ * @param _host IP address or hostname associated with the service.
+ * @param[inout] _port Pointer to port associated with the service.
+ * @param _concurrent Maximum number of concurrent clients. (max. CONFIG_HTTP_SERVER_MAX_CLIENTS)
+ * @param _backlog Maximum number of queued connections. (min. 1)
+ * @param _detail User-defined detail associated with the service.
+ * @param _res_fallback Fallback resource to be served if no other resource matches path
+ * @param _config Pointer to http_service_config structure
+ */
+#define HTTP_SERVICE_DEFINE_CONFIG(_name, _host, _port, _concurrent, _backlog, _detail,            \
+				   _res_fallback, _config)                                         \
+	extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[];      \
+	extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[];        \
+	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,               \
+				_res_fallback,                                                     \
+				&_CONCAT(_http_resource_desc_##_name, _list_start)[0],             \
+				&_CONCAT(_http_resource_desc_##_name, _list_end)[0], _config);
 
 /**
  * @brief Define an HTTPS service with static resources.
@@ -226,7 +328,43 @@ struct http_service_desc {
 	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,           \
 				_res_fallback,                                                 \
 				&_CONCAT(_http_resource_desc_##_name, _list_start)[0],         \
-				&_CONCAT(_http_resource_desc_##_name, _list_end)[0],           \
+				&_CONCAT(_http_resource_desc_##_name, _list_end)[0], NULL,     \
+				_sec_tag_list, _sec_tag_list_size);                            \
+	BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS),                               \
+		     "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
+
+/**
+ * @brief Define an HTTPS service with static resources and custom configuration.
+ *
+ * @note The @p _host parameter is used to specify an IP address either in
+ * IPv4 or IPv6 format a fully-qualified hostname or a virtual host. If left NULL, the listening
+ * port will listen on all addresses.
+ *
+ * @note The @p _port parameter must be non-`NULL`. It points to a location that specifies the port
+ * number to use for the service. If the specified port number is zero, then an ephemeral port
+ * number will be used and the actual port number assigned will be written back to memory. For
+ * ephemeral port numbers, the memory pointed to by @p _port must be writeable.
+ *
+ * @param _name Name of the service.
+ * @param _host IP address or hostname associated with the service.
+ * @param[inout] _port Pointer to port associated with the service.
+ * @param _concurrent Maximum number of concurrent clients. (max. CONFIG_HTTP_SERVER_MAX_CLIENTS)
+ * @param _backlog Maximum number of queued connections. (min. 1)
+ * @param _detail User-defined detail associated with the service.
+ * @param _res_fallback Fallback resource to be served if no other resource matches path
+ * @param _config Pointer to http_service_config structure
+ * @param _sec_tag_list TLS security tag list used to setup a HTTPS socket.
+ * @param _sec_tag_list_size TLS security tag list size used to setup a HTTPS socket.
+ */
+#define HTTPS_SERVICE_DEFINE_CONFIG(_name, _host, _port, _concurrent, _backlog, _detail,       \
+				    _res_fallback, _config, _sec_tag_list,                     \
+				    _sec_tag_list_size)                                        \
+	extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_start)[];  \
+	extern struct http_resource_desc _CONCAT(_http_resource_desc_##_name, _list_end)[];    \
+	__z_http_service_define(_name, _host, _port, _concurrent, _backlog, _detail,           \
+				_res_fallback,                                                 \
+				&_CONCAT(_http_resource_desc_##_name, _list_start)[0],         \
+				&_CONCAT(_http_resource_desc_##_name, _list_end)[0], _config,  \
 				_sec_tag_list, _sec_tag_list_size);                            \
 	BUILD_ASSERT(IS_ENABLED(CONFIG_NET_SOCKETS_SOCKOPT_TLS),                               \
 		     "TLS is required for HTTP secure (CONFIG_NET_SOCKETS_SOCKOPT_TLS)")
diff --git a/subsys/net/lib/http/http_server_core.c b/subsys/net/lib/http/http_server_core.c
@@ -156,7 +156,11 @@ int http_server_init(struct http_server_ctx *ctx)
 			proto = IPPROTO_TCP;
 		}
 
-		fd = zsock_socket(af, SOCK_STREAM, proto);
+		if (svc->config != NULL && svc->config->socket_creat != NULL) {
+			fd = svc->config->socket_create(svc, af, proto);
+		} else {
+			fd = zsock_socket(af, SOCK_STREAM, proto);
+		}
 		if (fd < 0) {
 			LOG_ERR("socket: %d", errno);
 			failed++;
