wireguard-freebsd/README.md

# WireGuard for FreeBSD

This is a kernel module for FreeBSD to support [WireGuard](https://www.wireguard.com/). It is being developed here before its eventual submission to FreeBSD.

### Installation instructions

Snapshots of this may be installed from packages:

```
# pkg install wireguard
```

### Building instructions

If you'd prefer to build this repo from scratch, rather than using a package, first make sure you have the latest net/wireguard-tools package installed, version ≥1.0.20210424. Then, on FreeBSD 12.3, 13.0, 13.1, and 13.2:

```
# git clone https://git.zx2c4.com/wireguard-freebsd
# make -C wireguard-freebsd/src
# make -C wireguard-freebsd/src load install
```

After that, it should be possible to use `wg(8)` and `wg-quick(8)` like usual, but with the faster kernel implementation.
Initial import There's still more to do with wiring this up properly. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:34:21 +01:00			`# WireGuard for FreeBSD`

build: include compat.h for all files 54b2075 ("build: only include compat.h for if_wg.c and fix build with an obj directory") scoped compat.h to if_wg.c, which broke building on 12.3. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2022-06-10 22:28:48 +02:00			`This is a kernel module for FreeBSD to support [WireGuard](https://www.wireguard.com/). It is being developed here before its eventual submission to FreeBSD.`
Initial import There's still more to do with wiring this up properly. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:34:21 +01:00
			`### Installation instructions`

ci: test on 12.1 and 12.2 Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-06-01 11:56:54 +02:00			`Snapshots of this may be installed from packages:`
support: prepare for out of tree builds This involves weird backporting things. Hopefully support.c here is not as bad as compat.h on Linux. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:46:08 +01:00
ci: test on 12.1 and 12.2 Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-06-01 11:56:54 +02:00			```
			`# pkg install wireguard`
			```

			`### Building instructions`

build: include compat.h for all files 54b2075 ("build: only include compat.h for if_wg.c and fix build with an obj directory") scoped compat.h to if_wg.c, which broke building on 12.3. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2022-06-10 22:28:48 +02:00			`If you'd prefer to build this repo from scratch, rather than using a package, first make sure you have the latest net/wireguard-tools package installed, version ≥1.0.20210424. Then, on FreeBSD 12.3, 13.0, 13.1, and 13.2:`
support: prepare for out of tree builds This involves weird backporting things. Hopefully support.c here is not as bad as compat.h on Linux. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:46:08 +01:00
Initial import There's still more to do with wiring this up properly. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:34:21 +01:00			```
support: prepare for out of tree builds This involves weird backporting things. Hopefully support.c here is not as bad as compat.h on Linux. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:46:08 +01:00			`# git clone https://git.zx2c4.com/wireguard-freebsd`
README: separate build stage Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-23 19:23:11 +01:00			`# make -C wireguard-freebsd/src`
compat: backport to FreeBSD 12.2 This should allow us to get more testing coverage earlier. This port here is also a bit janky. I really don't like the taskqgroup business, having to copy and paste those structs. And this isn't well tested, either. But, it's a start. This distinguishes between compat.h and support.h, though both header files are intended to operate in more or less the same way. It's important to keep some discipline between things that we're backporting and things that aren't _yet_ upstream or are shims for OpenBSD. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-18 00:43:55 +01:00			`# make -C wireguard-freebsd/src load install`
Initial import There's still more to do with wiring this up properly. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:34:21 +01:00			```
support: prepare for out of tree builds This involves weird backporting things. Hopefully support.c here is not as bad as compat.h on Linux. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2021-03-17 16:46:08 +01:00
			After that, it should be possible to use `wg(8)` and `wg-quick(8)` like usual, but with the faster kernel implementation.