This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 17 and 18
Revision 17 as of 2015-03-09 14:21:14
Size: 2682
Editor: TimoSirainen
Comment:
Revision 18 as of 2016-02-07 19:08:37
Size: 2814
Editor: TimoSirainen
Comment:
Deletions are marked like this. Additions are marked like this.
Line 33: Line 33:
pass_attrs=uid=user, userPassword=password, someAttribute=proxy, hostName=host pass_attrs = \
  =user=%{ldap:user}, \
  =password=%{ldap:userPassword},
  =proxy=%{ldap:proxyEnabled}, \
  =host=%{ldap:hostName}
Line 35: Line 39:
Note about the "proxy" or "proxy_maybe" fields: these represent an existence test.
Line 37: Line 40:
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.: Note about the "proxy", "proxy_maybe" and any other boolean type fields: these represent an existence test. Currently 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.:
Line 40: Line 43:
pass_attrs=uid=user,userPassword=password,=proxy=y,hostName=host pass_attrs = \
  
=user=%{ldap:user}, \
  =password=%{ldap:
userPassword},
  
=proxy=y, \
  =host=%{ldap:
hostName}

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).

  • login_user: Master passdb can use this to change the username. (v2.2.13+)
  • 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 (if proxy=y field isn't set).

  • 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 = \
  =user=%{ldap:user}, \
  =password=%{ldap:userPassword},
  =proxy=%{ldap:proxyEnabled}, \
  =host=%{ldap:hostName}

Note about the "proxy", "proxy_maybe" and any other boolean type fields: these represent an existence test. Currently 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 = \
  =user=%{ldap:user}, \
  =password=%{ldap:userPassword},
  =proxy=y, \
  =host=%{ldap:hostName}

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)