esp_wireguard, WireGuard Implementation for ESP-IDF
This is an implementation of the WireGuard® for ESP-IDF, based on WireGuard Implementation for lwIP.
Status
The code is alpha.
A single tunnel to a WireGuard peer has been working.
Supported ESP-IDF versions and targets
The following ESP-IDF versions are supported:
esp-idfmasteresp-idfv4.2.xesp-idfv4.3.x- ESP8266 RTOS SDK
v3.4
The following targets are supported:
esp32esp32s2esp32c3esp8266
Usage
In menuconfig under WireGuard, choose a TCP/IP adapter. The default is ESP-NETIF. SDKs older than esp-idf v4.1, including ESP8266 RTOS SDK v3.4 requires TCP/IP Adapter.
Both peers must have synced time. The library does not sync time.
A working network interface is required.
Create WireGuard configuration, wireguard_config_t. Use ESP_WIREGUARD_CONFIG_DEFAULT to initialize wireguard_config_t variable. Create wireguard_ctx_t. Pass the variables to esp_wireguard_init(). Then, call esp_wireguard_connect(). Call esp_wireguard_disconnect() to disconnect from the peer (and destroy the WireGuard interface).
#include <esp_wireguard.h>
esp_err_t err = ESP_FAIL;
wireguard_config_t wg_config = ESP_WIREGUARD_CONFIG_DEFAULT();
wg_config.private_key = CONFIG_WG_PRIVATE_KEY;
wg_config.listen_port = CONFIG_WG_LOCAL_PORT;
wg_config.public_key = CONFIG_WG_PEER_PUBLIC_KEY;
wg_config.allowed_ip = CONFIG_WG_LOCAL_IP_ADDRESS;
wg_config.allowed_ip_mask = CONFIG_WG_LOCAL_IP_NETMASK;
wg_config.endpoint = CONFIG_WG_PEER_ADDRESS;
wg_config.port = CONFIG_WG_PEER_PORT;
/* If the device is behind NAT or stateful firewall, set persistent_keepalive.
persistent_keepalive is disabled by default */
// wg_config.persistent_keepalive = 10;
wireguard_ctx_t ctx = {0};
err = esp_wireguard_init(&wg_config, &ctx);
err = esp_wireguard_connect(ctx);
/* do something */
err = esp_wireguard_disconnect(&ctx);
See examples at examples.
IPv6 support
Enable CONFIG_LWIP_IPV6 under lwip component in menuconfig.
IPv6 support is alpha and probably broken. See also Known issues.
Known issues
The implementation uses LwIP as TCP/IP protocol stack.
IPv6 support is not tested. Dual stack (IPv4 and IPv6) is not supported (see Issue #5). The first address of endpoint is used to choose IPv4 or IPv6 as a transport. The chosen transport must be available and usable.
The library assumes the interface is WiFi interface. Ethernet is not supported.
Older esp-idf versions with TCP/IP Adapter, such as v4.1.x, should work, but there are others issues, not directly related to the library.
License
BSD 3-Clause "New" or "Revised" License (SPDX ID: BSD-3-Clause). See LICENSE for details.
Authors
- Daniel Hope ([email protected])
- Kenta Ida ([email protected])
3 Dec 13, 2021
151 Jan 3, 2023
67 Dec 4, 2022
17 Nov 15, 2022
212 Dec 30, 2022
17 Nov 2, 2022
13 Aug 5, 2022
358 Jan 8, 2023
13 Apr 4, 2022
20 Jan 4, 2023
3 Mar 28, 2022
11 Oct 24, 2022
42 Mar 19, 2022