Page MenuHomePhorge
Files F117884610

No OneTemporary
Actions

Authored By
Unknown
Size
167 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/lib/imapoptions b/lib/imapoptions
index af999eaad..76094e2d8 100644
--- a/lib/imapoptions
+++ b/lib/imapoptions
@@ -1,2668 +1,2670 @@
# things inside of C comments get copied to the manpage
# things starting with # are ignored
/* .\" -*- nroff -*-
.TH IMAPD.CONF 5 "Project Cyrus" CMU
.\"
.\" Copyright (c) 1994-2008 Carnegie Mellon University. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. The name "Carnegie Mellon University" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission. For permission or any legal
.\" details, please contact
.\" Carnegie Mellon University
.\" Center for Technology Transfer and Enterprise Creation
.\" 4615 Forbes Avenue
.\" Suite 302
.\" Pittsburgh, PA 15213
.\" (412) 268-7393, fax: (412) 268-7395
.\" innovation@andrew.cmu.edu
.\"
.\" 4. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by Computing Services
.\" at Carnegie Mellon University (http://www.cmu.edu/computing/)."
.\"
.\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
.\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
.\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
.\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
.\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
.\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.SH NAME
imapd.conf \- IMAP configuration file
.SH DESCRIPTION
\fB/etc/imapd.conf\fR
is the configuration file for the Cyrus IMAP server. It defines
local parameters for IMAP.
.PP
Each line of the \fB/etc/imapd.conf\fR file has the form
.IP
\fIoption\fR: \fIvalue\fR
.PP
where \fIoption\fR is the name of the configuration option being set
and \fIvalue\fR is the value that the configuration option is being
set to.
.PP
Although there is no limit to the length of a line, a ``\\''
(backslash) character may be used as the last character on a line to
force it to continue on the next one. No additional whitespace is
inserted before or after the ``\\''. Note that a line that is split
using ``\\'' character(s) is still considered a single line.
For example
.IP
\fIoption\fR:\\
.br
.in +1
\fIvalue\fR1 \fIvalue\fR2 \\
.br
.in +1
\fIvalue\fR3
.PP
is equivalent to
.IP
\fIoption\fR: \fIvalue\fR1 \fIvalue\fR2 \fIvalue\fR3
.PP
Blank lines and lines beginning with ``#'' are ignored.
.PP
For boolean and enumerated options, the values ``yes'', ``on'', ``t'',
``true'' and ``1'' turn the option on, the values ``no'', ``off'',
``f'', ``false'' and ``0'' turn the option off.
.SH FIELD DESCRIPTIONS
.PP
The sections below detail options that can be placed in the
\fB/etc/imapd.conf\fR file, and show each option's default value.
Some options have no default value, these are listed with
``<no default>''. Some options default to the empty string, these
are listed with ``<none>''.
*/
# OPTIONS
{ "addressbookprefix", "#addressbooks", STRING }
/* The prefix for the addressbook mailboxes hierarchies. The hierarchy
delimiter will be automatically appended. The public addressbook
hierarchy will be at the toplevel of the shared namespace. A
user's personal addressbook hierarchy will be a child of their Inbox. */
{ "admins", "", STRING }
/* The list of userids with administrative rights. Separate each userid
with a space. Sites using Kerberos authentication may use
separate "admin" instances.
.PP
Note that accounts used by users should not be administrators.
Administrative accounts should not receive mail. That is, if user
"jbRo" is a user reading mail, he should not also be in the admins line.
Some problems may occur otherwise, most notably the ability of
administrators to create top-level mailboxes visible to users,
but not writable by users. */
{ "afspts_localrealms", NULL, STRING }
/* The list of realms which are to be treated as local, and thus stripped
during identifier canonicalization (for the AFSPTS ptloader module).
This is different from loginrealms in that it occurs later in the
authorization process (as the user id is canonified for PTS lookup) */
{ "afspts_mycell", NULL, STRING }
/* Cell to use for AFS PTS lookups. Defaults to the local cell. */
{ "allowallsubscribe", 0, SWITCH }
/* Allow subscription to nonexistent mailboxes. This option is
typically used on backend servers in a Murder so that users can
subscribe to mailboxes that don't reside on their "home" server.
This option can also be used as a workaround for IMAP clients which
don't play well with nonexistent or unselectable mailboxes (e.g.,
Microsoft Outlook). */
{ "allowanonymouslogin", 0, SWITCH }
/* Permit logins by the user "anonymous" using any password. Also
allows use of the SASL ANONYMOUS mechanism. */
{ "allowapop", 1, SWITCH }
/* Allow use of the POP3 APOP authentication command.
.PP
Note that this command requires that SASL is compiled with APOP
support, that the plaintext passwords are available in a SASL auxprop
backend (e.g., sasldb), and that the system can provide enough entropy
(e.g., from /dev/urandom) to create a challenge in the banner. */
{ "allownewnews", 0, SWITCH }
/* Allow use of the NNTP NEWNEWS command.
.PP
Note that this is a very expensive command and should only be
enabled when absolutely necessary. */
{ "allowplaintext", 0, SWITCH }
/* If enabled, allows the use of cleartext passwords on the wire.
.PP
By default, the use of cleartext passwords requires a TLS/SSL
encryption layer to be negotiated prior to any cleartext
authentication mechanisms being advertised or allowed. To require a
TLS/SSL encryption layer to be negotiated prior to ANY
authentication, see the \fItls_required\fR option. */
{ "allowusermoves", 0, SWITCH }
/* Allow moving user accounts (with associated meta-data) via RENAME
or XFER.
.PP
Note that measures should be taken to make sure that the user being
moved is not logged in, and cannot login during the move. Failure
to do so may result in the user's meta-data (seen state,
subscriptions, etc) being corrupted or out of date. */
{ "altnamespace", 1, SWITCH }
/* Use the alternate IMAP namespace, where personal folders reside at the
same level in the hierarchy as INBOX.
.PP
This option ONLY applies where interaction takes place with the
client/user. Currently this is limited to the IMAP protocol (imapd)
and Sieve scripts (lmtpd). This option does NOT apply to admin tools
such as cyradm (admins ONLY), reconstruct, quota, etc., NOR does it
affect LMTP delivery of messages directly to mailboxes via
plus-addressing. The default changed in 3.0 from off to on. */
{ "altprefix", "Alt Folders", STRING }
/* Alternative INBOX spellings that can't be accessed in altnamespace
otherwise go under here */
{ "annotation_db", "twoskip", STRINGLIST("skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for mailbox annotations. */
{ "annotation_db_path", NULL, STRING }
/* The absolute path to the annotations db file. If not specified,
will be configdirectory/annotations.db */
{ "anyoneuseracl", 1, SWITCH }
/* Should non-admin users be allowed to set ACLs for the 'anyone'
user on their mailboxes? In a large organization this can cause
support problems, but it's enabled by default. */
{ "annotation_allow_undefined", 0, SWITCH }
/* Allow clients to store values for entries which are not
defined either by Cyrus or in the annotations_definitions
file. */
{ "annotation_definitions", NULL, STRING }
/* File containing external (third-party) annotation definitions.
.PP
Each line of the file specifies the properties of an annotation and
has the following form:
.IP
\fIname\fR, \fIscope\fR, \fIattrib-type\fR, \fIproxy-type\fR,
\fIattrib-names\fR, \fIacl\fR
.\"
.IP \fIname\fR 5
is the hierarchical name as in RFC 5257 or RFC 5464 (in the latter case,
without the leading \fB/shared\fR or \fB/private\fR). For example,
/vendor/acme/blurdybloop.
.\"
.IP \fIscope\fR 5
specifies whether the annotation is for the \fBserver\fR, a
\fBmailbox\fR, or a \fBmessage\fR.
.\"
.IP \fIattrib-type\fR 5
.RS 5
specifies the attribute data type, which is used only to check the
string value passed by clients when setting annotations. The
\fIattrib-type\fR is one of:
.\"
.IP \fBstring\fR 5
any value is accepted.
.\"
.IP \fBcontent-type\fR 5
this obsolete data type, which was useful for early drafts of the standard,
is accepted but silently translated to \fBstring\fR.
.\"
.IP \fBboolean\fR 5
only the strings "true" or "false" are accepted. Checking is
case-insensitive but the value is forced to lowercase.
.\"
.IP \fBint\fR 5
integers are accepted.
.\"
.IP \fBuint\fR 5
non-negative integers are accepted.
.\"
.RE
.\"
.IP \fIproxy-type\fR 5
specifies whether this attribute is for the \fBbackend\fR or
\fBproxy\fR servers or both (\fBproxy_and_backend\fR)
.\"
.IP \fIattrib-names\fR 5
is the space-separated list of available attributes for the
annotation. Possible attribute names are \fBvalue.shared\fR,
\fBvalue.priv\fR, and \fBvalue\fR (which permits both \fBvalue.priv\fR
and \fBvalue.shared\fR). The attribute names \fBsize\fR,
\fBsize.shared\fR, and \fBsize.priv\fR are accepted but ignored; these
attributes are automatically provided by the server if the corresponding
\fBvalue\fR attribute is specified. Some obsolete attributes, which were
defined early drafts of the standard, are accepted and ignored with a
warning.
.\"
.IP \fIextra-permissions\fR 5
is the extra ACL permission bits required for setting this annotation, in
standard IMAP ACL permission bit string format. Note that this is
in addition to the permission bits specified in RFC 5257 and RFC 5464,
so leaving this field empty is harmless. Note also that there is no way
to specify that an annotation can only be set by an admin user; in
particular the \fBa\fP permission bit does not achieve this.
.PP
Blank lines and lines beginning with ``#'' are ignored.
*/
{ "annotation_callout", NULL, STRING }
/* The pathname of a callout to be used to automatically add annotations
or flags to a message when it is appended to a mailbox. The path can
be either an executable (including a script), or a UNIX domain
socket. */
{ "annotation_callout_disable_append", 0, SWITCH }
/* Disables annotations on append with xrunannotator */
{ "annotation_enable_legacy_commands", 0, SWITCH }
/* Whether to enable the legacy GETANNOTATION/SETANNOTATION commands.
These commands are deprecated and will be removed in the future,
but might be useful in the meantime for supporting old clients that
do not implement the RFC5464 IMAP METADATA extension. */
{ "aps_topic", NULL, STRING }
/* Topic for Apple Push Service registration. */
{ "aps_topic_caldav", NULL, STRING }
/* Topic for Apple Push Service registration for CalDAV. */
{ "aps_topic_carddav", NULL, STRING }
/* Topic for Apple Push Service registration for CardDAV. */
{ "archive_enabled", 0, SWITCH }
/* Is archiving enabled for this server. You also need to have an
archivepartition for the mailbox. Archiving allows older email
to be stored on slower, cheaper disks - even within the same
mailbox, as distinct from partitions. */
{ "archive_days", 7, INT }
/* The number of days after which to move messages to the archive partition
if archiving is enabled */
{ "archive_maxsize", 1024, INT }
/* The size in kilobytes of the largest message that won't be archived
immediately. Default is 1Mb */
{ "archive_keepflagged", 0, SWITCH }
/* If set, messages with the \\Flagged system flag won't be archived,
provided they are smaller than \fBarchive_maxsize\fR. */
# Commented out - there's no such thing as "archivepartition-name",
# but we need this for the man page
# { "archivepartition-name", NULL, STRING }
/* The pathname of the archive partition \fIname\fR, corresponding to
spool partition \fBpartition-name\fR. For any mailbox residing in
a directory on \fBpartition-name\fR, the archived messages will be
stored in a corresponding directory on \fBarchivepartition-name\fR.
Note that not every \fBpartition-name\fR option is strictly required
to have a corresponding \fBarchivepartition-name\fR option, but that
without one there's no benefit to enabling archiving. */
{ "auditlog", 0, SWITCH }
/* Should cyrus output log entries for every action taken on a message
file or mailboxes list entry? It's noisy so disabled by default, but
can be very useful for tracking down what happened if things look strange */
{ "auth_mech", "unix", STRINGLIST("unix", "pts", "krb", "krb5")}
/* The authorization mechanism to use. */
{ "autocreateinboxfolders", NULL, STRING, "2.5.0", "autocreate_inbox_folders" }
/* Deprecated in favor of \fIautocreate_inbox_folders\fR. */
{ "autocreatequota", 0, INT, "2.5.0", "autocreate_quota" }
/* Deprecated in favor of \fIautocreate_quota\fR. */
{ "autocreatequotamsg", -1, INT, "2.5.0", "autocreate_quota_messages" }
/* Deprecated in favor of \fIautocreate_quota_messages\fR. */
{ "autosievefolders", NULL, STRING, "2.5.0", "autocreate_sieve_folders" }
/* Deprecated in favor of \fIautocreate_sieve_folders\fR. */
{ "generate_compiled_sieve_script", 0, SWITCH, "2.5.0", "autocreate_sieve_script_compile" }
/* Deprecated in favor of \fIautocreate_sieve_script_compile\fR. */
{ "autocreate_sieve_compiled_script", NULL, STRING, "2.5.0", "autocreate_sieve_script_compiled" }
/* Deprecated in favor of \fIautocreate_sieve_script_compiled\fR. */
{ "autosubscribeinboxfolders", NULL, STRING, "2.5.0", "autocreate_subscribe_folders" }
/* Deprecated in favor of \fIautocreate_subscribe_folders\fR. */
{ "autosubscribesharedfolders", NULL, STRING, "2.5.0", "autocreate_subscribe_sharedfolders" }
/* Deprecated in favor of \fIautocreate_subscribe_sharedfolders\fR. */
{ "autosubscribe_all_sharedfolders", 0, SWITCH, "2.5.0", "autocreate_subscribe_sharedfolders_all" }
/* Deprecated in favor of \fIautocreate_subscribe_sharedfolders_all\fR. */
{ "autocreate_inbox_folders", NULL, STRING }
/* If a user does not have an INBOX already, and the INBOX is to be
created, create the list of folders in this setting as well.
\fIautocreate_inbox_folders\fR is a list of INBOX's subfolders
separated by a "|", that are automatically created by the server
under the following two scenarios. Leading and trailing whitespace is
stripped, so "Junk | Trash" results in two folders: "Junk" and
"Trash". See also the \fIxlist-flag\fR option, for setting
special-use flags on autocreated folders.
.PP
INBOX folders are created under both the following conditions:
.\"
.IP 1.
The user logins via the IMAP or the POP3 protocol.
\fIautocreate_quota\fR option must have a value of zero or greater.
.\"
.IP 2.
A message arrives for the user through the \fIlmtpd(8)\fR.
\fIautocreate_post\fR option must be enabled.
.PP
*/
{ "autocreate_post", 0, SWITCH }
/* If enabled, when \fIlmtpd(8)\fR receives an incoming mail for an
INBOX that does not exist, then the INBOX is automatically created
by \fIlmtpd(8)\fR and delivery of the message continues. */
{ "autocreate_quota", -1, INT }
/* If set to a value of zero or higher, users have their INBOX folders
created upon a successful login event or upon \fIlmtpd(8)\fR
message delivery if \fIautocreate_post\fR is enabled, provided their
INBOX did not yet already exist.
.PP
The user's quota is set to the value if it is greater than zero,
otherwise the user has unlimited quota.
.PP
Note that quota is specified in kilobytes. */
{ "autocreate_quota_messages", -1, INT }
/* If set to a value of zero or higher, users who have their INBOX
folders created upon a successful login event (see
\fIautocreate_quota\fR), or upon \fIlmtpd(8)\fR message delivery if
\fIautocreate_post\fR is enabled, receive the message quota
configured in this option.
.PP
The default of -1 disables assigning message quota.
.PP
For consistency with \fIautocreate_quota\fR, a value of zero is treated
as unlimited message quota, rather than a message quota of zero. */
{ "autocreate_sieve_folders", NULL, STRING }
/* A "|" separated list of subfolders of INBOX that will be
automatically created, if requested by a sieve filter, through the
"fileinto" action. The default is to create no folders
automatically.
.PP
Leading and trailing whitespace is stripped from each folder, so a
setting of "Junk | Trash" will create two folders: "Junk" and
"Trash". */
{ "autocreate_sieve_script", NULL, STRING }
/* The full path of a file that contains a sieve script. This script
automatically becomes a user's initial default sieve filter script.
.PP
When this option is not defined, no default sieve filter is created.
The file must be readable by the Cyrus daemon. */
{ "autocreate_sieve_script_compile", 0, SWITCH }
/* If set to yes and no compiled sieve script file exists, the sieve script which is
compiled on the fly will be saved in the file name that autocreate_sieve_compiledscript
option points to. In order a compiled script to be generated, autocreate_sieve_script and
autocreate_sieve_compiledscript must have valid values */
{ "autocreate_sieve_script_compiled", NULL, STRING }
/* The full path of a file that contains a compiled in bytecode sieve script. This script
automatically becomes a user's initial default sieve filter script. If this option is
not specified, or the filename doesn't exist then the script defined by
autocreate_sieve_script is compiled on the fly and installed as the user's default
sieve script */
{ "autocreate_subscribe_folders", NULL, STRING }
/* A list of folder names, separated by "|", that the users get automatically subscribed to,
when their INBOX is created. These folder names must have been included in the
autocreateinboxfolders option of the imapd.conf. */
{ "autocreate_subscribe_sharedfolders", NULL, STRING }
/* A list of shared folders (bulletin boards), separated by "|", that the users get
automatically subscribed to, after their INBOX is created. The shared folder must
have been created and the user must have the required permissions to get subscribed
to it. Otherwise, subscribing to the shared folder fails. */
{ "autocreate_subscribe_sharedfolders_all", 0, SWITCH }
/* If set to yes, the user is automatically subscribed to all shared folders, one has permission
to subscribe to. */
{ "autocreate_users", "anyone", STRING }
/* A space separated list of users and/or groups that are allowed their INBOX to be
automatically created. */
# Commented out - there's no such thing as "backuppartition-name",
# but we need this for the man page
# { "backuppartition-name", NULL, STRING }
/* The pathname of the backup partition \fIname\fR. At least one backup
partition pathname MUST be specified if backups are in use. Note that
there is no relationship between spool partitions and backup partitions. */
{ "backup_compact_minsize", 0, INT }
/* The minimum size in kilobytes of chunks in each backup. The compact tool
will try to combine adjacent chunks that are smaller than this.
.PP
Setting this value to zero or negative disables combining of chunks. */
{ "backup_compact_maxsize", 0, INT }
/* The maximum size in kilobytes of chunks in each backup. The compact tool
will try to split chunks larger than this into smaller chunks.
.PP
Setting this value to zero or negative disables splitting of chunks. */
{ "backup_compact_work_threshold", 1, INT }
/* The number of chunks that must obviously need compaction before the compact
tool will go ahead with the compaction. If set to less than one, the value
is treated as being one. */
{ "backup_staging_path", NULL, STRING }
/* The absolute path of the backup staging area. If not specified,
will be temp_path/backup */
{ "backup_retention_days", 7, INT }
/* The number of days to keep content in backup after it has been deleted
from the source. If set to a negative value or zero, deleted content
will be kept indefinitely. */
{ "backup_db", "twoskip", STRINGLIST("skiplist", "sql", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the backup locations database. */
{ "backup_db_path", NULL, STRING }
/* The absolute path to the backup db file. If not specified,
will be configdirectory/backups.db */
{ "backup_keep_previous", 0, SWITCH }
/* Whether the \fBctl_backups compact\fR and \fBctl_backups reindex\fR
commands should preserve the original file. The original file will
be named with a timestamped suffix. This is mostly useful for
debugging.
.PP
Note that with this enabled, compacting a backup will actually
increase the disk used by it (because there will now be an extra
copy: the original version, and the compacted version). */
{ "boundary_limit", 1000, INT }
/* messages are parsed recursively and a deep enough MIME structure
can cause a stack overflow. Do not parse deeper than this many
layers of MIME structure. The default of 1000 is much higher
than any sane message should have. */
{ "caldav_allowattach", 1, SWITCH }
/* Enable managed attachments support on the CalDAV server. */
{ "caldav_allowcalendaradmin", 0, SWITCH }
/* Enable per-user calendar administration web UI on the CalDAV server. */
{ "caldav_allowscheduling", "on", ENUM("off", "on", "apple") }
/* Enable calendar scheduling operations. If set to "apple", the
server will emulate Apple CalendarServer behavior as closely as
possible. */
{ "caldav_create_attach", 1, SWITCH }
/* Create the 'Attachments' collection if it doesn't already exist */
{ "caldav_create_default", 1, SWITCH }
/* Create the 'Default' calendar if it doesn't already exist */
{ "caldav_create_sched", 1, SWITCH }
/* Create the 'Inbox' and 'Outbox' calendars if they don't already exist */
{ "caldav_historical_age", 7, INT }
/* Number of days after an occurrence of event or task has concluded
that it is considered 'historical'. Changes to historical
occurrences of events or tasks WILL NOT have invite or reply
messages sent for them. A value less than zero means that events
and tasks are NEVER considered historical. */
{ "caldav_maxdatetime", "20380119T031407Z", STRING }
/* The latest date and time accepted by the server (ISO format). This
value is also used for expanding non-terminating recurrence rules.
.PP
Note that increasing this value will require the DAV databases for
calendars to be reconstructed with the \fBdav_reconstruct\fR
utility in order to see its effect on serer-side time-based
queries. */
{ "caldav_mindatetime", "19011213T204552Z", STRING }
/* The earliest date and time accepted by the server (ISO format). */
{ "caldav_realm", NULL, STRING }
/* The realm to present for HTTP authentication of CalDAV resources.
If not set (the default), the value of the "servername" option will
be used.*/
{ "calendarprefix", "#calendars", STRING }
/* The prefix for the calendar mailboxes hierarchies. The hierarchy
delimiter will be automatically appended. The public calendar
hierarchy will be at the toplevel of the shared namespace. A
user's personal calendar hierarchy will be a child of their Inbox. */
{ "calendar_user_address_set", NULL, STRING }
/* Space-separated list of domains corresponding to calendar user
addresses for which the server is responsible. If not set (the
default), the value of the "servername" option will be used. */
{ "carddav_allowaddmember", 0, SWITCH }
/* Enable support for POST add-member on the CardDAV server. */
{ "carddav_allowaddressbookadmin", 0, SWITCH }
/* Enable per-user addressbook administration web UI on the CardDAV server. */
{ "carddav_realm", NULL, STRING }
/* The realm to present for HTTP authentication of CardDAV resources.
If not set (the default), the value of the "servername" option will
be used.*/
{ "carddav_repair_vcard", 0, SWITCH }
/* If enabled, VCARDs with invalid content are attempted to be repaired
during creation. */
{ "chatty", 0, SWITCH }
/* If yes, syslog tags and commands for every IMAP command, mailboxes
for every lmtp connection, every POP3 command, etc */
{ "client_bind", 0, SWITCH }
/* If enabled, a specific IP will be bound when performing a client
connection. \fBclient_bind_name\fR is used if it is set, otherwise
\fBservername\fR is used. This is useful on multi-homed servers where
Cyrus should not use other services' interfaces.
.PP
If not enabled (the default), no bind will be performed. Client
connections will use an IP chosen by the operating system. */
{ "client_bind_name", NULL, STRING }
/* IPv4, IPv6 address or hostname to bind for client connections when
\fBclient_bind\fR is enabled. If not set (the default),
\fRservername\fR will be used. */
{ "client_timeout", 10, INT }
/* Number of seconds to wait before returning a timeout failure when
performing a client connection (e.g., in a murder environment) */
{ "commandmintimer", NULL, STRING }
/* Time in seconds. Any imap command that takes longer than this
time is logged. */
{ "configdirectory", NULL, STRING }
/* The pathname of the IMAP configuration directory. This field is
required. */
{ "createonpost", 0, SWITCH, "2.5.0", "autocreate_post" }
/* Deprecated in favor of \fIautocreate_post\fR. */
{ "conversations", 0, SWITCH }
/* Enable the XCONVERSATIONS extensions. Extract conversation
tracking information from incoming messages and track them
in per-user databases. */
{ "conversations_counted_flags", NULL, STRING }
/* space-separated list of flags for which per-conversation counts
will be kept. Note that you need to reconstruct the conversations
database with ctl_conversationsdb if you change this option on a
running server, or the counts will be wrong. */
{ "conversations_db", "skiplist", STRINGLIST("skiplist", "sql", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the per-user conversations database. */
{ "conversations_expire_days", 90, INT }
/* How long the conversations database keeps the message tracking
information needed for receiving new messages in existing
conversations, in days. */
{ "conversations_max_thread", 100, INT }
/* maximum size for a single thread. Threads will split if they have this many
* messages in them and another message arrives */
{ "crossdomains", 0, SWITCH }
/* Enable cross domain sharing. This works best with alt namespace and
unix hierarchy separators on, so you get Other Users/foo@example.com/... */
{ "crossdomains_onlyother", 0, SWITCH }
/* only show the domain for users in other domains than your own (for
backwards compatibility if you're already sharing */
{ "cyrus_user", NULL, STRING }
/* The username to use as the 'cyrus' user. If not configured, the compile
time default will be used. Can be further overridden by setting the
$CYRUS_USER environment variable. */
{ "davdriveprefix", "#drive", STRING }
/* The prefix for the DAV storage mailboxes hierarchies. The hierarchy
delimiter will be automatically appended. The public storage
hierarchy will be at the toplevel of the shared namespace. A
user's personal storage hierarchy will be a child of their Inbox. */
{ "davnotificationsprefix", "#notifications", STRING }
/* The prefix for the DAV notifications hierarchy. The hierarchy
delimiter will be automatically appended. The public notifications
hierarchy will be at the toplevel of the shared namespace. A
user's personal notifications hierarchy will be a child of their Inbox. */
{ "dav_realm", NULL, STRING }
/* The realm to present for HTTP authentication of generic DAV
resources (principals). If not set (the default), the value of the
"servername" option will be used.*/
{ "dav_lock_timeout", 20, INT }
/* The maximum time in seconds to wait for a write lock on the per-user
DAV database before timeout. For HTTP requests, the HTTP status code
503 is returned if the lock can not be obtained within this time. */
{ "debug_command", NULL, STRING }
/* Debug command to be used by processes started with -D option. The string
is a C format string that gets 3 options: the first is the name of the
executable (as specified in the cmd parameter in cyrus.conf). The second
is the pid (integer) and the third is the service ID.
Example: /usr/local/bin/gdb /usr/cyrus/bin/%s %d */
{ "defaultacl", "anyone lrs", STRING }
/* The Access Control List (ACL) placed on a newly-created (non-user)
mailbox that does not have a parent mailbox. */
{ "defaultdomain", "internal", STRING }
/* The default domain for virtual domain support */
{ "defaultpartition", NULL, STRING }
/* The partition name used by default for new mailboxes. If not
specified, the partition with the most free space will be used for
new mailboxes.
.PP
Note that the partition specified by this option must also be
specified as \fIpartition-name\fR, where you substitute 'name'
for the alphanumeric string you set \fIdefaultpartition\fR to. */
{ "defaultsearchtier", "", STRING }
/* Name of the default tier that messages will be indexed to. Search
indexes can be organized in tiers to allow index storage in different
directories and physical media. See the man page of squatter for
details. The default search tier also requires the definition
of an according \fIsearchtierpartition-name\fR entry.
.PP
This option MUST be specified for xapian search. */
{ "defaultserver", NULL, STRING }
/* The backend server name used by default for new mailboxes. If not
specified, the server with the most free space will be used for new
mailboxes. */
{ "deletedprefix", "DELETED", STRING }
/* With \fBdelete_mode\fR set to \fIdelayed\fR, the
\fBdeletedprefix\fR setting defines the prefix for the hierarchy of
deleted mailboxes.
.PP
The hierarchy delimiter will be automatically appended.
*/
{ "delete_mode", "delayed", ENUM("immediate", "delayed") }
/* The manner in which mailboxes are deleted. In the default
\fIdelayed\fR mode, mailboxes that are being deleted are renamed to
a special mailbox hierarchy under the \fBdeletedprefix\fR, to be
removed later by \fBcyr_expire(8)\fR.
.PP
In \fIimmediate\fR mode, the mailbox is removed from the filesystem
immediately.
*/
{ "delete_unsubscribe", 0, SWITCH }
/* Whether to also unsubscribe from mailboxes when they are deleted.
Note that this behaviour contravenes RFC 3501 section 6.3.9, but
may be useful for avoiding user/client software confusion.
The default is 'no'. */
{ "deleteright", "c", STRING }
/* Deprecated - only used for backwards compatibility with existing
installations. Lists the old RFC 2086 right which was used to
grant the user the ability to delete a mailbox. If a user has this
right, they will automatically be given the new 'x' right. */
{ "disable_user_namespace", 0, SWITCH }
/* Preclude list command on user namespace. If set to 'yes', the
LIST response will never include any other user's mailbox. Admin
users will always see all mailboxes. The default is 'no' */
{ "disable_shared_namespace", 0, SWITCH }
/* Preclude list command on shared namespace. If set to 'yes', the
LIST response will never include any non-user mailboxes. Admin
users will always see all mailboxes. The default is 'no' */
{ "disconnect_on_vanished_mailbox", 0, SWITCH }
/* If enabled, IMAP/POP3/NNTP clients will be disconnected by the
server if the currently selected mailbox is (re)moved by another
session. Otherwise, the missing mailbox is treated as empty while
in use by the client.*/
{ "ischedule_dkim_domain", NULL, STRING }
/* The domain to be reported as doing iSchedule DKIM signing. */
{ "ischedule_dkim_key_file", NULL, STRING }
/* File containing the private key for iSchedule DKIM signing. */
{ "ischedule_dkim_required", 1, SWITCH }
/* A DKIM signature is required on received iSchedule requests. */
{ "ischedule_dkim_selector", NULL, STRING }
/* Name of the selector subdividing the domain namespace. This
specifies the actual key used for iSchedule DKIM signing within the
domain. */
{ "duplicate_db", "twoskip", STRINGLIST("skiplist", "sql", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the duplicate delivery suppression
and sieve. */
{ "duplicate_db_path", NULL, STRING }
/* The absolute path to the duplicate db file. If not specified,
will be configdirectory/deliver.db */
{ "duplicatesuppression", 1, SWITCH }
/* If enabled, lmtpd will suppress delivery of a message to a mailbox if
a message with the same message-id (or resent-message-id) is recorded
as having already been delivered to the mailbox. Records the mailbox
and message-id/resent-message-id of all successful deliveries. */
{ "event_content_inclusion_mode", "standard", ENUM("standard", "message", "header", "body", "headerbody") }
/* The mode in which message content may be included with MessageAppend and
MessageNew. "standard" mode is the default behavior in which message is
included up to a size with the notification. In "message" mode, the message
is included and may be truncated to a size. In "header" mode, it includes
headers truncated to a size. In "body" mode, it includes body truncated
to a size. In "headerbody" mode, it includes full headers and body truncated
to a size */
{ "event_content_size", 0, INT }
/* Truncate the message content that may be included with MessageAppend and
MessageNew. Set 0 to include the entire message itself */
{ "event_exclude_flags", NULL, STRING }
/* Don't send event notification for given IMAP flag(s) */
{ "event_exclude_specialuse", "\\Junk", STRING }
/* Don't send event notification for folder with given special-use attributes.
Set ALL for any folder */
{ "event_extra_params", "timestamp", BITFIELD("bodyStructure", "clientAddress", "diskUsed", "flagNames", "messageContent", "messageSize", "messages", "modseq", "service", "timestamp", "uidnext", "vnd.cmu.midset", "vnd.cmu.unseenMessages", "vnd.cmu.envelope", "vnd.cmu.sessionId", "vnd.cmu.mailboxACL", "vnd.cmu.mbtype", "vnd.cmu.davFilename", "vnd.cmu.davUid", "vnd.fastmail.clientId", "vnd.fastmail.sessionId", "vnd.fastmail.convExists", "vnd.fastmail.convUnseen", "vnd.fastmail.cid", "vnd.fastmail.counters", "vnd.cmu.emailid", "vnd.cmu.threadid") }
/* Space-separated list of extra parameters to add to any appropriated event. */
{ "event_groups", "message mailbox", BITFIELD("message", "quota", "flags", "access", "mailbox", "subscription", "calendar", "applepushservice" ) }
/* Space-separated list of groups of related events to turn on notification */
{ "event_notifier", NULL, STRING }
/* Notifyd(8) method to use for "EVENT" notifications which are based on
the RFC 5423. If not set, "EVENT" notifications are disabled. */
{ "expunge_mode", "delayed", ENUM("immediate", "semidelayed", "delayed") }
/* The mode in which messages (and their corresponding cache entries)
are expunged. "semidelayed" mode is the old behavior in which the
message files are purged at the time of the EXPUNGE, but index
and cache records are retained to facilitate QRESYNC.
In "delayed" mode, which is the default since Cyrus 2.5.0,
the message files are also retained, allowing unexpunge to
rescue them. In "immediate" mode, both the message files and the
index records are removed as soon as possible. In all cases,
nothing will be finally purged until all other processes have
closed the mailbox to ensure they never see data disappear under
them. In "semidelayed" or "delayed" mode, a later run of "cyr_expire"
will clean out the retained records (and possibly message files).
This reduces the amount of I/O that takes place at the time of
EXPUNGE and should result in greater responsiveness for the client,
especially when expunging a large number of messages. */
{ "failedloginpause", 3, INT }
/* Number of seconds to pause after a failed login. */
{ "flushseenstate", 1, SWITCH, "2.5.0" }
/* Deprecated. No longer used */
{ "foolstupidclients", 0, SWITCH }
/* If enabled, only list the personal namespace when a LIST "*" is performed
(it changes the request to a LIST "INBOX*"). */
{ "force_sasl_client_mech", NULL, STRING }
/* Force preference of a given SASL mechanism for client side operations
(e.g., murder environments). This is separate from (and overridden by)
the ability to use the <host shortname>_mechs option to set preferred
mechanisms for a specific host */
{ "fulldirhash", 0, SWITCH }
/* If enabled, uses an improved directory hashing scheme which hashes
on the entire username instead of using just the first letter as
the hash. This changes hash algorithm used for quota and user
directories and if \fIhashimapspool\fR is enabled, the entire mail
spool.
.PP
Note that this option CANNOT be changed on a live system. The
server must be quiesced and then the directories moved with the
\fBrehash\fR utility. */
{ "hashimapspool", 0, SWITCH }
/* If enabled, the partitions will also be hashed, in addition to the
hashing done on configuration directories. This is recommended if
one partition has a very bushy mailbox tree. */
{ "debug", 0, SWITCH }
/* If enabled, allow syslog() to pass LOG_DEBUG messages. */
# Commented out - there's no such thing as "hostname_mechs", but we need
# this for the man page
# { "hostname_mechs", NULL, STRING }
/* Force a particular list of SASL mechanisms to be used when authenticating
to the backend server hostname (where hostname is the short hostname of
the server in question). If it is not specified it will query the server
for available mechanisms and pick one to use. - Cyrus Murder */
# Commented out - there's no such thing as "hostname_password", but we need
# this for the man page
# { "hostname_password", NULL, STRING }
/* The password to use for authentication to the backend server hostname
(where hostname is the short hostname of the server) - Cyrus Murder */
{ "httpallowcompress", 1, SWITCH }
/* If enabled, the server will compress response payloads if the client
indicates that it can accept them. Note that the compressed data
will appear in telemetry logs, leaving only the response headers as
human-readable.*/
{ "httpallowcors", NULL, STRING }
/* A wildmat pattern specifying a list of origin URIs ( scheme "://"
host [ ":" port ] ) that are allowed to make Cross-Origin Resource
Sharing (CORS) requests on the server. By default, CORS requests
are disabled.
.PP
Note that the scheme and host should both be lowercase, the port
should be omitted if using the default for the scheme (80 for http,
443 for https), and there should be no trailing '/' (e.g.:
"http://www.example.com:8080", "https://example.org"). */
{ "httpallowtrace", 0, SWITCH }
/* Allow use of the TRACE method.
.PP
Note that sensitive data might be disclosed by the response. */
{ "httpallowedurls", NULL, STRING }
/* Space-separated list of relative URLs (paths) rooted at
"httpdocroot" (see below) to be served by httpd. If set, this
option will limit served static content to only those paths specified
(returning "404 Not Found" to any other client requested URLs).
Otherwise, httpd will serve any content found in "httpdocroot".
.PP
Note that any path specified by "rss_feedlist_template" is an
exception to this rule.*/
{ "httpcontentmd5", 0, SWITCH }
/* If enabled, HTTP responses will include a Content-MD5 header for
the purpose of providing an end-to-end message integrity check
(MIC) of the payload body. Note that enabling this option will
use additional CPU to generate the MD5 digest, which may be ignored
by clients anyways. */
{ "httpdocroot", NULL, STRING }
/* If set, http will serve the static content (html/text/jpeg/gif
files, etc) rooted at this directory. Otherwise, httpd will not
serve any static content. */
{ "httpkeepalive", 20, INT }
/* Set the length of the HTTP server's keepalive heartbeat in seconds.
The default is 20. The minimum value is 0, which will disable the
keepalive heartbeat. When enabled, if a request takes longer than
\fIhttpkeepalive\fR seconds to process, the server will send the client
provisional responses every \fIhttpkeepalive\fR seconds until the
final response can be sent */
{ "httpmodules", "", BITFIELD("admin", "caldav", "carddav", "domainkey", "freebusy", "ischedule", "jmap", "prometheus", "rss", "tzdist", "webdav") }
/* Space-separated list of HTTP modules that will be enabled in
httpd(8). This option has no effect on modules that are disabled
at compile time due to missing dependencies (e.g. libical).
.PP
Note that "domainkey" depends on "ischedule" being enabled, and
that both "freebusy" and "ischedule" depend on "caldav" being
enabled. */
{ "httpprettytelemetry", 0, SWITCH }
/* If enabled, HTTP response payloads including server-generated
markup languages (HTML, XML) will utilize line breaks and
indentation to promote better human-readability in telemetry logs.
Note that enabling this option will increase the amount of data
sent across the wire. */
{ "httptimeout", 5, INT }
/* Set the length of the HTTP server's inactivity autologout timer,
in minutes. The default is 5. The minimum value is 0, which will
disable persistent connections. */
{ "idlesocket", "{configdirectory}/socket/idle", STRING }
/* Unix domain socket that idled listens on. */
{ "ignorereference", 0, SWITCH }
/* For backwards compatibility with Cyrus 1.5.10 and earlier -- ignore
the reference argument in LIST or LSUB commands. */
{ "imapidlepoll", 60, INT }
/* The interval (in seconds) for polling for mailbox changes and
ALERTs while running the IDLE command. This option is used when
idled is not enabled or cannot be contacted. The minimum value is
1. A value of 0 will disable IDLE. */
{ "imapidresponse", 1, SWITCH }
/* If enabled, the server responds to an ID command with a parameter
list containing: version, vendor, support-url, os, os-version,
command, arguments, environment. Otherwise the server returns NIL. */
{ "imapmagicplus", 0, SWITCH }
/* Only list a restricted set of mailboxes via IMAP by using
userid+namespace syntax as the authentication/authorization id.
Using userid+ (with an empty namespace) will list only subscribed
mailboxes. */
{ "imipnotifier", NULL, STRING }
/* Notifyd(8) method to use for "IMIP" notifications which are based on
the RFC 6047. If not set, "IMIP" notifications are disabled. */
{ "implicit_owner_rights", "lkxan", STRING }
/* The implicit Access Control List (ACL) for the owner of a mailbox. */
# Commented out - there's no such thing as "@include", but we need
# this for the man page
# { "@include", NULL, STRING }
/* Directive which includes the specified file as part of the
configuration. If the path to the file is not absolute, CYRUS_PATH
is prepended. */
{ "improved_mboxlist_sort", 0, SWITCH }
/* If enabled, a special comparator will be used which will correctly
sort mailbox names that contain characters such as ' ' and '-'.
.PP
Note that this option SHOULD NOT be changed on a live system. The
mailboxes database should be dumped (ctl_mboxlist) before the
option is changed, removed, and then undumped after changing the
option. When not using flat files for the subscriptions databases
the same has to be done (cyr_dbtool) for each subscription database
See improved_mboxlist_sort.html.*/
{ "jmap_emailsearch_db_path", NULL, STRING }
/* The absolute path to the JMAP email search cache file. If not
specified, JMAP Email/query and Email/queryChanges will not
cache email search results. */
{ "jmap_preview_annot", NULL, STRING }
/* The name of the per-message annotation, if any, to store message
previews. */
{ "jmap_imagesize_annot", NULL, STRING }
/* The name of the per-message annotation, if any, that stores a
JSON object, mapping message part numbers of MIME image types
to an array of their image dimensions. The array must have at
least two entries, where the first entry denotes the width
and the second entry the height of the image. Any additional
values are ignored.
For example, if message part 1.2 contains an image of width 300
and height 200, then the value of this annotation would be:
{ "1.2" : [ 300, 200 ] }
*/
{ "jmap_inlinedcids_annot", NULL, STRING }
/* The name of the per-message annotation, if any, that stores a
JSON object, mapping RFC2392 Content-IDs referenced in HTML bodies
to the respective HTML body part number.
For example, if message part 1.2 contains HTML and references an
inlined image at "cid:foo", then the value of this annotation
would be:
{ "<foo>" : "1.2" }
Note that the Content-ID key must be URL-unescaped and enclosed in
angular brackets, as defined in RFC2392. */
{ "jmap_preview_length", 64, INT }
/* The maximum byte length of dynamically generated message previews. Previews
stored in jmap_preview_annot take precedence. */
{ "jmap_max_size_upload", 1048576, INT }
/* The maximum size (in kilobytes) that the JMAP API accepts
for blob uploads. Returned as the maxSizeUpload property
value of the JMAP \"urn:ietf:params:jmap:core\" capabilities object.
Default is 1Gb. */
{ "jmap_max_concurrent_upload", 5, INT }
/* The value to return for the maxConcurrentUpload property of
the JMAP \"urn:ietf:params:jmap:core\" capabilities object. The Cyrus JMAP
implementation does not enforce this rate-limit. */
{ "jmap_max_size_request", 10240, INT }
/* The maximum size (in kilobytes) that the JMAP API accepts
for requests at the API endpoint. Returned as the
maxSizeRequest property value of the JMAP \"urn:ietf:params:jmap:core\"
capabilities object. Default is 10Mb. */
{ "jmap_max_concurrent_requests", 5, INT }
/* The value to return for the maxConcurrentRequests property of
the JMAP \"urn:ietf:params:jmap:core\" capabilities object. The Cyrus JMAP
implementation does not enforce this rate-limit. */
{ "jmap_max_calls_in_request", 50, INT }
/* The maximum number of calls per JMAP request object.
Returned as the maxCallsInRequest property value of the
JMAP \"urn:ietf:params:jmap:core\" capabilities object. */
{ "jmap_max_objects_in_get", 4096, INT }
/* The maximum number of ids that a JMAP client may request in
a single \"/get\" type method call. The actual number
of returned objects in the response may exceed this number
if the JMAP object type supports unbounded \"/get\" calls.
Returned as the maxObjectsInGet property value of the
JMAP \"urn:ietf:params:jmap:core\" capabilities object. */
{ "jmap_max_objects_in_set", 4096, INT }
/* The maximum number of objects a JMAP client may send to create,
update or destroy in a single /set type method call.
Returned as the maxObjectsInSet property value of the
JMAP \"urn:ietf:params:jmap:core\" capabilities object. */
{ "jmap_mail_max_size_attachments_per_email", 10240, INT }
/* The value (in kilobytes) to return for the maxSizeAttachmentsPerEmail
property of the JMAP \"urn:ietf:params:jmap:mail\" capabilities object. The Cyrus
JMAP implementation does not enforce this size limit. Default is 10 Mb.*/
{ "jmap_set_has_attachment", 1, SWITCH }
/* If enabled, the $hasAttachment flag is determined and set for new messages
created with the JMAP Email/set or Email/import methods. This option should
typically be enabled, but installations using Cyrus-external message
annatotors to determine the $hasAttachment flag might want to disable it. */
{ "jmapuploadfolder", "#jmap", STRING }
/* the name of the folder for JMAP uploads (#jmap) */
{ "iolog", 0, SWITCH }
/* Should cyrus output I/O log entries */
{ "ldap_authz", NULL, STRING }
/* SASL authorization ID for the LDAP server */
{ "ldap_base", "", STRING }
/* Contains the LDAP base dn for the LDAP ptloader module */
{ "ldap_bind_dn", NULL, STRING }
/* Bind DN for the connection to the LDAP server (simple bind).
Do not use for anonymous simple binds */
{ "ldap_deref", "never", STRINGLIST("search", "find", "always", "never") }
/* Specify how aliases dereferencing is handled during search. */
{ "ldap_domain_base_dn", "", STRING }
/* Base DN to search for domain name spaces. */
{ "ldap_domain_filter", "(&(objectclass=domainrelatedobject)(associateddomain=%s))", STRING }
/* Filter to use searching for domains */
{ "ldap_domain_name_attribute", "associateddomain", STRING }
/* The attribute name for domains. */
{ "ldap_domain_scope", "sub", STRINGLIST("sub", "one", "base") }
/* Search scope */
{ "ldap_domain_result_attribute", "inetdomainbasedn", STRING }
/* Result attribute */
{ "ldap_filter", "(uid=%u)", STRING }
/* Specify a filter that searches user identifiers. The following tokens can be
used in the filter string:
%% = %
%u = user
%U = user portion of %u (%U = test when %u = test@domain.tld)
%d = domain portion of %u if available (%d = domain.tld when %u =
- %test@domain.tld), otherwise same as %r
+ test@domain.tld), otherwise same as %R
+ %R = domain portion of %u starting with @ (%R = @domain.tld
+ when %u = test@domain.tld)
%D = user dn. (use when ldap_member_method: filter)
%1-9 = domain tokens (%1 = tld, %2 = domain when %d = domain.tld)
ldap_filter is not used when ldap_sasl is enabled. */
{ "ldap_group_base", "", STRING }
/* LDAP base dn for ldap_group_filter. */
{ "ldap_group_filter", "(cn=%u)", STRING }
/* Specify a filter that searches for group identifiers.
See ldap_filter for more options. */
{ "ldap_group_scope", "sub", STRINGLIST("sub", "one", "base") }
/* Specify search scope for ldap_group_filter. */
{ "ldap_id", NULL, STRING }
/* SASL authentication ID for the LDAP server */
{ "ldap_mech", NULL, STRING }
/* SASL mechanism for LDAP authentication */
{ "ldap_user_attribute", NULL, STRING }
/* Specify LDAP attribute to use as canonical user id */
{ "ldap_member_attribute", NULL, STRING }
/* See ldap_member_method. */
{ "ldap_member_base", "", STRING }
/* LDAP base dn for ldap_member_filter. */
{ "ldap_member_filter", "(member=%D)", STRING }
/* Specify a filter for "ldap_member_method: filter".
See ldap_filter for more options. */
{ "ldap_member_method", "attribute", STRINGLIST("attribute", "filter") }
/* Specify a group method. The "attribute" method retrieves groups from
a multi-valued attribute specified in ldap_member_attribute.
The "filter" method uses a filter, specified by ldap_member_filter, to find
groups; ldap_member_attribute is a single-value attribute group name. */
{ "ldap_member_scope", "sub", STRINGLIST("sub", "one", "base") }
/* Specify search scope for ldap_member_filter. */
{ "ldap_password", NULL, STRING }
/* Password for the connection to the LDAP server (SASL and simple bind).
Do not use for anonymous simple binds */
{ "ldap_realm", NULL, STRING }
/* SASL realm for LDAP authentication */
{ "ldap_referrals", 0, SWITCH }
/* Specify whether or not the client should follow referrals. */
{ "ldap_restart", 1, SWITCH }
/* Specify whether or not LDAP I/O operations are automatically restarted
if they abort prematurely. */
{ "ldap_sasl", 1, SWITCH }
/* Use SASL for LDAP binds in the LDAP PTS module. */
{ "ldap_sasl_authc", NULL, STRING, "2.5.0", "ldap_id" }
/* Deprecated. Use ldap_id */
{ "ldap_sasl_authz", NULL, STRING, "2.5.0", "ldap_authz" }
/* Deprecated. Use ldap_authz */
{ "ldap_sasl_mech", NULL, STRING, "2.5.0", "ldap_mech" }
/* Deprecated. Use ldap_mech */
{ "ldap_sasl_password", NULL, STRING, "2.5.0", "ldap_password" }
/* Deprecated. User ldap_password */
{ "ldap_sasl_realm", NULL, STRING, "2.5.0", "ldap_realm" }
/* Deprecated. Use ldap_realm */
{ "ldap_scope", "sub", STRINGLIST("sub", "one", "base") }
/* Specify search scope. */
{ "ldap_servers", "ldap://localhost/", STRING, "2.5.0", "ldap_uri" }
/* Deprecated. Use ldap_uri */
{ "ldap_size_limit", 1, INT }
/* Specify a number of entries for a search request to return. */
{ "ldap_start_tls", 0, SWITCH }
/* Use transport layer security for ldap:// using STARTTLS. Do not use
ldaps:// in 'ldap_uri' with this option enabled. */
{ "ldap_time_limit", 5, INT }
/* Specify a number of seconds for a search request to complete. */
{ "ldap_timeout", 5, INT }
/* Specify a number of seconds a search can take before timing out. */
{ "ldap_ca_dir", NULL, STRING }
/* Path to a directory with CA (Certificate Authority) certificates. */
{ "ldap_ca_file", NULL, STRING }
/* Patch to a file containing CA (Certificate Authority) certificate(s). */
{ "ldap_ciphers", NULL, STRING }
/* List of SSL/TLS ciphers to allow. The format of the string is
described in ciphers(1). */
{ "ldap_client_cert", NULL, STRING }
/* File containing the client certificate. */
{ "ldap_client_key", NULL, STRING }
/* File containing the private client key. */
{ "ldap_verify_peer", 0, SWITCH }
/* Require and verify server certificate. If this option is yes,
you must specify ldap_ca_file or ldap_ca_dir. */
{ "ldap_tls_cacert_dir", NULL, STRING, "2.5.0", "ldap_ca_dir" }
/* Deprecated in favor of \fIldap_ca_dir\fR. */
{ "ldap_tls_cacert_file", NULL, STRING, "2.5.0", "ldap_ca_file" }
/* Deprecated in favor of \fIldap_ca_file\fR. */
{ "ldap_tls_cert", NULL, STRING, "2.5.0", "ldap_client_cert" }
/* Deprecated in favor of \fIldap_client_cert\fR. */
{ "ldap_tls_key", NULL, STRING, "2.5.0", "ldap_client_key" }
/* Deprecated in favor of \fIldap_client_key\fR. */
{ "ldap_tls_check_peer", 0, SWITCH, "2.5.0", "ldap_verify_peer" }
/* Deprecated in favor of \fIldap_verify_peer\fR. */
{ "ldap_tls_ciphers", NULL, STRING, "2.5.0", "ldap_ciphers" }
/* Deprecated in favor of \fIldap_ciphers\fR. */
{ "ldap_uri", NULL, STRING }
/* Contains a list of the URLs of all the LDAP servers when using the
LDAP PTS module. */
{ "ldap_version", 3, INT }
/* Specify the LDAP protocol version. If ldap_start_tls and/or
ldap_use_sasl are enabled, ldap_version will be automatically
set to 3. */
{ "literalminus", 0, SWITCH }
/* if enabled, CAPABILITIES will reply with LITERAL- rather than
LITERAL+ (RFC 7888). Doesn't actually size-restrict uploads though */
{ "lmtp_downcase_rcpt", 1, SWITCH }
/* If enabled, lmtpd will convert the recipient addresses to lowercase
(up to a '+' character, if present). */
{ "lmtp_exclude_specialuse", NULL, STRING }
/* Don't allow delivery to folders with given special-use attributes. */
{ "lmtp_fuzzy_mailbox_match", 0, SWITCH }
/* If enabled, and the mailbox specified in the detail part of the
recipient (everything after the '+') does not exist, lmtpd will try
to find the closest match (ignoring case, ignoring whitespace,
falling back to parent) to the specified mailbox name. */
{ "lmtp_over_quota_perm_failure", 0, SWITCH }
/* If enabled, lmtpd returns a permanent failure code when a user's
mailbox is over quota. By default, the failure is temporary,
causing the MTA to queue the message and retry later. */
{ "lmtp_strict_quota", 0, SWITCH }
/* If enabled, lmtpd returns a failure code when the incoming message
will cause the user's mailbox to exceed its quota. By default, the
failure won't occur until the mailbox is already over quota. */
{ "lmtp_strict_rfc2821", 1, SWITCH }
/* By default, lmtpd will be strict (per RFC 2821) with regards to which
envelope addresses are allowed. If this option is set to false, 8bit
characters in the local-part of envelope addresses are changed to 'X'
instead. This is useful to avoid generating backscatter with
certain MTAs like Postfix or Exim which accept such messages. */
{ "lmtpsocket", "{configdirectory}/socket/lmtp", STRING }
/* Unix domain socket that lmtpd listens on, used by deliver(8). This should
match the path specified in cyrus.conf(5). */
{ "lmtptxn_timeout", 300, INT }
/* Timeout (in seconds) used during a lmtp transaction to a remote backend
(e.g. in a murder environment). Can be used to prevent hung lmtpds
on proxy hosts when a backend server becomes unresponsive during a
lmtp transaction. The default is 300 - change to zero for infinite. */
{ "lock_debugtime", NULL, STRING }
/* A floating point number of seconds. If set, time how long we wait for
any lock, and syslog the filename and time if it's longer than this
value. The default of NULL means not to time locks. */
# xxx how does this tie into virtual domains?
{ "loginrealms", "", STRING }
/* The list of remote realms whose users may authenticate using cross-realm
authentication identifiers. Separate each realm name by a space. (A
cross-realm identity is considered any identity returned by SASL
with an "@" in it.). */
{ "loginuseacl", 0, SWITCH }
/* If enabled, any authentication identity which has \fBa\fR rights on a
user's INBOX may log in as that user. */
{ "logtimestamps", 0, SWITCH }
/* Include notations in the protocol telemetry logs indicating the number of
seconds since the last command or response. */
{ "mailbox_default_options", 0, INT }
/* Default "options" field for the mailbox on create. You'll want to know
what you're doing before setting this, but it can apply some default
annotations like duplicate suppression */
{ "mailbox_initial_flags", NULL, STRING }
/* space-separated list of permanent flags which will be pre-set in every
newly created mailbox. If you know you will require particular
flag names then this avoids a possible race condition against a client
that fills the entire 128 available slots. Default is NULL, which is
no flags. Example: $Label1 $Label2 $Label3 NotSpam Spam */
{ "mailnotifier", NULL, STRING }
/* Notifyd(8) method to use for "MAIL" notifications. If not set, "MAIL"
notifications are disabled. */
{ "maxheaderlines", 1000, INT }
/* Maximum number of lines of header that will be processed into cache
records. Default 1000. If set to zero, it is unlimited.
If a message hits the limit, an error will be logged and the rest of
the lines in the header will be skipped. This is to avoid malformed
messages causing giant cache records */
{ "maxlogins_per_host", 0, INT }
/* Maximum number of logged in sessions allowed per host,
zero means no limit */
{ "maxlogins_per_user", 0, INT }
/* Maximum number of logged in sessions allowed per user,
zero means no limit */
{ "maxmessagesize", 0, INT }
/* Maximum incoming LMTP message size. If non-zero, lmtpd will reject
messages larger than \fImaxmessagesize\fR bytes. If set to 0, this
will allow messages of any size (the default). */
{ "maxquoted", 131072, INT }
/* Maximum size of a single quoted string for the parser. Default 128k */
{ "maxword", 131072, INT }
/* Maximum size of a single word for the parser. Default 128k */
{ "mboxkey_db", "twoskip", STRINGLIST("skiplist", "twoskip", "zeroskip") }
/* The cyrusdb backend to use for mailbox keys. */
{ "mboxlist_db", "twoskip", STRINGLIST("flat", "skiplist", "sql", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the mailbox list. */
{ "mboxlist_db_path", NULL, STRING }
/* The absolute path to the mailboxes db file. If not specified
will be configdirectory/mailboxes.db */
{ "mboxname_lockpath", NULL, STRING }
/* Path to mailbox name lock files (default $conf/lock) */
{ "metapartition_files", "", BITFIELD("header", "index", "cache", "expunge", "squat", "annotations", "lock", "dav", "archivecache") }
/* Space-separated list of metadata files to be stored on a
\fImetapartition\fR rather than in the mailbox directory on a spool
partition. */
# Commented out - there's no such thing as "metapartition-name",
# but we need this for the man page
# { "metapartition-name", NULL, STRING }
/* The pathname of the metadata partition \fIname\fR, corresponding to
spool partition \fBpartition-name\fR. For any mailbox residing in
a directory on \fBpartition-name\fR, the metadata files listed in
\fImetapartition_files\fR will be stored in a corresponding directory on
\fBmetapartition-name\fR. Note that not every
\fBpartition-name\fR option is required to have a corresponding
\fBmetapartition-name\fR option, so that you can selectively choose
which spool partitions will have separate metadata partitions. */
{ "mupdate_authname", NULL, STRING }
/* The SASL username (Authentication Name) to use when authenticating to the
mupdate server (if needed). */
{ "mupdate_config", "standard", ENUM("standard", "unified", "replicated") }
/* The configuration of the mupdate servers in the Cyrus Murder.
The "standard" config is one in which there are discreet frontend
(proxy) and backend servers. The "unified" config is one in which
a server can be both a frontend and backend. The "replicated"
config is one in which multiple backend servers all share the same
mailspool, but each have their own "replicated" copy of
mailboxes.db. */
{ "munge8bit", 1, SWITCH }
/* If enabled, lmtpd munges messages with 8-bit characters in the
headers. The 8-bit characters are changed to `X'. If
\fBreject8bit\fR is enabled, setting \fBmunge8bit\fR has no effect.
(A proper solution to non-ASCII characters in headers is offered by
RFC 2047 and its predecessors.) */
# xxx badly worded
{ "mupdate_connections_max", 128, INT }
/* The max number of connections that a mupdate process will allow, this
is related to the number of file descriptors in the mupdate process.
Beyond this number connections will be immediately issued a BYE response. */
{ "mupdate_password", NULL, STRING }
/* The SASL password (if needed) to use when authenticating to the
mupdate server. */
{ "mupdate_port", 3905, INT }
/* The port of the mupdate server for the Cyrus Murder */
{ "mupdate_realm", NULL, STRING }
/* The SASL realm (if needed) to use when authenticating to the mupdate
server. */
{ "mupdate_retry_delay", 20, INT }
/* The base time to wait between connection retries to the mupdate server. */
{ "mupdate_server", NULL, STRING }
/* The mupdate server for the Cyrus Murder */
{ "mupdate_username", "", STRING }
/* The SASL username (Authorization Name) to use when authenticating to
the mupdate server */
{ "mupdate_workers_max", 50, INT }
/* The maximum number of mupdate worker threads (overall) */
{ "mupdate_workers_maxspare", 10, INT }
/* The maximum number of idle mupdate worker threads */
{ "mupdate_workers_minspare", 2, INT }
/* The minimum number of idle mupdate worker threads */
{ "mupdate_workers_start", 5, INT }
/* The number of mupdate worker threads to start */
{ "netscapeurl", NULL, STRING }
/* If enabled at compile time, this specifies a URL to reply when
Netscape asks the server where the mail administration HTTP server
is. Administrators should set this to a local resource. */
{ "newsaddheaders", "to", BITFIELD("to", "replyto") }
/* Space-separated list of headers to be added to incoming usenet
articles. Added \fITo:\fR headers will contain email
delivery addresses corresponding to each newsgroup in the
\fINewsgroups:\fR header. Added \fIReply-To:\fR headers will
contain email delivery addresses corresponding to each newsgroup in
the \fIFollowup-To:\fR or \fINewsgroups:\fR header. If the
specified header(s) already exist in an article, the email
delivery addresses will be appended to the original header body(s).
.br
.sp
This option applies if and only if the \fBnewspostuser\fR option is
set. */
{ "newsgroups", "*", STRING }
/* A wildmat pattern specifying which mailbox hierarchies should be
treated as newsgroups. Only mailboxes matching the wildmat will
accept and/or serve articles via NNTP. If not set, a default
wildmat of "*" (ALL shared mailboxes) will be used. If the
\fInewsprefix\fR option is also set, the default wildmat will be
translated to "<newsprefix>.*" */
{ "newsmaster", "news", STRING }
/* Userid that is used for checking access controls when executing
Usenet control messages. For instance, to allow articles to be
automatically deleted by cancel messages, give the "news" user
the 'd' right on the desired mailboxes. To allow newsgroups to be
automatically created, deleted and renamed by the corresponding
control messages, give the "news" user the 'c' right on the desired
mailbox hierarchies. */
{ "newspeer", NULL, STRING }
/* A list of whitespace-separated news server specifications to which
articles should be fed. Each server specification is a string of
the form [user[:pass]@]host[:port][/wildmat] where 'host' is the fully
qualified hostname of the server, 'port' is the port on which the
server is listening, 'user' and 'pass' are the authentication
credentials and 'wildmat' is a pattern that specifies which groups
should be fed. If no 'port' is specified, port 119 is used. If
no 'wildmat' is specified, all groups are fed. If 'user' is specified
(even if empty), then the NNTP POST command will be used to feed
the article to the server, otherwise the IHAVE command will be
used.
.br
.sp
A '@' may be used in place of '!' in the wildmat to prevent feeding
articles cross-posted to the given group, otherwise cross-posted
articles are fed if any part of the wildmat matches. For example,
the string "peer.example.com:*,!control.*,@local.*" would feed all
groups except control messages and local groups to
peer.example.com. In the case of cross-posting to local groups,
these articles would not be fed. */
{ "newspostuser", NULL, STRING }
/* Userid used to deliver usenet articles to newsgroup folders
(usually via lmtp2nntp). For example, if set to "post", email sent
to "post+comp.mail.imap" would be delivered to the "comp.mail.imap"
folder.
.br
.sp
When set, the Cyrus NNTP server will add the header(s) specified in
the \fBnewsaddheaders\fR option to each incoming usenet article.
The added header(s) will contain email delivery addresses
corresponding to each relevent newsgroup. If not set, no headers
are added to usenet articles. */
{ "newsprefix", NULL, STRING }
/* Prefix to be prepended to newsgroup names to make the corresponding
IMAP mailbox names. */
{ "newsrc_db_path", NULL, STRING }
/* The absolute path to the newsrc db file. If not specified,
will be configdirectory/fetchnews.db */
{ "nntptimeout", 3, INT }
/* Set the length of the NNTP server's inactivity autologout timer,
in minutes. The minimum value is 3, the default. */
{ "notesmailbox", NULL, STRING }
/* The top level mailbox in each user's account which is used to store
* Apple-style Notes. Default is blank (disabled) */
{ "notifysocket", "{configdirectory}/socket/notify", STRING }
/* Unix domain socket that the mail notification daemon listens on. */
{ "notify_external", NULL, STRING }
/* Path to the external program that notifyd(8) will call to send mail
notifications.
.PP
The external program will be called with the following
command line options:
.TP
.BI \-c " class"
.\"
.TP
.BI \-p " priority"
.\"
.TP
.BI \-u " user"
.\"
.TP
.BI \-m " mailbox"
.PP
And the notification message will be available on \fIstdin\fR.
*/
# Commented out - there's no such thing as "partition-name", but we need
# this for the man page
# { "partition-name", NULL, STRING }
/* The pathname of the partition \fIname\fR. At least one partition
pathname MUST be specified. If the \fBdefaultpartition\fR option is
used, then its pathname MUST be specified. For example, if the
value of the \fBdefaultpartion\fR option is \fBpart1\fR, then the
\fBpartition-part1\fR field is required. */
{ "outbox_sendlater", 0, SWITCH }
/* If enabled, any message with a \Draft flag will be sent at the time of its INTERNALDATE */
{ "partition_select_mode", "freespace-most", STRINGLIST("random", "freespace-most", "freespace-percent-most", "freespace-percent-weighted", "freespace-percent-weighted-delta") }
/* Partition selection mode.
.PP
.IP \fIrandom\fR 5
(pseudo-)random selection
.\"
.IP \fIfreespace-most\fR 5
partition with the most free space (KiB)
.\"
.IP \fIfreespace-percent-most\fR 5
partition with the most free space (%)
.\"
.IP \fIfreespace-percent-weighted\fR 5
each partition is weighted according to its free space (%); the more free space
the partition has, the more chances it has to be selected
.\"
.IP \fIfreespace-percent-weighted-delta\fR 5
each partition is weighted according to its difference of free space (%)
compared to the most used partition; the more the partition is lagging behind
the most used partition, the more chances it has to be selected
.PP
Note that actually even the most used partition has a few chances to be
selected, and those chances increase when other partitions get closer
*/
{ "partition_select_exclude", NULL, STRING }
/* List of partitions to exclude from selection mode. */
{ "partition_select_usage_reinit", 0, INT }
/* For a given session, number of \fBoperations\fR (e.g. partition selection)
for which partitions usage data are cached. */
{ "partition_select_soft_usage_limit", 0, INT }
/* Limit of partition usage (%): if a partition is over that limit, it is
automatically excluded from selection mode.
.PP
If all partitions are over that limit, this feature is not used anymore.
*/
{ "plaintextloginpause", 0, INT }
/* Number of seconds to pause after a successful plaintext login. For
systems that support strong authentication, this permits users to
perceive a cost of using plaintext passwords. (This does not
affect the use of PLAIN in SASL authentications.) */
{ "plaintextloginalert", NULL, STRING }
/* Message to send to client after a successful plaintext login. */
{ "popexpiretime", -1, INT }
/* The number of days advertised as being the minimum a message may be
left on the POP server before it is deleted (via the CAPA command,
defined in the POP3 Extension Mechanism, which some clients may
support). "NEVER", the default, may be specified with a negative
number. The Cyrus POP3 server never deletes mail, no matter what
the value of this parameter is. However, if a site implements a
less liberal policy, it needs to change this parameter
accordingly. */
{ "popminpoll", 0, INT }
/* Set the minimum amount of time the server forces users to wait
between successive POP logins, in minutes. */
{ "popsubfolders", 0, SWITCH }
/* Allow access to subfolders of INBOX via POP3 by using
userid+subfolder syntax as the authentication/authorization id. */
{ "poppollpadding", 1, INT }
/* Create a softer minimum poll restriction. Allows \fIpoppollpadding\fR
connections before the minpoll restriction is triggered. Additionally,
one padding entry is recovered every \fIpopminpoll\fR minutes.
This allows for the occasional polling rate faster than popminpoll,
(i.e., for clients that require a send/receive to send mail) but still
enforces the rate long-term. Default is 1 (disabled).
.br
.sp
The easiest way to think of it is a queue of past connections, with one
slot being filled for every connection, and one slot being cleared
every \fIpopminpoll\fR minutes. When the queue is full, the user
will not be able to check mail again until a slot is cleared. If the
user waits a sufficient amount of time, they will get back many or all
of the slots. */
{ "poptimeout", 10, INT }
/* Set the length of the POP server's inactivity autologout timer,
in minutes. The minimum value is 10, the default. */
{ "popuseacl", 0, SWITCH }
/* Enforce IMAP ACLs in the pop server. Due to the nature of the POP3
protocol, the only rights which are used by the pop server are 'r',
't', and 's' for the owner of the mailbox. The 'r' right allows the
user to open the mailbox and list/retrieve messages. The 't' right
allows the user to delete messages. The 's' right allows messages
retrieved by the user to have the \\Seen flag set (only if
\fIpopuseimapflags\fR is also enabled). */
{ "popuseimapflags", 0, SWITCH }
/* If enabled, the pop server will set and obey IMAP flags. Messages
having the \\Deleted flag are ignored as if they do not exist.
Messages that are retrieved by the client will have the \\Seen flag
set. All messages will have the \\Recent flag unset. */
{ "postmaster", "postmaster", STRING }
/* Username that is used as the 'From' address in rejection MDNs produced
by sieve. */
{ "postspec", NULL, STRING }
{ "postuser", "", STRING }
/* Userid used to deliver messages to shared folders. For example, if
set to "bb", email sent to "bb+shared.blah" would be delivered to
the "shared.blah" folder. By default, an email address of
"+shared.blah" would be used. */
{ "proc_path", NULL, STRING }
/* Path to proc directory. Default is NULL - must be an absolute path
if specified. If not specified, the path $configdirectory/proc/ will be
used. */
{ "prometheus_enabled", 0, SWITCH }
/* Whether tracking of service metrics for Prometheus is enabled. */
{ "prometheus_need_auth", "admin", STRINGLIST("none", "user", "admin") }
/* Authentication level required to fetch Prometheus metrics. */
{ "prometheus_update_freq", 10, INT }
/* Frequency in seconds at which promstatsd should re-collate its
statistics report. The minimum value is 1, the default is 10. */
{ "prometheus_stats_dir", NULL, STRING }
/* Directory to use for gathering prometheus statistics. If specified,
must be an absolute path. If not specified, the default path
$configdirectory/stats/ will be used. It may be advantageous to locate this
directory on ephemeral storage. */
{ "proxy_authname", "proxy", STRING }
/* The authentication name to use when authenticating to a backend server
in the Cyrus Murder. */
{ "proxy_compress", 0, SWITCH }
/* Try to enable protocol-specific compression when performing a client
connection to a backend server in the Cyrus Murder.
.PP
Note that this should only be necessary over slow network
connections. Also note that currently only IMAP and MUPDATE support
compression. */
{ "proxy_password", NULL, STRING }
/* The default password to use when authenticating to a backend server
in the Cyrus Murder. May be overridden on a host-specific basis using
the hostname_password option. */
{ "proxy_realm", NULL, STRING }
/* The authentication realm to use when authenticating to a backend server
in the Cyrus Murder */
{ "proxyd_allow_status_referral", 0, SWITCH }
/* Set to true to allow proxyd to issue referrals to clients that support it
when answering the STATUS command. This is disabled by default since
some clients issue many STATUS commands in a row, and do not cache the
connections that these referrals would cause, thus resulting in a higher
authentication load on the respective backend server. */
{ "proxyd_disable_mailbox_referrals", 0, SWITCH }
/* Set to true to disable the use of mailbox-referrals on the
proxy servers. */
{ "proxyservers", NULL, STRING }
/* A list of users and groups that are allowed to proxy for other
users, separated by spaces. Any user listed in this will be
allowed to login for any other user: use with caution.
In a standard murder this option should ONLY be set on backends.
DO NOT SET on frontends or things won't work properly. */
{ "pts_module", "afskrb", STRINGLIST("afskrb", "ldap") }
/* The PTS module to use. */
{ "ptloader_sock", NULL, STRING }
/* Unix domain socket that ptloader listens on.
(defaults to configdirectory/ptclient/ptsock) */
{ "ptscache_db", "twoskip", STRINGLIST("skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the pts cache. */
{ "ptscache_db_path", NULL, STRING }
/* The absolute path to the ptscache db file. If not specified,
will be configdirectory/ptscache.db */
{ "ptscache_timeout", 10800, INT }
/* The timeout (in seconds) for the PTS cache database when using the
auth_krb_pts authorization method (default: 3 hours). */
{ "ptskrb5_convert524", 1, SWITCH }
/* When using the AFSKRB ptloader module with Kerberos 5 canonicalization,
do the final 524 conversion to get a n AFS style name (using '.' instead
of '/', and using short names */
{ "ptskrb5_strip_default_realm", 1, SWITCH }
/* When using the AFSKRB ptloader module with Kerberos 5 canonicalization,
strip the default realm from the userid (this does not affect the stripping
of realms specified by the afspts_localrealms option) */
{ "qosmarking", "cs0", ENUM("cs0", "cs1", "cs2", "cs3", "cs4", "cs5", "cs6", "cs7", "af11", "af12", "af13", "af21", "af22", "af23", "af31", "af32", "af33", "af41", "af42", "af43", "ef") }
/* This specifies the Class Selector or Differentiated Services Code Point
designation on IP headers (in the ToS field). */
{ "quota_db", "quotalegacy", STRINGLIST("flat", "skiplist", "sql", "quotalegacy", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for quotas. */
{ "quota_db_path", NULL, STRING }
/* The absolute path for the quota database (if you choose a single-file
quota DB type - or the base path if you choose quotalegacy). If
not specified will be configdirectory/quotas.db or configdirectory/quota/ */
{ "quotawarn", 90, INT }
/* The percent of quota utilization over which the server generates
warnings. */
{ "quotawarnkb", 0, INT }
/* The maximum amount of free space (in kB) at which to give a quota
warning (if this value is 0, or if the quota is smaller than this
amount, then warnings are always given). */
{ "quotawarnmsg", 0, INT }
/* The maximum amount of messages at which to give a quota warning
(if this value is 0, or if the quota is smaller than this
amount, then warnings are always given). */
{ "reject8bit", 0, SWITCH }
/* If enabled, lmtpd rejects messages with 8-bit characters in the
headers. */
{ "restore_authname", NULL, STRING }
/* The authentication used by the restore tool when authenticating
to an IMAP/sync server. */
{ "restore_password", NULL, STRING }
/* The password used by the restore tool when authenticating to an
IMAP/sync server. */
{ "restore_realm", NULL, STRING }
/* The authentication realm used by the restore tool when
authenticating to an IMAP/sync server. */
{ "reverseacls", 0, SWITCH }
/* At startup time, ctl_cyrusdb -r will check this value and it
will either add or remove reverse ACL pointers from mailboxes.db */
{ "rfc2046_strict", 0, SWITCH }
/* If enabled, imapd will be strict (per RFC 2046) when matching MIME
boundary strings. This means that boundaries containing other
boundaries as substrings will be treated as identical. Since
enabling this option will break some messages created by Eudora 5.1
(and earlier), it is recommended that it be left disabled unless
there is good reason to do otherwise. */
{ "rfc2047_utf8", 0, SWITCH }
/* If enabled, imapd will parse any non-encoded character sequence in
MIME header values as UTF8. This is useful for installations that
either advertise the UTF8SMTP (RFC 5335) extension or receive mails
with improperly escaped UTF-8 byte sequences. It is recommended that
this option is left disabled unless there is good reason to do
otherwise. */
{ "rfc3028_strict", 1, SWITCH }
/* If enabled, Sieve will be strict (per RFC 3028) with regards to
which headers are allowed to be used in address and envelope tests.
This means that only those headers which are defined to contain addresses
will be allowed in address tests and only "to" and "from" will be
allowed in envelope tests. When disabled, ANY grammatically correct header
will be allowed. */
{ "rss_feedlist_template", NULL, STRING }
/* File containing HTML that will be used as a template for displaying
the list of available RSS feeds. A single instance of the variable
%RSS_FEEDLIST% should appear in the file, which will be replaced by
a nested unordered list of feeds. The toplevel unordered list will
be tagged with an id of "feed" (<ul id='feed'>) which can be used
by stylesheet(s) in your template. The dynamically created list of
feeds based on the HTML template will be accessible at the "/rss"
URL on the server. */
{ "rss_feeds", "*", STRING }
/* A wildmat pattern specifying which mailbox hierarchies should be
treated as RSS feeds. Only mailboxes matching the wildmat will
have their messages available via RSS. If not set, a default
wildmat of "*" (ALL mailboxes) will be used. */
{ "rss_maxage", 0, INT }
/* Maximum age (in days) of items to display in an RSS channel. If
non-zero, httpd will only display items received within the last
\fIrss_maxage\fR days. If set to 0, all available items will be
displayed (the default). */
{ "rss_maxitems", 0, INT }
/* Maximum number of items to display in an RSS channel. If non-zero,
httpd will display no more than the \fIrss_maxitems\fR most recent
items. If set to 0, all available items will be displayed (the
default). */
{ "rss_maxsynopsis", 0, INT }
/* Maximum RSS item synopsis length. If non-zero, httpd will display
no more than the first \fIrss_maxsynopsis\fR characters of an
item's synopsis. If set to 0, the entire synopsis will be
displayed (the default). */
{ "rss_realm", NULL, STRING }
/* The realm to present for HTTP authentication of RSS feeds. If not
set (the default), the value of the "servername" option will be
used.*/
# Commented out - used by libsasl
# { "sasl_auto_transition", 0, SWITCH }
/* If enabled, the SASL library will automatically create authentication
secrets when given a plaintext password. See the SASL documentation. */
{ "sasl_maximum_layer", 256, INT }
/* Maximum SSF (security strength factor) that the server will allow a
client to negotiate. */
{ "sasl_minimum_layer", 0, INT }
/* The minimum SSF that the server will allow a client to negotiate.
A value of 1 requires integrity protection; any higher value
requires some amount of encryption. */
# Commented out - used by libsasl
# { "sasl_option", 0, STRING }
/* Any SASL option can be set by preceding it with \fBsasl_\fR. This
file overrides the SASL configuration file. */
# Commented out - used by libsasl
# { "sasl_pwcheck_method", NULL, STRING }
/* The mechanism used by the server to verify plaintext passwords.
Possible values include "auxprop", "saslauthd", and "pwcheck". */
{ "savedate", 0, SWITCH }
/* If turned on, enable the SAVEDATE extension. Note, if savedate is
* enabled then replicating to versions of Cyrus which don't support
* savedate will create annotations which aren't easily upgraded from. */
{ "search_batchsize", 20, INT }
/* The number of messages to be indexed in one batch (default 20).
Note that long batches may delay user commands or mail delivery. */
{ "search_normalisation_max", 1000, INT }
/* A resource bound for the combinatorial explosion of search expression
tree complexity caused by normalising expressions with many OR nodes.
These can use more CPU time to optimise than they save IO time in scanning
folders. */
{ "search_engine", "none", ENUM("none", "squat", "xapian") }
/* The indexing engine used to speed up searching. */
{ "search_fuzzy_always", 0, SWITCH }
/* Whether to enable RFC 6203 FUZZY search for all IMAP SEARCH. If turned
on, search attributes will be searched using FUZZY search by default.
If turned off, clients have to explicitly use the FUZZY search key to
enable fuzzy search for regular SEARCH commands. */
{ "search_index_headers", 1, SWITCH }
/* Whether to index headers other than From, To, Cc, Bcc, and Subject.
Experiment shows that some headers such as Received and DKIM-Signature
can contribute up to 2/3rds of the index size but almost nothing to
the utility of searching. Note that is header indexing is disabled,
headers can still be searched, the searches will just be slower.
*/
{ "search_indexed_db", "twoskip", STRINGLIST("flat", "skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the search latest indexed uid state. */
{ "search_maxtime", NULL, STRING }
/* The maximum number of seconds to run a search for before aborting. Default
of no value means search "forever" until other timeouts. */
{ "search_skipdiacrit", 1, SWITCH }
/* When searching, should diacriticals be stripped from the search
terms. The default is "true", a search for "hav" will match
"Håvard". This is not RFC5051 compliant, but it backwards
compatible, and may be preferred by some sites. */
{ "search_skiphtml", 0, SWITCH }
/* If enabled, HTML parts of messages are skipped, i.e. not indexed and
not searchable. Otherwise, they're indexed. */
{ "search_whitespace", "merge", ENUM("skip", "merge", "keep") }
/* When searching, how whitespace should be handled. Options are:
"skip" (default in 2.3 and earlier series) - where a search for
"equi" would match "the quick brown fox". "merge" - the default,
where "he qu" would match "the quick brownfox", and "keep",
where whitespace must match exactly. The default of "merge" is
recommended for most cases - it's a good compromise which
keeps words separate. */
{ "search_snippet_length", 255, INT }
/* The maximum byte length of a snippet generated by the XSNIPPETS
command. Only supported by the Xapian search backend, which
attempts to always fill search_snippet_length bytes in the
generated snippet. */
{ "search_stopword_path", NULL, STRING }
/* The absolute base path to the search stopword lists. If not specified,
no stopwords will be taken into account during search indexing. Currently,
the only supported and default stop word file is english.list. */
# Commented out - there's no such thing as "searchpartition-name",
# but we need this for the man page
# { "searchpartition-name", NULL, STRING }
/* The pathname where to store the xapian search indexes of \fIsearchtier\fR
for mailboxes of partition \fIname\fR. This must be configured for the
\fIdefaultsearchtier\fR and any additional search tier (see squatter for
details).
.PP
For example: if \fIdefaultpartition\fR is defined as part1 and
\fIdefaultsearchtier\fR as tier1 then the configuration must contain
an entry \fItier1searchpartition-part1\fR that defines the path where to
store this tier1's search index for the part1 partition.
.PP
This option MUST be specified for xapian search. */
{ "seenstate_db", "twoskip", STRINGLIST("flat", "skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the seen state. */
{ "sendmail", "/usr/lib/sendmail", STRING }
/* The pathname of the sendmail executable. Sieve invokes sendmail
for sending rejections, redirects and vacation responses. */
{ "sendmail_auth_id", "CYRUS_SENDMAIL_AUTH_ID", STRING }
/* The name of an environment variable to set when invoking sendmail.
The value of this environment variable will contain the user id
of the currently authenticated user. If no user is authenticated
the environment variable is not set. */
{ "serverlist", NULL, STRING }
/* Whitespace separated list of backend server names. Used for
finding server with the most available free space for proxying
CREATE. */
{ "serverlist_select_mode", "freespace-most", STRINGLIST("random", "freespace-most", "freespace-percent-most", "freespace-percent-weighted", "freespace-percent-weighted-delta") }
/* Server selection mode.
.PP
.IP \fIrandom\fR 5
(pseudo-)random selection
.\"
.IP \fIfreespace-most\fR 5
backend with the most (total) free space (KiB)
.\"
.IP \fIfreespace-percent-most\fR 5
backend whose partition has the most free space (%)
.\"
.IP \fIfreespace-percent-weighted\fR 5
same as for partition selection, comparing the free space (%) of the least used
partition of each backend
.\"
.IP \fIfreespace-percent-weighted-delta\fR 5
same as for partition selection, comparing the free space (%) of the least used
partition of each backend.
.PP
*/
{ "serverlist_select_usage_reinit", 0, INT }
/* For a given session, number of \fBoperations\fR (e.g. backend selection)
for which backend usage data are cached. */
{ "serverlist_select_soft_usage_limit", 0, INT }
/* Limit of backend usage (%): if a backend is over that limit, it is
automatically excluded from selection mode.
.PP
If all backends are over that limit, this feature is not used anymore.
*/
{ "servername", NULL, STRING }
/* This is the hostname visible in the greeting messages of the POP,
IMAP and LMTP daemons. If it is unset, then the result returned
from gethostname(2) is used. This is also the value used by murder
clusters to identify the host name. It should be resolvable by
DNS to the correct host, and unique within an active cluster. If
you are using low level replication (e.g. drbd) then it should be
the same on each copy and the DNS name should also be moved to
the new master on failover. */
{ "serverinfo", "on", ENUM("off", "min", "on") }
/* The server information to display in the greeting and capability
responses. Information is displayed as follows:
.IP
"off" = no server information in the greeting or capabilities
.br
"min" = \fIservername\fR in the greeting; no server information in the capabilities
.br
"on" = \fIservername\fR and product version in the greeting;
product version in the capabilities
.PP
*/
{ "sharedprefix", "Shared Folders", STRING }
/* If using the alternate IMAP namespace, the prefix for the shared
namespace. The hierarchy delimiter will be automatically appended.
*/
{ "sieve_allowreferrals", 1, SWITCH }
/* If enabled, timsieved will issue referrals to clients when the
user's scripts reside on a remote server (in a Murder).
Otherwise, timsieved will proxy traffic to the remote server. */
{ "sieve_duplicate_max_expiration", 7776000 /* 90 days */, INT }
/* Maximum expiration time (in seconds) for duplicate message tracking
records. */
{ "sieve_extensions", "fileinto reject vacation vacation-seconds imapflags notify include envelope environment body relational regex subaddress copy date index imap4flags mailbox mboxmetadata servermetadata variables editheader extlists duplicate ihave fcc special-use redirect-dsn redirect-deliverby mailboxid", BITFIELD("fileinto", "reject", "vacation", "vacation-seconds", "imapflags", "notify", "include", "envelope", "environment", "body", "relational", "regex", "subaddress", "copy", "date", "index", "imap4flags", "mailbox", "mboxmetadata", "servermetadata", "variables", "editheader", "extlists", "duplicate", "ihave", "fcc", "special-use", "redirect-dsn", "redirect-deliverby", "mailboxid") }
/* Space-separated list of Sieve extensions allowed to be used in
sieve scripts, enforced at submission by timsieved(8). Any
previously installed script will be unaffected by this option and
will continue to execute regardless of the extensions used. This
option has no effect on options that are disabled at compile time
(e.g., "regex"). */
{ "sieve_maxscriptsize", 32, INT }
/* Maximum size (in kilobytes) any sieve script can be, enforced at
submission by timsieved(8). */
{ "sieve_maxscripts", 5, INT }
/* Maximum number of sieve scripts any user may have, enforced at
submission by timsieved(8). */
{ "sieve_utf8fileinto", 0, SWITCH }
/* If enabled, the sieve engine expects folder names for the
\fIfileinto\fR action in scripts to use UTF8 encoding. Otherwise,
modified UTF7 encoding should be used. */
{ "sieve_sasl_send_unsolicited_capability", 0, SWITCH }
/* If enabled, timsieved will emit a capability response after a successful
SASL authentication, per draft-martin-managesieve-12.txt . */
{ "sieve_use_lmtp_reject", 1, SWITCH }
/* Enabled by default. If reject can be done via LMTP, then return a 550
rather than generating the bounce message in Cyrus. */
{ "sieve_vacation_min_response", 259200 /* 3 days */, INT }
/* Minimum time interval (in seconds) between consecutive vacation responses,
per draft-ietf-vacation-seconds.txt . */
{ "sieve_vacation_max_response", 7776000 /* 90 days */, INT }
/* Maximum time interval (in seconds) between consecutive vacation responses,
per draft-ietf-vacation-seconds.txt . */
{ "sievedir", "/usr/sieve", STRING }
/* If sieveusehomedir is false, this directory is searched for Sieve
scripts. */
{ "sievenotifier", NULL, STRING }
/* Notifyd(8) method to use for "SIEVE" notifications. If not set, "SIEVE"
notifications are disabled.
.PP
This method is only used when no method is specified in the script. */
{ "sieveusehomedir", 0, SWITCH }
/* If enabled, lmtpd will look for Sieve scripts in user's home
directories: ~user/.sieve. */
{ "anysievefolder", 0, SWITCH }
/* It must be "yes" in order to permit the autocreation of any INBOX subfolder
requested by a sieve filter, through the "fileinto" action. (default = no) */
{ "singleinstancestore", 1, SWITCH }
/* If enabled, imapd, lmtpd and nntpd attempt to only write one copy
of a message per partition and create hard links, resulting in a
potentially large disk savings. */
{ "skiplist_always_checkpoint", 1, SWITCH }
/* If enabled, this option forces the skiplist cyrusdb backend to
always checkpoint when doing a recovery. This causes slightly
more IO, but on the other hand leads to more efficient databases,
and the entire file is already "hot". */
{ "skiplist_unsafe", 0, SWITCH }
/* If enabled, this option forces the skiplist cyrusdb backend to
not sync writes to the disk. Enabling this option is NOT RECOMMENDED. */
{ "smtp_backend", "sendmail", STRINGLIST("host", "sendmail") }
/* The SMTP backend to use for sending email.
The \"host\" backend sends message submissions via
a TCP socket to the SMTP host defined in the config
option smtp_host.
The \"sendmail\" backend forks the Cyrus process into
the executable defined in the config option sendmail.
The executable must accept \"-bs\" as command line
argument, read from stdin and must implement the minimum
SMTP protocol as defined in section 4.5.1 of RFC 5321.
If the SMTP EHLO command reports AUTH (RFC 4954) as a
supported extension, then the MAIL FROM command includes
the AUTH parameter, with its value set to the name of any
authenticated user which triggered the email. The AUTH
parameter is omitted if the user is unknown to the calling
process.
If the directory
\fIconfigdirectory\fR/log/smtpclient.\ \fIsmtp_backend\fR
exists, then telemetry logs for outgoing SMTP sessions will
be created in this directory.
*/
{ "smtp_host", "localhost:587", STRING }
/* The SMTP host to use for sending mail (also see the
smpt_backend option). The value of this option must
the name or IP address of a TCP host, followed optionally
by a colon and the port or service to use. The default
port is 587. TLS may be activated by appending \"/tls\"
to the value. Authentication is enabled if smtp_auth_authname
is set. Authentication can be explicitly disabled by appending
\"/noauth\" to the host address. */
{ "smtp_auth_authname", NULL, STRING }
/* The authentication name to use when authenticating to the SMTP
server defined in smtp_host. */
{ "smtp_auth_password", NULL, STRING }
/* The password to use when authenticating to the SMTP server defined
in smtp_host. */
{ "smtp_auth_realm", NULL, STRING }
/* The authentication SASL realm to use when authenticating to a SMTP
server. */
{ "soft_noauth", 1, SWITCH }
/* If enabled, lmtpd returns temporary failures if the client does not
successfully authenticate. Otherwise lmtpd returns permanent failures
(causing the mail to bounce immediately). */
{ "sortcache_db", "twoskip", STRINGLIST("skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for caching sort results (currently only
used for xconvmultisort) */
{ "specialuse_extra", NULL, STRING }
/* Whitespace separated list of extra special-use attributes
that can be set on a mailbox. RFC 6154 currently lists
what special-use attributes can be set. This allows
extending that list in the future or adding your own
if needed. */
{ "specialusealways", 1, SWITCH }
/* If enabled, this option causes LIST and LSUB output to always include
the XLIST "special-use" flags */
{ "sql_database", NULL, STRING }
/* Name of the database which contains the cyrusdb table(s). */
{ "sql_engine", NULL, STRINGLIST("mysql", "pgsql", "sqlite") }
/* Name of the SQL engine to use. */
{ "sql_hostnames", "", STRING }
/* Comma separated list of SQL servers (in host[:port] format). */
{ "sql_passwd", NULL, STRING }
/* Password to use for authentication to the SQL server. */
{ "sql_user", NULL, STRING }
/* Username to use for authentication to the SQL server. */
{ "sql_usessl", 0, SWITCH }
/* If enabled, a secure connection will be made to the SQL server. */
{ "srs_alwaysrewrite", 0, SWITCH }
/* If true, perform SRS rewriting for ALL forwarding, even when not required. */
{ "srs_domain", NULL, STRING }
/* The domain to use in rewritten addresses. This must point only to machines
which know the encoding secret used by this system. When present, SRS is
enabled. */
{ "srs_hashlength", 0, INT }
/* The hash length to generate in a rewritten address. */
{ "srs_secrets", NULL, STRING }
/* A list of secrets with which to generate addresses. */
{ "srs_separator", NULL, STRING }
/* The separator to appear immediately after SRS[01] in rewritten addresses. */
{ "srvtab", "", STRING }
/* The pathname of \fIsrvtab\fR file containing the server's private
key. This option is passed to the SASL library and overrides its
default setting. */
{ "submitservers", NULL, STRING }
/* A list of users and groups that are allowed to resolve "urlauth=submit+"
IMAP URLs, separated by spaces. Any user listed in this will be
allowed to fetch the contents of any valid "urlauth=submit+" IMAP URL:
use with caution. */
{ "subscription_db", "flat", STRINGLIST("flat", "skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the subscriptions list. */
{ "suppress_capabilities", NULL, STRING }
/* Suppress the named capabilities from any capability response. Use the
exact case as it appears in the response, e.g.
"suppress_capabilities: ESEARCH QRESYNC WITHIN XLIST LIST-EXTENDED"
if you have a murder with 2.3.x backends and don't want clients being
confused by new capabilities that some backends don't support. */
{ "statuscache", 0, SWITCH }
/* Enable/disable the imap status cache. */
{ "statuscache_db", "twoskip", STRINGLIST("skiplist", "sql", "twoskip", "zeroskip") }
/* The cyrusdb backend to use for the imap status cache. */
{ "statuscache_db_path", NULL, STRING }
/* The absolute path to the statuscache db file. If not specified,
will be configdirectory/statuscache.db */
{ "sync_authname", NULL, STRING }
/* The authentication name to use when authenticating to a sync server.
Prefix with a channel name to only apply for that channel */
{ "sync_batchsize", 8192, INT }
/* the number of messages to upload in a single mailbox replication.
Default is 8192. If there are more than this many messages appended
to the mailbox, generate a synthetic partial state and send that. */
{ "sync_host", NULL, STRING }
/* Name of the host (replica running sync_server(8)) to which
replication actions will be sent by sync_client(8).
Prefix with a channel name to only apply for that channel */
{ "sync_log", 0, SWITCH }
/* Enable replication action logging by lmtpd(8), imapd(8), pop3d(8),
and nntpd(8). The log {configdirectory}/sync/log is used by
sync_client(8) for "rolling" replication. */
{ "sync_log_chain", 0, SWITCH }
/* Enable replication action logging by sync_server as well, allowing
chaining of replicas. Use this on 'B' for A => B => C replication layout */
{ "sync_log_channels", NULL, STRING }
/* If specified, log all events to multiple log files in directories
specified by each "channel". Each channel can then be processed
separately, such as by multiple sync_client(8)s in a mesh replication
scheme, or by squatter(8) for rolling search index updates.
.PP
You can use "" (the two-character string U+22 U+22) to mean the
default sync channel. */
{ "sync_log_unsuppressable_channels", "squatter", STRING }
/* If specified, the named channels are exempt from the effect of setting
sync_log_chain:off, i.e. they are always logged to by the sync_server
process. This is only really useful to allow rolling search indexing
on a replica. */
{ "sync_password", NULL, STRING }
/* The default password to use when authenticating to a sync server.
Prefix with a channel name to only apply for that channel */
{ "sync_port", NULL, STRING }
/* Name of the service (or port number) of the replication service on
replica host. Prefix with a channel name to only apply for that
channel. If not specified, and if sync_try_imap is set to "yes"
(the default), then the replication client will first try "imap"
(port 143) to check if imapd supports replication. otherwise it
will default to "csync" (usually port 2005). */
{ "sync_realm", NULL, STRING }
/* The authentication realm to use when authenticating to a sync server.
Prefix with a channel name to only apply for that channel */
{ "sync_repeat_interval", 1, INT }
/* Minimum interval (in seconds) between replication runs in rolling
replication mode. If a replication run takes longer than this
time, we repeat immediately.
Prefix with a channel name to only apply for that channel */
{ "sync_shutdown_file", NULL, STRING }
/* Simple latch used to tell sync_client(8) that it should shut down at the
next opportunity. Safer than sending signals to running processes.
Prefix with a channel name to only apply for that channel */
{ "sync_timeout", 1800, INT }
/* Number of seconds to wait for a response before returning a timeout
failure when talking to a replication peer (client or server). */
{ "sync_try_imap", 1, SWITCH }
/* Whether sync_client should try to perform an IMAP connection
before falling back to csync. If this is set to "no",
sync_client will only use csync. Prefix with a channel name to
apply only for that channel */
{ "syslog_prefix", NULL, STRING }
/* String to be prepended to the process name in syslog entries. */
{ "syslog_facility", NULL, STRING }
/* Configure a syslog facility. The default is whatever is compiled
in. Allowed values are: DAEMON, MAIL, NEWS, USER, and LOCAL0
through to LOCAL7 */
{ "tcp_keepalive", 0, SWITCH }
/* Enable keepalive on TCP connections */
{ "tcp_keepalive_cnt", 0, INT }
/* Number of TCP keepalive probes to send before declaring the
connection dead (0 == system default) */
{ "tcp_keepalive_idle", 0, INT }
/* Number of seconds a connection must be idle before keepalive
probes are sent (0 == system default) */
{ "tcp_keepalive_intvl", 0, INT }
/* Number of seconds between keepalive probes (0 == system default) */
{ "temp_path", "/tmp", STRING }
/* The pathname to store temporary files in */
{ "telemetry_bysessionid", 0, SWITCH }
/* If true, log by sessionid instead of PID for telemetry */
{ "timeout", 32, INT }
/* The length of the IMAP server's inactivity autologout timer,
in minutes. The minimum value is 30. The default is 32 to
allow a bit of leeway for clients that try to NOOP every 30
minutes. */
{ "zoneinfo_dir", NULL, STRING }
/* The directory where timezones generated by the Cyrus IMAPd vzic
command are located. If not specified, timezones are looked up
in the CYRUS_TIMEZONES_ZONEINFO_DIR path as defined during the
Cyrus build. */
{ "imapidletimeout", 0, INT }
/* Timeout for idling clients (RFC 2177) in minutes. If set to
zero (the default) or less, the value of "timeout" will be
used instead. */
{ "tls_ca_file", NULL, STRING, "2.5.0", "tls_client_ca_file" }
/* Deprecated in favor of \fItls_client_ca_file\fR. */
{ "tls_ca_path", NULL, STRING, "2.5.0", "tls_client_ca_dir" }
/* Deprecated in favor of \fItls_client_ca_dir\fR. */
{ "tlscache_db", "twoskip", STRINGLIST("skiplist", "sql", "twoskip", "zeroskip"), "2.5.0", "tls_sessions_db" }
/* Deprecated in favor of \fItls_sessions_db\fR. */
{ "tlscache_db_path", NULL, STRING, "2.5.0", "tls_sessions_db_path" }
/* Deprecated in favor of \fItls_sessions_db_path\fR. */
{ "tls_cert_file", NULL, STRING, "2.5.0", "tls_server_cert" }
/* Deprecated in favor of \fItls_server_cert\fR. */
{ "tls_cipher_list", "DEFAULT", STRING, "2.5.0", "tls_ciphers" }
/* Deprecated in favor of \fItls_ciphers\fR. */
{ "tls_ciphers", "DEFAULT", STRING }
/* The list of SSL/TLS ciphers to allow. The format of the string
(and definition of "DEFAULT") is described in \fBciphers(1)\fR.
.PP
See also Mozilla's server-side TLS recommendations:
.PP
https://wiki.mozilla.org/Security/Server_Side_TLS */
{ "tls_crl_file", NULL, STRING }
/* Path to a file containing the Certificate Revocation List */
{ "tls_client_ca_dir", NULL, STRING }
/* Path to a directory containing the CA certificates used to verify
client SSL certificates used for authentication. */
{ "tls_client_ca_file", NULL, STRING }
/* Path to a file containing the CA certificate(s) used to verify
client SSL certificates used for authentication. */
{ "tls_client_cert", NULL, STRING }
/* File containing the certificate presented to a server for authentication
during STARTTLS. A value of "disabled" will disable this server's use
of certificate-based authentication. */
{ "tls_client_certs", "optional", ENUM("off", "optional", "require") }
/* Disable ("off"), allow ("optional", default) or require ("require") the
use of SSL certificates by clients to authenticate themselves. */
{ "tls_client_key", NULL, STRING }
/* File containing the private key belonging to the tls_client_cert
certificate. A value of "disabled" will disable this server's use
of certificate-based authentication. */
{ "tls_eccurve", "prime256v1", STRING }
/* The elliptic curve used for ECDHE. Default is NIST Suite B prime256.
See 'openssl ecparam -list_curves' for possible values. */
{ "tls_key_file", NULL, STRING, "2.5.0", "tls_server_key" }
/* Deprecated in favor of \fItls_server_key\fR. */
{ "tls_required", 0, SWITCH }
/* If enabled, require a TLS/SSL encryption layer to be negotiated
prior to ANY authentication mechanisms being advertised or allowed. */
{ "tls_prefer_server_ciphers", 0, SWITCH }
/* Prefer the ciphers on the server side instead of client side. */
{ "tls_server_ca_dir", NULL, STRING }
/* Path to a directory with CA certificates used to verify certificates
offered when this server connects to other servers. This directory must
have filenames with the hashed value of the certificates (see
openssl(1)). */
{ "tls_server_ca_file", NULL, STRING }
/* Path to a file containing CA certificates used to verify certificates
offered when this server connects to other servers. */
{ "tls_server_cert", NULL, STRING }
/* File containing the certificate presented to clients. */
{ "tls_server_dhparam", NULL, STRING }
/* File containing the DH parameters belonging to the certificate in
tls_server_cert. */
{ "tls_server_key", NULL, STRING }
/* File containing the private key belonging to the certificate in
tls_server_cert. */
{ "tls_sessions_db", "twoskip", STRINGLIST("skiplist", "sql", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the TLS cache. */
{ "tls_sessions_db_path", NULL, STRING }
/* The absolute path to the TLS sessions db file. If not specified,
will be configdirectory/tls_sessions.db */
{ "tls_session_timeout", 1440, INT }
/* The length of time (in minutes) that a TLS session will be cached
for later reuse. The maximum value is 1440 (24 hours), the
default. A value of 0 will disable session caching. */
{ "tls_versions", "tls1_0 tls1_1 tls1_2", STRING }
/* A list of SSL/TLS versions to not disable. Cyrus IMAP SSL/TLS starts
with all protocols, and subtracts protocols not in this list. Newer
versions of SSL/TLS will need to be added here to allow them to get
disabled. */
{ "uidl_format", "cyrus", ENUM("uidonly", "cyrus", "dovecot", "courier") }
/* Choose the format for UIDLs in pop3. Possible values are "uidonly",
"cyrus", "dovecot" and "courier". "uidonly" forces the old default
of UID, "cyrus" is UIDVALIDITY.UID. Dovecot is 8 digits of leading
hex (lower case) each UID UIDVALIDITY. Courier is UIDVALIDITY-UID. */
{ "umask", "077", STRING }
/* The umask value used by various Cyrus IMAP programs. */
{ "userdeny_db", "flat", STRINGLIST("flat", "skiplist", "sql", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for the user access list. */
{ "userdeny_db_path", NULL, STRING }
/* The absolute path to the userdeny db file. If not specified,
will be configdirectory/user_deny.db */
{ "username_tolower", 1, SWITCH }
/* Convert usernames to all lowercase before login/authentication. This
is useful with authentication backends which ignore case during
username lookups (such as LDAP). */
{ "userprefix", "Other Users", STRING }
/* If using the alternate IMAP namespace, the prefix for the other users
namespace. The hierarchy delimiter will be automatically appended. */
# xxx badly worded
{ "unix_group_enable", 1, SWITCH }
/* Should we look up groups when using auth_unix (disable this if you are
not using groups in ACLs for your IMAP server, and you are using auth_unix
with a backend (such as LDAP) that can make getgrent() calls very
slow) */
{ "unixhierarchysep", 1, SWITCH }
/* Use the UNIX separator character '/' for delimiting levels of
mailbox hierarchy. Turn off to use the netnews separator
character '.'. Note that with the newnews separator, no dots may
occur in mailbox names. The default switched in 3.0 from off to on. */
{ "virtdomains", "off", ENUM("off", "userid", "on") }
/* Enable virtual domain support. If enabled, the user's domain will
be determined by splitting a fully qualified userid at the last '@'
or '%' symbol. If the userid is unqualified, and the virtdomains
option is set to "on", then the domain will be determined by doing
a reverse lookup on the IP address of the incoming network
interface, otherwise the user is assumed to be in the default
domain (if set). */
{ "xbackup_enabled", 0, SWITCH }
/* Enable support for the XBACKUP command in imapd. If enabled, admin
users can use this command to provoke a replication of specified users
to the named backup channel. */
# Commented out - there's no such thing as "xlist-flag", but we need
# this for the man page
# { "xlist-flag", NULL, STRING }
/* Set the special-use flag \fIflag\fR on the specified folder when it
is autocreated (see the \fIautocreate_inbox_folders\fR option). For
example, if \fBxlist-junk: Spam\fR is set, and the folder \fBSpam\fR
is autocreated, the special-use flag \fB\\Junk\fR will be set on it.
.PP
(This option is so named for backward compatibility with old config
files.)
*/
{ "lmtp_catchall_mailbox", NULL, STRING }
/* Mail sent to mailboxes which do not exist, will be delivered to
this user. NOTE: This must be an existing local user name with an
INBOX, NOT an email address! */
{ "zoneinfo_db", "twoskip", STRINGLIST("flat", "skiplist", "twoskip", "zeroskip")}
/* The cyrusdb backend to use for zoneinfo. */
{ "zoneinfo_db_path", NULL, STRING }
/* The absolute path to the zoneinfo db file. If not specified,
will be configdirectory/zoneinfo.db */
{ "object_storage_enabled", 0, SWITCH }
/* Is Object storage enabled for this server. You also need to have
archiving enabled and archivepartition for the mailbox.
Only email files will be stored on object Storage archive partition will be
used to store any other files */
{ "object_storage_dummy_spool", NULL, STRING }
/* Dummy object storage spool; this is for test only.
Spool where user directory (container) will be created to store all emails
in a flat structure */
{ "openio_namespace", NULL, STRING }
/* The OpenIO namespace used to store archived email messages. A namespace
identifies the physical platform cyrus must contact. This directive is used
by the OpenIO's SDK to locate its platform entry point. */
{ "openio_account", NULL, STRING }
/* The OpenIO account used to account for stored emails. Accounts are unique
in their namespace. They provides virtual partitions, with quotas and QoS
features. */
{ "openio_rawx_timeout", 30, INT }
/* The OpenIO timeout to query to the RAWX services (default 30 sec). */
{ "openio_proxy_timeout", 5, INT }
/* The OpenIO timeout to query to the PROXY services (default 5 sec). */
{ "openio_autocreate", 0, SWITCH }
/* Allow the OpenIO SDK to autocreate containers. Mainly destined to be turned
on development environments. In production, the container should have been
provisioned with the mailboxes. */
{ "openio_verbosity", NULL, STRING }
/* Sets the logging verbosity of the OpenIO's internal behavior. Admissible
values are: "warning", "notice", "info", "debug", "trace", "quiet".
The default verbosity is "warning". Set to "notice" for a few lines on a
per-client basis. Set to "info" for a few lines on a per-request basis. Set
to "debug" Set to "trace" to activate the underlying libcurl debug
output. Enabling a verbosity higher to equal than "debug" requires
the cyrus to be set in debug mode. The special "quiet" value disables all
kinds of logging at the GLib level. */
{ "caringo_hostname", NULL, STRING }
/* The Caringo hostname used to store archived email messages. A hostname
identifies the physical platform cyrus must contact. This directive is used
by the Caringo's SDK (CastorSDK: Caringo Simple Content Storage Protocol (SCSP)
on HTTP 1.1 using a RESTful architecture */
{ "caringo_port", 80, INT }
/* The port of the caringo server (caringo_hostname); default is 80. */
{ "fastmailsharing", 0, SWITCH }
/* If enabled, use FastMail style sharing (oldschool full server paths) */
/*
.SH SEE ALSO
.PP
\fBimapd(8)\fR, \fBpop3d(8)\fR, \fBnntpd(8)\fR, \fBlmtpd(8)\fR,
\fBhttpd(8)\fR, \fBtimsieved(8)\fR, \fBidled(8)\fR, \fBnotifyd(8)\fR,
\fBdeliver(8)\fR, \fBmaster(8)\fR, \fBciphers(1)\fR
*/
diff --git a/ptclient/ldap.c b/ptclient/ldap.c
index fccf41574..caed767d7 100644
--- a/ptclient/ldap.c
+++ b/ptclient/ldap.c
@@ -1,1605 +1,1605 @@
/* ldap.c - LDAP Backend to ptloader
*
* Copyright (c) 1994-2008 Carnegie Mellon University. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The name "Carnegie Mellon University" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For permission or any legal
* details, please contact
* Carnegie Mellon University
* Center for Technology Transfer and Enterprise Creation
* 4615 Forbes Avenue
* Suite 302
* Pittsburgh, PA 15213
* (412) 268-7393, fax: (412) 268-7395
* innovation@andrew.cmu.edu
*
* 4. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by Computing Services
* at Carnegie Mellon University (http://www.cmu.edu/computing/)."
*
* CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
* THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
* FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sysexits.h>
#include <syslog.h>
#include <config.h>
#include "ptloader.h"
#include "util.h"
#include "assert.h"
#ifdef HAVE_LDAP
#include <ctype.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/param.h>
#include <fcntl.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <sys/uio.h>
/* Functions like ldap_bind() have been deprecated in OpenLDAP 2.3 */
#define LDAP_DEPRECATED 1
#include <ldap.h>
#include <lber.h>
/* libimap */
#include "imap/global.h"
/* libconfig */
#include "libconfig.h"
/* libcyrus */
#include "auth_pts.h"
#include "strhash.h"
#include "xmalloc.h"
#include "xstrlcat.h"
/* xxx this just uses the UNIX canonicalization semantics, which is
* most likely wrong */
/* Map of which characters are allowed by auth_canonifyid.
* Key: 0 -> not allowed (special, ctrl, or would confuse Unix or imapd)
* 1 -> allowed, but requires an alpha somewhere else in the string
* 2 -> allowed, and is an alpha
*
* At least one character must be an alpha.
*
* This may not be restrictive enough.
* Here are the reasons for the restrictions:
*
* & forbidden because of MUTF-7. (This could be fixed.)
* : forbidden because it's special in /etc/passwd
* / forbidden because it can't be used in a mailbox name
* * % forbidden because they're IMAP magic in the LIST/LSUB commands
* ? it just scares me
* ctrl chars, DEL
* can't send them as IMAP characters in plain folder names, I think
* 80-FF forbidden because you can't send them in IMAP anyway
* (and they're forbidden as folder names). (This could be fixed.)
*
* + and - are *allowed* although '+' is probably used for userid+detail
* subaddressing and qmail users use '-' for subaddressing.
*
* Identifiers don't require a digit, really, so that should probably be
* relaxed, too.
*/
static char allowedchars[256] = {
/* 0 1 2 3 4 5 6 7 8 9 A B C D E F */
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 00-0F */
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 10-1F */
1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 1, 0, /* 20-2F */
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 0, /* 30-3F */
1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /* 40-4F */
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, /* 50-5F */
1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, /* 60-6F */
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 0, /* 70-7F */
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
};
typedef struct _ptsm {
const char *uri;
int version;
struct timeval timeout;
int size_limit;
int time_limit;
int deref;
int referrals;
int restart;
int scope;
const char *base;
int sasl;
const char *id;
const char *bind_dn;
const char *password;
const char *authz;
const char *mech;
const char *realm;
const char *filter;
const char *sasl_secprops;
int start_tls;
int tls_check_peer;
const char *tls_cacert_file;
const char *tls_cacert_dir;
const char *tls_ciphers;
const char *tls_cert;
const char *tls_key;
int member_method;
const char *user_attribute;
const char *member_attribute;
const char *member_filter;
const char *member_base;
int member_scope;
const char *group_filter;
const char *group_base;
int group_scope;
/* Used for domain name space -> root dn discovery */
const char *domain_base_dn;
const char *domain_filter;
const char *domain_name_attribute;
int domain_scope;
const char *domain_result_attribute;
LDAP *ld;
} t_ptsm;
#define PTSM_OK 0
#define PTSM_FAIL -1
#define PTSM_NOMEM -2
#define PTSM_RETRY -3
#define PTSM_MEMBER_METHOD_ATTRIBUTE 0
#define PTSM_MEMBER_METHOD_FILTER 1
#define ISSET(x) ((x != NULL) && (*(x) != '\0'))
#define EMPTY(x) ((x == NULL) || (*(x) == '\0'))
static t_ptsm *ptsm = NULL;
static int ptsmodule_interact(
LDAP *ld __attribute__((unused)),
unsigned flags __attribute__((unused)),
void *def,
void *inter)
{
sasl_interact_t *in = inter;
const char *p;
t_ptsm *ptsmdef = def;
for (;in->id != SASL_CB_LIST_END;in++) {
p = NULL;
switch(in->id) {
case SASL_CB_AUTHNAME:
if (ISSET(ptsmdef->id))
p = ptsmdef->id;
break;
case SASL_CB_USER:
if (ISSET(ptsmdef->authz))
p = ptsmdef->authz;
break;
case SASL_CB_GETREALM:
if (ISSET(ptsmdef->realm))
p = ptsmdef->realm;
break;
case SASL_CB_PASS:
if (ISSET(ptsmdef->password))
p = ptsmdef->password;
break;
}
in->result = p ? p : "";
in->len = strlen(in->result);
}
return LDAP_SUCCESS;
}
/*
* Convert 'identifier' into canonical form.
* Returns a pointer to a static buffer containing the canonical form
* or NULL if 'identifier' is invalid.
*
* XXX If any of the characters marked with 0 are valid and are cropping up,
* the right thing to do is probably to canonicalize the identifier to two
* representations: one for getpwent calls and one for folder names. The
* latter canonicalizes to a MUTF7 representation.
*/
static char *ptsmodule_canonifyid(const char *identifier, size_t len)
{
static char retbuf[81];
char sawalpha;
char *p;
int username_tolower = 0;
int i = 0;
if(!len) len = strlen(identifier);
if(len >= sizeof(retbuf)) return NULL;
memcpy(retbuf, identifier, len);
retbuf[len] = '\0';
if (!strncmp(retbuf, "group:", 6))
i = 6;
/* Copy the string and look up values in the allowedchars array above.
* If we see any we don't like, reject the string.
* Lowercase usernames if requested.
*/
username_tolower = config_getswitch(IMAPOPT_USERNAME_TOLOWER);
sawalpha = 0;
for(p = retbuf+i; *p; p++) {
if (username_tolower && Uisupper(*p))
*p = tolower((unsigned char)*p);
switch (allowedchars[*(unsigned char*) p]) {
case 0:
return NULL;
case 2:
sawalpha = 1;
/* FALL THROUGH */
default:
;
}
}
if (!sawalpha) return NULL; /* has to be one alpha char */
return retbuf;
}
static int ptsmodule_connect(void)
{
int rc = 0;
if (ptsm == NULL) // Sanity Check
return PTSM_FAIL;
if (ptsm->ld != NULL)
return PTSM_OK;
if (ISSET(ptsm->tls_cacert_file)) {
rc = ldap_set_option (NULL, LDAP_OPT_X_TLS_CACERTFILE, ptsm->tls_cacert_file);
if (rc != LDAP_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_X_TLS_CACERTFILE (%s).", ldap_err2string (rc));
}
}
if (ISSET(ptsm->tls_cacert_dir)) {
rc = ldap_set_option (NULL, LDAP_OPT_X_TLS_CACERTDIR, ptsm->tls_cacert_dir);
if (rc != LDAP_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_X_TLS_CACERTDIR (%s).", ldap_err2string (rc));
}
}
if (ptsm->tls_check_peer != 0) {
rc = ldap_set_option(NULL, LDAP_OPT_X_TLS_REQUIRE_CERT, &ptsm->tls_check_peer);
if (rc != LDAP_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_X_TLS_REQUIRE_CERT (%s).", ldap_err2string (rc));
}
}
if (ISSET(ptsm->tls_ciphers)) {
/* set cipher suite, certificate and private key: */
rc = ldap_set_option(NULL, LDAP_OPT_X_TLS_CIPHER_SUITE, ptsm->tls_ciphers);
if (rc != LDAP_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_X_TLS_CIPHER_SUITE (%s).", ldap_err2string (rc));
}
}
if (ISSET(ptsm->tls_cert)) {
rc = ldap_set_option(NULL, LDAP_OPT_X_TLS_CERTFILE, ptsm->tls_cert);
if (rc != LDAP_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_X_TLS_CERTFILE (%s).", ldap_err2string (rc));
}
}
if (ISSET(ptsm->tls_key)) {
rc = ldap_set_option(NULL, LDAP_OPT_X_TLS_KEYFILE, ptsm->tls_key);
if (rc != LDAP_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_X_TLS_KEYFILE (%s).", ldap_err2string (rc));
}
}
rc = ldap_initialize(&ptsm->ld, ptsm->uri);
if (rc != LDAP_SUCCESS) {
syslog(LOG_ERR, "ldap_initialize failed (%s)", ptsm->uri);
return PTSM_FAIL;
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_PROTOCOL_VERSION, &(ptsm->version));
if (rc != LDAP_OPT_SUCCESS) {
if (ptsm->sasl ||
ptsm->start_tls) {
syslog(LOG_ERR, "Failed to set LDAP_OPT_PROTOCOL_VERSION %d, required for ldap_start_tls and ldap_sasl.", ptsm->version);
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
return PTSM_FAIL;
} else
syslog(LOG_WARNING, "Unable to set LDAP_OPT_PROTOCOL_VERSION %d.", ptsm->version);
ptsm->version = LDAP_VERSION2;
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_NETWORK_TIMEOUT, &(ptsm->timeout));
if (rc != LDAP_OPT_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_NETWORK_TIMEOUT %ld.%06d.",
(long)ptsm->timeout.tv_sec, (int)ptsm->timeout.tv_usec);
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_SIZELIMIT, &(ptsm->size_limit));
if (rc != LDAP_OPT_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_SIZELIMIT %d.", ptsm->size_limit);
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_TIMELIMIT, &(ptsm->time_limit));
if (rc != LDAP_OPT_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_TIMELIMIT %d.", ptsm->time_limit);
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_DEREF, &(ptsm->deref));
if (rc != LDAP_OPT_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_DEREF %d.", ptsm->deref);
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_REFERRALS, ptsm->referrals ? LDAP_OPT_ON : LDAP_OPT_OFF);
if (rc != LDAP_OPT_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_REFERRALS.");
}
rc = ldap_set_option(ptsm->ld, LDAP_OPT_RESTART, ptsm->restart ? LDAP_OPT_ON : LDAP_OPT_OFF);
if (rc != LDAP_OPT_SUCCESS) {
syslog(LOG_WARNING, "Unable to set LDAP_OPT_RESTART.");
}
if (ptsm->start_tls) {
rc = ldap_start_tls_s(ptsm->ld, NULL, NULL);
if (rc != LDAP_SUCCESS) {
syslog(LOG_ERR, "start tls failed (%s).", ldap_err2string(rc));
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
return PTSM_FAIL;
}
}
if (ptsm->sasl) {
if (EMPTY(ptsm->mech))
ldap_get_option(ptsm->ld, LDAP_OPT_X_SASL_MECH, &(ptsm->mech));
if (EMPTY(ptsm->realm))
ldap_get_option(ptsm->ld, LDAP_OPT_X_SASL_REALM, &(ptsm->realm));
if (ISSET(ptsm->sasl_secprops)) {
rc = ldap_set_option(ptsm->ld, LDAP_OPT_X_SASL_SECPROPS, (void *) ptsm->sasl_secprops);
if( rc != LDAP_OPT_SUCCESS ) {
syslog(LOG_ERR, "Unable to set LDAP_OPT_X_SASL_SECPROPS.");
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
return PTSM_FAIL;
}
}
rc = ldap_sasl_interactive_bind_s(
ptsm->ld,
ptsm->bind_dn,
ptsm->mech,
NULL,
NULL,
LDAP_SASL_QUIET,
ptsmodule_interact,
ptsm);
} else
rc = ldap_simple_bind_s(ptsm->ld, ptsm->bind_dn, ptsm->password);
if (rc != LDAP_SUCCESS) {
syslog(LOG_ERR,
(ptsm->sasl ? "ldap_sasl_interactive_bind() failed %d (%s)." : "ldap_simple_bind() failed %d (%s)."), rc, ldap_err2string(rc));
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
return (rc == LDAP_SERVER_DOWN ? PTSM_RETRY : PTSM_FAIL);
}
return PTSM_OK;
}
/* API */
static void myinit(void)
{
const char *p = NULL;
if (ptsm)
return; // Already configured
ptsm = xmalloc(sizeof(t_ptsm));
if (ptsm == NULL) {
fatal("xmalloc() failed", EX_CONFIG);
}
ptsm->uri = (config_getstring(IMAPOPT_LDAP_URI) ?
config_getstring(IMAPOPT_LDAP_URI) : config_getstring(IMAPOPT_LDAP_SERVERS));
ptsm->version = (config_getint(IMAPOPT_LDAP_VERSION) == 2 ? LDAP_VERSION2 : LDAP_VERSION3);
ptsm->timeout.tv_sec = config_getint(IMAPOPT_LDAP_TIMEOUT);
ptsm->timeout.tv_usec = 0;
ptsm->restart = config_getswitch(IMAPOPT_LDAP_RESTART);
p = config_getstring(IMAPOPT_LDAP_DEREF);
if (!strcasecmp(p, "search")) {
ptsm->deref = LDAP_DEREF_SEARCHING;
} else if (!strcasecmp(p, "find")) {
ptsm->deref = LDAP_DEREF_FINDING;
} else if (!strcasecmp(p, "always")) {
ptsm->deref = LDAP_DEREF_ALWAYS;
} else {
ptsm->deref = LDAP_DEREF_NEVER;
}
ptsm->referrals = config_getswitch(IMAPOPT_LDAP_REFERRALS);
ptsm->size_limit = config_getint(IMAPOPT_LDAP_SIZE_LIMIT);
ptsm->time_limit = config_getint(IMAPOPT_LDAP_TIME_LIMIT);
p = config_getstring(IMAPOPT_LDAP_SCOPE);
if (!strcasecmp(p, "one")) {
ptsm->scope = LDAP_SCOPE_ONELEVEL;
} else if (!strcasecmp(p, "base")) {
ptsm->scope = LDAP_SCOPE_BASE;
} else {
ptsm->scope = LDAP_SCOPE_SUBTREE;
}
ptsm->bind_dn = config_getstring(IMAPOPT_LDAP_BIND_DN);
ptsm->sasl = config_getswitch(IMAPOPT_LDAP_SASL);
ptsm->id = (config_getstring(IMAPOPT_LDAP_ID) ?
config_getstring(IMAPOPT_LDAP_ID) : config_getstring(IMAPOPT_LDAP_SASL_AUTHC));
ptsm->authz = (config_getstring(IMAPOPT_LDAP_AUTHZ) ?
config_getstring(IMAPOPT_LDAP_AUTHZ) : config_getstring(IMAPOPT_LDAP_SASL_AUTHZ));
ptsm->mech = (config_getstring(IMAPOPT_LDAP_MECH) ?
config_getstring(IMAPOPT_LDAP_MECH) : config_getstring(IMAPOPT_LDAP_SASL_MECH));
ptsm->realm = (config_getstring(IMAPOPT_LDAP_REALM) ?
config_getstring(IMAPOPT_LDAP_REALM) : config_getstring(IMAPOPT_LDAP_SASL_REALM));
ptsm->password = (config_getstring(IMAPOPT_LDAP_PASSWORD) ?
config_getstring(IMAPOPT_LDAP_PASSWORD) : config_getstring(IMAPOPT_LDAP_SASL_PASSWORD));
ptsm->start_tls = config_getswitch(IMAPOPT_LDAP_START_TLS);
ptsm->tls_check_peer = config_getswitch(IMAPOPT_LDAP_VERIFY_PEER);
ptsm->tls_cacert_file = config_getstring(IMAPOPT_LDAP_CA_FILE);
ptsm->tls_cacert_dir = config_getstring(IMAPOPT_LDAP_CA_DIR);
ptsm->tls_ciphers = config_getstring(IMAPOPT_LDAP_CIPHERS);
ptsm->tls_cert = config_getstring(IMAPOPT_LDAP_CLIENT_CERT);
ptsm->tls_key = config_getstring(IMAPOPT_LDAP_CLIENT_KEY);
p = config_getstring(IMAPOPT_LDAP_MEMBER_METHOD);
if (!strcasecmp(p, "filter")) {
ptsm->member_method = PTSM_MEMBER_METHOD_FILTER;
} else {
ptsm->member_method = PTSM_MEMBER_METHOD_ATTRIBUTE;
}
p = config_getstring(IMAPOPT_LDAP_MEMBER_SCOPE);
if (!strcasecmp(p, "one")) {
ptsm->member_scope = LDAP_SCOPE_ONELEVEL;
} else if (!strcasecmp(p, "base")) {
ptsm->member_scope = LDAP_SCOPE_BASE;
} else {
ptsm->member_scope = LDAP_SCOPE_SUBTREE;
}
ptsm->member_filter = config_getstring(IMAPOPT_LDAP_MEMBER_FILTER);
ptsm->member_base = config_getstring(IMAPOPT_LDAP_MEMBER_BASE);
ptsm->member_attribute = (config_getstring(IMAPOPT_LDAP_MEMBER_ATTRIBUTE) ?
config_getstring(IMAPOPT_LDAP_MEMBER_ATTRIBUTE) : config_getstring(IMAPOPT_LDAP_MEMBER_ATTRIBUTE));
ptsm->user_attribute = (config_getstring(IMAPOPT_LDAP_USER_ATTRIBUTE) ?
config_getstring(IMAPOPT_LDAP_USER_ATTRIBUTE) : config_getstring(IMAPOPT_LDAP_USER_ATTRIBUTE));
p = config_getstring(IMAPOPT_LDAP_GROUP_SCOPE);
if (!strcasecmp(p, "one")) {
ptsm->group_scope = LDAP_SCOPE_ONELEVEL;
} else if (!strcasecmp(p, "base")) {
ptsm->group_scope = LDAP_SCOPE_BASE;
} else {
ptsm->group_scope = LDAP_SCOPE_SUBTREE;
}
ptsm->group_filter = config_getstring(IMAPOPT_LDAP_GROUP_FILTER);
ptsm->group_base = config_getstring(IMAPOPT_LDAP_GROUP_BASE);
ptsm->filter = config_getstring(IMAPOPT_LDAP_FILTER);
ptsm->base = config_getstring(IMAPOPT_LDAP_BASE);
if (ptsm->version != LDAP_VERSION3 && (ptsm->sasl || ptsm->start_tls))
ptsm->version = LDAP_VERSION3;
ptsm->domain_base_dn = config_getstring(IMAPOPT_LDAP_DOMAIN_BASE_DN);
ptsm->domain_filter = config_getstring(IMAPOPT_LDAP_DOMAIN_FILTER);
ptsm->domain_name_attribute = config_getstring(IMAPOPT_LDAP_DOMAIN_NAME_ATTRIBUTE);
p = config_getstring(IMAPOPT_LDAP_DOMAIN_SCOPE);
if (!strcasecmp(p, "one")) {
ptsm->domain_scope = LDAP_SCOPE_ONELEVEL;
} else if (!strcasecmp(p, "base")) {
ptsm->domain_scope = LDAP_SCOPE_BASE;
} else {
ptsm->domain_scope = LDAP_SCOPE_SUBTREE;
}
ptsm->domain_result_attribute = config_getstring(IMAPOPT_LDAP_DOMAIN_RESULT_ATTRIBUTE);
ptsm->ld = NULL;
}
/*
* Note: calling function must free memory.
*/
static int ptsmodule_escape(
const char *s,
const unsigned int n,
char **result)
{
char *buf;
char *end, *ptr, *temp;
if (n > strlen(s)) // Sanity check, just in case
return PTSM_FAIL;
buf = xmalloc(n * 5 + 1);
if (buf == NULL) {
return PTSM_NOMEM;
}
buf[0] = '\0';
ptr = (char *)s;
end = ptr + n;
while (((temp = strpbrk(ptr, "*()\\\0"))!=NULL) && (temp<end)) {
if (temp>ptr)
strncat(buf, ptr, temp-ptr);
switch (*temp) {
case '*':
strcat(buf, "\\2a");
break;
case '(':
strcat(buf, "\\28");
break;
case ')':
strcat(buf, "\\29");
break;
case '\\':
strcat(buf, "\\5c");
break;
case '\0':
strcat(buf, "\\00");
break;
}
ptr=temp+1;
}
if (ptr<end)
strncat(buf, ptr, end-ptr);
*result = buf;
return PTSM_OK;
}
static int ptsmodule_standard_root_dn(const char *domain, const char **result)
{
const char *dc_sep = ",dc=";
char *domain_copy;
char *part, *tok_state;
struct buf buf = BUF_INITIALIZER;
assert(domain != NULL && domain[0] != '\0');
syslog(LOG_DEBUG, "ptsmodule_standard_root_dn called for domain %s", domain);
/* Each dot is to be replaced with ',dc='.
* We also need a leading 'dc=' at the start.
*/
domain_copy = xstrdup(domain);
part = strtok_r(domain_copy, ".", &tok_state);
buf_setcstr(&buf, "dc=");
while (part != NULL) {
syslog(LOG_DEBUG, "Root DN now %s", buf_cstring(&buf));
buf_appendcstr(&buf, part);
syslog(LOG_DEBUG, "Root DN now %s", buf_cstring(&buf));
part = strtok_r(NULL, ".", &tok_state);
if (part != NULL)
buf_appendcstr(&buf, dc_sep);
}
free(domain_copy);
syslog(LOG_DEBUG, "Root DN now %s", buf_cstring(&buf));
*result = buf_release(&buf);
syslog(LOG_DEBUG, "Root DN now %s", *result);
return PTSM_OK;
}
static int ptsmodule_tokenize_domains(
const char *d,
int n,
char **result)
{
char *s, *s1;
char *lasts;
int nt, i, rc;
*result = NULL;
if (d == NULL || n < 1 || n > 9)
return PTSM_FAIL;
s = strdup(d);
if (s == NULL)
return PTSM_NOMEM;
for( nt=0, s1=s; *s1; s1++ )
if( *s1 == '.' ) nt++;
nt++;
if (n > nt) {
free(s);
return PTSM_FAIL;
}
i = nt - n;
s1 = (char *)strtok_r(s, ".", &lasts);
while(s1) {
if (i == 0) {
rc = ptsmodule_escape(s1, strlen(s1), result);
free(s);
return rc;
}
s1 = (char *)strtok_r(NULL, ".", &lasts);
i--;
}
free(s);
return PTSM_FAIL;
}
#define PTSM_MAX(a,b) (a>b?a:b)
/*
* ptsmodule_expand_tokens
* Parts with the strings provided.
* %% = %
* %u = user
* %U = user part of %u
- * %d = domain part of %u if available, otherwise same as %r
+ * %d = domain part of %u if available, otherwise same as %R
* %R = prepend '@' to domain
* %1-9 = domain tokens (%1 = tld, %2 = domain when %d = domain.tld)
* %D = user DN
* Note: calling function must free memory.
*/
static int ptsmodule_expand_tokens(
const char *pattern,
const char *username,
const char *dn,
char **result)
{
char *buf;
char *end, *ptr, *temp;
char *ebuf, *user;
char *domain;
int rc;
/* to permit multiple occurences of username and/or realm in filter */
/* and avoid memory overflow in filter build [eg: (|(uid=%u)(userid=%u)) ] */
int percents, user_len, dn_len, maxparamlength;
if (pattern == NULL) {
syslog(LOG_ERR, "filter pattern not setup");
return PTSM_FAIL;
}
/* find the longest param of username and realm,
do not worry about domain because it is always shorter
then username */
user_len = username ? strlen(username) : 0;
dn_len = dn ? strlen(dn) : 0;
maxparamlength = PTSM_MAX(user_len+1, dn_len); /* +1 for %R when '@' is prepended */
/* find the number of occurences of percent sign in filter */
for (percents=0, buf=(char *)pattern; *buf; buf++) {
if (*buf == '%') percents++;
}
/* percents * 3 * maxparamlength because we need to account for
* an entirely-escaped worst-case-length parameter */
buf = xmalloc(strlen(pattern) + (percents * 3 * maxparamlength) +1);
if (buf == NULL)
return PTSM_NOMEM;
buf[0] = '\0';
ptr = (char *)pattern;
end = ptr + strlen(ptr);
while ((temp=strchr(ptr,'%')) != NULL) {
if ((temp-ptr) > 0)
strncat(buf, ptr, temp-ptr);
if ((temp+1) >= end) {
syslog(LOG_DEBUG, "Incomplete lookup substitution format");
break;
}
switch (*(temp+1)) {
case '%':
strncat(buf,temp+1,1);
break;
case 'u':
if (ISSET(username)) {
rc = ptsmodule_escape(username, strlen(username), &ebuf);
if (rc == PTSM_OK) {
strcat(buf,ebuf);
free(ebuf);
}
} else
syslog(LOG_DEBUG, "Username not available.");
break;
case 'U':
if (ISSET(username)) {
user = strchr(username, '@');
rc = ptsmodule_escape(username, (user ? (unsigned char)(user - username) : strlen(username)), &ebuf);
if (rc == PTSM_OK) {
strcat(buf,ebuf);
free(ebuf);
}
} else
syslog(LOG_DEBUG, "Username not available.");
break;
case '1':
case '2':
case '3':
case '4':
case '5':
case '6':
case '7':
case '8':
case '9':
if (ISSET(username) && (domain = strchr(username, '@')) && domain[1]!='\0') {
rc=ptsmodule_tokenize_domains(domain+1, (int) *(temp+1)-48, &ebuf);
if (rc == PTSM_OK) {
strcat(buf,ebuf);
free(ebuf);
}
} else
syslog(LOG_DEBUG, "Domain tokens not available.");
break;
case 'R':
case 'd':
if (ISSET(username) && (domain = strchr(username, '@')) && domain[1]!='\0') {
rc=ptsmodule_escape(domain+1, strlen(domain+1), &ebuf);
if (rc == PTSM_OK) {
if (*(temp+1) == 'R')
strcat(buf,"@");
strcat(buf,ebuf);
free(ebuf);
}
break;
}
break;
case 'D':
if (ISSET(dn)) {
rc = ptsmodule_escape(dn, strlen(dn), &ebuf);
if (rc == PTSM_OK) {
strcat(buf,ebuf);
free(ebuf);
}
} else
syslog(LOG_DEBUG, "dn not available.");
break;
default:
break;
}
ptr=temp+2;
}
if (temp<end)
strcat(buf, ptr);
*result = buf;
return PTSM_OK;
}
static int ptsmodule_get_dn(
const char *canon_id,
size_t size,
char **ret)
{
int rc;
#if LDAP_VENDOR_VERSION >= 20125
struct berval *dn = NULL;
LDAPControl c;
LDAPControl *ctrl[2];
char *authzid;
#endif
char *base = NULL, *filter = NULL;
char *domain = NULL;
char domain_filter[1024];
char *attrs[] = {LDAP_NO_ATTRS,NULL}; //do not return all attrs!
char *domain_attrs[] = {(char *)ptsm->domain_name_attribute,(char *)ptsm->domain_result_attribute,NULL};
LDAPMessage *res;
LDAPMessage *entry;
char **vals;
/* unused: BerElement *ber; */
*ret = NULL;
if (ptsm->ld == NULL)
return PTSM_FAIL;
#if LDAP_VENDOR_VERSION >= 20125
if (ptsm->sasl) {
authzid = xmalloc(size + sizeof("u:"));
if (authzid == NULL)
return PTSM_NOMEM;
strcpy(authzid, "u:");
strcpy(authzid+2, canon_id);
c.ldctl_oid = LDAP_CONTROL_PROXY_AUTHZ;
c.ldctl_value.bv_val = authzid;
c.ldctl_value.bv_len = size + 2;
c.ldctl_iscritical = 1;
ctrl[0] = &c;
ctrl[1] = NULL;
rc = ldap_whoami_s(ptsm->ld, &dn, ctrl, NULL);
free(authzid);
if ( rc != LDAP_SUCCESS || !dn ) {
if (rc == LDAP_SERVER_DOWN) {
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
return PTSM_RETRY;
}
return PTSM_FAIL;
}
if ( dn->bv_val &&
!strncmp(dn->bv_val, "dn:", 3) )
*ret = strdup(dn->bv_val+3);
ber_bvfree(dn);
} else
#endif
{
rc = ptsmodule_expand_tokens(ptsm->filter, canon_id, NULL, &filter);
if (rc != PTSM_OK)
goto done;
if (ptsm->domain_base_dn && ptsm->domain_base_dn[0] != '\0' && (strrchr(canon_id, '@') == NULL)) {
syslog(LOG_DEBUG, "collecting all domains from %s", ptsm->domain_base_dn);
snprintf(domain_filter, sizeof(domain_filter), ptsm->domain_filter, "*");
syslog(LOG_DEBUG, "Domain filter: %s", domain_filter);
rc = ldap_search_st(ptsm->ld, ptsm->domain_base_dn, ptsm->domain_scope, domain_filter, domain_attrs, 0, &(ptsm->timeout), &res);
if (rc != LDAP_SUCCESS) {
if (rc == LDAP_SERVER_DOWN) {
syslog(LOG_ERR, "LDAP not available: %s", ldap_err2string(rc));
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
rc = PTSM_RETRY;
goto done;
}
syslog(LOG_ERR, "LDAP search for domain failed: %s", ldap_err2string(rc));
rc = PTSM_FAIL;
goto done;
}
if (ldap_count_entries(ptsm->ld, res) < 1) {
syslog(LOG_ERR, "No domain found");
rc = PTSM_FAIL;
goto done;
} else if (ldap_count_entries(ptsm->ld, res) >= 1) {
int count_matches = 0;
char *temp_base = NULL;
LDAPMessage *res2;
for (entry = ldap_first_entry(ptsm->ld, res); entry != NULL; entry = ldap_next_entry(ptsm->ld, entry)) {
if ((vals = ldap_get_values(ptsm->ld, entry, ptsm->domain_name_attribute)) != NULL) {
syslog(LOG_DEBUG, "we have a domain %s", vals[0]);
ptsmodule_standard_root_dn(vals[0], (const char **) &temp_base);
rc = ldap_search_st(ptsm->ld, temp_base, ptsm->scope, filter, attrs, 0, &(ptsm->timeout), &res2);
if (rc == LDAP_SUCCESS && ldap_count_entries(ptsm->ld, res2) == 1) {
syslog(LOG_DEBUG, "Found %s in %s", canon_id, temp_base);
base = temp_base;
count_matches++;
}
}
}
if (count_matches > 1) {
syslog(LOG_ERR, "LDAP search for %s failed because it matches multiple accounts.", canon_id);
rc = PTSM_FAIL;
goto done;
} else if (count_matches == 0) {
syslog(LOG_ERR, "LDAP search for %s failed because it does not match any account in all domains.", canon_id);
rc = PTSM_FAIL;
goto done;
}
syslog(LOG_DEBUG, "we have found %s in %s", canon_id, base);
}
}
else if (ptsm->domain_base_dn && ptsm->domain_base_dn[0] != '\0' && (strrchr(canon_id, '@') != NULL)) {
syslog(LOG_DEBUG, "Attempting to get domain for %s from %s", canon_id, ptsm->domain_base_dn);
/* Get the base dn to search from domain_base_dn searched on domain_scope with
domain_filter */
domain = strrchr(canon_id, '@');
/* Strip the first character which is a '@' */
domain = domain+1;
snprintf(domain_filter, sizeof(domain_filter), ptsm->domain_filter, domain);
syslog(LOG_DEBUG, "Domain filter: %s", domain_filter);
rc = ldap_search_st(ptsm->ld, ptsm->domain_base_dn, ptsm->domain_scope, domain_filter, domain_attrs, 0, &(ptsm->timeout), &res);
if (rc != LDAP_SUCCESS) {
if (rc == LDAP_SERVER_DOWN) {
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
syslog(LOG_ERR, "LDAP not available: %s", ldap_err2string(rc));
rc = PTSM_RETRY;
goto done;
}
syslog(LOG_ERR, "LDAP search for domain failed: %s", ldap_err2string(rc));
rc = PTSM_FAIL;
goto done;
}
if (ldap_count_entries(ptsm->ld, res) < 1) {
syslog(LOG_ERR, "No domain %s found", domain);
rc = PTSM_FAIL;
goto done;
} else if (ldap_count_entries(ptsm->ld, res) > 1) {
syslog(LOG_ERR, "Multiple domains %s found", domain);
rc = PTSM_FAIL;
goto done;
} else {
if ((entry = ldap_first_entry(ptsm->ld, res)) != NULL) {
if ((vals = ldap_get_values(ptsm->ld, entry, ptsm->domain_result_attribute)) != NULL) {
syslog(LOG_DEBUG, "Root DN for domain %s is %s", domain, vals[0]);
ptsm->base = vals[0];
rc = PTSM_OK;
} else if ((vals = ldap_get_values(ptsm->ld, entry, ptsm->domain_name_attribute)) != NULL) {
syslog(LOG_DEBUG, "Domain %s is an alias domain for parent domain %s", domain, vals[0]);
rc = ptsmodule_standard_root_dn(vals[0], &ptsm->base);
} else {
rc = ptsmodule_standard_root_dn(domain, &ptsm->base);
}
if (rc != PTSM_OK) {
goto done;
} else {
base = xstrdup(ptsm->base);
syslog(LOG_DEBUG, "Continuing with ptsm->base: %s", ptsm->base);
}
}
}
} else {
rc = ptsmodule_expand_tokens(ptsm->base, canon_id, NULL, &base);
if (rc != PTSM_OK)
goto done;
}
rc = ldap_search_st(ptsm->ld, base, ptsm->scope, filter, attrs, 0, &(ptsm->timeout), &res);
if (rc != LDAP_SUCCESS) {
syslog(LOG_DEBUG, "Searching %s with %s failed", base, base);
if (rc == LDAP_SERVER_DOWN) {
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
rc = PTSM_RETRY;
goto done;
}
rc = PTSM_FAIL;
goto done;
}
free(filter);
free(base);
/*
* We don't want to return the *first* entry found, we want to return
* the *only* entry found.
*/
if (ldap_count_entries(ptsm->ld, res) < 1) {
syslog(LOG_ERR, "No entries found");
} else if (ldap_count_entries(ptsm->ld, res) > 1) {
syslog(LOG_ERR, "Multiple entries found: %d", ldap_count_entries(ptsm->ld, res));
} else {
/* if ( ldap_count_entries(ptsm->ld, res) == 1 ) { */
if ((entry = ldap_first_entry(ptsm->ld, res)) != NULL) {
*ret = ldap_get_dn(ptsm->ld, entry);
}
}
ldap_msgfree(res);
res = NULL;
}
return (*ret ? PTSM_OK : PTSM_FAIL);
done:
if (filter)
free(filter);
if (base)
free(base);
return rc;
}
static int ptsmodule_make_authstate_attribute(
const char *canon_id,
size_t size,
const char **reply,
int *dsize,
struct auth_state **newstate)
{
char *dn = NULL;
LDAPMessage *res = NULL;
LDAPMessage *entry = NULL;
char **vals = NULL;
char **rdn = NULL;
int rc;
char *attrs[] = {(char *)ptsm->member_attribute,(char *)ptsm->user_attribute,NULL};
rc = ptsmodule_connect();
if (rc != PTSM_OK) {
*reply = "ptsmodule_connect() failed";
return rc;
}
rc = ptsmodule_get_dn(canon_id, size, &dn);
if (rc != PTSM_OK) {
*reply = "identifier not found";
goto done;
}
rc = ldap_search_st(ptsm->ld, dn, LDAP_SCOPE_BASE, "(objectclass=*)", attrs, 0, &(ptsm->timeout), &res);
if ( rc != LDAP_SUCCESS ) {
*reply = "ldap_search(attribute) failed";
if ( rc == LDAP_SERVER_DOWN ) {
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
rc = PTSM_RETRY;
} else
rc = PTSM_FAIL;
goto done;
}
if ((entry = ldap_first_entry(ptsm->ld, res)) != NULL) {
int i, numvals;
vals = ldap_get_values(ptsm->ld, entry, (char *)ptsm->member_attribute);
if (vals != NULL) {
numvals = ldap_count_values(vals);
*dsize = sizeof(struct auth_state) +
(numvals * sizeof(struct auth_ident));
*newstate = xmalloc(*dsize);
if (*newstate == NULL) {
*reply = "no memory";
rc = PTSM_FAIL;
goto done;
}
(*newstate)->ngroups = numvals;
(*newstate)->userid.id[0] = '\0';
for (i = 0; i < numvals; i++) {
unsigned int j;
strcpy((*newstate)->groups[i].id, "group:");
rdn = ldap_explode_rdn(vals[i],1);
for (j = 0; j < strlen(rdn[0]); j++) {
if (Uisupper(rdn[0][j]))
rdn[0][j]=tolower(rdn[0][j]);
}
strlcat((*newstate)->groups[i].id, rdn[0], sizeof((*newstate)->groups[i].id));
(*newstate)->groups[i].hash = strhash((*newstate)->groups[i].id);
}
ldap_value_free(rdn);
ldap_value_free(vals);
vals = NULL;
}
if ((char *)ptsm->user_attribute) {
vals = ldap_get_values(ptsm->ld, entry, (char *)ptsm->user_attribute);
if (vals != NULL) {
numvals = ldap_count_values(vals);
if (numvals == 1) {
if(!*newstate) {
*dsize = sizeof(struct auth_state);
*newstate = xmalloc(*dsize);
if (*newstate == NULL) {
*reply = "no memory";
rc = PTSM_FAIL;
goto done;
}
(*newstate)->ngroups = 0;
}
size=strlen(vals[0]);
strcpy((*newstate)->userid.id, ptsmodule_canonifyid(vals[0],size));
(*newstate)->userid.hash = strhash((*newstate)->userid.id);
}
ldap_value_free(vals);
vals = NULL;
}
}
}
if(!*newstate) {
*dsize = sizeof(struct auth_state);
*newstate = xmalloc(*dsize);
if (*newstate == NULL) {
*reply = "no memory";
rc = PTSM_FAIL;
goto done;
}
(*newstate)->ngroups = 0;
(*newstate)->userid.id[0] = '\0';
}
/* fill in the rest of our new state structure */
if ((*newstate)->userid.id[0]=='\0') {
strcpy((*newstate)->userid.id, canon_id);
(*newstate)->userid.hash = strhash(canon_id);
}
(*newstate)->mark = time(0);
rc = PTSM_OK;
done:;
if (res)
ldap_msgfree(res);
if (vals)
ldap_value_free(vals);
if (dn)
free(dn);
return rc;
}
static int ptsmodule_make_authstate_filter(
const char *canon_id,
size_t size,
const char **reply,
int *dsize,
struct auth_state **newstate)
{
char *base = NULL, *filter = NULL;
int rc;
int i; int n;
LDAPMessage *res = NULL;
LDAPMessage *entry = NULL;
char **vals = NULL;
char *attrs[] = {(char *)ptsm->member_attribute,NULL};
char *dn = NULL;
char *errdn = NULL;
rc = ptsmodule_connect();
if (rc != PTSM_OK) {
*reply = "ptsmodule_connect() failed";
return rc;
}
rc = ptsmodule_get_dn(canon_id, size, &dn);
if (rc != PTSM_OK) {
*reply = "identifier not found";
return rc;
}
rc = ptsmodule_expand_tokens(ptsm->member_filter, canon_id, dn, &filter);
if (rc != PTSM_OK) {
*reply = "ptsmodule_expand_tokens() failed for member filter";
goto done;
}
rc = ptsmodule_expand_tokens(ptsm->group_base, canon_id, dn, &base);
if (rc != PTSM_OK) {
*reply = "ptsmodule_expand_tokens() failed for member search base";
goto done;
}
rc = ldap_search_st(ptsm->ld, base, ptsm->group_scope, filter, attrs, 0, &(ptsm->timeout), &res);
if (rc != LDAP_SUCCESS) {
*reply = "ldap_search(filter) failed";
if (rc == LDAP_SERVER_DOWN) {
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
rc = PTSM_RETRY;
} else
rc = PTSM_FAIL;
goto done;
}
n = ldap_count_entries(ptsm->ld, res);
if (n < 0) {
*reply = "ldap_count_entries() failed";
rc = PTSM_FAIL;
goto done;
}
*dsize = sizeof(struct auth_state) + (n * sizeof(struct auth_ident));
*newstate = xmalloc(*dsize);
if (*newstate == NULL) {
*reply = "no memory";
rc = PTSM_FAIL;
goto done;
}
(*newstate)->ngroups = n;
strcpy((*newstate)->userid.id, canon_id);
(*newstate)->userid.hash = strhash(canon_id);
(*newstate)->mark = time(0);
for (i = 0, entry = ldap_first_entry(ptsm->ld, res); entry != NULL;
i++, entry = ldap_next_entry(ptsm->ld, entry)) {
if (errdn) ldap_memfree(errdn);
errdn = ldap_get_dn(ptsm->ld, entry);
vals = ldap_get_values(ptsm->ld, entry, (char *)ptsm->member_attribute);
if (vals == NULL) {
syslog(LOG_ERR, "Multiple values for attribute '%s' on entry '%s'",
ptsm->member_attribute,
errdn);
continue;
}
if (ldap_count_values(vals) < 1 ) {
syslog(LOG_ERR, "No values for attribute '%s' on entry '%s'",
ptsm->member_attribute,
errdn);
} else if (ldap_count_values(vals) > 1) {
syslog(LOG_ERR, "Too many values for attribute '%s' on entry '%s'",
ptsm->member_attribute,
errdn);
} else {
*reply = "too many values";
rc = PTSM_FAIL;
ldap_value_free(vals);
vals = NULL;
goto done;
}
strcpy((*newstate)->groups[i].id, "group:");
unsigned int j;
for (j =0; j < strlen(vals[0]); j++) {
if(Uisupper(vals[0][j]))
vals[0][j]=tolower(vals[0][j]);
}
strlcat((*newstate)->groups[i].id, vals[0], sizeof((*newstate)->groups[i].id));
(*newstate)->groups[i].hash = strhash((*newstate)->groups[i].id);
ldap_value_free(vals);
vals = NULL;
if (errdn) ldap_memfree(errdn);
errdn = NULL;
}
rc = PTSM_OK;
done:
if (res)
ldap_msgfree(res);
if (dn)
free(dn);
if (filter)
free(filter);
if (base)
free(base);
if (errdn)
ldap_memfree(errdn);
return rc;
}
static int ptsmodule_make_authstate_group(
const char *canon_id,
size_t size __attribute__((unused)),
const char **reply,
int *dsize,
struct auth_state **newstate)
{
char *base = NULL, *filter = NULL;
char *domain = NULL;
char domain_filter[1024];
char *domain_attrs[] = {(char *)ptsm->domain_name_attribute,(char *)ptsm->domain_result_attribute,NULL};
int rc;
int n;
LDAPMessage *res = NULL;
LDAPMessage *entry = NULL;
char **vals = NULL;
char *attrs[] = {NULL};
if (strncmp(canon_id, "group:", 6)) { // Sanity check
*reply = "not a group identifier";
rc = PTSM_FAIL;
goto done;
}
rc = ptsmodule_connect();
if (rc != PTSM_OK) {
*reply = "ptsmodule_connect() failed";
goto done;
}
rc = ptsmodule_expand_tokens(ptsm->group_filter, canon_id+6, NULL, &filter);
if (rc != PTSM_OK) {
*reply = "ptsmodule_expand_tokens() failed for group filter";
goto done;
}
if (ptsm->domain_base_dn && (strrchr(canon_id, '@') != NULL)) {
syslog(LOG_DEBUG, "(groups) Attempting to get domain for %s from %s", canon_id, ptsm->domain_base_dn);
/* Get the base dn to search from domain_base_dn searched on domain_scope with
domain_filter */
domain = strrchr(canon_id, '@');
syslog(LOG_DEBUG, "(groups) Input domain would be %s", domain);
/* Strip the first character which is a '@' AM: assuming ASCII */
domain = domain+1;
syslog(LOG_DEBUG, "(groups) Input domain would be %s", domain);
snprintf(domain_filter, sizeof(domain_filter), ptsm->domain_filter, domain);
syslog(LOG_DEBUG, "(groups) Domain filter: %s", domain_filter);
rc = ldap_search_st(ptsm->ld, ptsm->domain_base_dn, ptsm->domain_scope, domain_filter, domain_attrs, 0, &(ptsm->timeout), &res);
if (rc != LDAP_SUCCESS) {
syslog(LOG_DEBUG, "(groups) Result from domain query not OK");
goto done;
} else {
syslog(LOG_DEBUG, "(groups) Result from domain query OK");
}
if (ldap_count_entries(ptsm->ld, res) < 1) {
syslog(LOG_ERR, "(groups) No domain %s found", domain);
rc = PTSM_FAIL;
goto done;
} else if (ldap_count_entries(ptsm->ld, res) > 1) {
syslog(LOG_ERR, "(groups) Multiple domains %s found", domain);
rc = PTSM_FAIL;
goto done;
} else {
syslog(LOG_DEBUG, "(groups) Domain %s found", domain);
if ((entry = ldap_first_entry(ptsm->ld, res)) != NULL) {
if ((vals = ldap_get_values(ptsm->ld, entry, ptsm->domain_result_attribute)) != NULL) {
ptsm->group_base = vals[0];
rc = PTSM_OK;
} else if ((vals = ldap_get_values(ptsm->ld, entry, ptsm->domain_name_attribute)) != NULL) {
char *new_domain = xstrdup(vals[0]);
syslog(LOG_DEBUG, "(groups) Domain %s is now domain %s", domain, new_domain);
rc = ptsmodule_standard_root_dn(new_domain, &ptsm->group_base);
free(new_domain);
} else {
rc = ptsmodule_standard_root_dn(domain, &ptsm->group_base);
}
if (rc != PTSM_OK) {
goto done;
} else {
base = xstrdup(ptsm->group_base);
syslog(LOG_DEBUG, "Continuing with ptsm->group_base: %s", ptsm->group_base);
}
}
}
} else {
rc = ptsmodule_expand_tokens(ptsm->group_base, canon_id, NULL, &base);
if (rc != PTSM_OK)
goto done;
}
syslog(LOG_DEBUG, "(groups) about to search %s for %s", base, filter);
rc = ptsmodule_expand_tokens(ptsm->group_base, canon_id+6, NULL, &base);
if (rc != PTSM_OK) {
*reply = "ptsmodule_expand_tokens() failed for group search base";
goto done;
}
rc = ldap_search_st(ptsm->ld, base, ptsm->group_scope, filter, attrs, 0, &(ptsm->timeout), &res);
if (rc != LDAP_SUCCESS) {
*reply = "ldap_search(group) failed";
if (rc == LDAP_SERVER_DOWN) {
ldap_unbind(ptsm->ld);
ptsm->ld = NULL;
rc = PTSM_RETRY;
} else
rc = PTSM_FAIL;
goto done;
}
n = ldap_count_entries(ptsm->ld, res);
if (n != 1) {
*reply = "group identifier not found";
rc = PTSM_FAIL;
goto done;
}
*dsize = sizeof(struct auth_state) +
(n * sizeof(struct auth_ident));
*newstate = xmalloc(*dsize);
if (*newstate == NULL) {
*reply = "no memory";
rc = PTSM_FAIL;
goto done;
}
(*newstate)->ngroups = 0;
strcpy((*newstate)->userid.id, canon_id);
(*newstate)->userid.hash = strhash(canon_id);
(*newstate)->mark = time(0);
rc = PTSM_OK;
done:;
if (res)
ldap_msgfree(res);
if (filter)
free(filter);
if (base)
free(base);
return rc;
}
static struct auth_state *myauthstate(
const char *identifier,
size_t size,
const char **reply,
int *dsize)
{
const char *canon_id;
struct auth_state *newstate = NULL;
int rc;
int retries = 1;
canon_id = ptsmodule_canonifyid(identifier, size);
if (EMPTY(canon_id)) {
*reply = "ptsmodule_canonifyid() failed";
return NULL;
}
size = strlen(canon_id);
retry:;
*reply = NULL;
if (!strncmp(canon_id, "group:", 6))
rc = ptsmodule_make_authstate_group(canon_id, size, reply, dsize, &newstate);
else {
if (ptsm->member_method == PTSM_MEMBER_METHOD_ATTRIBUTE)
rc = ptsmodule_make_authstate_attribute(canon_id, size, reply, dsize, &newstate);
else
rc = ptsmodule_make_authstate_filter(canon_id, size, reply, dsize, &newstate);
}
if (rc == PTSM_RETRY &&
retries) {
retries--;
goto retry;
}
return newstate;
}
#else /* HAVE_LDAP */
static void myinit(void)
{
fatal("PTS module (ldap) not compiled in", EX_CONFIG);
}
static struct auth_state *myauthstate(
const char *identifier __attribute__((unused)),
size_t size __attribute__((unused)),
const char **reply __attribute__((unused)),
int *dsize __attribute__((unused)))
{
fatal("PTS module (ldap) not compiled in", EX_CONFIG);
}
#endif /* HAVE_LDAP */
struct pts_module pts_ldap =
{
"ldap", /* name */
&myinit,
&myauthstate,
};

File Metadata

Mime Type
text/x-diff
Expires
Mon, Apr 6, 1:33 AM (2 d, 10 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18831847
Default Alt Text
(167 KB)

Event Timeline