external/ibm-public/postfix/dist/man/man5/tcp_table.5

   1 .\"     $NetBSD$
   2 .\"
   3 .TH TCP_TABLE 5
   4 .ad
   5 .fi
   6 .SH NAME
   7 tcp_table
   8 \-
   9 Postfix client/server table lookup protocol
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 \fBpostmap -q "\fIstring\fB" tcp:\fIhost:port\fR
  14
  15 \fBpostmap -q - tcp:\fIhost:port\fR <\fIinputfile\fR
  16 .SH DESCRIPTION
  17 .ad
  18 .fi
  19 The Postfix mail system uses optional tables for address
  20 rewriting or mail routing. These tables are usually in
  21 \fBdbm\fR or \fBdb\fR format. Alternatively, table lookups
  22 can be directed to a TCP server.
  23
  24 To find out what types of lookup tables your Postfix system
  25 supports use the "\fBpostconf -m\fR" command.
  26
  27 To test lookup tables, use the "\fBpostmap -q\fR" command as
  28 described in the SYNOPSIS above.
  29 .SH "PROTOCOL DESCRIPTION"
  30 .na
  31 .nf
  32 .ad
  33 .fi
  34 The TCP map class implements a very simple protocol: the client
  35 sends a request, and the server sends one reply. Requests and
  36 replies are sent as one line of ASCII text, terminated by the
  37 ASCII newline character. Request and reply parameters (see below)
  38 are separated by whitespace.
  39
  40 Send and receive operations must complete in 100 seconds.
  41 .SH "REQUEST FORMAT"
  42 .na
  43 .nf
  44 .ad
  45 .fi
  46 Each request specifies a command, a lookup key, and possibly a
  47 lookup result.
  48 .IP "\fBget\fR SPACE \fIkey\fR NEWLINE"
  49 Look up data under the specified key.
  50 .IP "\fBput\fR SPACE \fIkey\fR SPACE \fIvalue\fR NEWLINE"
  51 This request is currently not implemented.
  52 .SH "REPLY FORMAT"
  53 .na
  54 .nf
  55 .ad
  56 .fi
  57 Each reply specifies a status code and text. Replies must be no
  58 longer than 4096 characters including the newline terminator.
  59 .IP "\fB500\fR SPACE \fItext\fR NEWLINE"
  60 In case of a lookup request, the requested data does not exist.
  61 In case of an update request, the request was rejected.
  62 The text describes the nature of the problem.
  63 .IP "\fB400\fR SPACE \fItext\fR NEWLINE"
  64 This indicates an error condition. The text describes the nature of
  65 the problem. The client should retry the request later.
  66 .IP "\fB200\fR SPACE \fItext\fR NEWLINE"
  67 The request was successful. In the case of a lookup request,
  68 the text contains an encoded version of the requested data.
  69 .SH "ENCODING"
  70 .na
  71 .nf
  72 .ad
  73 .fi
  74 In request and reply parameters, the character %, each non-printing
  75 character, and each whitespace character must be replaced by %XX,
  76 where XX is the corresponding ASCII hexadecimal character value. The
  77 hexadecimal codes can be specified in any case (upper, lower, mixed).
  78
  79 The Postfix client always encodes a request.
  80 The server may omit the encoding as long as the reply
  81 is guaranteed to not contain the % or NEWLINE character.
  82 .SH "SECURITY"
  83 .na
  84 .nf
  85 .ad
  86 .fi
  87 Do not use TCP lookup tables for security critical purposes.
  88 The client-server connection is not protected and the server
  89 is not authenticated.
  90 .SH BUGS
  91 .ad
  92 .fi
  93 Only the lookup method is currently implemented.
  94
  95 The client does not hang up when the connection is idle for
  96 a long time.
  97 .SH "SEE ALSO"
  98 .na
  99 .nf
 100 postmap(1), Postfix lookup table manager
 101 regexp_table(5), format of regular expression tables
 102 pcre_table(5), format of PCRE tables
 103 cidr_table(5), format of CIDR tables
 104 .SH "README FILES"
 105 .na
 106 .nf
 107 .ad
 108 .fi
 109 Use "\fBpostconf readme_directory\fR" or
 110 "\fBpostconf html_directory\fR" to locate this information.
 111 .na
 112 .nf
 113 DATABASE_README, Postfix lookup table overview
 114 .SH "LICENSE"
 115 .na
 116 .nf
 117 .ad
 118 .fi
 119 The Secure Mailer license must be distributed with this software.
 120 .SH "AUTHOR(S)"
 121 .na
 122 .nf
 123 Wietse Venema
 124 IBM T.J. Watson Research
 125 P.O. Box 704
 126 Yorktown Heights, NY 10598, USA