YAAWG: Yet another AmneziaWG variation for OpenWrt

This project is aimed to update sources of the initial AmneziaWG and make them as close to three upstream projects (luci-proto-wireguard, amneziawg-tools, amneziawg-linux-kernel-module) as possible.

Why? Because it looks like the original repository is abandoned: more than half a year has passed since the last commit and no bugs were fixed while two upstream projects receive updates on a regular basis (at least from the community).

The main differences and objectives:

1. luci-proto-amneziawg has been aligned in accordance with luci-proto-wireguard:
   • AmneziaWG settings tab now have placeholders (default values, if chosen, will mimic classic Wireguard protocol).
   • Fixed bug with QR code generation. Please note that the generated QR code will contain AmneziaWG specific information (remove it manually to make it compatible with classic Wireguard).
   • Added checkboxes to enable/disable peers.
   • Took luci-proto-wireguard as the codebase.
2. amneziawg-tools has been aligned in accordance with the upstream repo amneziawg-tools:
   • The package is now compiled based on the upstream repo. Master branch has been chosen as a reference.
   • Fixed bug with non-existent proto_amneziawg_check_installed method.
   • Changed temp folders and files to match the protocol name.
   • Refactored scripts a bit to make them look more amneziish.
3. kmod-amneziawg is now compiled totally based on the upstream amneziawg-linux-kernel-module repo. Master branch has been chosen as a reference.

Results

Everything seems to work fine. No major problems have been detected or reported so far.

How to build and use

Kudos to another fork and its Author (@defanator) for the build pipelines: https://github.com/defanator/amneziawg-openwrt Please refer to the original manual as well.

Side note: the build process is not hard at all, but requires some attention and basic knowledge.

General steps:

1. Get parameters for your router:
   • OpenWRT version: SNAPSHOT or release (e.x. 23.05.5). Can be found on the Status -> Overview page (Firmware Version parameter value).
   • Package manager you are using: apk (the newer one) or opkg (the legacy one). If you are running a stable version of OpenWRT then it's more likely you use opkg. apk is used only in the main/master branch so far. To make sure run the following commands: apk -h and opkg -h. The one that's won't fail (command not found message is shown) shows the package manager that you use.
   • CPU/package architecture: run apk info kernel or opkg info kernel (depending on your package manager) in console and check the Architecture value (e.x. aarch64_cortex-a53) or consult OpenWRT router database.
   • Target: can be found on the Status -> Overview page. The first part (before the slash) of the Target Platform value.
   • Subtarget: can be found on the Status -> Overview page. You guessed it! The second part (after the slash) of the Target Platform value.
   • Vermagic: run apk info kernel or opkg info kernel (depending on your package manager) in console check hash after the kernel version of the Version value. E.x. if the value equals to 6.6.52~f58afd3748410d3b1baa06a466d6682-r1 then vermagic equals to f58afd3748410d3b1baa06a466d6682. You can also choose:
     • auto: the script will get vermagic value from the OpenWrt site.
     • any: the script will not check the variable.
2. Make a fork of this repo.
3. Optional: update/change commit hashes (PKG_SOURCE_VERSION variable) of the upstream repos in amneziawg-tools/Makefile and kmod-amneziawg/Makefile file. Remember that amneziawg-tools features should match amneziawg-linux-kernel-module features, i.e. choose two corresponding commits in both repos.
4. Go to Actions (enable them is needed).
5. Choose Build OpenWrt toolchain cache, put your router parameters (from step 1) in the Run workflow menu and run the job.
6. It will take ~2-2.5 hours to build the cache. So get some cookies, tea, your favorite book and wait.
7. After the cache has been created, choose Build AmneziaWG from cache job, put the same parameters in the Run workflow menu and run it.
8. It will take ~10-15 minutes to build the binaries. After the process is finished you can download them in the job's artifacts section (bottom of the page).
9. Unpack the archive, and install:

• Via WebInterface (LuCi):
  • Go to System -> Software menu.
  • Press Upload Package...
  • Select kmod-amneziawg .ipk file.
  • Confirm installation.
  • Repeat those steps for amneziawg-tools .ipk file and then luci-proto-amneziawg .ipk file.
• Via console:
  • Transfer files into the router.
  • Run apk install {path to the kmod-amneziawg .ipk} or opkg install {path to the kmod-amneziawg .ipk} depending on your package manager.
  • Run apk install {path to the amneziawg-tools .ipk} or opkg install {path to the amneziawg-tools .ipk} depending on your package manager.
  • Run apk install {path to the luci-proto-amneziawg .ipk} or opkg install {path to the luci-proto-amneziawg .ipk} depending on your package manager.

11. Reboot router or run /etc/init.d/network restart command in the console.
12. Congratulations - you now have AmneziaWG installed on your router. Go to Network -> Interfaces page, press Add new interface.. and select AmneziaWG as protocol.

*Sometimes is is required to clean the browser's cache to see the new protocol available in the OpenWRT.