1.\" $NetBSD: wg-userspace.8,v 1.3 2020/08/26 16:03:42 riastradh Exp $ 2.\" 3.\" Copyright (C) Ryota Ozaki <ozaki.ryota@gmail.com> 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd August 20, 2020 31.Dt WG-USERSPACE 8 32.Os 33.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 34.Sh NAME 35.Nm wg-userspace 36.Nd manipulate wg userspace instances (EXPERIMENTAL) 37.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 38.Sh SYNOPSIS 39.Ar id 40.Ar command 41.Op Ar arguments 42.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 43.Sh DESCRIPTION 44.Nm 45is used to create, destroy and configure 46.Xr wg 4 47userspace instances. 48.Pp 49.Sy WARNING: 50.Nm 51is experimental. 52.Pp 53The following commands are supported: 54.Bl -tag -width "destroy" 55.It Cm create 56Create an interface. 57The interface will appear as 58.Li tun Ns Ar id 59to the rest of the system, and will be served by a rump server in whose 60context the interface appears as 61.Li wg Ns Ar id . 62.It Cm destroy 63Destroy an interface and stop the rump server behind it. 64.It Cm ifconfig Ar wgN Ar args... 65Run 66.Xr ifconfig 8 67in the context of the interface's rump server. 68For example, 69.Bd -literal -compact 70 # wg-userspace 0 ifconfig wg0 10.0.1.0/24 71.Ed 72will set the interface's IP address. 73.It Cm wgconfig Ar wgN Ar args... 74Run 75.Xr wgconfig 8 76in the context of the interface's rump server. 77For example, 78.Bd -literal -compact 79 # wg-userspace 0 wgconfig wg0 set listen-port 1234 80.Ed 81will set the interface's listening port. 82.It Cm debug Ar command Op Ar args... 83Run an arbitrary command in the context of the interface's 84rump server, using 85.Xr rumphijack 3 . 86.El 87.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 88.Sh SEE ALSO 89.Xr wg 4 , 90.Xr wg-keygen 8 , 91.Xr wgconfig 8 92.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 93.Sh HISTORY 94The 95.Nm 96command first appeared in 97.Nx 10.0 . 98.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 99.Sh AUTHORS 100The 101.Nm 102command is written by 103.An Ryota Ozaki 104.Aq ozaki.ryota@gmail.com . 105