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