1#++
2# NAME
3#         socketmap_table 5
4# SUMMARY
5#         Postfix socketmap table lookup client
6# SYNOPSIS
7#         \fBpostmap -q "\fIstring\fB" socketmap:inet:\fIhost\fB:\fIport\fB:\fIname\fR
8# .br
9#         \fBpostmap -q "\fIstring\fB" socketmap:unix:\fIpathname\fB:\fIname\fR
10#
11#         \fBpostmap -q - socketmap:inet:\fIhost\fB:\fIport\fB:\fIname\fB <\fIinputfile\fR
12# .br
13#         \fBpostmap -q - socketmap:unix:\fIpathname\fB:\fIname\fB <\fIinputfile\fR
14# DESCRIPTION
15#         The Postfix mail system uses optional tables for address
16#         rewriting, mail routing or policy lookup.
17#
18#         The Postfix socketmap client expects TCP endpoint names of
19#         the form \fBinet:\fIhost\fB:\fIport\fB:\fIname\fR, or
20#         UNIX-domain endpoints of the form \fBunix:\fIpathname\fB:\fIname\fR.
21#         In both cases, \fIname\fR specifies the name field in a
22#         socketmap client request (see "REQUEST FORMAT" below).
23# PROTOCOL
24# .ad
25# .fi
26#         Socketmaps use a simple protocol: the client sends one
27#         request, and the server sends one reply.  Each request and
28#         each reply are sent as one netstring object.
29# REQUEST FORMAT
30# .ad
31# .fi
32#         The socketmap protocol supports only the lookup request.
33#         The request has the following form:
34#
35# .IP "\fB\fIname\fB <space> \fIkey\fR"
36#         Search the named socketmap for the specified key.
37# .PP
38#         Postfix will not generate partial search keys such as domain
39#         names without one or more subdomains, network addresses
40#         without one or more least-significant octets, or email
41#         addresses without the localpart, address extension or domain
42#         portion. This behavior is also found with cidr:, pcre:, and
43#         regexp: tables.
44# REPLY FORMAT
45# .ad
46# .fi
47#         Replies must have the following form:
48# .IP "\fBOK <space> \fIdata\fR"
49#         The requested data was found.
50# .IP "\fBNOTFOUND <space>"
51#         The requested data was not found.
52# .IP "\fBTEMP <space> \fIreason\fR"
53# .IP "\fBTIMEOUT <space> \fIreason\fR"
54# .IP "\fBPERM <space> \fIreason\fR"
55#         The request failed. The reason, if non-empty, is descriptive
56#         text.
57# PROTOCOL LIMITS
58# .ad
59# .fi
60#         The Postfix socketmap client requires that replies are no
61#         longer than 100000 bytes (not including the netstring
62#         encapsulation). This limit can be changed with the
63#         socketmap_max_reply_size configuration parameter (Postfix 3.10
64#         and later).
65#
66#         The Postfix socketmap client enforces a 100s time limit to
67#         connect to a socketmap server, to send a request, and to receive
68#         a reply. It closes an idle connection after 10s, and closes
69#         an active connection after 100s. These limits are not (yet)
70#         configurable.
71# SECURITY
72# .ad
73# .fi
74#         This map cannot be used for security-sensitive information,
75#         because neither the connection nor the server are authenticated.
76# CONFIGURATION PARAMETERS
77# .ad
78# .fi
79# .IP "\fBsocketmap_max_reply_size (100000)\fR"
80#         The maximum allowed reply size from a socketmap server, not
81#         including the netstring encapsulation.
82# SEE ALSO
83#         https://cr.yp.to/proto/netstrings.txt, netstring definition
84#         postconf(1), Postfix supported lookup tables
85#         postmap(1), Postfix lookup table manager
86#         regexp_table(5), format of regular expression tables
87#         pcre_table(5), format of PCRE tables
88#         cidr_table(5), format of CIDR tables
89# README FILES
90# .ad
91# .fi
92#         Use "\fBpostconf readme_directory\fR" or
93#         "\fBpostconf html_directory\fR" to locate this information.
94# .na
95# .nf
96#         DATABASE_README, Postfix lookup table overview
97# BUGS
98#         The protocol time limits are not yet configurable.
99# LICENSE
100# .ad
101# .fi
102#         The Secure Mailer license must be distributed with this software.
103# HISTORY
104#         Socketmap support was introduced with Postfix version 2.10.
105#
106#         The socketmap protocol was published with Sendmail v8.13.
107# AUTHOR(S)
108#         Wietse Venema
109#         IBM T.J. Watson Research
110#         P.O. Box 704
111#         Yorktown Heights, NY 10598, USA
112#
113#         Wietse Venema
114#         Google, Inc.
115#         111 8th Avenue
116#         New York, NY 10011, USA
117#
118#         Wietse Venema
119#         porcupine.org
120#--
121
122