Home | History | Annotate | Line # | Download | only in html
tcp_table.5.html revision 1.1.1.6
      1      1.1      tron <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
      2      1.1      tron         "http://www.w3.org/TR/html4/loose.dtd">
      3      1.1      tron <html> <head>
      4  1.1.1.5  christos <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
      5  1.1.1.6  christos <link rel='stylesheet' type='text/css' href='postfix-doc.css'>
      6      1.1      tron <title> Postfix manual - tcp_table(5) </title>
      7      1.1      tron </head> <body> <pre>
      8      1.1      tron TCP_TABLE(5)                                                      TCP_TABLE(5)
      9      1.1      tron 
     10      1.1      tron <b>NAME</b>
     11      1.1      tron        tcp_table - Postfix client/server table lookup protocol
     12      1.1      tron 
     13      1.1      tron <b>SYNOPSIS</b>
     14      1.1      tron        <b>postmap -q "</b><i>string</i><b>" <a href="tcp_table.5.html">tcp</a>:</b><i>host:port</i>
     15      1.1      tron 
     16      1.1      tron        <b>postmap -q - <a href="tcp_table.5.html">tcp</a>:</b><i>host:port</i> &lt;<i>inputfile</i>
     17      1.1      tron 
     18      1.1      tron <b>DESCRIPTION</b>
     19  1.1.1.2      tron        The  Postfix  mail system uses optional tables for address rewriting or
     20  1.1.1.2      tron        mail routing. These tables are usually in <b>dbm</b> or  <b>db</b>  format.  Alterna-
     21  1.1.1.2      tron        tively, table lookups can be directed to a TCP server.
     22      1.1      tron 
     23  1.1.1.2      tron        To  find  out  what types of lookup tables your Postfix system supports
     24  1.1.1.2      tron        use the "<b>postconf -m</b>" command.
     25      1.1      tron 
     26  1.1.1.2      tron        To test lookup tables, use the "<b>postmap -q</b>" command as described in the
     27  1.1.1.2      tron        SYNOPSIS above.
     28      1.1      tron 
     29      1.1      tron <b>PROTOCOL DESCRIPTION</b>
     30  1.1.1.2      tron        The TCP map class implements a very simple protocol: the client sends a
     31  1.1.1.2      tron        request, and the server sends one reply. Requests and replies are  sent
     32  1.1.1.2      tron        as  one  line of ASCII text, terminated by the ASCII newline character.
     33  1.1.1.2      tron        Request and reply parameters (see below) are separated by whitespace.
     34      1.1      tron 
     35  1.1.1.2      tron        Send and receive operations must complete in 100 seconds.
     36      1.1      tron 
     37      1.1      tron <b>REQUEST FORMAT</b>
     38  1.1.1.4  christos        The tcp_table protocol supports only the lookup request.   The  request
     39  1.1.1.4  christos        has the following form:
     40      1.1      tron 
     41      1.1      tron        <b>get</b> SPACE <i>key</i> NEWLINE
     42      1.1      tron               Look up data under the specified key.
     43      1.1      tron 
     44  1.1.1.4  christos        Postfix  will  not  generate  partial  search keys such as domain names
     45  1.1.1.4  christos        without one or more subdomains, network addresses without one  or  more
     46  1.1.1.4  christos        least-significant  octets,  or  email  addresses without the localpart,
     47  1.1.1.4  christos        address extension or domain portion. This behavior is also  found  with
     48  1.1.1.4  christos        <a href="cidr_table.5.html">cidr</a>:, <a href="pcre_table.5.html">pcre</a>:, and <a href="regexp_table.5.html">regexp</a>: tables.
     49      1.1      tron 
     50      1.1      tron <b>REPLY FORMAT</b>
     51  1.1.1.2      tron        Each  reply specifies a status code and text. Replies must be no longer
     52  1.1.1.2      tron        than 4096 characters including the newline terminator.
     53      1.1      tron 
     54      1.1      tron        <b>500</b> SPACE <i>text</i> NEWLINE
     55  1.1.1.2      tron               In case of a lookup request, the requested data does not  exist.
     56  1.1.1.4  christos               The text describes the nature of the problem.
     57      1.1      tron 
     58      1.1      tron        <b>400</b> SPACE <i>text</i> NEWLINE
     59  1.1.1.2      tron               This indicates an error condition. The text describes the nature
     60  1.1.1.2      tron               of the problem. The client should retry the request later.
     61      1.1      tron 
     62      1.1      tron        <b>200</b> SPACE <i>text</i> NEWLINE
     63  1.1.1.2      tron               The request was successful. In the case of a lookup request, the
     64  1.1.1.2      tron               text contains an encoded version of the requested data.
     65      1.1      tron 
     66      1.1      tron <b>ENCODING</b>
     67  1.1.1.4  christos        In  request  and  reply  parameters, the character %, each non-printing
     68  1.1.1.2      tron        character, and each whitespace character must be replaced by %XX, where
     69  1.1.1.2      tron        XX is the corresponding ASCII hexadecimal character value. The hexadec-
     70  1.1.1.2      tron        imal codes can be specified in any case (upper, lower, mixed).
     71  1.1.1.2      tron 
     72  1.1.1.4  christos        The Postfix client always encodes a request.  The server may  omit  the
     73  1.1.1.4  christos        encoding  as  long  as  the reply is guaranteed to not contain the % or
     74  1.1.1.2      tron        NEWLINE character.
     75      1.1      tron 
     76      1.1      tron <b>SECURITY</b>
     77  1.1.1.4  christos        Do not use TCP lookup  tables  for  security  critical  purposes.   The
     78  1.1.1.2      tron        client-server connection is not protected and the server is not authen-
     79  1.1.1.2      tron        ticated.
     80      1.1      tron 
     81      1.1      tron <b>BUGS</b>
     82      1.1      tron        Only the lookup method is currently implemented.
     83      1.1      tron 
     84  1.1.1.4  christos        The client does not hang up when the connection  is  idle  for  a  long
     85  1.1.1.2      tron        time.
     86      1.1      tron 
     87      1.1      tron <b>SEE ALSO</b>
     88      1.1      tron        <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager
     89      1.1      tron        <a href="regexp_table.5.html">regexp_table(5)</a>, format of regular expression tables
     90      1.1      tron        <a href="pcre_table.5.html">pcre_table(5)</a>, format of PCRE tables
     91      1.1      tron        <a href="cidr_table.5.html">cidr_table(5)</a>, format of CIDR tables
     92      1.1      tron 
     93      1.1      tron <b>README FILES</b>
     94      1.1      tron        <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
     95      1.1      tron 
     96      1.1      tron <b>LICENSE</b>
     97  1.1.1.2      tron        The Secure Mailer license must be distributed with this software.
     98      1.1      tron 
     99      1.1      tron <b>AUTHOR(S)</b>
    100      1.1      tron        Wietse Venema
    101      1.1      tron        IBM T.J. Watson Research
    102      1.1      tron        P.O. Box 704
    103      1.1      tron        Yorktown Heights, NY 10598, USA
    104      1.1      tron 
    105  1.1.1.3  christos        Wietse Venema
    106  1.1.1.3  christos        Google, Inc.
    107  1.1.1.3  christos        111 8th Avenue
    108  1.1.1.3  christos        New York, NY 10011, USA
    109  1.1.1.3  christos 
    110      1.1      tron                                                                   TCP_TABLE(5)
    111      1.1      tron </pre> </body> </html>
    112