summaryrefslogtreecommitdiffhomepage
path: root/wireguard-go-rs/libwg/README.md
blob: e5b96928f7cfa75052d54e2ae1889cf1f3596722 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Introduction

`libwg` is a tiny wrapper around `wireguard-go`, with the main purpose of providing a simple FFI-friendly interface.

It currently offers support for the following platforms:

- Linux
- macOS
- Android
- Windows

# Organization

`libwg.go` has shared code that is used on all platforms.

`libwg_default.go` has default implementations for Linux-based systems.

`libwg_android.go` has code specifically for Android.

`libwg_windows.go` has code specifically for Windows.

# Usage

Call `wgTurnOn` to create and activate a tunnel. The prototype is different on different platforms, see the code for details.

Call `wgTurnOff` to destroy the tunnel.