Development discussion of WireGuard
 help / color / mirror / Atom feed
* Single-file C Embeddable Library for WireGuard Device Configuration
@ 2018-02-15 14:42 Jason A. Donenfeld
  0 siblings, 0 replies; only message in thread
From: Jason A. Donenfeld @ 2018-02-15 14:42 UTC (permalink / raw)
  To: WireGuard mailing list, Toke Høiland-Jørgensen

Hi Toke & List,

There's been some interest in integrating WireGuard configuration into
various utilities, such as bird, babel, networkmanager, and more.
Indeed shelling out to wg(8) is sub-par for core networking utilities,
such as routing daemons. Unfortunately, Netlink is horrible in so many
ways, and -- with the single exception of Joerg Thalheim's heroic
hustle with systemd-networkd -- people tend to get discouraged pretty
quickly when trying to do the WireGuard Netlink dance and importing
Netlink library dependencies, and so forth. I'm still displeased about
having to move away from a simpler API at the behest of upstream, but
such is life.

In order to make things more pleasant, I've made a single-file C
library, which is meant to be copy and pasted directly into your
application, and then tweaked as needed. It currently exports a few
simple methods for managing the device:

int wg_set_device(wg_device_t *dev);
int wg_get_device(wg_device_t **dev, const char *device_name);
void wg_free_device(wg_device_t *dev);
char *wg_list_device_names(void); /* first\0second\0third\0forth\0last\0\0 */

And some helper methods for dealing with keys with constant-time algorithms:

void wg_key_to_base64(wg_base64_string_key_t base64, const wg_key_t key);
bool wg_key_from_base64(wg_key_t key, const wg_base64_string_key_t base64);
bool wg_key_is_zero(const wg_key_t key);

And some handy macro iterators:

#define wg_for_each_device_name(__names, __name, __len)
#define wg_for_each_peer(__dev, __peer)
#define wg_for_each_allowedip(__peer, __allowedip)

The README has more info here:

https://git.zx2c4.com/WireGuard/tree/contrib/examples/embeddable-wg-library/README

It only depends on libc, and compiles with pretty much any C compiler.

I expect that some people might not need all the functionality, in
which case, simply deleting what you don't need is an easy
possibility. Others will need to change calling conventions or types
or file descriptor management or memory allocators, and that's fine
too. The point is that it's just a little chunk of nice code, from
which you can craft your WireGuard integration.

Enjoy!

Jason

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2018-02-15 14:35 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-02-15 14:42 Single-file C Embeddable Library for WireGuard Device Configuration Jason A. Donenfeld

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).