shorewall_code/manpages6/shorewall6-notrack.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry>
  <refmeta>
    <refentrytitle>shorewall6-notrack</refentrytitle>

    <manvolnum>5</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>notrack</refname>

    <refpurpose>shorewall6 notrack file</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/etc/shorewall6/notrack</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>The original intent of the notrack file was to exempt certain
    traffic from Netfilter connection tracking. Traffic matching entries in
    this file were not to be tracked.</para>

    <para>The role of the file was expanded in Shorewall 4.4.27 to include all
    rules tht can be added in the Netfilter <emphasis
    role="bold">raw</emphasis> table.</para>

    <para>The file supports two different column layouts: FORMAT 1 and FORMAT
    2, FORMAT 1 being the default. The two differ in that FORMAT 2 has an
    additional leading ACTION column. When an entry in the file of this form
    is encountered, the format of the following entries are assumed to be of
    the specified <replaceable>format</replaceable>.</para>

    <simplelist>
      <member>FORMAT <replaceable>format</replaceable></member>
    </simplelist>

    <para>where <replaceable>format</replaceable> is either <emphasis
    role="bold">1</emphasis> or <emphasis role="bold">2</emphasis>.</para>

    <para>The columns in the file are as follows (where the column name is
    followed by a different name in parentheses, the different name is used in
    the alternate specification syntax).</para>

    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">ACTION</emphasis> - {<emphasis
        role="bold">NOTRACK</emphasis>|<emphasis
        role="bold">CT</emphasis>:<replaceable>option</replaceable>:<replaceable>args</replaceable>}</term>

        <listitem>
          <para>This column is only present when FORMAT = 2. Values other than
          NOTRACK require <firstterm>CT Target </firstterm>support in your
          iptables and kernel.</para>

          <para>Possible values for <replaceable>option</replaceable> and
          <replaceable>arg</replaceable>s are:</para>

          <itemizedlist>
            <listitem>
              <para><option>notrack</option> (no
              <replaceable>arg</replaceable>)</para>

              <para>Disables connection tracking for this packet, the same as
              if NOTRACK has been specified in this column.</para>
            </listitem>

            <listitem>
              <para><option>helper</option>:<replaceable>name</replaceable></para>

              <para>Use the helper identified by the name to this connection.
              This is more flexible than loading the conntrack helper with
              preset ports.</para>
            </listitem>

            <listitem>
              <para><option>ctevents</option>:<replaceable>event</replaceable>,...</para>

              <para>Only generate the specified conntrack events for this
              connection. Possible event types are: <emphasis
              role="bold">new</emphasis>, <emphasis
              role="bold">related</emphasis>, <emphasis
              role="bold">destroy</emphasis>, <emphasis
              role="bold">reply</emphasis>, <emphasis
              role="bold">assured</emphasis>, <emphasis
              role="bold">protoinfo</emphasis>, <emphasis
              role="bold">helper</emphasis>, <emphasis
              role="bold">mark</emphasis> (this is connection mark, not packet
              mark), <emphasis role="bold">natseqinfo</emphasis>, and
              <emphasis role="bold">secmark</emphasis>.</para>
            </listitem>

            <listitem>
              <para><option>expevents</option><option>:new</option></para>

              <para>Only generate a new expectation events for this
              connection.</para>
            </listitem>

            <listitem>
              <para><option>zone</option>:<replaceable>id</replaceable></para>

              <para>Assign this packet to zone <replaceable>id</replaceable>
              and only have lookups done in that zone. By default, packets
              have zone 0.</para>
            </listitem>
          </itemizedlist>

          <para>When FORMAT = 1, this column is not present and the rule is
          processed as if NOTRACK had been entered in this column.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SOURCE ‒
        <emphasis>zone</emphasis>[:<emphasis>interface</emphasis>][:<emphasis>address-list</emphasis>]</term>

        <listitem>
          <para>where <replaceable>zone</replaceable> is the name of a zone,
          <replaceable>interface</replaceable> is an interface to that zone,
          and <replaceable>address-list</replaceable> is a comma-separated
          list of addresses (may contain exclusion - see <ulink
          url="shorewall-exclusion.html">shorewall6-exclusion</ulink>
          (5)).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>DEST ‒
        [<replaceable>interface</replaceable>|<replaceable>address-list</replaceable>]</term>

        <listitem>
          <para>where <replaceable>address-list</replaceable> is a
          comma-separated list of addresses (may contain exclusion - see
          <ulink url="shorewall-exclusion.html">shorewall6-exclusion</ulink>
          (5)). If an interface is given:</para>

          <itemizedlist>
            <listitem>
              <para>It must be up and configured with an IPv6 address when
              Shorewall is started or restarted.</para>
            </listitem>

            <listitem>
              <para>All routes out of the interface must be configured when
              Shorewall is started or restarted.</para>
            </listitem>

            <listitem>
              <para>Default routes out of the interface will result in a
              warning message and will be ignored.</para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>PROTO ‒
        <replaceable>protocol-name-or-number</replaceable></term>

        <listitem>
          <para>A protocol name from <filename>/etc/protocols</filename> or a
          protocol number.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>DEST PORT(S) (dport) - port-number/service-name-list</term>

        <listitem>
          <para>A comma-separated list of port numbers and/or service names
          from <filename>/etc/services</filename>. May also include port
          ranges of the form
          <replaceable>low-port</replaceable>:<replaceable>high-port</replaceable>
          if your kernel and iptables include port range support.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>SOURCE PORT(S) (sport) - port-number/service-name-list</term>

        <listitem>
          <para>A comma-separated list of port numbers and/or service names
          from <filename>/etc/services</filename>. May also include port
          ranges of the form
          <replaceable>low-port</replaceable>:<replaceable>high-port</replaceable>
          if your kernel and iptables include port range support.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>USER/GROUP (user) ‒
        [<replaceable>user</replaceable>][:<replaceable>group</replaceable>]</term>

        <listitem>
          <para>May only be specified if the SOURCE
          <replaceable>zone</replaceable> is $FW. Specifies the effective user
          id and or group id of the process sending the traffic.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>FILES</title>

    <para>/etc/shorewall6/notrack</para>
  </refsect1>

  <refsect1>
    <title>See ALSO</title>

    <para><ulink
    url="http://shorewall.net/configuration_file_basics.htm#Pairs">http://shorewall.net/configuration_file_basics.htm#Pairs</ulink></para>

    <para>shorewall6(8), shorewall6-accounting(5), shorewall6-actions(5),
    shorewall6-blacklist(5), shorewall6-hosts(5), shorewall6-interfaces(5),
    shorewall6-ipsec(5), shoewall6-netmap(5),shorewall6-params(5),
    shorewall6-policy(5), shorewall6-providers(5), shorewall6-proxyarp(5),
    shorewall6-rtrules(5), shorewall6-routestopped(5),
    shorewall6-rules(5), shorewall6.conf(5), shorewall6-secmarks(5),
    shorewall6-tcclasses(5), shorewall6-tcdevices(5), shorewall6-tcrules(5),
    shorewall6-tos(5), shorewall6-tunnels(5), shorewall-zones(5)</para>
  </refsect1>
</refentry>