Happy New Year!

[openldap] / contrib / slapd-modules / smbk5pwd / README

diff --git a/contrib/slapd-modules/smbk5pwd/README b/contrib/slapd-modules/smbk5pwd/README
index 8ccad2f05af6ad07b9b0435b8853bbe1fb886995..f8784d2d075292143fb2e28fbc1dc4f39e001345 100644 (file)
--- a/contrib/slapd-modules/smbk5pwd/README
+++ b/contrib/slapd-modules/smbk5pwd/README
@@ -1,13 +1,3 @@
-Copyright 2004-2005 Howard Chu, Symas Corp. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted only as authorized by the OpenLDAP
-Public License.
-
-A copy of this license is available in the file LICENSE in the
-top-level directory of the distribution or, alternatively, at
-<http://www.OpenLDAP.org/license.html>.
-
 This directory contains a slapd overlay, smbk5pwd, that extends the
 PasswordModify Extended Operation to update Kerberos keys and Samba
 password hashes for an LDAP user.
@@ -42,7 +32,38 @@ To use the overlay, add:
 to your slapd configuration file. (You should obtain the necessary schema
 files from the Heimdal and/or Samba distributions. At this time, there
 are several known errors in these schema files that you will have to
-correct before they will load in slapd.)
+correct before they will load in slapd.  As of Samba 3.0 the schema looks
+fine as shipped.)
+
+All modules compiled in (i.e. krb5 and samba) are enabled; the statement
+
+       smbk5pwd-enable         <module>
+
+can be used to enable only the desired one(s); legal values for <module>
+are "krb5", "samba" and "shadow", if they are respectively enabled by defining
+DO_KRB5, DO_SAMBA and DO_SHADOW.
+
+The samba module also supports the
+
+       smbk5pwd-must-change    <seconds>
+
+which sets the "sambaPwdMustChange" attribute accordingly to force passwd
+expiry.  A value of 0 disables this feature.
+
+The overlay now supports table-driven configuration, and thus can be run-time
+loaded and configured via back-config.  The layout of the entry is
+
+       # {0}smbk5pwd, {1}bdb, config
+       dn: olcOverlay={0}smbk5pwd,olcDatabase={1}bdb,cn=config
+       objectClass: olcOverlayConfig
+       objectClass: olcSmbK5PwdConfig
+       olcOverlay: {0}smbk5pwd
+       olcSmbK5PwdEnable: krb5
+       olcSmbK5PwdEnable: samba
+       olcSmbK5PwdMustChange: 2592000
+
+which enables both krb5 and samba modules with a password expiry time
+of 30 days.
 
 The provided Makefile builds both Kerberos and Samba support by default.
 You must edit the Makefile to insure that the correct include and library
@@ -57,3 +78,17 @@ If you need to build the overlay statically, you will have to move it into the
 slapd/overlays directory and edit the Makefile and overlays.c to reference
 it. You will also have to define SLAPD_OVER_SMBK5PWD to SLAPD_MOD_STATIC,
 and add the relevant libraries to the main slapd link command.
+
+---
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
+Copyright 2004-2016 The OpenLDAP Foundation.
+Portions Copyright 2004-2005 Howard Chu, Symas Corp. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
+
+A copy of this license is available in the file LICENSE in the
+top-level directory of the distribution or, alternatively, at
+<http://www.OpenLDAP.org/license.html>.
+