1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
|
Starting with the Beta 4 distribution, we are using a new configuration
system, which was built using the Free Software Foundation's
@samp{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.
@end menu
@node Build Requirements, Unpacking the Sources, Building Kerberos V5, Building Kerberos V5
@section 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 @dfn{build tree}, which contains the compiled
@file{*.o} file and executables, separate from your source tree, you
will need a @samp{make} program which supports @samp{VPATH}, or
you will need to use a tool such as @samp{lndir} to produce a symbolic
link tree for your build tree.
@node Unpacking the Sources, Doing the Build, Build Requirements, Building Kerberos V5
@section 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 @file{krb5.src.tar.gz},
contains the sources for all of Kerberos except for the crypto library,
which is found in the file @file{krb5.crypto.tar.gz}.
Both files should be unpacked in the same directory, such as
@file{/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.)
@node Doing the Build, Testing the Build, Unpacking the Sources, Building Kerberos V5
@section 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 @ref{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::
@end menu
@node Building Within a Single Tree, Building with Separate Build Directories, Doing the Build, Doing the Build
@subsection Building Within a Single Tree
If you don't want separate build trees for each architecture, then
use the following abbreviated procedure.
@enumerate
@item
@code{cd /u1/krb5/src}
@item
@code{./configure}
@item
@code{make}
@end enumerate
That's it!
@node Building with Separate Build Directories, Building using lndir, Building Within a Single Tree, Doing the Build
@subsection 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
@samp{make} program support @samp{VPATH}. GNU's make will provide this
functionality, for example.) If your @samp{make} program does not
support this, see the next section.
For example, if you wish to create a build directory for @code{pmax} binaries
you might use the following procedure:
@enumerate
@item
@code{mkdir /u1/krb5/pmax}
@item
@code{cd /u1/krb5/pmax}
@item
@code{../src/configure}
@item
@code{make}
@end enumerate
@node Building using lndir, , Building with Separate Build Directories, Doing the Build
@subsection Building Using @samp{lndir}
If you wish to keep separate build directories for each platform, and
you do not have access to a @samp{make} program which supports @samp{VPATH},
all is not lost. You can use the @samp{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:
@enumerate
@item
@code{mkdir /u1/krb5/solaris}
@item
@code{cd /u1/krb5/solaris}
@item
@code{/u1/krb5/src/util/lndir `pwd`/../src}
@item
@code{./configure}
@item
@code{make}
@end enumerate
You must give an absolute pathname to @samp{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.
@node Testing the Build, Options to Configure, Doing the Build, Building Kerberos V5
@section 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 @samp{make} to start
building Kerberos; see @ref{Doing the Build}.):
@example
% make check
@end example
@menu
* The DejaGnu Tests::
@end menu
@node The DejaGnu Tests, , Testing the Build, Testing the Build
@subsection 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 (@samp{rlogind} and @samp{telnetd}) which require
the ability to @samp{rlogin} as root to the local machine. Admittedly,
this does require the use of a @file{.rhosts} file or some authenticated
means. @footnote{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 @file{.k5login} or @file{.klogin} respectively to
allow you access.}
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
@samp{make} will consider a failure of the testing process. Do not worry
about this, as these tests are the last run when @samp{make check} is
executed from the top level of the build tree.
@node Options to Configure, osconf.h, Testing the Build, Building Kerberos V5
@section Options to Configure
There are a number of options to @samp{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 @samp{configure}
program.
@table @code
@item --help
Provides help to configure. This will list the set of commonly used
options for building Kerberos.
@item --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.
@item --exec-prefix=DIR
This option allows one to separate the architecture independent programs
from the configuration files and manual pages.
@item --with-cc=COMPILER
Use @code{COMPILER} as the C compiler.
@item --with-ccopts=FLAGS
Use @code{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 @samp{-g} flag nor the @samp{-O} flag to @samp{cc}.
@item --with-cppopts=CPPOPTS
Use @code{CPPOPTS} as the default set of C preprocessor flags. The most
common use of this option is to select certain @code{#define}'s for use
with the operating system's include files.
@item --with-linker=LINKER
Use @code{LINKER} as the default loader if it should be different from C
compiler as specified above.
@item --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.
@item --with-krb4
This option enables Kerberos V4 backwards compatibility using the
builtin Kerberos V4 library.
@item --with-krb4=KRB4DIR
This option enables Kerberos V4 backwards compatibility using a
pre-existing Kerberos V4 installation. The directory specified by
@code{KRB4DIR} specifies where the V4 header files should be found
(@file{/KRB4DIR/include}) as well as where the V4 Kerberos library
should be found (@file{/KRB4DIR/lib}).
@item --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.
@item --with-netlib[=libs]
Allows for suppression of or replacement of network libraries. By
default, Kerberos V5 configuration will look for @code{-lnsl} and
@code{-lsocket}. If your operating system has a broken resolver library
(see @ref{Solaris versions 2.0 through 2.3}) or fails to pass the tests in
@file{src/tests/resolv} you will need to use this option.
@item --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.
@item --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.)
@item --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.
@item --with-tcl=TCLPATH
Some of the unit-tests in the build tree rely upon using a program in
Tcl. The directory specified by @code{TCLPATH} specifies where the Tcl
header file (@file{/TCLPATH/include/tcl.h} as well as where the Tcl
library should be found (@file{/TCLPATH/lib}).
@end table
For example, in order to configure Kerberos on a Solaris machine using
the @samp{suncc} with the optimizer turned on, run the configure
script with the following options:
@example
% ./configure --with-cc=suncc --with-ccopts=-O
@end example
@node osconf.h, Shared Library Support, Options to Configure, Building Kerberos V5
@section @file{osconf.h}
There is one configuration file which you may wish to edit to control
various compile-time parameters in the Kerberos distribution:
@file{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 @file{config.h} no longer
exists as its functionality has been merged into the auto-configuration
process. @xref{Options to Configure}.
@table @code
@item 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
@file{krb.conf} file.
@item DEFAULT_LNAME_FILENAME
The pathname to the database that maps authentication names to local
account names. See kdb5_anadd(8).
@item DEFAULT_KEYTAB_NAME
The type and pathname to the default server keytab file (the equivalent
of Kerberos V4's @file{/etc/srvtab}).
@item DEFAULT_KDC_ENCTYPE
The default encryption type for the KDC.
@item KDCRCACHE
The name of the replay cache used by the KDC.
@item RCTMPDIR
The directory which stores replay caches.
@item DEFAULT_KDB_FILE
The location of the default database
@end table
@node Shared Library Support, OS Incompatibilities, osconf.h, Building Kerberos V5
@section 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 @samp{--enable-shared}.
@ifset notdef
XXX What does this mean?
One special note is that if the Kerberos V4 compatibility is compiled
in, you @b{must not} specify an alternate Kerberos V4 library from the
one in the tree or you will be missing references.
@end ifset
@node OS Incompatibilities, Using Autoconf, Shared Library Support, Building Kerberos V5
@section 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 @b{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::
@end menu
@node AIX, Alpha OSF/1 V1.3, OS Incompatibilities, OS Incompatibilities
@subsection AIX
The AIX 3.2.5 linker dumps core trying to build a shared
@samp{libkrb5.a} produced with the GNU C compiler. The native AIX
compiler works fine. This problem is fixed using the AIX 4.1 linker.
@node Alpha OSF/1 V1.3, Alpha OSF/1 (Digital Unix) V2.0++, AIX, OS Incompatibilities
@subsection Alpha OSF/1 V1.3
Using the native compiler, compiling with the @samp{-O} compiler flag
causes the @code{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.
@node Alpha OSF/1 (Digital Unix) V2.0++, BSDI, Alpha OSF/1 V1.3, OS Incompatibilities
@subsection Alpha OSF/1 V2.0++
There used to be a bug when using the native compiler in compiling
@file{md4.c} when compiled without either the @samp{-O} or @samp{-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.
@node BSDI, HPUX, Alpha OSF/1 (Digital Unix) V2.0++, OS Incompatibilities
@subsection BSDI
BSDI versions 1.0 and 1.1 reportedly has a bad @samp{sed} which causes
it to go into an infinite loop during the build. The work around is
to use a @samp{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.)
@node HPUX, Solaris versions 2.0 through 2.3, BSDI, OS Incompatibilities
@subsection 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 @samp{+Olibcalls -D_HPUX_SOURCE} (this has only been
tested for HPUX 9.0). At this point, using GCC is probably your best
bet.
@node Solaris versions 2.0 through 2.3, Solaris 2.X, HPUX, OS Incompatibilities
@subsection Solaris versions 2.0 through 2.3
The @code{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,
@samp{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:
@enumerate
@item
Supply your own resolver library. (such as bind-4.9.3pl1 availavle
from ftp.vix.com)
@item
Upgrade to Solaris 2.4
@item
Make sure your /etc/nsswitch.conf has `files' before `dns' like:
@example
hosts: files dns
@end example
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:
@example
18.172.1.4 dcl.mit.edu dcl
@end example
Note that making this change may cause other programs in your
environment to break or behave differently.
@end enumerate
@node Solaris 2.X, SGI Irix 5.X, Solaris versions 2.0 through 2.3, OS Incompatibilities
@subsection Solaris 2.X
You @b{must} compile Kerberos V5 without the UCB compatibility
libraries. This means that @file{/usr/ucblib} must not be in the
LD_LIBRARY_PATH environment variable when you compile it. Alternatively
you can use the @code{-i} option to @samp{cc}, by using the specifying
@code{--with-ccopts=-i} option to @samp{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.)
@node SGI Irix 5.X, Ultrix 4.2/3, Solaris 2.X, OS Incompatibilities
@subsection 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
@samp{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 @code{-lsocket}
library in which the routine @code{gethostbyname()} is broken. The
system supplied version in @code{-lc} appears to work though so one may
simply specify @code{--with-netlib} option to @samp{configure}.
In 5.3, @code{gethostbyname()} is no longer present in @code{-lsocket} and
is no longer an issue.
@node Ultrix 4.2/3, , SGI Irix 5.X, OS Incompatibilities
@subsection 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.
@ifset notdef
On the DEC MIPS platform, using the native compiler, @file{md4.c} and
@file{md5.c} can not be compiled with the optimizer set at level 1.
That is, you must specify either @samp{--with-ccopts=-O} and
@samp{--with-ccopts=-g} to configure. If you don't specify either, the
compile will never complete.
The optimizer isn't hung; it just takes an exponentially long time.
Compiling 6 out of the 48 algorithmic steps takes 3 seconds; compiling 7
steps takes 9 seconds; compiling 8 steps takes 27 seconds, and so on.
Calculations estimate it will finish in approximately 3,469 billion
years....
Using GCC instead of the native compiler will also work fine, both with
or without optimization.
@end ifset
@node Using Autoconf, , OS Incompatibilities, Building Kerberos V5
@section Using @samp{Autoconf}
(If you are not a developer, you can skip this section.)
In most of the Kerberos V5 source directories, there is a
@file{configure} script which automatically determines the compilation
environment and creates the proper Makefiles for a particular platform.
These @file{configure} files are generated using @samp{autoconf} version
2.4, which can be found in the @file{src/util/autoconf} directory in the
distribution.
Normal users will not need to worry about running @samp{autoconf}; the
distribution comes with the @file{configure} files already prebuilt.
Developers who wish to modify the @file{configure.in} files should see
@ref{Top, , Overview, autoconf, The Autoconf Manual}.
Note that in order to run @samp{autoconf}, you must have GNU @samp{m4}
in your path. Before you use the @samp{autoconf} in the Kerberos V5
source tree, you may also need to run @samp{configure}, and then run
@samp{make} in the @file{src/util/autoconf} directory in order to
properly set up @samp{autoconf}.
One tool which is provided for the convenience of developers can be
found in @file{src/util/reconf}. This program should be run while the
current directory is the top source directory. It will automatically
rebuild any @file{configure} files which need rebuilding. If you know
that you have made a change that will require that all the
@file{configure} files need to be rebuilt from scratch, specify the
@code{--force} option:
@example
% cd /u1/krb5/src
% ./util/reconf --force
@end example
The developmental sources are a raw source tree (before it's been packaged
for public release), without the pre-built @file{configure} files.
In order to build from such a source tree, you must do:
@example
% cd krb5/util/autoconf
% ./configure
% make
% cd ../..
% util/reconf
@end example
Then follow the instructions for building packaged source trees (above).
To install the binaries into a binary tree, do:
@example
% cd /u1/krb5/src
% make all
% make install DESTDIR=somewhere-else
@end example
|