]> granicus.if.org Git - linux-pam/blob - README
Imported 0.72 Linux-PAM sources
[linux-pam] / README
1 #
2 # $Id$
3 #
4
5 Hello!
6
7 Thanks for downloading Linux-PAM.
8
9 --------------------------------------------------------------------
10 Before you begin:
11
12   * This distribution requires GNU's Make
13   * It requires GNU's C-compiler: gcc (and 'ld')
14   * it also requires the GNU shell: bash
15   * some of the modules require the presence of libpwdb see redhat
16   * two modules have some need for libcrack too..
17
18 --------------------------------------------------------------------
19 [
20 Zeroth (optional) thing to do: check the detatched "pgp" signature for
21 this distribution file, it should be signed by
22
23 Type Bits/KeyID    Date       User ID
24 pub  1024/2A398175 1996/11/17 Andrew G. Morgan <morgan@linux.kernel.org>
25 ]
26
27 First thing to do (I assume you have successfully unpacked it!) is to
28 run:
29
30     make check                           [ requires md5sum to be present ]
31
32 This will also check that the distribution has arrived intact. [
33 Later, If you change some things, running this command from this
34 directory will show you what files you have altered. ]
35
36 If you choose to get and install the RCS files that accompany this
37 release, you may also run
38
39         make RCScheck
40
41 from this directory.
42
43 Next, you should check the symbolic link
44
45         .../Linux-PAM-X.YY/default.defs
46
47 points to the file that best describes your system. The various *.defs
48 files that are included in this distribution are to be found in the
49 directory:
50
51         .../Linux-PAM-X.YY/defs/
52
53 This should configure the distribution to compile on your system. The
54 default is the version I use for maintaining the distribution. [If you
55 don't find one that suits your needs, please try to create one, email
56 it to me and I will include it in a future release.]
57
58 If you are running an ELF based Linux system you should be able to
59 compile the distribution straight from the box. If you are running an
60 a.out based system, then some of the functionality of Linux-PAM will
61 be unavailable to you. Instead, you must switch the DYNAMIC variables
62 *off* in your "defs" file: comment out the DYNAMIC and DYNAMIC_LIBPAM
63 defines and uncomment the STATIC and STATIC_LIBPAM defines. NOTE, for
64 ELF based systems, almost any combination of these four definitions is
65 legal... If you have ELF, I recommend the default however.
66
67 Second, try to compile it. Use the following command in *this*
68 directory:
69
70         make
71
72 [ or 'make all' if you prefer ]. The first time you type make, it is
73 likely to complain. This is to remind you to remove any libraries from
74 previous versions of the distribution that are likely to confuse this
75 make... Type 'make' again.
76
77 Before you do the third thing. You should think about whether you want
78 the default configuration scripts to be installed or not. If you have
79 a working PAM based system you probably do *not* want this.. Whatever,
80 before Linux-PAM installs the default scripts you will be prompted as
81 to whether it is a good idea. Be sure to say NO if you are worried!
82 ** You have been warned. **
83
84 Third, to install the stuff you need to be root. Do the following:
85
86         su -c "make install"
87
88 If everything has worked as intended there should now be
89
90         some executables                in      ./bin/
91         some filters for pam_filter     in      /usr/sbin/pam_filter/
92         some configuration files:
93                 /etc/pam.conf
94                 /etc/security/*.conf
95         libpam_misc.a (static library)  in      /usr/lib/
96
97 In addition:
98
99     if dynamically linked:
100
101         libpam.so.XXX (shared library)          in      /usr/lib/
102         libpam_misc.so.XXX (shared library)     in      /usr/lib/
103         pam_*.so (modules)                      in      /usr/lib/security/
104
105     if statically linked:
106
107         libpam.a (static library)       in      /usr/lib/
108
109 [These are the default directories that I use. Your own system may
110 differ as specified in your XXX.defs file.]
111
112 NOTES:
113
114 * The documentation, what there is of it, is in ./doc. I am only
115 including the sgml format source-files. But try to make .ps files
116 available from the above http address. To locally use these sgml files
117 you should have linuxdoc-sgml installed. Sorry, but I'm conserving net
118 bandwidth by only including sources!
119
120 * The source for each module is to be found in ./modules/XXX. If you
121 want to add a new one, make a directory like XXX for it. Add the name
122 (XXX) to MODDIRS in ./modules/Makefile and hopefully it will become
123 part of the overall make. Note, the Makefile in ./modules/ is now
124 smart enough to check if the directory is there before it changes into
125 it; If you want to start working on a module, send me its name and I
126 will add it to the "official" Makefile.. This way, you should be able
127 to insert your developing module into any new release, and not have to
128 worry at first about letting it out to the public. This may also give
129 other people some idea about whether a module is currently being
130 worked on or not.
131
132 * Currently, you have to 'make' binaries from this directory. 'make
133 clean', however, works in any directory that has a Makefile.
134
135 * Also, you can 'make remove' (as root) from *this* directory and it
136 will delete the various installed files dotted around the system. THIS
137 IS A VERY BAD IDEA IF YOUR SYSTEM DEPENDS ON PAM TO WORK!!!
138
139 * 'make sterile' does 'make remove' and then 'make extraclean', this
140 might be required if you are alternating your choice of
141 STATIC(_LIBPAM) and DYNAMIC(_LIBPAM) compilation. SEE COMMENT IN
142 UPPERCASE IN PARAGRAPH ABOVE!!!!
143
144 Best wishes
145
146 Andrew Morgan
147
148 Email bugs/comments to: the Linux-PAM list <pam-list@redhat.com>
149 or me <morgan@linux.kernel.org>
150
151 To see about joining the mailing list, send the following email:
152 --------------------------------
153 To: pam-list-request@redhat.com
154 Subject: help
155 <empty text>
156 --------------------------------
157
158 Additionally, some Linux-PAM files have been known to be found at one
159 or more of the following places (they are not always the most up to
160 date...):
161
162 http://www.redhat.com/linux-info/pam/
163
164 ftp://bach.cis.temple.edu/pub/People/Alex/private/PAM
165 ftp://ftp.redhat.com/pub/misc/
166 ftp://linux.nrao.edu/pub/linux/ALPHA/PAM/
167 ftp://tsx-11.mit.edu/pub/linux/ALPHA/PAM/