Import Upstream version 0.69.0
[hcoop/debian/courier-authlib.git] / README.ldap
CommitLineData
d9898ee8 1LDAP support based on a patch by:
2Luc Saillard <luc.saillard@alcove.fr> Thu, 30 Dec 1999 20:33:08 +0100
3
4Adapted as a generic authlib authentication module - SV 12/31/99.
5
6Configuration File
7------------------
8
9 LDAP configuration is placed in the file authldaprc, which is installed,
10 by default, as /usr/lib/courier-imap/etc/authldaprc.
11 Use --with-authldaprc=pathname to override the location.
12
13 This file must be owned by root and have the permissions set to 0400
14 because the LDAP administrator password is stored in this file.
15
16 See the default authldaprc for more information.
17
18 CC both me and Luc Saillard for questions on authldap.
19
20Schema
21------
22
23OpenLDAP 2.0 defaults to schema checking on all directories. The file
24authldap.schema contains a definition of a LDAP objects
25CourierMailAccount, CourierMailAlias, and CourierDomainAlias.
26
27Only CourierMailAccount is used for mailbox authentication (i.e. IMAP,
28webmail). The other two objects are used by LDAP-based mail routing
29in the Courier Mail Server.
30
8d138742
CE
31The file authldap.ldif contains an ldif format definition of the same objects.
32This is the same schema definition as in authldap.schema, except in the ldif
33format.
34
d9898ee8 35Here are some sample LDAP objects that use this schema:
36
37dn: o=example, c=com
38ObjectClass: organization
39o: example
40c: com
41
42dn: mail=xyz123@example.com, o=example, c=com
43ObjectClass: CourierMailAccount
8d138742
CE
44ObjectClass: person
45cn: Xavier Y Zimmerman
46sn: Zimmerman
d9898ee8 47mail: xyz123@example.com
d9898ee8 48clearPassword: tux
49userPassword: {MD5}WrbkuYvH+3FvwH7Zj+34Ag==
50homeDirectory: /home/xyz123
51uidNumber: 1001
52gidNumber: 1001
53
54dn: mail=mailalias@example.com, o=example, c=com
55ObjectClass: CourierMailAlias
8d138742
CE
56ObjectClass: nisMailAlias
57cn: mailalias
d9898ee8 58mail: mailalias
59maildrop: xyz123
60
61dn: virtualdomain=domain.com, o=example, c=com
8d138742 62ObjectClass: nisMailAlias
d9898ee8 63ObjectClass: CourierDomainAlias
8d138742 64cn: domain.com
d9898ee8 65virtualdomain: domain.com
66virtualdomainuser: wxyz456
67
68
69Notice on Luc's original patch:
70-------------------------------
71
72 Copyright (C) 1999 Luc Saillard
73
74 This program is free software; you can redistribute it and/or modify
75 it under the terms of the GNU General Public License as published by
76 the Free Software Foundation; either version 2 of the License, or
77 (at your option) any later version.
78
79 This program is distributed in the hope that it will be useful,
80 but WITHOUT ANY WARRANTY; without even the implied warranty of
81 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
82 GNU General Public License for more details.
83
84 You should have received a copy of the GNU General Public License
85 along with this program; if not, write to the Free Software
86 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
87