xref: /netbsd-src/external/ibm-public/postfix/dist/html/socketmap_table.5.html (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
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<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  endpoints 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 each reply are  sent  as  one
31       netstring object.
32
33<b>REQUEST FORMAT</b>
34       The  socketmap  protocol supports only the lookup request.  The request
35       has the following form:
36
37       <i>name</i> &lt;<b>space</b>&gt; <i>key</i>
38              Search the named socketmap for the specified key.
39
40       Postfix will not generate partial search  keys  such  as  domain  names
41       without  one  or more subdomains, network addresses without one or more
42       least-significant octets, or email  addresses  without  the  localpart,
43       address  extension  or domain portion. This behavior is also found with
44       <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.
45
46<b>REPLY FORMAT</b>
47       The Postfix socketmap client requires that replies are not longer  than
48       100000  characters (not including the netstring encapsulation). Replies
49       must have the following form:
50
51       <b>OK</b> &lt;<b>space</b>&gt; <i>data</i>
52              The requested data was found.
53
54       <b>NOTFOUND</b> &lt;<b>space</b>&gt;
55              The requested data was not found.
56
57       <b>TEMP</b> &lt;<b>space</b>&gt; <i>reason</i>
58
59       <b>TIMEOUT</b> &lt;<b>space</b>&gt; <i>reason</i>
60
61       <b>PERM</b> &lt;<b>space</b>&gt; <i>reason</i>
62              The request failed. The reason,  if  non-empty,  is  descriptive
63              text.
64
65<b>SECURITY</b>
66       This map cannot be used for security-sensitive information,
67       because neither the connection nor the server are authenticated.
68
69<b>SEE ALSO</b>
70       <a href="http://cr.yp.to/proto/netstrings.txt">http://cr.yp.to/proto/netstrings.txt</a>, netstring definition
71       <a href="postconf.1.html">postconf(1)</a>, Postfix supported lookup tables
72       <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager
73       <a href="regexp_table.5.html">regexp_table(5)</a>, format of regular expression tables
74       <a href="pcre_table.5.html">pcre_table(5)</a>, format of PCRE tables
75       <a href="cidr_table.5.html">cidr_table(5)</a>, format of CIDR tables
76
77<b>README FILES</b>
78       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
79
80<b>BUGS</b>
81       The protocol limits are not yet configurable.
82
83<b>LICENSE</b>
84       The Secure Mailer license must be distributed with this software.
85
86<b>HISTORY</b>
87       Socketmap support was introduced with Postfix version 2.10.
88
89<b>AUTHOR(S)</b>
90       Wietse Venema
91       IBM T.J. Watson Research
92       P.O. Box 704
93       Yorktown Heights, NY 10598, USA
94
95       Wietse Venema
96       Google, Inc.
97       111 8th Avenue
98       New York, NY 10011, USA
99
100                                                            SOCKETMAP_TABLE(5)
101</pre> </body> </html>
102