xref: /netbsd-src/external/ibm-public/postfix/dist/proto/socketmap_table (revision f3bc92a4f25066883a5d85d66df30605583c883c)
116d67a18Stron#++
216d67a18Stron# NAME
316d67a18Stron#	socketmap_table 5
416d67a18Stron# SUMMARY
516d67a18Stron#	Postfix socketmap table lookup client
616d67a18Stron# SYNOPSIS
716d67a18Stron#	\fBpostmap -q "\fIstring\fB" socketmap:inet:\fIhost\fB:\fIport\fB:\fIname\fR
816d67a18Stron# .br
916d67a18Stron#	\fBpostmap -q "\fIstring\fB" socketmap:unix:\fIpathname\fB:\fIname\fR
1016d67a18Stron#
1116d67a18Stron#	\fBpostmap -q - socketmap:inet:\fIhost\fB:\fIport\fB:\fIname\fB <\fIinputfile\fR
1216d67a18Stron# .br
1316d67a18Stron#	\fBpostmap -q - socketmap:unix:\fIpathname\fB:\fIname\fB <\fIinputfile\fR
1416d67a18Stron# DESCRIPTION
1516d67a18Stron#	The Postfix mail system uses optional tables for address
1616d67a18Stron#	rewriting. mail routing or policy lookup.
1716d67a18Stron#
1816d67a18Stron#	The Postfix socketmap client expects TCP endpoint names of
1916d67a18Stron#	the form \fBinet:\fIhost\fB:\fIport\fB:\fIname\fR, or
20e262b48eSchristos#	UNIX-domain endpoints of the form \fBunix:\fIpathname\fB:\fIname\fR.
2116d67a18Stron#	In both cases, \fIname\fR specifies the name field in a
2216d67a18Stron#	socketmap client request (see "REQUEST FORMAT" below).
2316d67a18Stron# PROTOCOL
2416d67a18Stron# .ad
2516d67a18Stron# .fi
2616d67a18Stron#	Socketmaps use a simple protocol: the client sends one
2716d67a18Stron#	request, and the server sends one reply.  Each request and
28*f3bc92a4Schristos#	each reply are sent as one netstring object.
2916d67a18Stron# REQUEST FORMAT
3016d67a18Stron# .ad
3116d67a18Stron# .fi
3216d67a18Stron#	The socketmap protocol supports only the lookup request.
33e262b48eSchristos#	The request has the following form:
3416d67a18Stron#
35e262b48eSchristos# .IP "\fB\fIname\fB <space> \fIkey\fR"
36e262b48eSchristos#	Search the named socketmap for the specified key.
37e262b48eSchristos# .PP
3816d67a18Stron#	Postfix will not generate partial search keys such as domain
3916d67a18Stron#	names without one or more subdomains, network addresses
4016d67a18Stron#	without one or more least-significant octets, or email
4116d67a18Stron#	addresses without the localpart, address extension or domain
4216d67a18Stron#	portion. This behavior is also found with cidr:, pcre:, and
4316d67a18Stron#	regexp: tables.
4416d67a18Stron# REPLY FORMAT
4516d67a18Stron# .ad
4616d67a18Stron# .fi
4716d67a18Stron#	The Postfix socketmap client requires that replies are not
4816d67a18Stron#	longer than 100000 characters (not including the netstring
4916d67a18Stron#	encapsulation). Replies must have the following form:
5016d67a18Stron# .IP "\fBOK <space> \fIdata\fR"
5116d67a18Stron#	The requested data was found.
5216d67a18Stron# .IP "\fBNOTFOUND <space>"
5316d67a18Stron#	The requested data was not found.
5416d67a18Stron# .IP "\fBTEMP <space> \fIreason\fR"
5516d67a18Stron# .IP "\fBTIMEOUT <space> \fIreason\fR"
5616d67a18Stron# .IP "\fBPERM <space> \fIreason\fR"
5716d67a18Stron#	The request failed. The reason, if non-empty, is descriptive
5816d67a18Stron#	text.
5916d67a18Stron# SECURITY
6016d67a18Stron#	This map cannot be used for security-sensitive information,
6116d67a18Stron#	because neither the connection nor the server are authenticated.
6216d67a18Stron# SEE ALSO
6316d67a18Stron#	http://cr.yp.to/proto/netstrings.txt, netstring definition
6416d67a18Stron#	postconf(1), Postfix supported lookup tables
6516d67a18Stron#	postmap(1), Postfix lookup table manager
6616d67a18Stron#	regexp_table(5), format of regular expression tables
6716d67a18Stron#	pcre_table(5), format of PCRE tables
6816d67a18Stron#	cidr_table(5), format of CIDR tables
6916d67a18Stron# README FILES
7016d67a18Stron# .ad
7116d67a18Stron# .fi
7216d67a18Stron#	Use "\fBpostconf readme_directory\fR" or
7316d67a18Stron#	"\fBpostconf html_directory\fR" to locate this information.
7416d67a18Stron# .na
7516d67a18Stron# .nf
7616d67a18Stron#	DATABASE_README, Postfix lookup table overview
7716d67a18Stron# BUGS
7816d67a18Stron#	The protocol limits are not yet configurable.
7916d67a18Stron# LICENSE
8016d67a18Stron# .ad
8116d67a18Stron# .fi
8216d67a18Stron#	The Secure Mailer license must be distributed with this software.
8316d67a18Stron# HISTORY
8416d67a18Stron#	Socketmap support was introduced with Postfix version 2.10.
8516d67a18Stron# AUTHOR(S)
8616d67a18Stron#	Wietse Venema
8716d67a18Stron#	IBM T.J. Watson Research
8816d67a18Stron#	P.O. Box 704
8916d67a18Stron#	Yorktown Heights, NY 10598, USA
90e262b48eSchristos#
91e262b48eSchristos#	Wietse Venema
92e262b48eSchristos#	Google, Inc.
93e262b48eSchristos#	111 8th Avenue
94e262b48eSchristos#	New York, NY 10011, USA
9516d67a18Stron#--
9616d67a18Stron
97