{ "content": [ { "type": "text", "text": "# proxymap (info)\n\n## NAME\n\nproxymap - Postfix lookup table proxy server\n\n## SYNOPSIS\n\nproxymap [generic Postfix daemon options]\n\n## DESCRIPTION\n\nThe proxymap(8) server provides read-only or read-write table lookup\nservice to Postfix processes. These services are implemented with dis-\ntinct service names: proxymap and proxywrite, respectively. The purpose\nof these services is:\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SERVER PROCESS MANAGEMENT**\n- **SECURITY**\n- **DIAGNOSTICS**\n- **BUGS**\n- **CONFIGURATION PARAMETERS**\n- **SEE ALSO**\n- **README FILES**\n- **LICENSE**\n- **HISTORY**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "proxymap", "section": "", "mode": "info", "summary": "proxymap - Postfix lookup table proxy server", "synopsis": "proxymap [generic Postfix daemon options]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "postconf", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/postconf/5/json" }, { "name": "master", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/master/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 76, "subsections": [] }, { "name": "SERVER PROCESS MANAGEMENT", "lines": 7, "subsections": [] }, { "name": "SECURITY", "lines": 24, "subsections": [] }, { "name": "DIAGNOSTICS", "lines": 2, "subsections": [] }, { "name": "BUGS", "lines": 11, "subsections": [] }, { "name": "CONFIGURATION PARAMETERS", "lines": 56, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "README FILES", "lines": 4, "subsections": [] }, { "name": "LICENSE", "lines": 2, "subsections": [] }, { "name": "HISTORY", "lines": 14, "subsections": [] } ], "sections": { "NAME": { "content": "proxymap - Postfix lookup table proxy server\n", "subsections": [] }, "SYNOPSIS": { "content": "proxymap [generic Postfix daemon options]\n", "subsections": [] }, "DESCRIPTION": { "content": "The proxymap(8) server provides read-only or read-write table lookup\nservice to Postfix processes. These services are implemented with dis-\ntinct service names: proxymap and proxywrite, respectively. The purpose\nof these services is:\n\no To overcome chroot restrictions. For example, a chrooted SMTP\nserver needs access to the system passwd file in order to reject\nmail for non-existent local addresses, but it is not practical\nto maintain a copy of the passwd file in the chroot jail. The\nsolution:\n\nlocalrecipientmaps =\nproxy:unix:passwd.byname $aliasmaps\n\no To consolidate the number of open lookup tables by sharing one\nopen table among multiple processes. For example, making mysql\nconnections from every Postfix daemon process results in \"too\nmany connections\" errors. The solution:\n\nvirtualaliasmaps =\nproxy:mysql:/etc/postfix/virtualalias.cf\n\nThe total number of connections is limited by the number of\nproxymap server processes.\n\no To provide single-updater functionality for lookup tables that\ndo not reliably support multiple writers (i.e. all file-based\ntables).\n\nThe proxymap(8) server implements the following requests:\n\nopen maptype:mapname flags\nOpen the table with type maptype and name mapname, as controlled\nby flags. The reply includes the maptype dependent flags (to\ndistinguish a fixed string table from a regular expression ta-\nble).\n\nlookup maptype:mapname flags key\nLook up the data stored under the requested key. The reply is\nthe request completion status code and the lookup result value.\nThe maptype:mapname and flags are the same as with the open re-\nquest.\n\nupdate maptype:mapname flags key value\nUpdate the data stored under the requested key. The reply is\nthe request completion status code. The maptype:mapname and\nflags are the same as with the open request.\n\nTo implement single-updater maps, specify a process limit of 1\nin the master.cf file entry for the proxywrite service.\n\nThis request is supported in Postfix 2.5 and later.\n\ndelete maptype:mapname flags key\nDelete the data stored under the requested key. The reply is\nthe request completion status code. The maptype:mapname and\nflags are the same as with the open request.\n\nThis request is supported in Postfix 2.5 and later.\n\nsequence maptype:mapname flags function\nIterate over the specified database. The function is one of\nDICTSEQFUNFIRST or DICTSEQFUNNEXT. The reply is the re-\nquest completion status code and a lookup key and result value,\nif found.\n\nThis request is supported in Postfix 2.9 and later.\n\nThe request completion status is one of OK, RETRY, NOKEY (lookup failed\nbecause the key was not found), BAD (malformed request) or DENY (the\ntable is not approved for proxy read or update access).\n\nThere is no close command, nor are tables implicitly closed when a\nclient disconnects. The purpose is to share tables among multiple\nclient processes.\n", "subsections": [] }, "SERVER PROCESS MANAGEMENT": { "content": "proxymap(8) servers run under control by the Postfix master(8) server.\nEach server can handle multiple simultaneous connections. When all\nservers are busy while a client connects, the master(8) creates a new\nproxymap(8) server process, provided that the process limit is not ex-\nceeded. Each server terminates after serving at least $maxuse clients\nor after $maxidle seconds of idle time.\n", "subsections": [] }, "SECURITY": { "content": "The proxymap(8) server opens only tables that are approved via the\nproxyreadmaps or proxywritemaps configuration parameters, does not\ntalk to users, and can run at fixed low privilege, chrooted or not.\nHowever, running the proxymap server chrooted severely limits usabil-\nity, because it can open only chrooted tables.\n\nThe proxymap(8) server is not a trusted daemon process, and must not be\nused to look up sensitive information such as UNIX user or group IDs,\nmailbox file/directory names or external commands.\n\nIn Postfix version 2.2 and later, the proxymap client recognizes re-\nquests to access a table for security-sensitive purposes, and opens the\ntable directly. This allows the same main.cf setting to be used by sen-\nsitive and non-sensitive processes.\n\nPostfix-writable data files should be stored under a dedicated direc-\ntory that is writable only by the Postfix mail system, such as the\nPostfix-owned datadirectory.\n\nIn particular, Postfix-writable files should never exist in root-owned\ndirectories. That would open up a particular type of security hole\nwhere ownership of a file or directory does not match the provider of\nits content.\n", "subsections": [] }, "DIAGNOSTICS": { "content": "Problems and transactions are logged to syslogd(8) or postlogd(8).\n", "subsections": [] }, "BUGS": { "content": "The proxymap(8) server provides service to multiple clients, and must\ntherefore not be used for tables that have high-latency lookups.\n\nThe proxymap(8) read-write service does not explicitly close lookup ta-\nbles (even if it did, this could not be relied on, because the process\nmay be terminated between table updates). The read-write service\nshould therefore not be used with tables that leave persistent storage\nin an inconsistent state between updates (for example, CDB). Tables\nthat support \"sync on update\" should be safe (for example, Berkeley DB)\nas should tables that are implemented by a real DBMS.\n", "subsections": [] }, "CONFIGURATION PARAMETERS": { "content": "On busy mail systems a long time may pass before proxymap(8) relevant\nchanges to main.cf are picked up. Use the command \"postfix reload\" to\nspeed up a change.\n\nThe text below provides only a parameter summary. See postconf(5) for\nmore details including examples.\n\nconfigdirectory (see 'postconf -d' output)\nThe default location of the Postfix main.cf and master.cf con-\nfiguration files.\n\ndatadirectory (see 'postconf -d' output)\nThe directory with Postfix-writable data files (for example:\ncaches, pseudo-random numbers).\n\ndaemontimeout (18000s)\nHow much time a Postfix daemon process may take to handle a re-\nquest before it is terminated by a built-in watchdog timer.\n\nipctimeout (3600s)\nThe time limit for sending or receiving information over an in-\nternal communication channel.\n\nmaxidle (100s)\nThe maximum amount of time that an idle Postfix daemon process\nwaits for an incoming connection before terminating voluntarily.\n\nmaxuse (100)\nThe maximal number of incoming connections that a Postfix daemon\nprocess will service before terminating voluntarily.\n\nprocessid (read-only)\nThe process ID of a Postfix command or daemon process.\n\nprocessname (read-only)\nThe process name of a Postfix command or daemon process.\n\nproxyreadmaps (see 'postconf -d' output)\nThe lookup tables that the proxymap(8) server is allowed to ac-\ncess for the read-only service.\n\nAvailable in Postfix 2.5 and later:\n\ndatadirectory (see 'postconf -d' output)\nThe directory with Postfix-writable data files (for example:\ncaches, pseudo-random numbers).\n\nproxywritemaps (see 'postconf -d' output)\nThe lookup tables that the proxymap(8) server is allowed to ac-\ncess for the read-write service.\n\nAvailable in Postfix 3.3 and later:\n\nservicename (read-only)\nThe master.cf service name of a Postfix daemon process.\n", "subsections": [] }, "SEE ALSO": { "content": "postconf(5), configuration parameters\nmaster(5), generic daemon options\n", "subsections": [] }, "README FILES": { "content": "Use \"postconf readmedirectory\" or \"postconf htmldirectory\" to locate\nthis information.\nDATABASEREADME, Postfix lookup table overview\n", "subsections": [] }, "LICENSE": { "content": "The Secure Mailer license must be distributed with this software.\n", "subsections": [] }, "HISTORY": { "content": "The proxymap service was introduced with Postfix 2.0.\n\nAUTHOR(S)\nWietse Venema\nIBM T.J. Watson Research\nP.O. Box 704\nYorktown Heights, NY 10598, USA\n\nWietse Venema\nGoogle, Inc.\n111 8th Avenue\nNew York, NY 10011, USA\n\nPROXYMAP(8postfix)", "subsections": [] } } } }