Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libpam / modules / pam_krb5 / README
1 $FreeBSD: src/lib/libpam/modules/pam_krb5/README,v 1.1.2.2 2001/07/29 18:57:30 markm Exp $
2
3 This is the README for pam_krb5, a PAM module which support Kerberos 5
4 authentication.
5
6 This software is Copyright (c) 1999-2000 Frank Cusack.
7 All Rights Reserved.
8
9 See the COPYRIGHT file, included with this distribution, for copyright
10 and redistribution information.
11
12 Author:
13 Frank Cusack
14 <fcusack@fcusack.com>
15
16
17 I. Kerberos notes
18
19 This PAM module requires the MIT 1.1+ release of Kerberos, or the Cygnus
20 CNS distribution. It has not been tested against heimdal or any other
21 Kerberos distributions.
22
23 Unlike other PAM Kerberos 5 modules out there, this one does not
24 use any private Kerberos interfaces. Thus, you need only the
25 header files and libraries that are part of the Kerberos distribution.
26
27
28 II. OS notes
29
30 This software has been tested against Solaris 2.6. It should compile
31 against Linux (distributions?) with minimal (if any) changes. Reports
32 of OS [in]compatibilities are welcomed.
33
34 dtlogin on Solaris doesn't support xrealm logins (probably a good thing).
35
36 III. PAM notes/open issues
37
38 auth module:
39 When is pam_sm_setcred() ever called with flags other than PAM_ESTABLISH_CRED?
40 It would be fairly easy to support PAM_DELETE_CRED.
41
42 acct module:
43 I believe this to be complete.
44
45 session module:
46 This is complete (both functions just return success).
47
48 passwd module:
49 When is pam_sm_chauthtok() ever called with flags other than
50 PAM_UPDATE_AUTHTOK?
51
52
53 IV. Usage
54
55 Simply change /etc/pam.conf to include this module. Make sure to include
56 the acct category whenever you use the auth category, or .k5login will
57 not get checked.
58
59 You probably want to make this module "sufficient", before your unix
60 (or other) module(s).
61
62
63 V. Acknowledgements
64
65 Thanks to Naomaru Itoi <itoi@eecs.umich.edu>,
66 Curtis King <curtis.king@cul.ca>, and Derrick Brashear <shadow@dementia.org>,
67 all of whom have written and made available Kerberos 4/5 modules.
68 Although no code in this module is directly from these author's modules,
69 (except the get_user_info() routine in support.c; derived from whichever
70 of these authors originally wrote the first module the other 2 copied from),
71 it was extremely helpful to look over their code which aided in my design.
72