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