usr.sbin/vknetd/vknetd.8

   1 .\"
   2 .\" Copyright (c) 2008 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to The DragonFly Project
   5 .\" by Matthew Dillon <dillon@backplane.com>
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in
  15 .\"    the documentation and/or other materials provided with the
  16 .\"    distribution.
  17 .\" 3. Neither the name of The DragonFly Project nor the names of its
  18 .\"    contributors may be used to endorse or promote products derived
  19 .\"    from this software without specific, prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $DragonFly: src/usr.sbin/vknetd/vknetd.8,v 1.3 2008/05/31 12:04:15 swildner Exp $
  35 .\"
  36 .Dd May 26, 2008
  37 .Dt vknetd 8
  38 .Os
  39 .Sh NAME
  40 .Nm vknetd
  41 .Nd create a bridged network for (typically user-run) vkernel's
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl cdU
  45 .Op Fl b Ar bridgeN
  46 .Op Fl p Ar socket_path
  47 .Op Fl t Ar tapN
  48 .Op Ar address/cidrbits
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility creates a virtualized bridged network suitable for vkernel use.
  53 The utility was created to simplify vkernel oprations and to allow user-run
  54 vkernels to have access to a network.
  55 General use is to specify a large 10-dot network which multiple vkernels are
  56 then able to connect to, and backfeed the whole mess to a TAP interface.
  57 .Pp
  58 A vkernel would make use of the virtualized network by specifying
  59 .Fl I Ar /dev/vknet
  60 instead of a
  61 .Xr tap 4
  62 interface.
  63 Any number of vkernels may connect to the virtual network.
  64 .Pp
  65 .Nm
  66 Implements a simple bridge for all entities connected to it.
  67 A cache
  68 of MAC addresses is built up (just like an etherswitch does) and matching
  69 packets will be forwarded directly to the proper 'port' (connected clients
  70 or TAP interface).
  71 Unknown MACs will be broadcast.
  72 .Pp
  73 The following options are available:
  74 .Bl -tag -width flag
  75 .It Fl c
  76 Connect into the bridge and monitor activity.
  77 This option currently only monitors broadcast packets.
  78 Packets with cached MACs are not monitored.
  79 .It Fl d
  80 Debug mode.
  81 Do not go into the background.
  82 .It Fl U
  83 Unsecure mode.
  84 Act as a pure bridge and do not try to secure the IP
  85 space from host visibility.
  86 This is typically used with the
  87 .Fl b
  88 option to directly bridge
  89 .Nm
  90 into the host rather then operating it as a separate subnet.
  91 .It Fl b Ar bridgeN
  92 The
  93 .Xr tap 4
  94 interface
  95 will be bridged into the specified bridge.
  96 .It Fl p Ar socket_path
  97 Specify where to create the unix domain socket in the filesystem space.
  98 By default the socket is called
  99 .Pa /dev/vknet .
 100 .It Fl t Ar tapN
 101 Specify a particular
 102 .Xr tap 4
 103 interface to use.
 104 If not specified,
 105 .Nm
 106 will search for an unused tap interface.
 107 .It Ar address/cidrbits
 108 When operating in secure mode (which is the default), a CIDR block must be
 109 specified.
 110 The address is the address you wish to assign to the TAP
 111 interface and will sit on both the host and virtual networks if not bridged.
 112 The
 113 .Ar cidrbits
 114 is the number of bits representing the virtual subnet.
 115 For example,
 116 10.1.0.1/24 places the tap interface on 10.1.0.1 and gives you an 8 bit
 117 subnet capable of handling 254 hosts.
 118 .El
 119 .Sh EXAMPLES
 120 .Li "vknetd 10.1.0.1/16"
 121 .Sh REQUIREMENTS
 122 .Nm
 123 requires that the
 124 .Ar if_tap
 125 and
 126 .Ar if_bridge
 127 modules be loaded.
 128 In addition, a 'vknet' group must exist in /etc/groups.
 129 .Sh FILES
 130 .Bl -tag -width /var/log/lastlog -compact
 131 .It Pa /dev/tap*
 132 TAP interface used to route packets from userland providers back into the
 133 real machine.
 134 If not otherwise specified an unused tap interface will be selected.
 135 .It Pa /dev/vknet
 136 Default socket
 137 .Nm
 138 sits on waiting for connections.
 139 .El
 140 .Sh BUGS
 141 .Nm
 142 defaults to secure mode and will prevent IP spoofing, but the security
 143 does not yet handle ARP issues so ARP spoofing can be used to create a
 144 denial of service attack on the host network.
 145 .Pp
 146 .Nm
 147 does not currently implement a timeout for its MAC cache.
 148 .Sh SEE ALSO
 149 .Xr vknet 1 ,
 150 .Xr vke 4 ,
 151 .Xr vkernel 7
 152 .Sh HISTORY
 153 The
 154 .Nm
 155 command was written by Matthew Dillon and first appeared in
 156 .Dx 1.13
 157 in May 2008.