openswan/programs/tncfg/tncfg.8.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4 <refentry>
   5 <refmeta>
   6 <refentrytitle>IPSEC_TNCFG</refentrytitle>
   7 <manvolnum>8</manvolnum>
   8 <refmiscinfo class='date'>21 Jun 2000</refmiscinfo>
   9 </refmeta>
  10 <refnamediv id='name'>
  11 <refname>ipsec tncfg</refname>
  12 <refpurpose>manipulate KLIPS virtual interfaces</refpurpose>
  13 </refnamediv>
  14 <!-- body begins here -->
  15 <refsynopsisdiv id='synopsis'>
  16 <cmdsynopsis>
  17   <command>ipsec</command>
  18     <arg choice='plain'>tncfg</arg>
  19     <sbr/>
  20     <arg choice='plain'>ipsec tncfg</arg>
  21     <arg choice='plain'>--create </arg>
  22     <arg choice='plain'><replaceable>virtual</replaceable></arg>
  23     <sbr/>
  24     <arg choice='plain'>ipsec tncfg</arg>
  25     <arg choice='plain'>--delete </arg>
  26     <arg choice='plain'><replaceable>virtual</replaceable></arg>
  27     <sbr/>
  28     <arg choice='plain'>ipsec tncfg</arg>
  29     <arg choice='plain'>--attach </arg>
  30     <arg choice='plain'>--virtual </arg>
  31     <arg choice='plain'><replaceable>virtual</replaceable></arg>
  32     <arg choice='plain'>--physical </arg>
  33     <arg choice='plain'><replaceable>physical</replaceable></arg>
  34     <sbr/>
  35     <arg choice='plain'>ipsec tncfg</arg>
  36     <arg choice='plain'>--detach </arg>
  37     <arg choice='plain'>--virtual </arg>
  38     <arg choice='plain'><replaceable>virtual</replaceable></arg>
  39     <sbr/>
  40     <arg choice='plain'>ipsec tncfg</arg>
  41     <arg choice='plain'>--clear </arg>
  42     <sbr/>
  43     <arg choice='plain'>ipsec tncfg</arg>
  44     <arg choice='plain'>--version </arg>
  45     <sbr/>
  46     <arg choice='plain'>ipsec tncfg</arg>
  47     <arg choice='plain'>--help </arg>
  48 </cmdsynopsis>
  49 </refsynopsisdiv>
  50
  51 <refsect1 id='obsolete'><title>OBSOLETE</title>
  52 <para>Note that tncfg is only supported on the classic KLIPS stack. It is
  53 not supported on any other stack and will be completely removed in future
  54 versions. A replacement command still needs to be designed</para>
  55 </refsect1>
  56
  57 <refsect1 id='description'><title>DESCRIPTION</title>
  58 <para>The historical use of <emphasis remap='I'>tncfg</emphasis> is to
  59 attach/detach IPsec virtual interfaces (e.g. ipsec0) to/from physical interfaces
  60 (e.g. eth0) through which packets will be forwarded once processed by KLIPS.</para>
  61
  62 <para>The modern use of tncfg is to create and delete virtual interfaces known
  63 as mastXXX. mast stands for Mooring and XXX.</para>
  64
  65 <para>The form with no additional arguments lists the contents of
  66 /proc/net/ipsec_tncfg.  The format of /proc/net/ipsec_tncfg is discussed
  67 in ipsec_tncfg(5).</para>
  68 <para>
  69 The
  70 <option>--attach</option>
  71 form attaches the
  72 <emphasis remap='I'>virtual</emphasis>
  73 interface to the
  74 <emphasis remap='I'>physical</emphasis>
  75 one.</para>
  76 <para>
  77 The
  78 <option>--detach</option>
  79 form detaches the
  80 <emphasis remap='I'>virtual</emphasis>
  81 interface from whichever physical interface it is attached to.
  82 </para>
  83 <para>
  84 The
  85 <option>--clear</option>
  86 form clears all the
  87 <emphasis remap='I'>virtual</emphasis>
  88 interfaces from whichever physical interfaces they were attached to.</para>
  89
  90 <para>Virtual interfaces typically have names like
  91 <emphasis remap='B'>ipsec0</emphasis> or <emphasis remap='B'>mast0</emphasis>
  92 while physical interfaces typically have names like
  93 <emphasis remap='B'>eth0</emphasis>
  94 or
  95 <emphasis remap='B'>ppp0</emphasis>.</para>
  96 </refsect1>
  97
  98 <refsect1 id='examples'><title>EXAMPLES</title>
  99 <variablelist remap='TP'>
 100   <varlistentry>
 101   <term><emphasis remap='B'>ipsec tncfg --create mast12</emphasis></term>
 102   <listitem>
 103 <para>creates the mast12 device.</para>
 104   </listitem>
 105   </varlistentry>
 106 </variablelist>
 107
 108 <variablelist remap='TP'>
 109   <varlistentry>
 110   <term><emphasis remap='B'>ipsec tncfg --create ipsec4</emphasis></term>
 111   <listitem>
 112 <para>creates an ipsec4 device, but does not attach it.</para>
 113   </listitem>
 114   </varlistentry>
 115 </variablelist>
 116
 117 <variablelist remap='TP'>
 118   <varlistentry>
 119   <term><emphasis remap='B'>ipsec tncfg --attach --virtual ipsec0 --physical eth0</emphasis></term>
 120   <listitem>
 121 <para>attaches the
 122 <emphasis remap='B'>ipsec0</emphasis>
 123 virtual device to the
 124 <emphasis remap='B'>eth0</emphasis>
 125 physical device.</para>
 126   </listitem>
 127   </varlistentry>
 128 </variablelist>
 129
 130 </refsect1>
 131
 132 <refsect1 id='files'><title>FILES</title>
 133 <para>/proc/net/ipsec_tncfg, /usr/local/bin/ipsec</para>
 134 </refsect1>
 135
 136 <refsect1 id='see_also'><title>SEE ALSO</title>
 137 <para>ipsec(8), ipsec_manual(8), ipsec_eroute(8), ipsec_spi(8),
 138 ipsec_spigrp(8), ipsec_klipsdebug(8), ipsec_tncfg(5)</para>
 139 </refsect1>
 140
 141 <refsect1 id='history'><title>HISTORY</title>
 142 <para>Written for the Linux FreeS/WAN project
 143 &lt;<ulink url='http://www.freeswan.org/'>http://www.freeswan.org/</ulink>&gt;
 144 by Richard Guy Briggs.</para>
 145
 146 </refsect1>
 147 </refentry>
 148