1 @value{PRODUCT} uses a configuration system built using the Free
2 Software Foundation's @samp{autoconf} program. This system makes
3 Kerberos V5 much simpler to build and reduces the amount of effort
4 required in porting Kerberos V5 to a new platform.
7 * Organization of the Source Directory:: Description of the source tree.
8 * Build Requirements:: How much disk space, etc. you need to
10 * Unpacking the Sources:: Preparing the source tree.
11 * Doing the Build:: Compiling Kerberos.
12 * Installing the Binaries:: Installing the compiled binaries.
13 * Testing the Build:: Making sure Kerberos built correctly.
14 * Options to Configure:: Command-line options to Configure
15 * osconf.h:: Header file-specific configurations
16 * Shared Library Support:: Building Shared Libraries for Kerberos V5
17 * OS Incompatibilities:: Special cases to watch for.
18 * Using Autoconf:: Modifying Kerberos V5's
19 configuration scripts.
22 @node Organization of the Source Directory, Build Requirements, Building Kerberos V5, Building Kerberos V5
23 @section Build Requirements
25 Below is a brief overview of the organization of the complete source
26 directory. More detailed descriptions follow.
30 applications with @value{PRODUCT} extensions
32 @value{PRODUCT} user programs
34 manpages for @value{PRODUCT} and the @value{PRODUCT} login program
38 administrative interface to the Kerberos master database
40 the @value{PRODUCT} Authentication Service and Key Distribution Center
42 utilities for converting between Kerberos 4 and Kerberos 5
44 libraries for use with/by @value{PRODUCT}
46 source code for building @value{PRODUCT} on MacOS
48 templates for source code files
50 utilities for propagating the database to slave KDCs
54 various utilities for building/configuring the code, sending bug reports, etc.
56 source code for building @value{PRODUCT} on Windows (see windows/README)
60 * The appl Directory::
61 * The clients Directory::
62 * The gen-manpages Directory::
63 * The include Directory::
64 * The kadmin Directory::
66 * The krb524 Directory::
68 * The prototype Directory::
69 * The slave Directory::
70 * The util Directory::
73 @node The appl Directory, The clients Directory, Organization of the Source Directory, Organization of the Source Directory
74 @subsection The appl Directory
76 The Kerberos release provides certain UNIX utilities, modified to use
77 Kerberos authentication. In the @i{appl/bsd} directory are the
78 Berkeley utilities @i{login}, @i{rlogin}, @i{rsh}, and @i{rcp}, as well as
79 the associated daemons @i{kshd} and @i{klogind}. The @i{login} program
80 obtains ticket-granting tickets for users upon login; the other utilities
81 provide authenticated Unix network services.
83 The @i{appl} directory also contains Kerberized telnet and ftp programs,
84 as well as sample Kerberos application client and server programs.
86 @node The clients Directory, The gen-manpages Directory, The appl Directory, Organization of the Source Directory
87 @subsection The clients Directory
89 This directory contains the code for several user-oriented programs.
93 This program destroys the user's active Kerberos authorization tickets.
94 @value{COMPANY} recommends that users @code{kdestroy} before logging out.
97 This program prompts users for their Kerberos principal name and password,
98 and attempts to get an initial ticket-granting-ticket for that principal.
101 This program lists the Kerberos principal and Kerberos tickets held in
102 a credentials cache, or the keys held in a keytab file.
105 This program changes a user's Kerberos password.
108 This program is a Kerberized verions of the @code{su} program that is
109 meant to securely change the real and effective user ID to that of the
110 target user and to create a new security context.
113 This program acquires a service ticket for the specified Kerberos
114 principals and prints out the key version numbers of each.
117 @node The gen-manpages Directory, The include Directory, The clients Directory, Organization of the Source Directory
118 @subsection The gen-manpages Directory
120 There are two manual pages in this directory. One is an introduction
121 to the Kerberos system. The other describes the @code{.k5login} file
122 which allows users to give access with their UID to other users
123 authenticated by the Kerberos system.
125 @node The include Directory, The kadmin Directory, The gen-manpages Directory, Organization of the Source Directory
126 @subsection The include Directory
128 This directory contains the @i{include} files needed to build the
131 @node The kadmin Directory, The kdc Directory, The include Directory, Organization of the Source Directory
132 @subsection The kadmin Directory
134 In this directory is the code for the utilities @code{kadmin},
135 @code{kadmin.local}, @code{kdb5_util}, and @code{ktutil}.
136 @code{ktutil} is the Kerberos keytab file maintenance utility from
137 which a Kerberos administrator can read, write, or edit entries in a
138 Kerberos V5 keytab or Kerberos V4 srvtab. @code{kadmin} and
139 @code{kadmin.local} are command-line interfaces to the Kerberos V5 KADM5
140 administration system. @code{kadmin.local} runs on the master KDC and
141 does not use Kerberos to authenticate to the database, while
142 @code{kadmin} uses Kerberos authentication and an encrypted RPC. The
143 two provide identical functionalities, which allow administrators to
144 modify the database of Kerberos principals. @code{kdb5_util} allows
145 administrators to perform low-level maintenance procedures on Kerberos
146 and the KADM5 database. With this utility, databases can be created,
147 destroyed, or dumped to and loaded from ASCII files. It can also be
148 used to create master key stash files.
150 @node The kdc Directory, The krb524 Directory, The kadmin Directory, Organization of the Source Directory
151 @subsection The kdc Directory
153 This directory contains the code for the @code{krb5kdc} daemon, the
154 Kerberos Authentication Service and Key Distribution Center.
156 @node The krb524 Directory, The lib Directory, The kdc Directory, Organization of the Source Directory
157 @subsection The krb524 Directory
159 This directory contains the code for @code{krb524}, a service that
160 converts Kerberos V5 credentials into Kerberos V4 credentials suitable
161 for use with applications that for whatever reason do not use V5
164 @node The lib Directory, The prototype Directory, The krb524 Directory, Organization of the Source Directory
165 @subsection The lib Directory
167 The @i{lib} directory contain 10 subdirectories as well as some
168 definition and glue files. The @i{crypto} subdirectory contains the
169 Kerberos V5 encryption library. The @i{des425} subdirectory exports
170 the Kerberos V4 encryption API, and translates these functions into
171 calls to the Kerberos V5 encryption API. The @i{gssapi} library
172 contains the Generic Security Services API, which is a library of
173 commands to be used in secure client-server communication. The
174 @i{kadm5} directory contains the libraries for the KADM5 administration
175 utilities. The Kerberos 5 database libraries are contained in
176 @i{kdb}. The directories @i{krb4} and @i{krb5} contain the Kerberos 4
177 and Kerberos 5 APIs, respectively. The @i{rpc} directory contains the
178 API for the Kerberos Remote Procedure Call protocol.
180 @node The prototype Directory, The slave Directory, The lib Directory, Organization of the Source Directory
181 @subsection The prototype Directory
183 This directory contains several template files. The @code{prototype.h}
184 and @code{prototype.c} files contain the MIT copyright message and a
185 placeholder for the title and description of the file.
186 @code{prototype.h} also has a short template for writing @code{ifdef}
187 and @code{ifndef} preprocessor statements. The @code{getopt.c} file
188 provides a template for writing code that will parse the options with
189 which a program was called.
191 @node The slave Directory, The util Directory, The prototype Directory, Organization of the Source Directory
192 @subsection The slave Directory
194 This directory contains code which allows for the propagation of the
195 Kerberos principal database from the master KDC to slave KDCs over an
196 encrypted, secure channel. @code{kprop} is the program which actually
197 propagates the database dump file. @code{kpropd} is the Kerberos V5
198 slave KDC update server which accepts connections from the @code{kprop}
199 program. @code{kslave_update} is a script that takes the name of a
200 slave server, and propagates the database to that server if the
201 database has been modified since the last dump or if the database has
202 been dumped since the last propagation.
204 @node The util Directory, , The slave Directory, Organization of the Source Directory
205 @subsection The util Directory
207 This directory contains several utility programs and libraries. The
208 programs used to configure and build the code, such as @code{autoconf},
209 @code{lndir}, @code{kbuild}, @code{reconf}, and @code{makedepend},
210 are in this directory. The @i{profile} directory contains most of the
211 functions which parse the Kerberos configuration files (@code{krb5.conf}
212 and @code{kdc.conf}). Also in this directory are the Kerberos error table
213 library and utilities (@i{et}), the Sub-system library and utilities
214 (@i{ss}), database utilities (@i{db2}), pseudo-terminal utilities
215 (@i{pty}), and bug-reporting program @code{send-pr}.
217 @node Build Requirements, Unpacking the Sources, Organization of the Source Directory, Building Kerberos V5
218 @section Organization of the Source Directory
220 In order to build Kerberos V5, you will need approximately 60-70
221 megabytes of disk space. The exact amount will vary depending on the
222 platform and whether the distribution is compiled with debugging symbol
225 If you wish to keep a separate @dfn{build tree}, which contains the compiled
226 @file{*.o} file and executables, separate from your source tree, you
227 will need a @samp{make} program which supports @samp{VPATH}, or
228 you will need to use a tool such as @samp{lndir} to produce a symbolic
229 link tree for your build tree.
231 @node Unpacking the Sources, Doing the Build, Build Requirements, Building Kerberos V5
232 @section Unpacking the Sources
234 The first step in each of these build procedures is to unpack the
235 source distribution. The Kerberos V5 distribution comes in a tar file,
236 generally named @file{krb5-@value{RELEASE}.tar}, which contains a
237 compressed tar file consisting of the sources for all of Kerberos
238 (generally @file{krb5-@value{RELEASE}.tar.gz}) and a PGP signature for
239 this source tree (generally @file{krb5-@value{RELEASE}.tar.gz.asc}).
240 @value{COMPANY} highly recommends that you verify the integrity of the
241 source code using this signature.
243 Unpack the compressed tar file in some directory, such as
244 @file{/u1/krb5-@value{RELEASE}}. (In the rest of this document, we
245 will assume that you have chosen to unpack the Kerberos V5 source
246 distribution in this directory. Note that the tarfiles will by default
247 all unpack into the @file{./krb5-@value{RELEASE}} directory, so that if
248 your current directory is @file{/u1} when you unpack the tarfiles, you
249 will get @file{/u1/krb5-@value{RELEASE}/src}, etc.)
252 @node Doing the Build, Installing the Binaries, Unpacking the Sources, Building Kerberos V5
253 @section Doing the Build
255 You have a number of different options in how to build Kerberos. If you
256 only need to build Kerberos for one platform, using a single directory
257 tree which contains both the source files and the object files is the
258 simplest. However, if you need to maintain Kerberos for a large number
259 of platforms, you will probably want to use separate build trees for
260 each platform. We recommend that you look at @ref{OS
261 Incompatibilities}, for notes that we have on particular operating
265 * Building Within a Single Tree::
266 * Building with Separate Build Directories::
267 * Building using lndir::
270 @node Building Within a Single Tree, Building with Separate Build Directories, Doing the Build, Doing the Build
271 @subsection Building Within a Single Tree
273 If you don't want separate build trees for each architecture, then
274 use the following abbreviated procedure.
278 @code{cd /u1/krb5-@value{RELEASE}/src}
287 @node Building with Separate Build Directories, Building using lndir, Building Within a Single Tree, Doing the Build
288 @subsection Building with Separate Build Directories
290 If you wish to keep separate build directories for each platform, you
291 can do so using the following procedure. (Note, this requires that your
292 @samp{make} program support @samp{VPATH}. GNU's make will provide this
293 functionality, for example.) If your @samp{make} program does not
294 support this, see the next section.
296 For example, if you wish to create a build directory for @code{pmax} binaries
297 you might use the following procedure:
301 @code{mkdir /u1/krb5-@value{RELEASE}/pmax}
303 @code{cd /u1/krb5-@value{RELEASE}/pmax}
305 @code{../src/configure}
310 @node Building using lndir, , Building with Separate Build Directories, Doing the Build
311 @subsection Building Using @samp{lndir}
313 If you wish to keep separate build directories for each platform, and
314 you do not have access to a @samp{make} program which supports @samp{VPATH},
315 all is not lost. You can use the @samp{lndir} program to create
316 symbolic link trees in your build directory.
318 For example, if you wish to create a build directory for solaris binaries
319 you might use the following procedure:
323 @code{mkdir /u1/krb5-@value{RELEASE}/solaris}
325 @code{cd /u1/krb5-@value{RELEASE}/solaris}
327 @code{/u1/krb5-@value{RELEASE}/src/util/lndir `pwd`/../src}
334 You must give an absolute pathname to @samp{lndir} because it has a bug that
335 makes it fail for relative pathnames. Note that this version differs
336 from the latest version as distributed and installed by the XConsortium
337 with X11R6. Either version should be acceptable.
339 @node Installing the Binaries, Testing the Build, Doing the Build, Building Kerberos V5
340 @section Installing the Binaries
342 Once you have built Kerberos, you should install the binaries. You
343 can do this by running:
349 If you want to install the binaries into a destination directory that
350 is not their final destination, which may be convenient if you want to
351 build a binary distribution to be deployed on multiple hosts, you may
355 % make install DESTDIR=/path/to/destdir
358 This will install the binaries under @code{DESTDIR/PREFIX}, e.g., the
359 user programs will install into @code{DESTDIR/PREFIX/bin}, the
360 libraries into @code{DESTDIR/PREFIX/lib}, etc.
362 Note that if you want to test the build (see @ref{Testing the Build}),
363 you usually do not need to do a @code{make install} first.
365 @node Testing the Build, Options to Configure, Installing the Binaries, Building Kerberos V5
366 @section Testing the Build
368 The Kerberos V5 distribution comes with built-in regression tests. To
369 run them, simply type the following command while in the top-level build
370 directory (i.e., the directory where you sent typed @samp{make} to start
371 building Kerberos; see @ref{Doing the Build}.):
378 * The DejaGnu Tests::
382 @node The DejaGnu Tests, The KADM5 Tests, Testing the Build, Testing the Build
383 @subsection The DejaGnu Tests
385 Some of the built-in regression tests are setup to use the DejaGnu
386 framework for running tests. These tests tend to be more comprehensive
387 than the normal built-in tests as they setup test servers and test
388 client/server activities.
390 DejaGnu may be found wherever GNU software is archived.
392 Most of the tests are setup to run as a non-privledged user. For some
393 of the krb-root tests to work properly, either (a) the user running the
394 tests must not have a .k5login file in the home directory or (b) the
395 .k5login file must contain an entry for @code{<username>@@KRBTEST.COM}.
396 There are two series of tests (@samp{rlogind} and @samp{telnetd}) which
397 require the ability to @samp{rlogin} as root to the local
398 machine. Admittedly, this does require the use of a @file{.rhosts} file
399 or some authenticated means. @footnote{If you are fortunate enough to
400 have a previous version of Kerberos V5 or V4 installed, and the Kerberos
401 rlogin is first in your path, you can setup @file{.k5login} or
402 @file{.klogin} respectively to allow you access.}
404 If you cannot obtain root access to your machine, all the other tests
405 will still run. Note however, with DejaGnu 1.2, the "untested testcases"
406 will cause the testsuite to exit with a non-zero exit status which
407 @samp{make} will consider a failure of the testing process. Do not worry
408 about this, as these tests are the last run when @samp{make check} is
409 executed from the top level of the build tree. This problem does not
410 exist with DejaGnu 1.3.
412 @node The KADM5 Tests, , The DejaGnu Tests, Testing the Build
413 @subsection The KADM5 Tests
415 Regression tests for the KADM5 system, including the GSS-RPC, KADM5
416 client and server libraries, and kpasswd, are also included in this
417 release. Each set of KADM5 tests is contained in a sub-directory called
418 @code{unit-test} directly below the system being tested. For example,
419 lib/rpc/unit-test contains the tests for GSS-RPC. The tests are all
420 based on DejaGnu (but they are not actually called part of "The DejaGnu
421 tests," whose naming predates the inclusion of the KADM5 system). In
422 addition, they require the Tool Command Language (TCL) header files and
423 libraries to be available during compilation and some of the tests also
424 require Perl in order to operate. If all of these resources are not
425 available during configuration, the KADM5 tests will not run. The TCL
426 installation directory can be specified with the @code{--with-tcl}
427 configure option. (See @xref{Options to Configure}.) The runtest and
428 perl programs must be in the current execution path.
430 If you install DejaGnu, TCL, or Perl after configuring and building
431 Kerberos and then want to run the KADM5 tests, you will need to
432 re-configure the tree and run @code{make} at the top level again to make
433 sure all the proper programs are built. To save time, you actually only
434 need to reconfigure and build in the directories src/kadmin/testing,
435 src/lib/rpc, src/lib/kadm5.
437 @node Options to Configure, osconf.h, Testing the Build, Building Kerberos V5
438 @section Options to Configure
440 There are a number of options to @samp{configure} which you can use to
441 control how the Kerberos distribution is built. The following table
442 lists the most commonly used options to Kerberos V5's @samp{configure}
449 Provides help to configure. This will list the set of commonly used
450 options for building Kerberos.
452 @item --prefix=PREFIX
454 By default, Kerberos will install the package's files rooted at
455 `/usr/local' as in `/usr/local/bin', `/usr/local/sbin', etc. If you
456 desire a different location, use this option.
458 @item --exec-prefix=EXECPREFIX
460 This option allows one to separate the architecture independent programs
461 from the configuration files and manual pages.
463 @item --localstatedir=LOCALSTATEDIR
465 This option sets the directory for locally modifiable single-machine
466 data. In Kerberos, this mostly is useful for setting a location for the
467 KDC data files, as they will be installed in
468 @code{LOCALSTATEDIR/krb5kdc}, which is by default
469 @code{PREFIX/var/krb5kdc}.
473 Use @code{COMPILER} as the C compiler.
477 Use @code{FLAGS} as the default set of C compiler flags.
479 Note that if you use the native Ultrix compiler on a
480 DECstation you are likely to lose if you pass no flags to cc; md4.c
481 takes an estimated 3,469 billion years to compile if you provide neither
482 the @samp{-g} flag nor the @samp{-O} flag to @samp{cc}.
484 @item CPPFLAGS=CPPOPTS
486 Use @code{CPPOPTS} as the default set of C preprocessor flags. The most
487 common use of this option is to select certain @code{#define}'s for use
488 with the operating system's include files.
492 Use @code{LINKER} as the default loader if it should be different from C
493 compiler as specified above.
497 This option allows one to specify optional arguments to be passed to the
498 linker. This might be used to specify optional library paths.
502 This option enables Kerberos V4 backwards compatibility using the
503 builtin Kerberos V4 library.
505 @item --with-krb4=KRB4DIR
507 This option enables Kerberos V4 backwards compatibility using a
508 pre-existing Kerberos V4 installation. The directory specified by
509 @code{KRB4DIR} specifies where the V4 header files should be found
510 (@file{KRB4DIR/include}) as well as where the V4 Kerberos library should
511 be found (@file{KRB4DIR/lib}).
515 Disables Kerberos V4 backwards compatibility. This prevents Kerberos V4
516 clients from using the V5 services including the KDC. This would be
517 useful if you know you will never install or need to interact with V4
520 @item --with-netlib[=libs]
522 Allows for suppression of or replacement of network libraries. By
523 default, Kerberos V5 configuration will look for @code{-lnsl} and
524 @code{-lsocket}. If your operating system has a broken resolver library
525 (see @ref{Solaris versions 2.0 through 2.3}) or fails to pass the tests in
526 @file{src/tests/resolv} you will need to use this option.
528 @item --with-tcl=TCLPATH
530 Some of the unit-tests in the build tree rely upon using a program in
531 Tcl. The directory specified by @code{TCLPATH} specifies where the Tcl
532 header file (@file{TCLPATH/include/tcl.h} as well as where the Tcl
533 library should be found (@file{TCLPATH/lib}).
535 @item --enable-shared
537 This option will turn on the building and use of shared library objects
538 in the Kerberos build. This option is only supported on certain
542 @item --enable-dns-for-kdc
543 @item --enable-dns-for-realm
545 Enable the use of DNS to look up a host's Kerberos realm, or a realm's
546 KDCs, if the information is not provided in krb5.conf. See @ref{Hostnames
547 for the Master and Slave KDCs} for information about using DNS to
548 locate the KDCs, and @ref{Mapping Hostnames onto Kerberos Realms} for
549 information about using DNS to determine the default realm. By default,
550 DNS lookups are enabled for the former but not for the latter.
552 @item --enable-kdc-replay-cache
554 Enable a cache in the KDC to detect retransmitted messages, and resend
555 the previous responses to them. This protects against certain types of
556 attempts to extract information from the KDC through some of the
557 hardware preauthentication systems.
559 @item --with-system-et
561 Use an installed version of the error-table support software, the
562 @samp{compile_et} program, the @file{com_err.h} header file and the
563 @file{com_err} library. If these are not in the default locations,
564 you may wish to specify @code{CPPFLAGS=-I/some/dir} and
565 @code{LDFLAGS=-L/some/other/dir} options at configuration time as
568 If this option is not given, a version supplied with the Kerberos
569 sources will be built and installed along with the rest of the
570 Kerberos tree, for Kerberos applications to link against.
572 @item --with-system-ss
574 Use an installed version of the subsystem command-line interface
575 software, the @samp{mk_cmds} program, the @file{ss/ss.h} header file
576 and the @file{ss} library. If these are not in the default locations,
577 you may wish to specify @code{CPPFLAGS=-I/some/dir} and
578 @code{LDFLAGS=-L/some/other/dir} options at configuration time as
579 well. See also the @samp{SS_LIB} option.
581 If this option is not given, the @file{ss} library supplied with the
582 Kerberos sources will be compiled and linked into those programs that
583 need it; it will not be installed separately.
587 If @samp{-lss} is not the correct way to link in your installed
588 @file{ss} library, for example if additional support libraries are
589 needed, specify the correct link options here. Some variants of this
590 library are around which allow for Emacs-like line editing, but
591 different versions require different support libraries to be
592 explicitly specified.
594 This option is ignored if @samp{--with-system-ss} is not specified.
596 @item --with-system-db
598 Use an installed version of the Berkeley DB package, which must
599 provide an API compatible with version 1.85. This option is
600 @emph{unsupported} and untested. In particular, we do not know if the
601 database-rename code used in the dumpfile load operation will behave
604 If this option is not given, a version supplied with the Kerberos
605 sources will be built and installed. (We are not updating this
606 version at this time because of licensing issues with newer versions
607 that we haven't investigated sufficiently yet.)
609 @item DB_HEADER=headername.h
611 If @samp{db.h} is not the correct header file to include to compile
612 against the Berkeley DB 1.85 API, specify the correct header file name
613 with this option. For example, @samp{DB_HEADER=db3/db_185.h}.
617 If @samp{-ldb} is not the correct library specification for the
618 Berkeley DB library version to be used, override it with this option.
619 For example, @samp{DB_LIB=-ldb-3.3}.
623 For example, in order to configure Kerberos on a Solaris machine using
624 the @samp{suncc} compiler with the optimizer turned on, run the configure
625 script with the following options:
628 % ./configure CC=suncc CFLAGS=-O
631 For a slightly more complicated example, consider a system where
632 several packages to be used by Kerberos are installed in
633 @samp{/usr/foobar}, including Berkeley DB 3.3, and an @samp{ss}
634 library that needs to link against the @samp{curses} library. The
635 configuration of Kerberos might be done thus:
638 % ./configure CPPFLAGS=-I/usr/foobar/include LDFLAGS=-L/usr/foobar/lib \
639 --with-system-et --with-system-ss --with-system-db \
640 SS_LIB='-lss -lcurses' \
641 DB_HEADER=db3/db_185.h DB_LIB=-ldb-3.3
644 In previous releases, @code{--with-} options were used to specify the
645 compiler and linker and their options.
647 @node osconf.h, Shared Library Support, Options to Configure, Building Kerberos V5
648 @section @file{osconf.h}
650 There is one configuration file which you may wish to edit to control
651 various compile-time parameters in the Kerberos distribution:
652 @file{include/krb5/stock/osconf.h}. The list that follows is by no means
653 complete, just some of the more interesting variables.
655 Please note: The former configuration file @file{config.h} no longer
656 exists as its functionality has been merged into the auto-configuration
657 process. @xref{Options to Configure}.
662 @item DEFAULT_PROFILE_PATH
664 The pathname to the file which contains the profiles for the known realms,
665 their KDCs, etc. The default value is @value{DefaultDefaultProfilePath}.
667 The profile file format is no longer the same format as Kerberos V4's
668 @file{krb.conf} file.
670 @item DEFAULT_KEYTAB_NAME
672 The type and pathname to the default server keytab file (the
673 equivalent of Kerberos V4's @file{/etc/srvtab}). The default is
674 @value{DefaultDefaultKeytabName}.
676 @item DEFAULT_KDC_ENCTYPE
678 The default encryption type for the KDC. The default value is
679 @value{DefaultMasterKeyType}.
683 The name of the replay cache used by the KDC. The default value is
684 @value{DefaultKDCRCache}.
688 The directory which stores replay caches. The default is to try
689 @value{DefaultRCTmpDirs}.
691 @item DEFAULT_KDB_FILE
693 The location of the default database. The default value is
694 @value{DefaultDatabaseName}.
698 @node Shared Library Support, OS Incompatibilities, osconf.h, Building Kerberos V5
699 @section Shared Library Support
701 Shared library support is provided for a few operating systems. There
702 are restrictions as to which compiler to use when using shared
703 libraries. In all cases, executables linked with the shared libraries in
704 this build process will have built in the location of the libraries,
705 therefore obliterating the need for special LD_LIBRARY_PATH, et al environment
706 variables when using the programs. Except where noted, multiple versions
707 of the libraries may be installed on the same system and continue to
710 Currently the supported platforms are Solaris 2.6-2.9 (aka SunOS
711 5.6-5.9), Irix 6.5, Redhat Linux, MacOS 8-10, and Microsoft Windows
714 Shared library support has been tested on the following platforms but
715 not exhaustively (they have been built but not necessarily tested in an
716 installed state): Tru64 (aka Alpha OSF/1 or Digital Unix) 4.0, and
719 Platforms for which there is shared library support but not significant
720 testing include FreeBSD, OpenBSD, AIX (4.3.3), Linux, NetBSD 1.4.x
721 (i386), and SunOS 4.x.
723 To enable shared libraries on the above platforms, run the configure
724 script with the option @samp{--enable-shared}.
728 XXX What does this mean?
730 One special note is that if the Kerberos V4 compatibility is compiled
731 in, you @b{must not} specify an alternate Kerberos V4 library from the
732 one in the tree or you will be missing references.
736 @node OS Incompatibilities, Using Autoconf, Shared Library Support, Building Kerberos V5
737 @section Operating System Incompatibilities
739 This section details operating system incompatibilities with Kerberos V5
740 which have been reported to the developers at MIT. If you find
741 additional incompatibilities, and/or discover work arounds to such
742 problems, please send a report via the @code{krb5-send-pr} program.
748 * Alpha OSF/1 (Digital Unix) V2.0++::
751 * Solaris versions 2.0 through 2.3::
758 @node AIX, Alpha OSF/1 V1.3, OS Incompatibilities, OS Incompatibilities
761 The AIX 3.2.5 linker dumps core trying to build a shared
762 @samp{libkrb5.a} produced with the GNU C compiler. The native AIX
763 compiler works fine. This problem is fixed using the AIX 4.1 linker.
765 @node Alpha OSF/1 V1.3, Alpha OSF/1 (Digital Unix) V2.0++, AIX, OS Incompatibilities
766 @subsection Alpha OSF/1 V1.3
768 Using the native compiler, compiling with the @samp{-O} compiler flag
769 causes the @code{asn.1} library to be compiled incorrectly.
771 Using GCC version 2.6.3 or later instead of the native compiler will also work
772 fine, both with or without optimization.
774 @node Alpha OSF/1 (Digital Unix) V2.0++, BSDI, Alpha OSF/1 V1.3, OS Incompatibilities
775 @subsection Alpha OSF/1 V2.0++
777 There used to be a bug when using the native compiler in compiling
778 @file{md4.c} when compiled without either the @samp{-O} or @samp{-g}
779 compiler options. We have changed the code and there is no problem
780 under V2.1, but we do not have access to V2.0 to test and see if the
781 problem would exist there. (We welcome feedback on this issue). There
782 was never a problem in using GCC version 2.6.3.
784 In version 3.2 and beyond of the operating system, we have not seen any
785 problems with the native compiler.
787 @c @node Alpha Tru64 UNIX 5.0
788 @c @subsection Alpha Tru64 UNIX 5.0
789 @c ... login.krb5 problems
791 @node BSDI, HPUX, Alpha OSF/1 (Digital Unix) V2.0++, OS Incompatibilities
794 BSDI versions 1.0 and 1.1 reportedly has a bad @samp{sed} which causes
795 it to go into an infinite loop during the build. The work around is
796 to use a @samp{sed} from somewhere else, such as GNU. (This may be
797 true for some versions of other systems derived from BSD 4.4, such as
800 @node HPUX, Solaris versions 2.0 through 2.3, BSDI, OS Incompatibilities
803 The native (bundled) compiler for HPUX currently will not work,
804 because it is not a full ANSI C compiler. The optional ANSI C
805 compiler should work as long as you give it the @samp{-Ae} flag
806 (i.e. @samp{./configure CC='cc -Ae'}). This is equivalent to
807 @samp{./configure CC='c89 -D_HPUX_SOURCE'}, which was the previous
808 recommendation. This has only been tested recently for HPUX 10.20.
810 @node Solaris versions 2.0 through 2.3, Solaris 2.X, HPUX, OS Incompatibilities
811 @subsection Solaris versions 2.0 through 2.3
813 The @code{gethostbyname()} routine is broken; it does not return a fully
814 qualified domain name, even if you are using the Domain Name Service
815 routines. Since Kerberos V5 uses the fully qualified domain name as the
816 second component of a service principal (i.e,
817 @samp{host/tsx-11.mit.edu@@ATHENA.MIT.EDU}), this causes problems for servers
818 who try to figure out their own fully qualified domain name.
825 Supply your own resolver library. (such as bind-4.9.3pl1 available
829 Upgrade to Solaris 2.4
832 Make sure your /etc/nsswitch.conf has `files' before `dns' like:
838 and then in /etc/hosts, make sure there is a line with your
839 workstation's IP address and hostname, with the fully qualified domain
843 18.172.1.4 dcl.mit.edu dcl
846 Note that making this change may cause other programs in your
847 environment to break or behave differently.
851 @node Solaris 2.X, Solaris 9, Solaris versions 2.0 through 2.3, OS Incompatibilities
852 @subsection Solaris 2.X
854 You @b{must} compile Kerberos V5 without the UCB compatibility
855 libraries. This means that @file{/usr/ucblib} must not be in the
856 LD_LIBRARY_PATH environment variable when you compile it. Alternatively
857 you can use the @code{-i} option to @samp{cc}, by using the specifying
858 @code{CFLAGS=-i} option to @samp{configure}.
860 If you are compiling for a 64-bit execution environment, you may need
861 to configure with the option @code{CFLAGS="-D_XOPEN_SOURCE=500
862 -D__EXTENSIONS__"}. This is not well tested; at MIT we work primarily
863 with the 32-bit execution environment.
865 @node Solaris 9, SGI Irix 5.X, Solaris 2.X, OS Incompatibilities
866 @subsection Solaris 9
868 Solaris 9 has a kernel race condition which causes the final output
869 written to the slave side of a pty to be lost upon the final close()
870 of the slave device. This causes the dejagnu-based tests to fail
871 intermittently. A workaround exists, but requires some help from the
872 scheduler, and the ``make check'' must be executed from a shell with
873 elevated priority limits.
877 @code{priocntl -s -c FX -m 30 -p 30 -i pid nnnn}
879 as root, where @code{nnnn} is the pid of the shell whose priority
880 limit you wish to raise.
882 @node SGI Irix 5.X, Ultrix 4.2/3, Solaris 9, OS Incompatibilities
883 @subsection SGI Irix 5.X
885 If you are building in a tree separate from the source tree, the vendors
886 version of make does not work properly with regards to
887 @samp{VPATH}. It also has problems with standard inference rules in 5.2
888 (not tested yet in 5.3) so one needs to use GNU's make.
890 Under 5.2, there is a bug in the optional System V @code{-lsocket}
891 library in which the routine @code{gethostbyname()} is broken. The
892 system supplied version in @code{-lc} appears to work though so one may
893 simply specify @code{--with-netlib} option to @samp{configure}.
895 In 5.3, @code{gethostbyname()} is no longer present in @code{-lsocket} and
896 is no longer an issue.
898 @node Ultrix 4.2/3, , SGI Irix 5.X, OS Incompatibilities
899 @subsection Ultrix 4.2/3
901 The DEC MIPS platform currently will not support the native compiler,
902 since the Ultrix compiler is not a full ANSI C compiler. You should use
907 On the DEC MIPS platform, using the native compiler, @file{md4.c} and
908 @file{md5.c} can not be compiled with the optimizer set at level 1.
909 That is, you must specify either @samp{CFLAGS=-O} and
910 @samp{CFLAGS=-g} to configure. If you don't specify either, the
911 compile will never complete.
913 The optimizer isn't hung; it just takes an exponentially long time.
914 Compiling 6 out of the 48 algorithmic steps takes 3 seconds; compiling 7
915 steps takes 9 seconds; compiling 8 steps takes 27 seconds, and so on.
916 Calculations estimate it will finish in approximately 3,469 billion
919 Using GCC instead of the native compiler will also work fine, both with
920 or without optimization.
924 @node Using Autoconf, , OS Incompatibilities, Building Kerberos V5
925 @section Using @samp{Autoconf}
927 (If you are not a developer, you can skip this section.)
929 In most of the Kerberos V5 source directories, there is a
930 @file{configure} script which automatically determines the compilation
931 environment and creates the proper Makefiles for a particular
932 platform. These @file{configure} files are generated using
933 @samp{autoconf}, which can be found in the @file{src/util/autoconf}
934 directory in the distribution.
936 Normal users will not need to worry about running @samp{autoconf}; the
937 distribution comes with the @file{configure} files already prebuilt.
938 Developers who wish to modify the @file{configure.in} files should see
939 @ref{Top, , Overview, autoconf, The Autoconf Manual}.
941 Note that in order to run @samp{autoconf}, you must have GNU @samp{m4}
942 in your path. Before you use the @samp{autoconf} in the Kerberos V5
943 source tree, you may also need to run @samp{configure}, and then run
944 @samp{make} in the @file{src/util/autoconf} directory in order to
945 properly set up @samp{autoconf}.
947 One tool which is provided for the convenience of developers can be
948 found in @file{src/util/reconf}. This program should be run while the
949 current directory is the top source directory. It will automatically
950 rebuild any @file{configure} files which need rebuilding. If you know
951 that you have made a change that will require that all the
952 @file{configure} files need to be rebuilt from scratch, specify the
953 @code{--force} option:
956 % cd /u1/krb5-@value{RELEASE}/src
957 % ./util/reconf --force
960 The developmental sources are a raw source tree (before it's been packaged
961 for public release), without the pre-built @file{configure} files.
962 In order to build from such a source tree, you must do:
965 % cd krb5/util/autoconf
972 Then follow the instructions for building packaged source trees (above).
973 To install the binaries into a binary tree, do:
976 % cd /u1/krb5-@value{RELEASE}/src
978 % make install DESTDIR=somewhere-else