Skip to content

About

WireGuard implementation for ESP32 Arduino

Resources

Stars

3 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

44 Commits

Folders and files

Repository files navigation

Fork Notes

This is a patched fork of ciniml/WireGuard-ESP32-Arduino with the following fixes:

  • IDF >= 4.1 compatibility: replaced deprecated tcpip_adapter with esp_netif using compile-time version detection (WIREGUARD_USE_ESP_NETIF)
  • Missing declaration: added handshake_destroy() forward declaration to wireguard.h
  • Compiler warning fix: corrected a24 type in x25519.c to silence -Wstringop-overread on GCC 12+
  • Split tunnel: setDefaultRoute(false) keeps the tunnel off the default route; setAllowedIPs() / clearAllowedIPs() set the peer's allowed IPs
  • Local UDP port: the device no longer sends from the endpoint's port; setLocalPort() picks one, default 0 (random). Fixes handshakes looping back through hairpin NAT when local and remote ports are equal

WireGuard Implementation for ESP32 Arduino

This is an implementation of the WireGuard® for ESP32 Arduino.

Almost all of this code is based on the WireGuard Implementation for lwIP, but some potion of the code is adjusted to build with ESP32 Arduino.

How to use

  1. Include WireGuard-ESP32.h at the early part of the sketch.
#include <WireGuard-ESP32.h>
  1. Define the instance of the WireGuard class at module level.
static WireGuard wg;
  1. Connect to WiFi AP by using WiFi class.
WiFi.begin(ssid, password);
while( !WiFi.isConnected() ) {
    delay(1000);
}
  1. Sync the system time via NTP.
configTime(9 * 60 * 60, 0, "ntp.jst.mfeed.ad.jp", "ntp.nict.jp", "time.google.com");
  1. Start the WireGuard interface.
wg.begin(
    local_ip,           // IP address of the local interface
    private_key,        // Private key of the local interface
    endpoint_address,   // Address of the endpoint peer.
    public_key,         // Public key of the endpoint peer.
    endpoint_port);     // Port pf the endpoint peer.

You can see an example sketch uptime_post.ino, which connects SORACOM Arc WireGuard endpoint and post uptime to SORACOM Harvest via WireGuard connection.

License

The original WireGuard implementation for lwIP is licensed under BSD 3 clause license so the code in this repository also licensed under the same license.

Original license is below:

The code is copyrighted under BSD 3 clause Copyright (c) 2021 Daniel Hope (www.floorsense.nz)

See LICENSE for details

About

WireGuard implementation for ESP32 Arduino

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages