xref: /netbsd-src/usr.sbin/wg-userspace/wg-userspace.8 (revision 25154f5f0c9e0097a4759778b662a840acd95f6f)
1*25154f5fSriastradh.\"	$NetBSD: wg-userspace.8,v 1.3 2020/08/26 16:03:42 riastradh Exp $
261fd7d67Sriastradh.\"
361fd7d67Sriastradh.\" Copyright (C) Ryota Ozaki <ozaki.ryota@gmail.com>
461fd7d67Sriastradh.\" All rights reserved.
561fd7d67Sriastradh.\"
661fd7d67Sriastradh.\" Redistribution and use in source and binary forms, with or without
761fd7d67Sriastradh.\" modification, are permitted provided that the following conditions
861fd7d67Sriastradh.\" are met:
961fd7d67Sriastradh.\" 1. Redistributions of source code must retain the above copyright
1061fd7d67Sriastradh.\"    notice, this list of conditions and the following disclaimer.
1161fd7d67Sriastradh.\" 2. Redistributions in binary form must reproduce the above copyright
1261fd7d67Sriastradh.\"    notice, this list of conditions and the following disclaimer in the
1361fd7d67Sriastradh.\"    documentation and/or other materials provided with the distribution.
1461fd7d67Sriastradh.\" 3. Neither the name of the University nor the names of its contributors
1561fd7d67Sriastradh.\"    may be used to endorse or promote products derived from this software
1661fd7d67Sriastradh.\"    without specific prior written permission.
1761fd7d67Sriastradh.\"
1861fd7d67Sriastradh.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1961fd7d67Sriastradh.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2061fd7d67Sriastradh.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2161fd7d67Sriastradh.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2261fd7d67Sriastradh.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2361fd7d67Sriastradh.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2461fd7d67Sriastradh.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2561fd7d67Sriastradh.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2661fd7d67Sriastradh.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2761fd7d67Sriastradh.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2861fd7d67Sriastradh.\" SUCH DAMAGE.
2961fd7d67Sriastradh.\"
303699389bSriastradh.Dd August 20, 2020
3161fd7d67Sriastradh.Dt WG-USERSPACE 8
3261fd7d67Sriastradh.Os
333699389bSriastradh.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
3461fd7d67Sriastradh.Sh NAME
3561fd7d67Sriastradh.Nm wg-userspace
36*25154f5fSriastradh.Nd manipulate wg userspace instances (EXPERIMENTAL)
373699389bSriastradh.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
3861fd7d67Sriastradh.Sh SYNOPSIS
3961fd7d67Sriastradh.Ar id
403699389bSriastradh.Ar command
4161fd7d67Sriastradh.Op Ar arguments
423699389bSriastradh.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
4361fd7d67Sriastradh.Sh DESCRIPTION
4461fd7d67Sriastradh.Nm
45*25154f5fSriastradhis used to create, destroy and configure
46*25154f5fSriastradh.Xr wg 4
47*25154f5fSriastradhuserspace instances.
48*25154f5fSriastradh.Pp
49*25154f5fSriastradh.Sy WARNING:
50*25154f5fSriastradh.Nm
51*25154f5fSriastradhis experimental.
523699389bSriastradh.Pp
533699389bSriastradhThe following commands are supported:
543699389bSriastradh.Bl -tag -width "destroy"
553699389bSriastradh.It Cm create
56*25154f5fSriastradhCreate an interface.
573699389bSriastradhThe interface will appear as
583699389bSriastradh.Li tun Ns Ar id
593699389bSriastradhto the rest of the system, and will be served by a rump server in whose
603699389bSriastradhcontext the interface appears as
613699389bSriastradh.Li wg Ns Ar id .
623699389bSriastradh.It Cm destroy
63*25154f5fSriastradhDestroy an interface and stop the rump server behind it.
643699389bSriastradh.It Cm ifconfig Ar wgN Ar args...
653699389bSriastradhRun
663699389bSriastradh.Xr ifconfig 8
67*25154f5fSriastradhin the context of the interface's rump server.
683699389bSriastradhFor example,
693699389bSriastradh.Bd -literal -compact
703699389bSriastradh	# wg-userspace 0 ifconfig wg0 10.0.1.0/24
713699389bSriastradh.Ed
72*25154f5fSriastradhwill set the interface's IP address.
733699389bSriastradh.It Cm wgconfig Ar wgN Ar args...
743699389bSriastradhRun
753699389bSriastradh.Xr wgconfig 8
76*25154f5fSriastradhin the context of the interface's rump server.
773699389bSriastradhFor example,
783699389bSriastradh.Bd -literal -compact
793699389bSriastradh	# wg-userspace 0 wgconfig wg0 set listen-port 1234
803699389bSriastradh.Ed
81*25154f5fSriastradhwill set the interface's listening port.
823699389bSriastradh.It Cm debug Ar command Op Ar args...
83*25154f5fSriastradhRun an arbitrary command in the context of the interface's
843699389bSriastradhrump server, using
853699389bSriastradh.Xr rumphijack 3 .
863699389bSriastradh.El
873699389bSriastradh.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
8861fd7d67Sriastradh.Sh SEE ALSO
8961fd7d67Sriastradh.Xr wg 4 ,
9061fd7d67Sriastradh.Xr wg-keygen 8 ,
9161fd7d67Sriastradh.Xr wgconfig 8
923699389bSriastradh.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
9361fd7d67Sriastradh.Sh HISTORY
9461fd7d67SriastradhThe
9561fd7d67Sriastradh.Nm
9661fd7d67Sriastradhcommand first appeared in
973699389bSriastradh.Nx 10.0 .
983699389bSriastradh.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
9961fd7d67Sriastradh.Sh AUTHORS
10061fd7d67SriastradhThe
10161fd7d67Sriastradh.Nm
10261fd7d67Sriastradhcommand is written by
10361fd7d67Sriastradh.An Ryota Ozaki
10461fd7d67Sriastradh.Aq ozaki.ryota@gmail.com .
105