xref: /freebsd/sbin/nos-tun/nos-tun.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1e66dbdb6SPoul-Henning Kamp.\"
2e66dbdb6SPoul-Henning Kamp.\" ----------------------------------------------------------------------------
3e66dbdb6SPoul-Henning Kamp.\" "THE BEER-WARE LICENSE" (Revision 42):
4e66dbdb6SPoul-Henning Kamp.\" <phk@FreeBSD.org> wrote this file.  As long as you retain this notice you
5e66dbdb6SPoul-Henning Kamp.\" can do whatever you want with this stuff. If we meet some day, and you think
6e66dbdb6SPoul-Henning Kamp.\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
7e66dbdb6SPoul-Henning Kamp.\" ----------------------------------------------------------------------------
8e66dbdb6SPoul-Henning Kamp.\"
9*04970b8dSSevan Janiyan.Dd October 5, 2016
10e66dbdb6SPoul-Henning Kamp.Dt NOS-TUN 8
119fe48c6eSRuslan Ermilov.Os
12e66dbdb6SPoul-Henning Kamp.Sh NAME
13e66dbdb6SPoul-Henning Kamp.Nm nos-tun
1459edad7aSPhilippe Charnier.Nd implement ``nos'' or ``ka9q'' style IP over IP tunnel
15e66dbdb6SPoul-Henning Kamp.Sh SYNOPSIS
167c7fb079SRuslan Ermilov.Nm
17e66dbdb6SPoul-Henning Kamp.Fl t
18e66dbdb6SPoul-Henning Kamp.Ar tunnel
19e66dbdb6SPoul-Henning Kamp.Fl s
20e66dbdb6SPoul-Henning Kamp.Ar source
21e66dbdb6SPoul-Henning Kamp.Fl d
22e66dbdb6SPoul-Henning Kamp.Ar destination
23d59cf2acSPoul-Henning Kamp.Fl p
24d59cf2acSPoul-Henning Kamp.Ar protocol_number
258d646af5SRuslan Ermilov.Op Ar source
26e66dbdb6SPoul-Henning Kamp.Ar target
27e66dbdb6SPoul-Henning Kamp.Sh DESCRIPTION
28e1205e80SPhilippe CharnierThe
29e1205e80SPhilippe Charnier.Nm
30e1205e80SPhilippe Charnierutility is used to establish an
31e66dbdb6SPoul-Henning Kamp.Em nos
32e66dbdb6SPoul-Henning Kampstyle tunnel, (also known as
33e66dbdb6SPoul-Henning Kamp.Em ka9q
34e66dbdb6SPoul-Henning Kampor
35e66dbdb6SPoul-Henning Kamp.Em IP-IP
36e66dbdb6SPoul-Henning Kamptunnel) using a
37e66dbdb6SPoul-Henning Kamp.Xr tun 4
38e66dbdb6SPoul-Henning Kampkernel interface.
39e66dbdb6SPoul-Henning Kamp.Pp
4059edad7aSPhilippe Charnier.Ar Tunnel
41e66dbdb6SPoul-Henning Kampis the name of the tunnel device
4259edad7aSPhilippe Charnier.Pa /dev/tun0
43e66dbdb6SPoul-Henning Kampfor example.
44e66dbdb6SPoul-Henning Kamp.Pp
4559edad7aSPhilippe Charnier.Ar Source
46e66dbdb6SPoul-Henning Kampand
47e66dbdb6SPoul-Henning Kamp.Ar destination
48e66dbdb6SPoul-Henning Kampare the addresses used on the tunnel device.
49e66dbdb6SPoul-Henning KampIf you configure the tunnel against a cisco router, use a netmask of
50e66dbdb6SPoul-Henning Kamp.Dq 255.255.255.252
519806e231SRuslan Ermilovon the cisco.
529806e231SRuslan ErmilovThis is because the tunnel is a point-to-point interface
5359edad7aSPhilippe Charnierin the
54f050f700SMike Pritchard.Fx
550227791bSRuslan Ermilovend, a concept cisco does not really implement.
56e66dbdb6SPoul-Henning Kamp.Pp
57d59cf2acSPoul-Henning Kamp.Ar Protocol number
58ef8f7ac9SSheldon Hearnsets tunnel mode.
5978d9ac57SBill FumerolaOriginal KA9Q NOS uses 94 but many people use 4
6078d9ac57SBill Fumerolaon the worldwide backbone of ampr.org.
61d59cf2acSPoul-Henning Kamp.Pp
6259edad7aSPhilippe Charnier.Ar Target
63e66dbdb6SPoul-Henning Kampis the address of the remote tunnel device, this must match the source
64e66dbdb6SPoul-Henning Kampaddress set on the remote end.
65e66dbdb6SPoul-Henning Kamp.Sh EXAMPLES
6659edad7aSPhilippe CharnierThis end, a
67f050f700SMike Pritchard.Fx
6859edad7aSPhilippe Charnierbox on address 192.168.59.34:
691252c1bbSRuslan Ermilov.Bd -literal -offset indent
70e66dbdb6SPoul-Henning Kampnos-tun -t /dev/tun0 -s 192.168.61.1 -d 192.168.61.2 192.168.56.45
71e66dbdb6SPoul-Henning Kamp.Ed
72e66dbdb6SPoul-Henning Kamp.Pp
73e66dbdb6SPoul-Henning KampRemote cisco on address 192.168.56.45:
741252c1bbSRuslan Ermilov.Bd -literal -offset indent
75e66dbdb6SPoul-Henning Kampinterface tunnel 0
76e66dbdb6SPoul-Henning Kampip address 192.168.61.2 255.255.255.252
77e66dbdb6SPoul-Henning Kamptunnel mode nos
78e66dbdb6SPoul-Henning Kamptunnel destination 192.168.59.34
79e66dbdb6SPoul-Henning Kamptunnel source 192.168.56.45
80e66dbdb6SPoul-Henning Kamp.Ed
81*04970b8dSSevan Janiyan.Sh HISTORY
82*04970b8dSSevan JaniyanThe
83*04970b8dSSevan Janiyan.Nm
84*04970b8dSSevan Janiyanutility appeared in
85*04970b8dSSevan Janiyan.Fx 3.0 .
8659edad7aSPhilippe Charnier.Sh AUTHORS
87f4d874a1SRuslan Ermilov.An -nosplit
88bd0891ceSBaptiste Daroussin.An Nickolay N. Dudorov Aq Mt nnd@itfs.nsk.su
8959edad7aSPhilippe Charnierwrote the program,
90bd0891ceSBaptiste Daroussin.An Poul-Henning Kamp Aq Mt phk@FreeBSD.org
9159edad7aSPhilippe Charnierwrote the man-page.
92bd0891ceSBaptiste Daroussin.An Isao SEKI Aq Mt iseki@gongon.com
93d59cf2acSPoul-Henning Kampadded a new flag, IP protocol number.
946087df9eSRuslan Ermilov.Sh BUGS
950227791bSRuslan ErmilovWe do not allow for setting our source address for multihomed machines.
96