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