]> git.sur5r.net Git - openldap/blob - contrib/slapd-modules/smbk5pwd/README
Add description of {K5KEY} password mech
[openldap] / contrib / slapd-modules / smbk5pwd / README
1 Copyright 2004-2005 Howard Chu, Symas Corp. All rights reserved.
2
3 Redistribution and use in source and binary forms, with or without
4 modification, are permitted only as authorized by the OpenLDAP
5 Public License.
6
7 A copy of this license is available in the file LICENSE in the
8 top-level directory of the distribution or, alternatively, at
9 <http://www.OpenLDAP.org/license.html>.
10
11 This directory contains a slapd overlay, smbk5pwd, that extends the
12 PasswordModify Extended Operation to update Kerberos keys and Samba
13 password hashes for an LDAP user.
14
15 The Kerberos support is written for Heimdal using its hdb-ldap backend.
16 If a PasswordModify is performed on an entry that has the krb5KDCEntry
17 objectclass, then the krb5Key and krb5KeyVersionNumber will be updated
18 using the new password in the PasswordModify request. Additionally, a
19 new "{K5KEY}" password hash mechanism is provided. krb5KDCEntries that
20 have this hash specifier in their userPassword attribute, Simple Binds
21 will be checked against the Kerberos keys of the Entry. No data is
22 needed after the "{K5KEY}" hash specifier in the userPassword, it is
23 looked up from the Entry directly.
24
25 The Samba support is written using the Samba 3.0 LDAP schema. If a
26 PasswordModify is performed on an entry that has the sambaSamAccount
27 objectclass, then the sambaLMPassword, sambaNTPassword, and sambaPwdLastSet
28 attributes will be updated accordingly.
29
30 To use the overlay, add:
31
32         include <path to>/krb5-kdc.schema
33         include <path to>/samba.schema
34
35         moduleload <path to>smbk5pwd.so
36         ...
37
38         database bdb
39         ...
40         overlay smbk5pwd
41
42 to your slapd configuration file. (You should obtain the necessary schema
43 files from the Heimdal and/or Samba distributions. At this time, there
44 are several known errors in these schema files that you will have to
45 correct before they will load in slapd.)
46
47 The provided Makefile builds both Kerberos and Samba support by default.
48 You must edit the Makefile to insure that the correct include and library
49 paths are used. You can change the DEFS macro if you only want one or the
50 other of Kerberos or Samba support.
51
52 This overlay is only set up to be built as a dynamically loaded module.
53 If you need to build it statically, you will have to move it into the
54 slapd/overlays directory and edit the Makefile and overlays.c to reference
55 it. You will also have to define SLAPD_OVER_SMBK5PWD to SLAPD_MOD_STATIC,
56 and add the relevant libraries to the main slapd link command.