This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 13 and 14
Revision 13 as of 2010-03-12 11:51:55
Size: 2649
Editor: TimoSirainen
Comment: use a cleaner ldap proxy example
Revision 14 as of 2010-06-14 19:53:46
Size: 2575
Editor: TimoSirainen
Comment:
Deletions are marked like this. Additions are marked like this.
Line 10: Line 10:
 * nopassword: v1.1+: If you want to allow all passwords, use an empty password and this field.  * nopassword: If you want to allow all passwords, use an empty password and this field.
Line 20: Line 20:
dovecot-sql.conf: dovecot-sql.conf.ext:
Line 25: Line 25:
# NOTE: Dovecot doesn't really support line splitting with '\' currently
Line 33: Line 32:
pass_attrs=uid=user,userPassword=password,someAttribute=proxy,hostName=host pass_attrs=uid=user, userPassword=password, someAttribute=proxy, hostName=host

Password database extra fields

The primary purpose of a password database lookup is to return the password for a given user. It may however also return other fields which are treated specially:

  • user: Change the username (eg. lowercase it).

  • allow_nets: Allow user to log in from only specified IPs.

  • proxy and proxy_maybe: Proxy the connection to another IMAP/POP3 server.

  • host: Send login referral to client.

  • nologin: User isn't actually allowed to log in even if the password matches, with optionally a different reason given as the authentication failure message.

  • nodelay: Don't delay reply to client in case of an authentication failure.

  • nopassword: If you want to allow all passwords, use an empty password and this field.

How to return these extra fields depends on the password database you use. See the password database pages on how to do it. Some passdbs however don't support returning them at all, such as PAM.

The password database may also return fields prefixed with userdb_. These fields are only saved and used later as if they came from the user database's extra fields. Typically this is done only when using prefetch userdb.

Note that boolean fields are true always if the field exists. So nodelay, nodelay=yes, nodelay=no and nodelay=0 all mean that the nodelay field is true. With SQL the field is considered to be non-existent if its value is NULL.

Examples

SQL

dovecot-sql.conf.ext:

password_query = SELECT userid as user, password, 'Y' as proxy, host \
  FROM users WHERE userid = '%u'

LDAP

dovecot-ldap.conf

format is <ldap attribute 1>=<dovecot field 1>,<ldap attribute 2>=<dovecot field 2>,...

pass_attrs=uid=user, userPassword=password, someAttribute=proxy, hostName=host

Note about the "proxy" or "proxy_maybe" fields: these represent an existence test.

In LDAP, this translates to "will proxy (or proxy_maybe) if this attribute exists". This allows the proxy behaviour to be selectable per user. To have it "always" on, use a template, e.g.:

pass_attrs=uid=user,userPassword=password,=y=proxy,hostName=host

passwd-file

user:{plain}pass::::::proxy=y host=127.0.0.1

None: PasswordDatabase/ExtraFields (last edited 2019-09-11 14:02:20 by MichaelSlusarz)