net: http: Add HTTP server library support

This commit creates a HTTP server library. So instead of creating
a complex HTTP server application for serving HTTP requests, the
developer can use the HTTP server API to create HTTP server
insteances. This commit also adds support for creating HTTPS servers.

Signed-off-by: Jukka Rissanen <[email protected]>

Author: jukkar

include/net/http.h

@@ -4,10 +4,8 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
-BOARD ?= frdm_k64f
+BOARD ?= qemu_x86
 CONF_FILE ?= prj_$(BOARD).conf
 
 include $(ZEPHYR_BASE)/Makefile.inc
-ifeq  ($(BOARD), qemu_x86)
-	include $(ZEPHYR_BASE)/samples/net/common/Makefile.ipstack
-endif
+include $(ZEPHYR_BASE)/samples/net/common/Makefile.ipstack

samples/net/http_server/Makefile

@@ -7,14 +7,13 @@ Overview
 ********
 
 The HTTP Server sample application for Zephyr implements a basic TCP server
-on top of the HTTP Parser Library that is able to receive HTTP 1.1 requests,
+on top of the HTTP Server Library that is able to receive HTTP 1.1 requests,
 parse them and write back the responses.
 
-This sample  code generates HTTP 1.1 responses dynamically
-and does not serve content from a file system. The source code includes
-examples on how to write HTTP 1.1 responses: 200 OK, 400 Bad Request,
-403 Forbidden, 404 Not Found and soft HTTP errors like 200 OK with a 404
-Not Found HTML message.
+This sample code generates HTTP 1.1 responses dynamically and does not serve
+content from a file system. The source code includes examples on how to write
+HTTP 1.1 responses: 200 OK, 400 Bad Request, 403 Forbidden, 404 Not Found and
+soft HTTP errors like 200 OK with a 404 Not Found HTML message.
 
 The source code for this sample application can be found at:
 :file:`samples/net/http_server`.
@@ -23,39 +22,24 @@ Requirements
 ************
 
 - Linux machine with wget and the screen terminal emulator
-- Freedom Board (FRDM-K64F)
+- Either QEMU or real device like Freedom Board (FRDM-K64F)
 - LAN for testing purposes (Ethernet)
 
 Building and Running
 ********************
 
-Currently, the HTTP Server application is configured to listen at port 80,
-This value is defined in the :file:`samples/net/http_server/src/config.h`
-file:
+Currently, the HTTP Server application is configured to listen at port 80.
+If you want to modify the http-server sample application, please check
+the configuration settings in :file:`samples/net/http_server/src/main.c` file
+and also in the :file:`samples/net/http_server/src/config.h` file.
 
-.. code-block:: c
-
-	#define ZEPHYR_PORT		80
-
-Open the project configuration file for your platform, for example the
-:file:`prj_frdm_k64f.conf` file is the configuration file for the
-:ref:`frdm_k64f` board. For IPv4 networks, set the following variables:
-
-.. code-block:: console
-
-	CONFIG_NET_IPV4=y
-	CONFIG_NET_IPV6=n
-
-IPv6 is the preferred routing technology for this sample application,
-if CONFIG_NET_IPV6=y is set, the value of CONFIG_NET_IPV4=y is ignored.
-
-This sample code only supports static IP addresses that are defined in the
-project configuration file:
+This sample code supports both static and dynamic (DHCPv4) IP addresses that
+can be defined in the project configuration file:
 
 .. code-block:: console
 
 	CONFIG_NET_APP_MY_IPV6_ADDR="2001:db8::1"
-	CONFIG_NET_APP_MY_IPV4_ADDR="192.168.1.101"
+	CONFIG_NET_APP_MY_IPV4_ADDR="192.0.2.1"
 
 Adding URLs
 ===========
@@ -66,9 +50,11 @@ following lines:
 
 .. code-block:: c
 
-	http_url_default_handler(http_write_soft_404_not_found);
-	http_url_add("/headers", HTTP_URL_STANDARD, http_write_header_fields);
-	http_url_add("/index.html", HTTP_URL_STANDARD, http_write_it_works);
+	http_server_add_default(&http_urls, http_response_soft_404);
+	http_server_add_url(&http_urls, "/headers", HTTP_URL_STANDARD,
+			    http_response_header_fields);
+	http_server_add_url(&http_urls, "/index.html", HTTP_URL_STANDARD,
+			    http_response_it_works);
 
 The first line defines how Zephyr will deal with unknown URLs. In this case,
 it will respond with a soft HTTP 404 status code, i.e. an HTTP 200 OK status
@@ -114,19 +100,20 @@ serial console under other operating systems.
 Sample Output
 =============
 
-Assume that this HTTP server is configured to listen at 192.168.1.101 port 80.
+Assume in this example that this HTTP server is configured to listen at
+IPv4 address 192.168.1.120 and IPv6 address 2001:db8::1 port 80.
 On your Linux host computer, open a terminal window and type:
 
 .. code-block:: console
 
-	wget 192.168.1.101/index.html
+	wget 192.168.1.120/index.html
 
 wget will show:
 
 .. code-block:: console
 
-	--2017-01-17 00:37:44--  http://192.168.1.101/
-	Connecting to 192.168.1.101:80... connected.
+	--2017-01-17 00:37:44--  http://192.168.1.120/
+	Connecting to 192.168.1.120:80... connected.
 	HTTP request sent, awaiting response... 200 OK
 	Length: unspecified [text/html]
 	Saving to: 'index.html'
@@ -146,32 +133,38 @@ The screen application will display the following information:
 
 .. code-block:: console
 
-	[dev/eth_mcux] [INF] eth_0_init: Enabled 100M full-duplex mode.
-	[dev/eth_mcux] [DBG] eth_0_init: MAC 00:04:9f:c9:29:6e
-	Zephyr HTTP Server
-	Address: 192.168.1.101, port: 80
-
-	----------------------------------------------------
-	[print_client_banner:42] Connection accepted
-	Address: 192.168.1.10, port: 54327
-	[http_ctx_get:268] Free ctx found, index: 0
-	[http_write:59] net_pkt_get_tx, rc: 0 <OK>
-	[http_write:82] net_context_send: 0 <OK>
-	[http_rx_tx:86] Connection closed by peer
+	[dev/eth_mcux] [DBG] eth_0_init: MAC 00:04:9f:52:44:02
+	[sample/net] [INF] net_sample_app_init: Run HTTPS server
+	[sample/net] [INF] setup_dhcpv4: Running
+	[dev/eth_mcux] [DBG] eth_0_init: MAC 00:04:9f:f1:80:9e
+	[sample/net] [INF] net_sample_app_init: Run HTTPS server
+	[sample/net] [INF] setup_dhcpv4: Running dhcpv4 client...
+	[sample/net] [INF] ipv6_event_handler: IPv6 address: 2001:db8::1
+	[dev/eth_mcux] [INF] eth_mcux_phy_event: Enabled 10M half-duplex mode.
+	[sample/net] [INF] ipv4_addr_add_handler: IPv4 address: 192.168.1.120
+	[sample/net] [INF] ipv4_addr_add_handler: Lease time: 86400 seconds
+	[sample/net] [INF] ipv4_addr_add_handler: Subnet: 255.255.255.0
+	[sample/net] [INF] ipv4_addr_add_handler: Router: 192.168.1.1
+	[https/server] [INF] new_server: Zephyr HTTPS Server (0x20002370)
+	[https/server] [DBG] https_handler: (0x2000b5b4): HTTPS handler starting
+	[https/server] [INF] new_server: Zephyr HTTP Server (0x20001840)
+	[https/server] [INF] new_client: HTTP connection from 192.168.1.107:44410 (0x20006af4)
+	[https/server] [DBG] http_recv: (0x2000d6b4): Received 336 bytes data
+	[https/server] [DBG] http_process_recv: (0x2000d6b4): Calling handler 0x00000d89 context 0x20001840
 
 
 To obtain the HTTP Header Fields web page, use the following command:
 
 .. code-block:: console
 
-	wget 192.168.1.101/headers -O index.html
+	wget 192.168.1.120/headers -O index.html
 
 wget will show:
 
 .. code-block:: console
 
-	--2017-01-19 22:09:55--  http://192.168.1.101/headers
-	Connecting to 192.168.1.101:80... connected.
+	--2017-01-19 22:09:55--  http://192.168.1.120/headers
+	Connecting to 192.168.1.120:80... connected.
 	HTTP request sent, awaiting response... 200 OK
 	Length: unspecified [text/html]
 	Saving to: 'index.html'
@@ -190,7 +183,7 @@ This is the HTML file generated by Zephyr and downloaded by wget:
 	<ul>
 	<li>User-Agent: Wget/1.16 (linux-gnu)</li>
 	<li>Accept: */*</li>
-	<li>Host: 192.168.1.101</li>
+	<li>Host: 192.168.1.120</li>
 	<li>Connection: Keep-Alive</li>
 	</ul>
 	<h2>HTTP Method: GET</h2>
@@ -203,7 +196,7 @@ To test the 404 Not Found soft error, use the following command:
 
 .. code-block:: console
 
-	wget 192.168.1.101/not_found -O index.html
+	wget 192.168.1.120/not_found -O index.html
 
 Zephyr will generate an HTTP response with the following header:
 
@@ -224,32 +217,11 @@ and this is the HTML message that wget will save:
 	<body><h1><center>404 Not Found</center></h1></body>
 	</html>
 
-To test the HTTP Basic Authentication functionality, use the
-following command:
-
-.. code-block:: console
-
-	wget 192.168.1.101/auth -O index.html --user=zephyr --password=0123456789
-
-the :file:`index.html` file will contain the following information:
-
-.. code-block:: html
-
-	<html>
-	<head>
-	<title>Zephyr HTTP Server</title>
-	</head>
-	<body>
-	<h1><center>Zephyr HTTP server</center></h1>
-	<h2><center>user: zephyr, password: 0123456789</center></h2>
-	</body>
-	</html>
-
 HTTPS Server
 ============
 
 The sample code also includes a HTTPS (HTTP over TLS) server example
-running side by side with the HTTP server, this server runs on qemu.
+running side by side with the HTTP server, this server runs on QEMU.
 In order to compile and run the code execute:
 
 .. code-block:: console
@@ -266,25 +238,23 @@ The app will show the following on the screen:
 
 .. code-block:: console
 
-	Zephyr HTTP Server
-	Address: 192.0.2.1, port: 80
-	Zephyr HTTPS Server
-	Address: 192.0.2.1, port: 443
-	failed
-	! mbedtls_ssl_handshake returned -29312
+	[https/server] [INF] new_client: HTTPS connection from 192.168.1.107:35982 (0x20006b4c)
+	[https/server] [DBG] https_handler: (0x2000b5b4): Read HTTPS request
+	[https/server] [DBG] https_handler: (0x2000b5b4): Write HTTPS response
+	[https/server] [DBG] http_process_recv: (0x2000b5b4): Calling handler 0x00000ce9 context 0x20002370
 
 Now execute the following command on a different terminal window
 
 .. code-block:: console
 
-	wget https://192.0.2.1 --no-check-certificate
+	wget https://192.168.1.120 --no-check-certificate
 
 This will be shown on the screen
 
 .. code-block:: console
 
-	Connecting to 192.0.2.1:443... connected.
-	WARNING: cannot verify 192.0.2.1's certificate
+	Connecting to 192.168.1.120:443... connected.
+	WARNING: cannot verify 192.168.1.120's certificate
 	Unable to locally verify the issuer's authority.
 	HTTP request sent, awaiting response... 200 OK
 	Length: unspecified [text/html]
@@ -304,7 +274,4 @@ Known Issues and Limitations
 
 - Currently, this sample application only generates HTTP responses in
   chunk transfer mode.
-- Clients must close the connection to allow the HTTP server to release
-  the network context and accept another connection.
-- The use of mbedTLS and IPv6 takes more than the available ram for the
-  emulation platform, so only IPv4 works for now in QEMU.
+- Basic authentication is not yet implemented.

samples/net/http_server/README.rst

@@ -11,26 +11,38 @@ CONFIG_NET_PKT_TX_COUNT=16
 CONFIG_NET_BUF_RX_COUNT=16
 CONFIG_NET_BUF_TX_COUNT=16
 
-CONFIG_NET_IPV6_RA_RDNSS=y
-CONFIG_NET_IFACE_UNICAST_IPV4_ADDR_COUNT=3
+CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT=2
+CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT=4
+
+CONFIG_NET_MAX_CONTEXTS=16
 
 CONFIG_TEST_RANDOM_GENERATOR=y
 
 CONFIG_STDOUT_CONSOLE=y
 
+CONFIG_SYS_LOG_SHOW_COLOR=y
+CONFIG_SYS_LOG_NET_LEVEL=4
+CONFIG_NET_DEBUG_HTTP=y
+
 CONFIG_HTTP_SERVER=y
-CONFIG_HTTP_PARSER=y
 
-# Enable IPv6 support
 CONFIG_NET_IPV6=y
-# Enable IPv4 support
-CONFIG_NET_IPV4=n
+CONFIG_NET_IPV4=y
+#CONFIG_NET_DHCPV4=y
+
+CONFIG_HTTPS=y
+CONFIG_MBEDTLS=y
+CONFIG_MBEDTLS_BUILTIN=y
+CONFIG_MBEDTLS_CFG_FILE="config-mini-tls1_2.h"
 
 CONFIG_NET_APP_SETTINGS=y
 CONFIG_NET_APP_MY_IPV6_ADDR="2001:db8::1"
-CONFIG_NET_APP_MY_IPV4_ADDR="192.168.1.101"
+CONFIG_NET_APP_MY_IPV4_ADDR="192.0.2.1"
 
-CONFIG_NET_MAX_CONTEXTS=16
+CONFIG_NET_SHELL=y
+
+CONFIG_NET_MGMT=y
+CONFIG_NET_MGMT_EVENT=y
 
 # ENC28J60 Ethernet Device
 CONFIG_ETH_ENC28J60=y
@@ -42,4 +54,3 @@ CONFIG_ETH_ENC28J60_0_MAC5=0x36
 
 # Arduino 101
 CONFIG_SPI=y
-

samples/net/http_server/prj_arduino_101.conf

@@ -1,7 +1,6 @@
 CONFIG_NETWORKING=y
 CONFIG_NET_TCP=y
 CONFIG_RANDOM_GENERATOR=y
-CONFIG_NET_ARP=y
 CONFIG_NET_LOG=y
 CONFIG_INIT_STACKS=y
 
@@ -10,24 +9,32 @@ CONFIG_NET_PKT_TX_COUNT=16
 CONFIG_NET_BUF_RX_COUNT=16
 CONFIG_NET_BUF_TX_COUNT=16
 
-CONFIG_NET_IPV6_RA_RDNSS=y
-CONFIG_NET_IFACE_UNICAST_IPV4_ADDR_COUNT=3
+CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT=3
+CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT=4
 
 CONFIG_STDOUT_CONSOLE=y
 
+CONFIG_SYS_LOG_SHOW_COLOR=y
+CONFIG_SYS_LOG_NET_LEVEL=4
+CONFIG_NET_DEBUG_HTTP=y
+
 CONFIG_HTTP_SERVER=y
-CONFIG_HTTP_PARSER=y
 
-# Enable IPv6 support
 CONFIG_NET_IPV6=y
-# Enable IPv4 support
 CONFIG_NET_IPV4=n
 
+CONFIG_HTTPS=y
+CONFIG_MBEDTLS=y
+CONFIG_MBEDTLS_BUILTIN=y
+CONFIG_MBEDTLS_CFG_FILE="config-mini-tls1_2.h"
+
 CONFIG_NET_APP_SETTINGS=y
 CONFIG_NET_APP_MY_IPV6_ADDR="2001:db8::1"
-CONFIG_NET_APP_MY_IPV4_ADDR="192.168.1.101"
 
-CONFIG_NET_MAX_CONTEXTS=16
+CONFIG_NET_SHELL=y
+
+CONFIG_NET_MGMT=y
+CONFIG_NET_MGMT_EVENT=y
 
 CONFIG_BLUETOOTH=y
 CONFIG_BLUETOOTH_DEBUG_LOG=y
@@ -40,7 +47,7 @@ CONFIG_TEST_RANDOM_GENERATOR=y
 CONFIG_NET_L2_BLUETOOTH=y
 CONFIG_NET_L2_BLUETOOTH_ZEP1656=y
 CONFIG_NET_DEBUG_L2_BLUETOOTH=y
-CONFIG_SYS_LOG_SHOW_COLOR=y
 CONFIG_NET_STATISTICS=y
-CONFIG_NET_IF_UNICAST_IPV6_ADDR_COUNT=3
-CONFIG_NET_IF_MCAST_IPV6_ADDR_COUNT=2
+
+# This sample is meant to be compilable in QEMU only
+CONFIG_RAM_SIZE=300