xref: /netbsd-src/external/ibm-public/postfix/dist/html/socketmap_table.5.html (revision 059c16a85b0b39d60ad6d18f53c09510815afa2b)
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
2        "http://www.w3.org/TR/html4/loose.dtd">
3<html> <head>
4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
6<title> Postfix manual - socketmap_table(5) </title>
7</head> <body> <pre>
8SOCKETMAP_TABLE(5)                                          SOCKETMAP_TABLE(5)
9
10<b>NAME</b>
11       socketmap_table - Postfix socketmap table lookup client
12
13<b>SYNOPSIS</b>
14       <b>postmap -q "</b><i>string</i><b>" <a href="socketmap_table.html">socketmap</a>:inet:</b><i>host</i><b>:</b><i>port</i><b>:</b><i>name</i>
15       <b>postmap -q "</b><i>string</i><b>" <a href="socketmap_table.html">socketmap</a>:unix:</b><i>pathname</i><b>:</b><i>name</i>
16
17       <b>postmap -q - <a href="socketmap_table.html">socketmap</a>:inet:</b><i>host</i><b>:</b><i>port</i><b>:</b><i>name</i> &lt;<i>inputfile</i>
18       <b>postmap -q - <a href="socketmap_table.html">socketmap</a>:unix:</b><i>pathname</i><b>:</b><i>name</i> &lt;<i>inputfile</i>
19
20<b>DESCRIPTION</b>
21       The  Postfix  mail  system  uses optional tables for address rewriting.
22       mail routing or policy lookup.
23
24       The Postfix socketmap client expects TCP endpoint  names  of  the  form
25       <b>inet:</b><i>host</i><b>:</b><i>port</i><b>:</b><i>name</i>,  or  UNIX-domain  endpoints of the form <b>unix:</b><i>path-</i>
26       <i>name</i><b>:</b><i>name</i>.  In both cases, <i>name</i> specifies the name field in a socketmap
27       client request (see "REQUEST FORMAT" below).
28
29<b>PROTOCOL</b>
30       Socketmaps use a simple protocol: the client sends one request, and the
31       server sends one reply.  Each request and each reply are  sent  as  one
32       netstring object.
33
34<b>REQUEST FORMAT</b>
35       The  socketmap  protocol supports only the lookup request.  The request
36       has the following form:
37
38       <i>name</i> &lt;<b>space</b>&gt; <i>key</i>
39              Search the named socketmap for the specified key.
40
41       Postfix will not generate partial search  keys  such  as  domain  names
42       without  one  or more subdomains, network addresses without one or more
43       least-significant octets, or email  addresses  without  the  localpart,
44       address  extension  or domain portion. This behavior is also found with
45       <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.
46
47<b>REPLY FORMAT</b>
48       The Postfix socketmap client requires that replies are not longer  than
49       100000  characters (not including the netstring encapsulation). Replies
50       must have the following form:
51
52       <b>OK</b> &lt;<b>space</b>&gt; <i>data</i>
53              The requested data was found.
54
55       <b>NOTFOUND</b> &lt;<b>space</b>&gt;
56              The requested data was not found.
57
58       <b>TEMP</b> &lt;<b>space</b>&gt; <i>reason</i>
59
60       <b>TIMEOUT</b> &lt;<b>space</b>&gt; <i>reason</i>
61
62       <b>PERM</b> &lt;<b>space</b>&gt; <i>reason</i>
63              The request failed. The reason,  if  non-empty,  is  descriptive
64              text.
65
66<b>SECURITY</b>
67       This map cannot be used for security-sensitive information,
68       because neither the connection nor the server are authenticated.
69
70<b>SEE ALSO</b>
71       <a href="http://cr.yp.to/proto/netstrings.txt">http://cr.yp.to/proto/netstrings.txt</a>, netstring definition
72       <a href="postconf.1.html">postconf(1)</a>, Postfix supported lookup tables
73       <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager
74       <a href="regexp_table.5.html">regexp_table(5)</a>, format of regular expression tables
75       <a href="pcre_table.5.html">pcre_table(5)</a>, format of PCRE tables
76       <a href="cidr_table.5.html">cidr_table(5)</a>, format of CIDR tables
77
78<b>README FILES</b>
79       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
80
81<b>BUGS</b>
82       The protocol limits are not yet configurable.
83
84<b>LICENSE</b>
85       The Secure Mailer license must be distributed with this software.
86
87<b>HISTORY</b>
88       Socketmap support was introduced with Postfix version 2.10.
89
90<b>AUTHOR(S)</b>
91       Wietse Venema
92       IBM T.J. Watson Research
93       P.O. Box 704
94       Yorktown Heights, NY 10598, USA
95
96       Wietse Venema
97       Google, Inc.
98       111 8th Avenue
99       New York, NY 10011, USA
100
101                                                            SOCKETMAP_TABLE(5)
102</pre> </body> </html>
103