Move OpenLDAP includes to AM_CPPFLAGS to avoid dropping other defines
[heimdal.git] / doc / heimdal.texi
blobb2602b3fb1cc405ddb9129495714016b9a1d91a6
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @c $Id$
4 @setfilename heimdal.info
5 @settitle HEIMDAL
6 @iftex
7 @afourpaper
8 @end iftex
9 @c some sensible characters, please?
10 @tex
11 \input latin1.tex
12 @end tex
13 @setchapternewpage on
14 @syncodeindex pg cp
15 @c %**end of header
17 @include vars.texi
19 @set UPDATED $Date$
20 @set VERSION @value{PACKAGE_VERSION}
21 @set EDITION 1.0
23 @ifinfo
24 @dircategory Security
25 @direntry
26 * Heimdal: (heimdal).           The Kerberos 5 distribution from KTH
27 @end direntry
28 @end ifinfo
30 @c title page
31 @titlepage
32 @title Heimdal
33 @subtitle Kerberos 5 from KTH
34 @subtitle Edition @value{EDITION}, for version @value{VERSION}
35 @subtitle 2008
36 @author Johan Danielsson
37 @author Love Hörnquist Åstrand
38 @author Assar Westerlund
39 @author last updated @value{UPDATED}
41 @def@copynext{@vskip 20pt plus 1fil@penalty-1000}
42 @def@copyrightstart{}
43 @def@copyrightend{}
44 @page
45 @copyrightstart
46 Copyright (c) 1997-2008 Kungliga Tekniska Högskolan 
47 (Royal Institute of Technology, Stockholm, Sweden).
48 All rights reserved.
50 Redistribution and use in source and binary forms, with or without
51 modification, are permitted provided that the following conditions
52 are met:
54 1. Redistributions of source code must retain the above copyright
55    notice, this list of conditions and the following disclaimer.
57 2. Redistributions in binary form must reproduce the above copyright
58    notice, this list of conditions and the following disclaimer in the
59    documentation and/or other materials provided with the distribution.
61 3. Neither the name of the Institute nor the names of its contributors
62    may be used to endorse or promote products derived from this software
63    without specific prior written permission.
65 THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
66 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
67 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
68 ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
69 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
70 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
71 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
72 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
73 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
74 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
75 SUCH DAMAGE.
77 @copynext
79 Copyright (C) 1990 by the Massachusetts Institute of Technology
81 Export of this software from the United States of America may
82 require a specific license from the United States Government.
83 It is the responsibility of any person or organization contemplating
84 export to obtain such a license before exporting.
86 WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
87 distribute this software and its documentation for any purpose and
88 without fee is hereby granted, provided that the above copyright
89 notice appear in all copies and that both that copyright notice and
90 this permission notice appear in supporting documentation, and that
91 the name of M.I.T. not be used in advertising or publicity pertaining
92 to distribution of the software without specific, written prior
93 permission.  M.I.T. makes no representations about the suitability of
94 this software for any purpose.  It is provided "as is" without express
95 or implied warranty.
97 @copynext
99 Copyright (c) 1988, 1990, 1993
100      The Regents of the University of California.  All rights reserved.
102 Redistribution and use in source and binary forms, with or without
103 modification, are permitted provided that the following conditions
104 are met:
106 1. Redistributions of source code must retain the above copyright
107    notice, this list of conditions and the following disclaimer.
109 2. Redistributions in binary form must reproduce the above copyright
110    notice, this list of conditions and the following disclaimer in the
111    documentation and/or other materials provided with the distribution.
113 3. Neither the name of the University nor the names of its contributors
114    may be used to endorse or promote products derived from this software
115    without specific prior written permission.
117 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
118 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
119 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
120 ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
121 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
122 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
123 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
124 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
125 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
126 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
127 SUCH DAMAGE.
129 @copynext
131 Copyright 1992 Simmule Turner and Rich Salz.  All rights reserved. 
133 This software is not subject to any license of the American Telephone 
134 and Telegraph Company or of the Regents of the University of California. 
136 Permission is granted to anyone to use this software for any purpose on
137 any computer system, and to alter it and redistribute it freely, subject
138 to the following restrictions:
140 1. The authors are not responsible for the consequences of use of this
141    software, no matter how awful, even if they arise from flaws in it.
143 2. The origin of this software must not be misrepresented, either by
144    explicit claim or by omission.  Since few users ever read sources,
145    credits must appear in the documentation.
147 3. Altered versions must be plainly marked as such, and must not be
148    misrepresented as being the original software.  Since few users
149    ever read sources, credits must appear in the documentation.
151 4. This notice may not be removed or altered.
153 @copynext
155 IMath is Copyright 2002-2005 Michael J. Fromberger
156 You may use it subject to the following Licensing Terms:
158 Permission is hereby granted, free of charge, to any person obtaining
159 a copy of this software and associated documentation files (the
160 "Software"), to deal in the Software without restriction, including
161 without limitation the rights to use, copy, modify, merge, publish,
162 distribute, sublicense, and/or sell copies of the Software, and to
163 permit persons to whom the Software is furnished to do so, subject to
164 the following conditions:
166 The above copyright notice and this permission notice shall be
167 included in all copies or substantial portions of the Software.
169 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
170 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
171 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
172 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
173 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
174 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
175 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
177 @copynext
179 Copyright (c) 2005 Doug Rabson
180 All rights reserved.
182 Redistribution and use in source and binary forms, with or without
183 modification, are permitted provided that the following conditions
184 are met:
185 1. Redistributions of source code must retain the above copyright
186    notice, this list of conditions and the following disclaimer.
187 2. Redistributions in binary form must reproduce the above copyright
188    notice, this list of conditions and the following disclaimer in the
189    documentation and/or other materials provided with the distribution.
191 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
192 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
193 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
194 ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
195 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
196 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
197 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
198 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
199 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
200 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
201 SUCH DAMAGE.
203 @copynext
205 Copyright (c) 2005 Marko Kreen
206 All rights reserved.
208 Redistribution and use in source and binary forms, with or without
209 modification, are permitted provided that the following conditions
210 are met:
211 1. Redistributions of source code must retain the above copyright
212        notice, this list of conditions and the following disclaimer.
213 2. Redistributions in binary form must reproduce the above copyright
214        notice, this list of conditions and the following disclaimer in the
215        documentation and/or other materials provided with the distribution.
217 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
218 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
219 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
220 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
221 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
222 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
223 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
224 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
225 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
226 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
227 SUCH DAMAGE.
229 @copynext
231 Copyright (c) 2006,2007
232 NTT (Nippon Telegraph and Telephone Corporation) . All rights reserved.
234 Redistribution and use in source and binary forms, with or without
235 modification, are permitted provided that the following conditions
236 are met:
237 1. Redistributions of source code must retain the above copyright
238   notice, this list of conditions and the following disclaimer as
239   the first lines of this file unmodified.
240 2. Redistributions in binary form must reproduce the above copyright
241   notice, this list of conditions and the following disclaimer in the
242   documentation and/or other materials provided with the distribution.
244 THIS SOFTWARE IS PROVIDED BY NTT ``AS IS'' AND ANY EXPRESS OR
245 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
246 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
247 IN NO EVENT SHALL NTT BE LIABLE FOR ANY DIRECT, INDIRECT,
248 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
249 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
250 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
251 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
252 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
253 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
255 @copyrightend
256 @end titlepage
258 @macro manpage{man, section}
259 @cite{\man\(\section\)}
260 @end macro
262 @c Less filling! Tastes great!
263 @iftex
264 @parindent=0pt
265 @global@parskip 6pt plus 1pt
266 @global@chapheadingskip = 15pt plus 4pt minus 2pt 
267 @global@secheadingskip = 12pt plus 3pt minus 2pt
268 @global@subsecheadingskip = 9pt plus 2pt minus 2pt
269 @end iftex
270 @ifinfo
271 @paragraphindent 0
272 @end ifinfo
274 @ifnottex
275 @node Top, Introduction, (dir), (dir)
276 @top Heimdal
277 @end ifnottex
279 This manual is last updated @value{UPDATED} for version
280 @value{VERSION} of Heimdal.
282 @menu
283 * Introduction::                
284 * What is Kerberos?::           
285 * Building and Installing::     
286 * Setting up a realm::          
287 * Applications::                
288 * Things in search for a better place::  
289 * Kerberos 4 issues::           
290 * Windows 2000 compatability::  
291 * Programming with Kerberos::   
292 * Migration::                   
293 * Acknowledgments::             
295 @detailmenu
296  --- The Detailed Node Listing ---
298 Setting up a realm
300 * Configuration file::          
301 * Creating the database::       
302 * Modifying the database::      
303 * keytabs::                     
304 * Serving Kerberos 4/524/kaserver::  
305 * Remote administration::       
306 * Password changing::           
307 * Testing clients and servers::  
308 * Slave Servers::               
309 * Incremental propagation::     
310 * Encryption types and salting::                     
311 * Cross realm::                 
312 * Transit policy::              
313 * Setting up DNS::              
314 * Using LDAP to store the database::  
315 * Providing Kerberos credentials to servers and programs::  
316 * Setting up PK-INIT::
318 Applications
320 * Authentication modules::      
321 * AFS::                         
323 Authentication modules
325 * Digital SIA::                 
326 * IRIX::                        
328 Kerberos 4 issues
330 * Principal conversion issues::  
331 * Converting a version 4 database::  
332 * kaserver::                    
334 Windows 2000 compatability
336 * Configuring Windows 2000 to use a Heimdal KDC::  
337 * Inter-Realm keys (trust) between Windows 2000 and a Heimdal KDC::  
338 * Create account mappings::     
339 * Encryption types::            
340 * Authorisation data::          
341 * Quirks of Windows 2000 KDC::  
342 * Useful links when reading about the Windows 2000::  
344 Programming with Kerberos
346 @end detailmenu
347 @end menu
349 @include intro.texi
350 @include whatis.texi
351 @include install.texi
352 @include setup.texi
353 @include apps.texi
354 @include misc.texi
355 @include kerberos4.texi
356 @include win2k.texi
357 @include programming.texi
358 @include migration.texi
359 @include ack.texi
361 @c @shortcontents
362 @contents
364 @bye