This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 8 and 9
Revision 8 as of 2003-08-25 00:09:32
Size: 17051
Editor: ip68-100-111-121
Comment:
Revision 9 as of 2003-08-25 02:31:20
Size: 17504
Editor: ip68-100-111-121
Comment:
Deletions are marked like this. Additions are marked like this.
Line 19: Line 19:
{{{
Line 20: Line 21:

drwx--x--x 3 postoffice mail - 1024 Aug 23 04:15 ole_wobble 
 drwx--x--x 3 postoffice mail - 1024 Aug 23 04:15 ole_wobble
}}}
Line 43: Line 44:
{{{
Line 44: Line 46:
}}}
Line 46: Line 49:
{{{
Line 47: Line 51:
}}}
Line 57: Line 62:
{{{
Line 58: Line 64:
}}}
Line 59: Line 66:
{{{
Line 60: Line 68:
}}}
Line 63: Line 72:
{{{
Line 64: Line 74:
}}}
Line 67: Line 78:
{{{
Line 68: Line 80:
Line 70: Line 81:
Line 72: Line 82:
}}}
Line 74: Line 85:
{{{
Line 75: Line 87:
}}}
Line 80: Line 93:
{{{
Line 83: Line 96:
Line 85: Line 97:
Line 87: Line 98:
Line 89: Line 99:
Line 91: Line 100:
Line 96: Line 104:
Line 98: Line 105:
Line 103: Line 109:
Line 105: Line 110:
Line 107: Line 111:
Line 112: Line 115:
Line 114: Line 116:
Line 116: Line 117:
Line 118: Line 118:
Line 120: Line 119:
Line 122: Line 120:
Line 124: Line 121:
Line 129: Line 125:
Line 131: Line 126:
Line 133: Line 127:
Line 135: Line 128:
Line 137: Line 129:
Line 139: Line 130:
Line 141: Line 131:
Line 143: Line 132:
  }}}
Line 166: Line 155:
{{{
Line 167: Line 157:
}}}
Line 171: Line 161:
{{{
Line 173: Line 164:
Line 175: Line 165:
}}}
Line 182: Line 173:
 $ ldappasswd -W -S -D "cn=Manager,dc=krig,dc=net" "uid=dovecot,ou=accounts,dc=wibble,dc=net" }}}
$ ldappasswd -W -S -D "cn=Manager,dc=krig,dc=net"
"uid=dovecot,ou=accounts,dc=wibble,dc=net"
}}}
Line 184: Line 178:
 $ ldappasswd -W -S -D "cn=Manager,dc=krig,dc=net"    "uid=ole_wobble,ou=accounts,dc=wibble,dc=net" {{{
$ ldappasswd -W -S -D "cn=Manager,dc=krig,dc=net" "uid=ole_wobble,ou=accounts,dc=wibble,dc=net"
}}}
Line 189: Line 185:
{{{
Line 190: Line 187:
}}}
Line 196: Line 194:
{{{
Line 197: Line 196:
}}}
Line 200: Line 200:
{{{
Line 201: Line 202:
}}}
Line 202: Line 204:
{{{
Line 203: Line 206:
}}}
Line 204: Line 208:
{{{
Line 205: Line 210:
}}}
Line 207: Line 213:
{{{
Line 208: Line 215:
}}}
Line 231: Line 239:
{{{
Line 232: Line 241:
}}}
Line 245: Line 255:
{{{
Line 246: Line 257:
}}}
Line 259: Line 271:
{{{
Line 260: Line 273:
}}}
Line 264: Line 278:
{{{
Line 266: Line 280:
}}}
Line 269: Line 284:
{{{
Line 271: Line 286:
}}}
Line 274: Line 290:
{{{
Line 276: Line 292:
}}}
Line 278: Line 295:
{{{
Line 280: Line 297:
}}}
Line 284: Line 302:
{{{
Line 286: Line 304:
}}}
Line 289: Line 308:
{{{
Line 291: Line 310:
}}}
Line 296: Line 316:
{{{
Line 298: Line 318:
}}}
Line 312: Line 333:
 user_attrs = `uid,,,uid,,` {{{
user_attrs = uid,,,uid,,
}}}
Line 316: Line 339:
{{{
Line 318: Line 341:
}}}
Line 321: Line 345:
{{{
Line 323: Line 347:
}}}
Line 325: Line 350:
{{{
Line 327: Line 352:
}}}
Line 330: Line 356:
{{{
Line 332: Line 358:
}}}
Line 335: Line 362:
{{{
Line 337: Line 364:
}}}
Line 343: Line 371:
{{{
Line 345: Line 373:
}}}
Line 349: Line 377:
{{{
Line 351: Line 379:
}}}
Line 353: Line 382:
{{{
Line 355: Line 384:
}}}
Line 357: Line 387:
{{{
Line 359: Line 389:
}}}
Line 366: Line 397:
{{{
Line 367: Line 399:
}}}
Line 368: Line 401:
{{{
Line 369: Line 403:
---- }}}
----
{{{
Line 372: Line 407:
}}}
Line 375: Line 411:
{{{
Line 377: Line 413:
Line 379: Line 414:
Line 381: Line 415:
Line 383: Line 416:
Line 385: Line 417:
Line 387: Line 418:
}}}
Line 389: Line 421:
{{{
Line 391: Line 423:
Line 393: Line 424:
}}}
Line 396: Line 428:
{{{
Line 398: Line 430:
Line 400: Line 431:
}}}
Line 402: Line 434:
{{{
Line 404: Line 436:
}}}
Line 406: Line 439:
{{{
Line 408: Line 441:
}}}
Line 409: Line 443:
{{{
Line 410: Line 445:
}}}
Line 415: Line 451:
{{{
Line 417: Line 453:
}}}
Line 421: Line 458:
{{{
Line 423: Line 460:
}}}
Line 427: Line 465:
{{{
Line 429: Line 467:
}}}
Line 432: Line 471:
{{{
Line 434: Line 473:
}}}
Line 437: Line 477:
{{{
Line 440: Line 480:
}}}
Line 442: Line 483:
{{{
Line 444: Line 485:
}}}
Line 446: Line 488:
{{{
Line 449: Line 491:
}}}
Line 451: Line 494:
{{{
Line 453: Line 497:
}}}
Line 456: Line 501:
{{{
Line 458: Line 503:
}}}
Line 460: Line 506:
{{{
Line 462: Line 508:
}}}
Line 464: Line 511:
{{{
Line 465: Line 513:
---- }}}
----
{{{
Line 468: Line 517:
}}}

Software

FreeBSD 4.8

openldap-2.1.22

dovecot-0.99.10

Environment

This sets up mail accounts for people who don't have accounts on the FBSD box; e.g. there is a mail account for ole_wobble in the LDAP registry, but no matching account in the Unix passwd file. However, each mail account does require its own directory in /var/mail; e.g. for user Ole Wobble Olson, you need the directory /var/mail/ole_wobble. There is a Unix account named postoffice which handles all administrative tasks and owns the directories and files set up for mail accounts in /var/mail. The group for files in /var/mail is mail. Using ole_wobble as an example:

        # ls -l /var/mail | grep ole_wobble
        drwx--x--x  3 postoffice  mail  - 1024 Aug 23 04:15 ole_wobble

Mail storage is mbox, but these instructions should work fine with Maildir directories. The UID number for the postoffice account is 3000 and the GID number is 8. Change the ID numbers to match your system.

In each user directory in /var/mail, I create three files: inbox, outbox, and Trash. These are needed for the MUAs (mail clients) we use. Eudora requires the inbox to be "inbox", all lower case; mutt requires the outbox to be "outbox", all lower case, and Eudora uses a trash box named "Trash".

If you want to use raw logging, you will need to add a directory named "dovecot.rawlog" to /home/postoffice.

OpenLDAP

The OpenLDAP instructions are *extremely* sketchy and are intended only to supplement the instructions at the OpenLDAP web site. They give information specific to a Dovecot setup that is missing from the OpenLDAP manual.

If you have portupgrade installed, the simplest way to install OpenLDAP is by using the portinstall tool.

        # portinstall openldap21

The instructions for configuring OpenLDAP, including a Quick Install Guide, are at

        http://www.openldap.org

OpenLDAP appears to be difficult to install properly. My first two attempts were unsuccessful. The FreeBSD port includes Pearl scripts that run tests to ensure that the installation succeeded. Even though the installation passed the tests, it couldn't be configured to work properly. You may need to install a few times before you get a usable installation of OpenLDAP.

Go to /usr/local/etc/rc.d, and copy slapd.sh.sample to slapd.sh. (Yes, Virginia, there is a slap daemon.) Open the file in a text editor. Ignore the line that says

        # Uncomment one of the following: 

Comment out the line that says

        slapd_args="-u ldap -g ldap"

Save your changes and close the text editor.

Go to the directory containing the OpenLDAP configuration files.

        # cd /usr/local/etc/openldap

Make a copy of slapd.conf.default and name it slapd.conf. Open slapd.conf in a text editor. You will need the the following lines to reference the schemas you need:

        include         /usr/local/etc/openldap/schema/core.schema
        include         /usr/local/etc/openldap/schema/cosine.schema
        include         /usr/local/etc/openldap/schema/nis.schema

The following line will set the default password hashing method to the CRYPT algorithm, which is compatible with Dovecot:

        password-hash {CRYPT}

The Quick Install Guide at the OpenLDAP explains how to set up an administrator with global rights on the LDAP registry, and how to add entries. Here is a data hierarchy in ldif format that can be used to provide Dovecot mail accounts. You should be able to copy it into an ldif file, modify it for your own use, and install it all at once.

        dn: dc=wibble,dc=net
                objectClass: top
                objectClass: dcObject
                objectClass: organization
                o: Wibble Corp.
                dc: wibble
                description: Wibble, with Ole Wobble and Ole Wubble

        dn: ou=accounts,dc=wibble,dc=net
                objectClass: top
                objectClass: organizationalUnit
                ou: accounts

        dn: uid=dovecot,ou=accounts,dc=wibble,dc=net
                objectClass: top
                objectclass: person
                uid: dovecot
                sn: dovecot

        dn: uid=ole_wobble,ou=accounts,dc=wibble,dc=net
                objectClass: top
                objectclass: person
                objectClass: posixAccount
                cn: Ole Wobble Olson
                uid: ole_wobble
                uidNumber: 3000
                gidNumber: 8
                homeDirectory: /usr/home/postoffice

        dn: uid=ole_wubble,ou=accounts,dc=wibble,dc=net
                objectClass: top
                objectclass: person
                objectClass: posixAccount
                cn: Ole Wubble Olson
                uid: ole_wubble
                uidNumber: 3000
                gidNumber: 8
                homeDirectory: /usr/home/postoffice

The expression "dc=wibble,dc=net" should match the suffix setting in slap.conf.

If you plan to install this by copying it to a file and running ldapadd, you must retain the blank lines above the lines that begin with "dn: ", but remove any other blank lines.

The uidNumber is set to the uid number of the postoffice account. The gidNumber is set to the gid number of the mail group. The homeDirectory is set to the home directory of the postoffice account. This allows the raw log function to write to that directory. If you don't include the homeDirectory attribute, you will have to apply a patch to Dovecot. The patch is described below, in the Installing Dovecot section. The use of the posixAccount object class requires that you use the uid, cn, uidNumber, gidNumber, and homeDirectory attributes (and therefore shouldn't need the patch).

The home directory is always set to the home directory of the postoffice account. This allows writing raw logs to the postoffice home directory.

To insert the entries above, save them in a file named wibble.ldif. Run ldapadd from the command line:

        ldapadd -W -D "cn=Manager,dc=krig,dc=net" -f /usr/local/etc/openldap/wibble.ldif

Returning to slap.conf, the following will give dovecot read access to the entries in the ou=accounts section, but no write access and no access to other parts of the registry.

        access to dn.children="ou=accounts,dc=wibble,dc=net"
                by dn="uid=dovecot,ou=accounts,dc=wibble,dc=net" read
                by anonymous auth

This is enough to allow Dovecot to authenticate mail users and itself.

The final step in setting up your LDAP registry is to add the passwords. Every account in the ou=accounts section will need one. Assuming that you've slavishly imitated the example in the Quick Install Guide at the OpenLDAP site and called your LDAP administrator "Manager", you can add passwords from the command line with }}}

  • $ ldappasswd -W -S -D "cn=Manager,dc=krig,dc=net"

"uid=dovecot,ou=accounts,dc=wibble,dc=net" }}} for the dovecot user and

        $ ldappasswd -W -S -D "cn=Manager,dc=krig,dc=net" "uid=ole_wobble,ou=accounts,dc=wibble,dc=net" 

for mail accounts. The -S option prompts you for the new password, and the -W option prompts you for the LDAP Manager password.

You can view the finished registry with

        $ ldapsearch -LLL -W -D "cn=Manager,dc=krig,dc=net" -b "dc=krig,dc=net" "(objectclass=*)"

Installing Dovecot

Again, the simplest approach is the portinstall tool. If you don't include homeDirectory info with your all your LDAP entries, you will need a patch. Download the patch from

        http://dovecot.procontrol.fi/patches/auth-no-homedir.patch 

To apply the patch, go to /usr/ports/mail/dovecot. If you've previously installed dovecot and still have the work directory, you need to remove it.

        # make distclean

Then you need to recreate the work directory.

        # make patch

Go to the directory containing the file you need to patch.

        # cd /usr/ports/mail/dovecot/work/dovecot-0.99.10/src/auth

Copy auth-no-homedir.patch (the patch file you downloaded) to this directory. Now run patch.

        # patch -p0 < auth-no-homedir.patch

If you get no error messages, you can proceed with the installation. If you do get error messages, you will need to apply the patch by hand. Open auth-no-homedir.patch in a text viewer. The file you need to patch is listed in the first line of auth-no-homedir.patch. Open that file in a text editor in another ttyv or xterm.

The path file contains two contiguous lines, the first beginning with a "-" and the second beginning with a "+". The first is the line you will delete from the file to be patched, and the second is the line that will replace it; i.e. subtract the "-" line and add the "+" line. Immediately surrounding the two lines are the context lines; three above and three below. Search for the line in the file to be patched that matches the "-" line *and* has the same context lines above and below. When you find this line, delete it and replace it with the "+" line in the patch file. (Do not include the "+" marker.) Double check that you have deleted only what needs to be deleted and added only what needs to be added. Save the file and close the text editor and text viewer. Delete auth-no-homedir.patch.

Once you have successfully run patch or patched by hand, return to /usr/ports/mail/dovecot. Open the Makefile in a text editor. Find the line that begins with "CONFIGURE_ARGS+=". If you don't have the following two arguments, add them.

        --with-rawlog --with-ldap

Raw logging isn't necessary, but it can be useful. You have to have the --with-ldap argument to enable Dovecot to work with LDAP.

If you remove support for alternative authentication methods (PAM, PGSQL, etc), you should leave support for passwd. When I was debugging my configuration, I found it helpful to switch between passwd and LDAP authentication. If my setup worked with passwd and not with LDAP, then I knew that I needed to look at Dovecot's LDAP configuration, or at OpenLDAP.

Save your changes to Makefile, and close the editor.

Now you're ready to install.

        # make install

If make completes and registers Dovecot without giving error messages, then your installation was successful.

Configure Dovecot

dovecot-ldap.conf

To start Dovecot automatically when you boot, go to /usr/local/etc/rc.d and copy dovecot.sh.sample to dovecot.sh.

Go to /usr/local/share/doc/dovecot and copy dovecot-ldap.conf to the /usr/local/etc directory. Go to the /usr/local/etc directory and open dovecot-ldap.conf in a text editor.

The first setting is

        hosts = localhost

If Dovecot and OpenLDAP are running on the same machine, then this is fine. If you have OpenLDAP running on a different machine, you will need to set this to the name of the LDAP machine.


        dn = uid=dovecot,ou=accounts,dc=wibble,dc=net

This is set to the Distinguished Name that identifies the Dovecot entry in your LDAP registry.


        dnpass = flop

Set this to the password you assigned dovecot using the ldappasswd command.


        ldap_version = 3

'Nuff said.


        base = ou=accounts,dc=wibble,dc=net

This tells Dovecot where to search in your LDAP registry. Dovecot will search for passwords and UIDs in the entries that fall below ou=accounts in the data hierarchy.


        deref = never

If you are referencing and dereferencing aliases, then you know a lot more about LDAP than I do.


        scope = subtree

This tells Dovecot to search all entries that fall below the base entry. If it were set to "onelevel", Dovecot would search only entries one level below the base entry. If it were set to "base", Dovecot would search only the base entry.


        user_attrs = uid,homeDirectory,,uid,uidNumber,gidNumber

From an e-mail that Timo sent to the list:

  • The first uid is the virtual user name that you log in with. For

    example user@domain.com. The second uid is the system user id which is used to lookup groups from /etc/groups file...You really don't want to have it if you have only virtual users. Two commas mean simply that the value in the middle of them doesn't exist. That'd be the MAIL environment which you can use to override config file's default_mail_env. By default it doesn't exist in LDAP so it's empty.

If you have set up your LDAP registry so that it doesn't supply homeDirectory, uidNumber, and gidNumber (which means that you've applied the homeDirectory patch, you're not using raw logging, you've set default values for uid and gid in this config file, and your LDAP entries don't use the posixAccount object class), you can try the following:

        user_attrs = uid,,,uid,,

I haven't tried it, so I can't promise that it works. If you change the default setting, don't remove any of the commas.


        user_filter = (&(objectClass=posixAccount)(uid=%u))

Specifies which class to search in a given entry, and to find the uid that matches the user name passed by the mail client.


        pass_attrs = uid,userPassword

Which attributes to use when matching passwords.


        pass_filter = (&(objectClass=posixAccount)(uid=%u))

Specifies which class to search in a given entry, and to find the uid that matches the user name passed by the mail client.


        default_pass_scheme = CRYPT

If you leave this commented out, Dovecot will automatically detect that OpenLDAP is using CRYPT.


        user_global_uid = 3000

This provides a default UID number for LDAP entries that lack the uidNumber attribute. If you use the posixAccount object class in your LDAP registry, you can't enter data for an account without providing a uidNumber and gidNumber, so this and the next setting aren't necessary.


        user_global_gid = 8

dovecot.conf

While still in /usr/local/etc, open dovecot.conf in a text editor.

        base_dir = /var/dovecot/

This was created for you during installation.


        protocols = imap

You can add other protocols if you want. This setup only uses IMAP.


        imap_listen = *:143

You don't need to specify port 143; I just like to be specific. According to the documentation, * causes Dovecot to listen on all available IP4 interfaces. If your IMAP box is also your Internet gateway, and you're not offering mail services externally, then you probably don't want that. You can specify your LAN interface and Dovecot will continue to listen at localhost. If your host name isn't exposed externally, then you can use

        imap_listen = wibblemailhost:143

Otherwise use

        imap_listen = 192.168.15.23:143


        ssl_disable = yes

If you have this set to yes, you can ignore the SSL settings that follow in dovecot.conf.


        login_dir = /var/dovecot/login
        login_chroot = yes
        login = imap
        login_executable = /usr/local/libexec/dovecot/imap-login
        login_user = dovecot
        verbose_proctitle = yes

The above are all part of the default conf file.


        first_valid_uid = 3000
        last_valid_uid = 3000

If you are assigning the postoffice UID number to all mail accounts, you can restrict access to only that UID number.


        first_valid_gid = 8
        last_valid_gid = 8

Since all mail accounts are assigned the mail group's number...


        valid_chroot_dirs = /var/mail

Another default conf file setting.


        default_mail_env = mbox:/var/mail/%u

or

        default_mail_env = maildir:/var/mail/%u

This tells Dovecot where the mail for a given account is located. Dovecot replaces "%u" with the account name. For the two user accounts in the ldif data hierarchy given above, "%u" would expand to ole_wobble and ole_wubble.


        client_workarounds = oe6-fetch-no-newmail outlook-idle

We don't use Outlook or Outlook Express. However, someone may decide to use an MS mail client in the future, and leaving this in place does no harm.


        mail_save_crlf = yes

My IMAP box really doesn't work very hard, so I don't think it matters how this is set. If your mail server gets hammered regularly, you may want to play with this and see if it makes a difference in speed.


        maildir_copy_with_hardlinks = yes

Another performance tweak that doesn't matter to me, but may matter to you. "yes" is supposed to be faster.


        mbox_locks = fcntl

I also tried flock and dotlock, and they work FBSD. This is the preferred setting, if it works on your system.


        imap_executable = /usr/local/libexec/dovecot/imap
        auth = default

More default conf file settings.


        auth_mechanisms = plain

"plain" seems more likely to work under more circumstances.


        auth_userdb = ldap /usr/local/etc/dovecot-ldap.conf
        auth_passdb = ldap /usr/local/etc/dovecot-ldap.conf

If you need to switch to passwd authentication for testing, change this to

        auth_userdb = passwd
        auth_passdb = passwd /etc/master.passwd

The comments in dovecot.conf make it look like there's supposed to be a colon in there, but this is the correct form.


        auth_executable = /usr/local/libexec/dovecot/dovecot-auth

More default conf file settings.


        auth_user = dovecot-auth

If you need to switch to passwd authentication for testing, change this to

        auth_user = root


        auth_verbose = yes

If you have to debug your configuration, you'll want as much information as possible.

None: HowTo/DovecotOpenLdap (last edited 2019-06-12 17:12:37 by 62)