This is Info file krb5-install.info, produced by Makeinfo-1.55 from the input file install.texinfo.  File: krb5-install.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) This file documents how to install the beta 7 release of Kerberos V5. Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996 by the Massachusetts Institute of Technology. Export of software employing encryption from the United States of America may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting. WITHIN THAT CONSTRAINT, permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of M.I.T. not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. M.I.T. makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. Kerberos V5 includes documentation and software developed at the University of California at Berkeley, which includes this copyright notice: Copyright (C) 1983 Regents of the University of California. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the University of California, Berkeley and its contributors. 4. Neither the name of the University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notices and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions. * Menu: * Introduction:: * Realm Configuration Decisions:: * Building Kerberos V5:: * Installing Kerberos V5:: * Bug Reports for Kerberos V5:: * Files::  File: krb5-install.info, Node: Introduction, Next: Realm Configuration Decisions, Prev: Top, Up: Top Introduction ************ * Menu: * What is Kerberos and How Does it Work?:: * Why Should I use Kerberos?:: * Please Read the Documentation:: * Overview of This Guide::  File: krb5-install.info, Node: What is Kerberos and How Does it Work?, Next: Why Should I use Kerberos?, Prev: Introduction, Up: Introduction What is Kerberos and How Does it Work? ====================================== Kerberos V5 is based on the Kerberos authentication system developed at MIT. Under Kerberos, a client (generally either a user or a service) sends a request for a ticket to the Key Distribution Center (KDC). The KDC creates a "ticket-granting ticket" (TGT) for the client, encrypts it using the client's password as the key, and sends the encrypted TGT back to the client. The client then attempts to decrypt the TGT, using its password. If the client successfully decrypts the TGT (i.e., if the client gave the correct password), it keeps the decrypted TGT, which indicates proof of the client's identity. The TGT, which expires at a specified time, permits the client to obtain additional tickets, which give permission for specific services. The requesting and granting of these additional tickets is user-transparent.  File: krb5-install.info, Node: Why Should I use Kerberos?, Next: Please Read the Documentation, Prev: What is Kerberos and How Does it Work?, Up: Introduction Why Should I use Kerberos? ========================== Since Kerberos negotiates authenticated, and optionally encrypted, communications between two points anywhere on the internet, it provides a layer of security that is not dependent on which side of a firewall either client is on. Since studies have shown that half of the computer security breaches in industry happen from inside firewalls, Kerberos V5 from MIT will play a vital role in the security of your network. This document is one piece of the document set for Kerberos V5. The documents, and their intended audiences, are: * Kerberos V5 Installation Guide: a concise guide for installing Kerberos V5. Kerberos administrators (particularly whoever will be making site-wide decisions about the installation) and the system administrators who will be installing the software should read this guide. * Kerberos V5 System Administrator's Guide: a sysadmin's guide to administering a Kerberos installation. The System Administrator's Guide describes the administration software and suggests policies and procedures for administering a Kerberos installation. Anyone who will have administrative access to your Kerberos database should read this guide. * Kerberos V5 UNIX User's Guide: a guide to using the Kerberos UNIX client programs. All users on UNIX systems should read this guide, particularly the "Tutorial" section.  File: krb5-install.info, Node: Please Read the Documentation, Next: Overview of This Guide, Prev: Why Should I use Kerberos?, Up: Introduction Please Read the Documentation ============================= As with any software package that uses a centrallized database, the installation procedure is somewhat involved, and requires forethought and planning. MIT has attempted to make this Kerberos V5 Installation Guide as concise as possible, rather than making it an exhaustive description of the details of Kerberos. Consequently, everything in this guide appears because MIT believes that it is important. Please read and follow these instructions carefully, and if there is anything you do not understand or are not sure of, please don't hesitate to call us.  File: krb5-install.info, Node: Overview of This Guide, Prev: Please Read the Documentation, Up: Introduction Overview of This Guide ====================== The next chapter describes the decisions you need to make before installing Kerberos V5. Chapter three describes installation procedures for each class of Kerberos machines: 1. Key Distribution Centers (KDCs). A. The Master KDC. B. Slave KDCs. 2. Client machines (user machines): A. UNIX client machines. B. Windows machines. C. Macintoshes. 3. application server machines Note that a machine can be both a client machine and an application server. Chapter four describes our problem reporting system. The appendices give sample configuration files.  File: krb5-install.info, Node: Realm Configuration Decisions, Next: Building Kerberos V5, Prev: Introduction, Up: Top Realm Configuration Decisions ***************************** Before installing Kerberos V5, it is necessary to consider the following issues: * The name of your Kerberos realm (or the name of each realm, if you need more than one). * How you will map your hostnames onto Kerberos realms. * Which ports your KDC and and kadmin (database access) services will use. * How many slave KDCs you need and where they should be located. * The hostnames of your master and slave KDCs. * How frequently you will propagate the database from the master KDC to the slave KDCs. * Whether you need backward compatibility with Kerberos V4. * Menu: * Kerberos Realms:: * Mapping Hostnames onto Kerberos Realms:: * Ports for the KDC and Admin Services:: * Slave KDCs:: * Hostnames for the Master and Slave KDCs:: * Database Propagation::  File: krb5-install.info, Node: Kerberos Realms, Next: Mapping Hostnames onto Kerberos Realms, Prev: Realm Configuration Decisions, Up: Realm Configuration Decisions Kerberos Realms =============== Although your Kerberos realm can be any ASCII string, convention is to make it the same as your domain name, in upper-case letters. For example, hosts in the domain fubar.org would be in the Kerberos realm FUBAR.ORG. If you need multiple Kerberos realms, MIT recommends that you use descriptive names which end with your domain name, such as BOSTON.FUBAR.ORG and SAN_FRANCISCO.FUBAR.ORG.  File: krb5-install.info, Node: Mapping Hostnames onto Kerberos Realms, Next: Ports for the KDC and Admin Services, Prev: Kerberos Realms, Up: Realm Configuration Decisions Mapping Hostnames onto Kerberos Realms ====================================== Mapping hostnames onto Kerberos realms is done through a set of rules in the `krb5.conf' configuration file. (*Note krb5.conf::.) You can specify mappings for an entire domain or subdomain, and/or on a hostname-by-hostname basis. Since greater specificity takes precedence, you would do this by specifying the mappings for a given domain or subdomain and listing the exceptions.  File: krb5-install.info, Node: Ports for the KDC and Admin Services, Next: Slave KDCs, Prev: Mapping Hostnames onto Kerberos Realms, Up: Realm Configuration Decisions Ports for the KDC and Admin Services ==================================== The default ports used by Kerberos are port 88 for the KDC(1) and port 749 for the admin server. You can, however, choose to run on other ports, as long as they are specified in each host's `/etc/services' and `krb5.conf' files, and the `kdc.conf' file on each KDC. Because the kadmin port was recently assigned, MIT recommands that you specify it explicitly in your `krb5.conf' and `kdc.conf' files. For a more thorough treatment of port numbers used by the Kerberos V5 programs, refer to the "Configuring Your Firewall to Work With Kerberos V5" section of the `Kerberos V5 System Administrator's Guide'. ---------- Footnotes ---------- (1) Kerberos V4 used port 750. If necessary, you can run on both ports for backward compatibility.  File: krb5-install.info, Node: Slave KDCs, Next: Hostnames for the Master and Slave KDCs, Prev: Ports for the KDC and Admin Services, Up: Realm Configuration Decisions Slave KDCs ========== Slave KDCs provide an additional source of Kerberos ticket-granting services in the event of inaccessibility of the master KDC. The number of slave KDCs you need and the decision of where to place them, both physically and logically, depend on the specifics of your network. All of the Kerberos authentication on your network requires that each client be able to contact a KDC. Therefore, you need to anticipate any likely reason a KDC might be unavailable and have a slave KDC to take up the slack. Some considerations include: * Have at least one slave KDC as a backup, for when the master KDC is down, is being upgraded, or is otherwise unavailable. * If your network is split such that a network outage is likely to cause some segment or segments of the network to become cut off or isolated, have a slave KDC accessible to each segment. * If possible, have at least one slave KDC in a different building from the master, in case of power outages, fires, or other localized disasters. If you have a large and/or complex network, MIT will be happy to work with you to determine the optimal number and placement of your slave KDCs.  File: krb5-install.info, Node: Hostnames for the Master and Slave KDCs, Next: Database Propagation, Prev: Slave KDCs, Up: Realm Configuration Decisions Hostnames for the Master and Slave KDCs ======================================= MIT recommends that your KDCs have a predefined set of cnames, such as `kerberos' for the master KDC and `kerberos-1', `kerberos-2', ... for the slave KDCs. This way, if you need to swap a machine, you only need to change a DNS entry, rather than having to change hostnames.  File: krb5-install.info, Node: Database Propagation, Prev: Hostnames for the Master and Slave KDCs, Up: Realm Configuration Decisions Database Propagation ==================== The Kerberos database resides on the master KDC, and must be propagated regularly (usually by a cron job) to the slave KDCs. In deciding how frequently the propagation should happen, you will need to balance the amount of time the propagation takes against the maximum reasonable amount of time a user should have to wait for a password change to take effect. MIT recommends that this be no longer than an hour. If the propagation time is longer than this maximum reasonable time (e.g., you have a particularly large database, you have a lot of slaves, and/or you experience frequent network delays), you may wish to cut down on your propagation delay by performing the propagation in parallel. To do this, have the master KDC propagate the database to one set of slaves, and then have each of these slaves propagate the database to additional slaves.  File: krb5-install.info, Node: Building Kerberos V5, Next: Installing Kerberos V5, Prev: Realm Configuration Decisions, Up: Top Building Kerberos V5 ******************** Starting with the Beta 4 distribution, we are using a new configuration system, which was built using the Free Software Foundation's `autoconf' program. This system will hopefully make Kerberos V5 much simpler to build and reduce the amount of effort required in porting Kerberos V5 to a new platform. * Menu: * Build Requirements:: How much disk space, etc. you need to build Kerberos. * Unpacking the Sources:: Preparing the source tree. * Doing the Build:: Compiling Kerberos. * Testing the Build:: Making sure Kerberos built correctly. * Options to Configure:: Command-line options to Configure * osconf.h:: Header file-specific configurations * Shared Library Support:: Building Shared Libraries for Kerberos V5 * OS Incompatibilities:: Special cases to watch for. * Using Autoconf:: Modifying Kerberos V5's configuration scripts.  File: krb5-install.info, Node: Build Requirements, Next: Unpacking the Sources, Prev: Building Kerberos V5, Up: Building Kerberos V5 Build Requirements ================== In order to build Kerberos V5, you will need approximately 60-70 megabytes of disk space. The exact amount will vary depending on the platform and whether the distribution is compiled with debugging symbol tables or not. If you wish to keep a separate "build tree", which contains the compiled `*.o' file and executables, separate from your source tree, you will need a `make' program which supports `VPATH', or you will need to use a tool such as `lndir' to produce a symbolic link tree for your build tree.  File: krb5-install.info, Node: Unpacking the Sources, Next: Doing the Build, Prev: Build Requirements, Up: Building Kerberos V5 Unpacking the Sources ===================== The first step in each of these build procedures is to unpack the source distribution. The Kerberos V5 distribution comes in two compressed tar files. The first file, which is generally named `krb5.src.tar.gz', contains the sources for all of Kerberos except for the crypto library, which is found in the file `krb5.crypto.tar.gz'. Both files should be unpacked in the same directory, such as `/u1/krb5'. (In the rest of this document, we will assume that you have chosen to unpack the Kerberos V5 source distribution in this directory.)  File: krb5-install.info, Node: Doing the Build, Next: Testing the Build, Prev: Unpacking the Sources, Up: Building Kerberos V5 Doing the Build =============== You have a number of different options in how to build Kerberos. If you only need to build Kerberos for one platform, using a single directory tree which contains both the source files and the object files is the simplest. However, if you need to maintain Kerberos for a large number of platforms, you will probably want to use separate build trees for each platform. We recommend that you look at see *Note OS Incompatibilities:: for notes that we have on particular operating systems. * Menu: * Building Within a Single Tree:: * Building with Separate Build Directories:: * Building using lndir::  File: krb5-install.info, Node: Building Within a Single Tree, Next: Building with Separate Build Directories, Prev: Doing the Build, Up: Doing the Build Building Within a Single Tree ----------------------------- If you don't want separate build trees for each architecture, then use the following abbreviated procedure. 1. `cd /u1/krb5/src' 2. `./configure' 3. `make' That's it!  File: krb5-install.info, Node: Building with Separate Build Directories, Next: Building using lndir, Prev: Building Within a Single Tree, Up: Doing the Build Building with Separate Build Directories ---------------------------------------- If you wish to keep separate build directories for each platform, you can do so using the following procedure. (Note, this requires that your `make' program support `VPATH'. GNU's make will provide this functionality, for example.) If your `make' program does not support this, see the next section. For example, if you wish to create a build directory for `pmax' binaries you might use the following procedure: 1. `mkdir /u1/krb5/pmax' 2. `cd /u1/krb5/pmax' 3. `../src/configure' 4. `make'  File: krb5-install.info, Node: Building using lndir, Prev: Building with Separate Build Directories, Up: Doing the Build Building Using `lndir' ---------------------- If you wish to keep separate build directories for each platform, and you do not have access to a `make' program which supports `VPATH', all is not lost. You can use the `lndir' program to create symbolic link trees in your build directory. For example, if you wish to create a build directory for solaris binaries you might use the following procedure: 1. `mkdir /u1/krb5/solaris' 2. `cd /u1/krb5/solaris' 3. `/u1/krb5/src/util/lndir `pwd`/../src' 4. `./configure' 5. `make' You must give an absolute pathname to `lndir' because it has a bug that makes it fail for relative pathnames. Note that this version differs from the latest version as distributed and installed by the XConsortium with X11R6. Either version should be acceptable.  File: krb5-install.info, Node: Testing the Build, Next: Options to Configure, Prev: Doing the Build, Up: Building Kerberos V5 Testing the Build ================= The Kerberos V5 distribution comes with built-in regression tests. To run them, simply type the following command while in the top-level build directory (i.e., the directory where you sent typed `make' to start building Kerberos; see *Note Doing the Build::.): % make check * Menu: * The DejaGnu Tests::  File: krb5-install.info, Node: The DejaGnu Tests, Prev: Testing the Build, Up: Testing the Build The DejaGnu Tests ----------------- Some of the built-in regression tests are setup to use the DejaGnu framework for running tests. These tests tend to be more comprehensive than the normal built-in tests as they setup test servers and test client/server activities. DejaGnu may be found wherever GNU software is archived. Most of the tests are setup to run as a non-privledged user. There are two series of tests (`rlogind' and `telnetd') which require the ability to `rlogin' as root to the local machine. Admittedly, this does require the use of a `.rhosts' file or some other authenticated means. (1) If you cannot obtain root access to your machine, all the other tests will still run. Note however, with DejaGnu 1.2, the "untested testcases" will cause the testsuite to exit with a non-zero exit status which `make' will consider a failure of the testing process. Do not worry about this, as these tests are the last run when `make check' is executed from the top level of the build tree. ---------- Footnotes ---------- (1) If you are fortunate enough to have a previous version of Kerberos V5 or V4 installed, and the Kerberos rlogin is first in your path, you can setup `.k5login' or `.klogin' respectively to allow you access.  File: krb5-install.info, Node: Options to Configure, Next: osconf.h, Prev: Testing the Build, Up: Building Kerberos V5 Options to Configure ==================== There are a number of options to `configure' which you can use to control how the Kerberos distribution is built. The following table lists the most commonly used options to Kerberos V5's `configure' program. `--help' Provides help to configure. This will list the set of commonly used options for building Kerberos. `--prefix=DIR' By default, Kerberos will install the package's files rooted at `/usr/local' as in `/usr/local/bin', `/usr/local/sbin', etc. If you desire a different location use this option. `--exec-prefix=DIR' This option allows one to separate the architecture independent programs from the configuration files and manual pages. `--with-cc=COMPILER' Use `COMPILER' as the C compiler. `--with-ccopts=FLAGS' Use `FLAGS' as the default set of C compiler flags. Note that if you use the native Ultrix compiler on a DECstation you are likely to lose if you pass no flags to cc; md4.c takes an estimated 3,469 billion years to compile if you provide neither the `-g' flag nor the `-O' flag to `cc'. `--with-cppopts=CPPOPTS' Use `CPPOPTS' as the default set of C preprocessor flags. The most common use of this option is to select certain `#define''s for use with the operating system's include files. `--with-linker=LINKER' Use `LINKER' as the default loader if it should be different from C compiler as specified above. `--with-ldopts=LDOPTS' This option allows one to specify optional arguments to be passed to the linker. This might be used to specify optional library paths. `--with-krb4' This option enables Kerberos V4 backwards compatibility using the builtin Kerberos V4 library. `--with-krb4=KRB4DIR' This option enables Kerberos V4 backwards compatibility. The directory specified by `KRB4DIR' specifies where the V4 header files should be found (`/KRB4DIR/include') as well as where the V4 Kerberos library should be found (`/KRB4DIR/lib'). `--without-krb4' Disables Kerberos V4 backwards compatibility. This prevents Kerberos V4 clients from using the V5 services including the KDC. This would be useful if you know you will never install or need to interact with V4 clients. `--with-netlib[=libs]' Allows for suppression of or replacement of network libraries. By default, Kerberos V5 configuration will look for `-lnsl' and `-lsocket'. If your operating system has a broken resolver library (see *Note Solaris versions 2.0 through 2.3::) or fails to pass the tests in `src/tests/resolv' you will need to use this option. `--enable-shared' This option will turn on the building and use of shared library objects in the Kerberos build. This option is only supported on certain platforms. `--with-vague-errors' If enabled, gives vague and unhelpful error messages to the client... er, attacker. (Needed to meet silly government regulations; most other sites will want to keep this undefined.) `--with-kdc-kdb-update' Set this option if you want to allow the KDC to modify the Kerberos database; this allows the last request information to be updated, as well as the failure count information. Note that this doesn't work if you're using slave servers!!! It also causes the database to be modified (and thus needing to be locked) frequently. Please note that the implementors do not regularly test this feature. `--with-kdb-db=database' The configuration process will try to determine a working set of libraries required to implement the Kerberos database. Configure will look for interfaces that use or emulate a `ndbm' or `dbm' library. Failing that, a build in copy of the Berkeley DB code will be used. You may decide to compile a different interface than the default by specifying one of "ndbm", "dbm", or "db". An important note on platforms where the `ndbm' implementation is based on GDBM (such as the Linux Slackware distribution). GDBM has its own built in file locking which prevents simultaneous access to the database from two separate processes in which one wants to modify the database while the otherone only wants to read. (i.e. the KDC and administrative servers). In this case, you will need to specify the use of the Berkeley DB. For example, in order to configure Kerberos on a Solaris machine using the `suncc' with the optimizer turned on, run the configure script with the following options: % ./configure --with-cc=suncc --with-ccopts=-O  File: krb5-install.info, Node: osconf.h, Next: Shared Library Support, Prev: Options to Configure, Up: Building Kerberos V5 `osconf.h' ========== There is one configuration file which you may wish to edit to control various compile-time parameters in the Kerberos distribution: `include/krb5/stock/osconf.h'. The list that follows is by no means complete, just some of the more interesting variables. Please note: The former configuration file `config.h' no longer exists as its functionality has been merged into the auto-configuration process. *Note Options to Configure::. `DEFAULT_PROFILE_PATH' The pathname to the file which contains the profiles for the known realms, their KDCs, etc. The profile file format is no longer the same format as Kerberos V4's `krb.conf' file. `DEFAULT_LNAME_FILENAME' The pathname to the database that maps authentication names to local account names. See kdb5_anadd(8). `DEFAULT_KEYTAB_NAME' The type and pathname to the default server keytab file (the equivalent of Kerberos V4's `/etc/srvtab'). `DEFAULT_KDC_ENCTYPE' The default encryption type for the KDC. `KDCRCACHE' The name of the replay cache used by the KDC. `RCTMPDIR' The directory which stores replay caches. `DEFAULT_KDB_FILE' The location of the default database  File: krb5-install.info, Node: Shared Library Support, Next: OS Incompatibilities, Prev: osconf.h, Up: Building Kerberos V5 Shared Library Support ====================== Shared library support is provided for a few operating systems. There are restrictions as to which compiler to use when using shared libraries. In all cases, executables linked with the shared libraries in this build process will have built in the location of the libraries, therefore obliterating the need for special LD_LIBRARY_PATH, et al environment variables when using the programs. Except where noted, multiple versions of the libraries may be installed on the same system and continue to work. Currently the supported platforms are: NetBSD 1.0A, AIX 3.2.5, AIX 4.1, Solaris 5.3, Alpha OSF/1 >= 2.1, HP-UX >= 9.X. To enable shared libraries on the above platforms, run the configure script with the option `--enable-shared'.  File: krb5-install.info, Node: OS Incompatibilities, Next: Using Autoconf, Prev: Shared Library Support, Up: Building Kerberos V5 Operating System Incompatibilities ================================== This section details operating system incompatibilities with Kerberos V5 which have been reported to the developers at MIT. If you find additional incompatibilities, and/or discover work arounds to such problems, please send a report to krb5-bugs@mit.edu. Thanks! * Menu: * AIX:: * Alpha OSF/1 V1.3:: * Alpha OSF/1 (Digital Unix) V2.0++:: * BSDI:: * HPUX:: * Solaris versions 2.0 through 2.3:: * Solaris 2.X:: * SGI Irix 5.X:: * Ultrix 4.2/3::  File: krb5-install.info, Node: AIX, Next: Alpha OSF/1 V1.3, Prev: OS Incompatibilities, Up: OS Incompatibilities AIX --- The AIX 3.2.5 linker dumps core trying to build a shared `libkrb5.a' produced with the GNU C compiler. The native AIX compiler works fine. This problem is fixed using the AIX 4.1 linker.  File: krb5-install.info, Node: Alpha OSF/1 V1.3, Next: Alpha OSF/1 (Digital Unix) V2.0++, Prev: AIX, Up: OS Incompatibilities Alpha OSF/1 V1.3 ---------------- Using the native compiler, compiling with the `-O' compiler flag causes the `asn.1' library to be compiled incorrectly. Using GCC version 2.6.3 or later instead of the native compiler will also work fine, both with or without optimization.  File: krb5-install.info, Node: Alpha OSF/1 (Digital Unix) V2.0++, Next: BSDI, Prev: Alpha OSF/1 V1.3, Up: OS Incompatibilities Alpha OSF/1 V2.0++ ------------------ There used to be a bug when using the native compiler in compiling `md4.c' when compiled without either the `-O' or `-g' compiler options. We have changed the code and there is no problem under V2.1, but we do not have access to V2.0 to test and see if the problem would exist there. (We welcome feedback on this issue). There was never a problem in using GCC version 2.6.3. In version 3.2 and beyond of the operating system, we have not seen any problems with the native compiler.  File: krb5-install.info, Node: BSDI, Next: HPUX, Prev: Alpha OSF/1 (Digital Unix) V2.0++, Up: OS Incompatibilities BSDI ---- BSDI versions 1.0 and 1.1 reportedly has a bad `sed' which causes it to go into an infinite loop during the build. The work around is to use a `sed' from somewhere else, such as GNU. (This may be true for some versions of other systems derived from BSD 4.4, such as NetBSD and FreeBSD.)  File: krb5-install.info, Node: HPUX, Next: Solaris versions 2.0 through 2.3, Prev: BSDI, Up: OS Incompatibilities HPUX ---- The native compiler for HPUX currently will not work, because it is not a full ANSI C compiler. The optional compiler (c89) should work as long as you give it the `+Olibcalls -D_HPUX_SOURCE' (this has only been tested for HPUX 9.0). At this point, using GCC is probably your best bet.  File: krb5-install.info, Node: Solaris versions 2.0 through 2.3, Next: Solaris 2.X, Prev: HPUX, Up: OS Incompatibilities Solaris versions 2.0 through 2.3 -------------------------------- The `gethostbyname()' routine is broken; it does not return a fully qualified domain name, even if you are using the Domain Name Service routines. Since Kerberos V5 uses the fully qualified domain name as the second component of a service principal (i.e, `host/tsx-11.mit.edu@ATHENA.MIT.EDU'), this causes problems for servers who try to figure out their own fully qualified domain name. Workarounds: 1. Supply your own resolver library. (such as bind-4.9.3pl1 availavle from ftp.vix.com) 2. Upgrade to Solaris 2.4 3. Make sure your /etc/nsswitch.conf has `files' before `dns' like: hosts: files dns and then in /etc/hosts, make sure there is a line with your workstation's IP address and hostname, with the fully qualified domain name first. Example: 18.172.1.4 dcl.mit.edu dcl Note that making this change may cause other programs in your environment to break or behave differently.  File: krb5-install.info, Node: Solaris 2.X, Next: SGI Irix 5.X, Prev: Solaris versions 2.0 through 2.3, Up: OS Incompatibilities Solaris 2.X ----------- You must compile Kerberos V5 without the UCB compatibility libraries. This means that `/usr/ucblib' must not be in the LD_LIBRARY_PATH environment variable when you compile it. Alternatively you can use the `-i' option to `cc', by using the specifying `--with-ccopts=-i' option to `configure'. Shared library support only works when using the Sunsoft C compiler. We are currently using version 3.0.1. (The latest GCC may work; this needs to be tested.)  File: krb5-install.info, Node: SGI Irix 5.X, Next: Ultrix 4.2/3, Prev: Solaris 2.X, Up: OS Incompatibilities SGI Irix 5.X ------------ If you are building in a tree separate from the source tree, the vendors version of make does not work properly with regards to `VPATH'. It also has problems with standard inference rules in 5.2 (not tested yet in 5.3) so one needs to use GNU's make. Under 5.2, there is a bug in the optional System V `-lsocket' library in which the routine `gethostbyname()' is broken. The system supplied version in `-lc' appears to work though so one may simply specify `--with-netlib' option to `configure'. In 5.3, `gethostbyname()' is no longer present in `-lsocket' and is no longer an issue.  File: krb5-install.info, Node: Ultrix 4.2/3, Prev: SGI Irix 5.X, Up: OS Incompatibilities Ultrix 4.2/3 ------------ The DEC MIPS platform currently will not support the native compiler, since the Ultrix compiler is not a full ANSI C compiler. You should use GCC instead.  File: krb5-install.info, Node: Using Autoconf, Prev: OS Incompatibilities, Up: Building Kerberos V5 Using `Autoconf' ================ (If you are not a developer, you can skip this section.) In most of the Kerberos V5 source directories, there is a `configure' script which automatically determines the compilation environment and creates the proper Makefiles for a particular platform. These `configure' files are generated using `autoconf' version 2.4, which can be found in the `src/util/autoconf' directory in the distribution. Normal users will not need to worry about running `autoconf'; the distribution comes with the `configure' files already prebuilt. Developers who wish to modify the `configure.in' files should see *Note Overview: (autoconf)Top. Note that in order to run `autoconf', you must have GNU `m4' in your path. Before you use the `autoconf' in the Kerberos V5 source tree, you may also need to run `configure', and then run `make' in the `src/util/autoconf' directory in order to properly set up `autoconf'. One tool which is provided for the convenience of developers can be found in `src/util/reconf'. This program should be run while the current directory is the top source directory. It will automatically rebuild any `configure' files which need rebuilding. If you know that you have made a change that will require that all the `configure' files need to be rebuilt from scratch, specify the `--force' option: % cd /u1/krb5/src % ./util/reconf --force The developmental sources are a raw source tree (before it's been packaged for public release), without the pre-built `configure' files. In order to build from such a source tree, you must do: % cd krb5/util/autoconf % ./configure % make % cd ../.. % util/reconf Then follow the instructions for building packaged source trees (above). To install the binaries into a binary tree, do: % cd /u1/krb5/src % make all % make install DESTDIR=somewhere-else  File: krb5-install.info, Node: Installing Kerberos V5, Next: Bug Reports for Kerberos V5, Prev: Building Kerberos V5, Up: Top Installing Kerberos V5 ********************** The sections of this chapter describe procedures for installing Kerberos V5 on: 1. The KDCs 2. Client machines A. UNIX client machines B. Windows machines C. Macintoshes 3. UNIX Application Servers * Menu: * Installing KDCs:: * Installing and Configuring UNIX Client Machines:: * UNIX Application Servers::  File: krb5-install.info, Node: Installing KDCs, Next: Installing and Configuring UNIX Client Machines, Prev: Installing Kerberos V5, Up: Installing Kerberos V5 Installing KDCs =============== The Key Distribution Centers (KDCs) issue Kerberos tickets. Each KDC contains a copy of the Kerberos database. The master KDC contains the master copy of the database, which it propagates to the slave KDCs at regular intervals. All database changes (such as password changes) are made on the master KDC. Slave KDCs provide Kerberos ticket-granting services, but not database access. This allows clients to continue to obtain tickets when the master KDC is unavailable. MIT's recommends that you install all of your KDCs to be able to function as either the master or one of the slaves. This will enable you to easily switch your master KDC with one of the slaves if necessary. (*Note Switching Master and Slave KDCs::.) This installation procedure is based on that recommendation. * Menu: * Install the Master KDC:: * Install the Slave KDCs:: * Back on the Master KDC:: * Finish Installing the Slave KDCs:: * Add Kerberos Principals to the Database:: * Limit Access to the KDCs:: * Switching Master and Slave KDCs::  File: krb5-install.info, Node: Install the Master KDC, Next: Install the Slave KDCs, Prev: Installing KDCs, Up: Installing KDCs Install the Master KDC ---------------------- This installation procedure will require you to go back and forth a couple of times between the master KDC and each of the slave KDCs. The first few steps must be done on the master KDC. * Menu: * Edit the Configuration Files:: * Create the Database:: * Add Administrators to the Acl File:: * Add Administrators to the Kerberos Database:: * Create a kadmind Keytab:: * Start the Kerberos Daemons::  File: krb5-install.info, Node: Edit the Configuration Files, Next: Create the Database, Prev: Install the Master KDC, Up: Install the Master KDC Edit the Configuration Files ............................ Modify the configuration files, `/etc/krb5.conf' (*note krb5.conf::.) and `/usr/krb5/lib/krb5kdc/kdc.conf' (*note kdc.conf::.) to reflect the correct information (such as the hostnames and realm name) for your realm. MIT recommends that you keep `krb5.conf' in `/etc'. The `krb5.conf' file may contain a pointer to `kdc.conf', which you need to change if you want to move `kdc.conf' to another location.  File: krb5-install.info, Node: Create the Database, Next: Add Administrators to the Acl File, Prev: Edit the Configuration Files, Up: Install the Master KDC Create the Database ................... You will use the `kdb5_util' command *on the Master KDC* to create the Kerberos database and the optional stash file. The "stash file" is a local copy of the master key that resides in encrypted form on the KDC's local disk. The stash file is used to authenticate the KDC to itself automatically before starting the `kadmind' and `krb5kdc' daemons (e.g., as part of the machine's boot sequence). The stash file, like the keytab file (*Note The Keytab File::) is a potential point-of-entry for a break-in, and if compromised, would allow unrestricted access to the Kerberos database. If you choose to install a stash file, it should be readable only by root, and should exist only on the KDC's local disk. The file should not be part of any backup of the machine, unless access to the backup data is secured as tightly as access to the master password itself. Note that `kdb5_util' will prompt you for the master key for the Kerberos database. This key can be any string. A good key is one you can remember, but that no one else can guess. Examples of bad keys are words that can be found in a dictionary, any common or popular name, especially a famous person (or cartoon character), your username in any form (e.g., forward, backward, repeated twice, etc.), and any of the sample keys that appear in this manual. One example of a key which would be good if it did not appear in this manual is "MITiys4K5!", which represents the sentence "MIT is your source for Kerberos 5!" (It's the first letter of each word, substituting the numeral "4" for the word "for", and includes the punctuation mark at the end.) The following is an example of how to create a Kerberos database and stash file on the master KDC, using the `kdb5_util' command. (The line that begins with => is a continuation of the previous line.) Replace ATHENA.MIT.EDU with the name of your Kerberos realm. shell% /usr/krb5/sbin/kdb5_util create -r ATHENA.MIT.EDU -s kdb5_util: No such file or directory while setting active database to '/krb5/principal' Initializing database '/usr/krb5/lib/krb5kdc/principal' for => realm 'ATHENA.MIT.EDU', master key name 'K/M@ATHENA.MIT.EDU' You will be prompted for the database Master Password. It is important that you NOT FORGET this password. Enter KDC database master key: <= Type the master password. Re-enter KDC database master key to verify: <= Type it again. shell% This will create five files in the directory specified in your `kdc.conf' file: two Kerberos database files, `principal.db', and `principal.ok'; the Kerberos administrative database file, `principal.kadm5'; the administrative database lock file, `principal.kadm5.lock'; and the stash file, `.k5stash'. (The default directory is `/usr/krb5/lib/krb5kdc'.) If you do not want a stash file, run the above command without the `-s' option.  File: krb5-install.info, Node: Add Administrators to the Acl File, Next: Add Administrators to the Kerberos Database, Prev: Create the Database, Up: Install the Master KDC Add Administrators to the Acl File .................................. Next, you need create an Access Control List (acl) file, and put the Kerberos principal of at least one of the administrators into it. The filename should match the value you have set for "acl_file" in your `kdc.conf' file. The default file name is `kadm5.acl'. The format of the file is: Kerberos principal permissions optional target principal The Kerberos principal (and optional target principal) can include the "*" wildcard, so if you want any principal with the instance "admin" to have full permissions on the database, you could use the principal "`*/admin@REALM'" where "REALM" is your Kerberos realm. Note: a common use of an admin instance is so you can grant separate permissions (such as administrator access to the Kerberos database) to a separate Kerberos principal. For example, the user `joeadmin' might have a principal for his administrative use, called `joeadmin/admin'. This way, `joeadmin' would obtain `joeadmin/admin' tickets only when he actually needs to use those permissions. Refer to the Kerberos V5 Administrator's Guide or the Kerberos V5 User's Guide for more detailed explanations of "principals" and "instances". The permissions (acls) recognized in the acl file are the following: a allows the addition of principals or policies in the database. A prohibits the addition of principals or policies in the database. d allows the deletion of principals or policies in the database. D prohibits the deletion of principals or policies in the database. m allows the modification of principals or policies in the database. M prohibits the modification of principals or policies in the database. c allows the changing of passwords for principals in the database. C prohibits the changing of passwords for principals in the database. i allows inquiries to the database. I prohibits inquiries to the database. l allows the listing of principals or policies in the database. L prohibits the listing of principals or policies in the database. * Short for all privileges (admcil). x Short for all privileges (admcil); identical to "*". To give the principal `*/admin@ATHENA.MIT.EDU' permission to change all of the database permissions on any principal permissions, you would place the following line in the file: */admin@ATHENA.MIT.EDU * To give the principal `joeadmin@ATHENA.MIT.EDU' permission to add, list, and inquire about any principal that has the instance "root", you would add the following line to the acl file: joeadmin@ATHENA.MIT.EDU ali */root@ATHENA.MIT.EDU  File: krb5-install.info, Node: Add Administrators to the Kerberos Database, Next: Create a kadmind Keytab, Prev: Add Administrators to the Acl File, Up: Install the Master KDC Add Administrators to the Kerberos Database ........................................... Next you need to add administrative principals to the Kerberos database. (You must add at least one now.) To do this, use `kadmin.local' *on the master KDC*, as in the following example: shell% /usr/krb5/sbin/kadmin.local kadmin: addprinc admin/admin@ATHENA.MIT.EDU WARNING: no policy specified for "admin/admin@ATHENA.MIT.EDU"; defaulting to no policy. Enter password for principal admin/admin@ATHENA.MIT.EDU: <= Enter a password. Re-enter password for principal admin/admin@ATHENA.MIT.EDU: <= Type it again. Principal "admin/admin@ATHENA.MIT.EDU" created. kadmin:  File: krb5-install.info, Node: Create a kadmind Keytab, Next: Start the Kerberos Daemons, Prev: Add Administrators to the Kerberos Database, Up: Install the Master KDC Create a kadmind Keytab ....................... The kadmind keytab is the key that kadmind will use to decrypt administrators' Kerberos tickets to determine whether or not it should give them access to the database. You need to create the kadmin keytab with entries for the principals `kadmin/admin' and `kadmin/changepw'. (These principals are placed in the Kerberos database automatically when you create it.) To create the kadmin keytab, run `kadmin' and use the `ktadd' command, as in the following example. (The line beginning with => is a continuation of the previous line.): shell% /usr/krb5/sbin/kadmin kadmin: ktadd -k /usr/krb5/lib/krb5kdc/kadm5.keytab => kadmin/admin kadmin/changepw kadmin: Entry for principal kadmin/admin@ATHENA.MIT.EDU with kvno 3, encryption type DES-CBC-CRC added to keytab WRFILE:/usr/krb5/lib/krb5kdc/kadm5.keytab. kadmin: quit shell% As specified in the `-k' argument, `ktadd' will save the extracted keytab as `/usr/krb5/lib/krb5kdc/kadm5.keytab'. The filename you use must be the one specified in your `kdc.conf' file.  File: krb5-install.info, Node: Start the Kerberos Daemons, Prev: Create a kadmind Keytab, Up: Install the Master KDC Start the Kerberos Daemons on the Master KDC ............................................ At this point, you are ready to start the Kerberos daemons on the Master KDC. To do so, type: shell% /usr/krb5/sbin/krb5kdc shell% /usr/krb5/sbin/kadmind Each daemon will fork and run in the background. Assuming you want these daemons to start up automatically at boot time, you can add them to the KDC's `/etc/rc' or `/etc/inittab' file. You need to have a stash file in order to do this.  File: krb5-install.info, Node: Install the Slave KDCs, Next: Back on the Master KDC, Prev: Install the Master KDC, Up: Installing KDCs Install the Slave KDCs ---------------------- You are now ready to start configuring the slave KDCs. Assuming you are setting the KDCs up so that you can easily switch the master KDC with one of the slaves, you should perform each of these steps on the master KDC as well as the slave KDCs, unless these instructions specify otherwise. * Menu: * Create Host Keys for the Slave KDCs:: * Extract Host Keytabs for the KDCs:: * Set Up the Slave KDCs for Database Propagation::  File: krb5-install.info, Node: Create Host Keys for the Slave KDCs, Next: Extract Host Keytabs for the KDCs, Prev: Install the Slave KDCs, Up: Install the Slave KDCs Create Host Keys for the Slave KDCs ................................... Each KDC needs a host principal in the Kerberos database. You can enter these from any host, once the `kadmind' daemon is running. For example, if your master KDC were called kerberos.mit.edu, and you had two KDC slaves named kerberos-1.mit.edu and kerberos-2.mit.edu, you would type the following: shell% /usr/krb5/sbin/kadmin kadmin: addprinc -randpass host/kerberos.mit.edu WARNING: no policy specified for "host/kerberos.mit.edu@ATHENA.MIT.EDU"; defaulting to no policy. Principal "host/kerberos.mit.edu@ATHENA.MIT.EDU" created. kadmin: addprinc -randpass host/kerberos-1.mit.edu WARNING: no policy specified for "host/kerberos-1.mit.edu@ATHENA.MIT.EDU"; defaulting to no policy. Principal "host/kerberos-1.mit.edu@ATHENA.MIT.EDU" created. kadmin: addprinc -randpass host/kerberos-2.mit.edu WARNING: no policy specified for "host/kerberos-2.mit.edu@ATHENA.MIT.EDU"; defaulting to no policy. Principal "host/kerberos-2.mit.edu@ATHENA.MIT.EDU" created. kadmin: It is not actually necessary to have the master KDC server in the Kerberos database, but it can be handy if: * anyone will be logging into the machine as something other than root * you want to be able to swap the master KDC with one of the slaves if necessary.