Merge from vendor branch CVS:
[dragonfly.git] / crypto / heimdal-0.6.3 / doc / intro.texi
1 @c $Id: intro.texi,v 1.13 2003/03/15 13:42:16 lha Exp $
2
3 @node Introduction, What is Kerberos?, Top, Top
4 @c @node Introduction, What is Kerberos?, Top, Top
5 @comment  node-name,  next,  previous,  up
6 @chapter Introduction
7
8 @heading What is Heimdal?
9
10 Heimdal is a free implementation of Kerberos 5. The goals are to:
11
12 @itemize @bullet
13 @item
14 have an implementation that can be freely used by anyone
15 @item
16 be protocol compatible with existing implementations and, if not in
17 conflict, with RFC 1510 (and any future updated RFC)
18 @item
19 be reasonably compatible with the M.I.T Kerberos V5 API
20 @item
21 have support for Kerberos V5 over GSS-API (RFC1964)
22 @item
23 include the most important and useful application programs (rsh, telnet,
24 popper, etc.)
25 @item
26 include enough backwards compatibility with Kerberos V4
27 @end itemize
28
29 @heading Status
30
31 Heimdal has the following features (this does not mean any of this
32 works):
33
34 @itemize @bullet
35 @item
36 a stub generator and a library to encode/decode/whatever ASN.1/DER
37 stuff
38 @item
39 a @code{libkrb5} library that should be possible to get to work with
40 simple applications
41 @item
42 a GSS-API library that should have all the important functions for
43 building applications
44 @item
45 Eric Young's @file{libdes}
46 @item
47 @file{kinit}, @file{klist}, @file{kdestroy}
48 @item
49 @file{telnet}, @file{telnetd}
50 @item
51 @file{rsh}, @file{rshd}
52 @item
53 @file{popper}, @file{push} (a movemail equivalent)
54 @item
55 @file{ftp}, and @file{ftpd}
56 @item
57 a library @file{libkafs} for authenticating to AFS and a program
58 @file{afslog} that uses it
59 @item
60 some simple test programs
61 @item
62 a KDC that supports most things; optionally, it may also support
63 Kerberos V4 and kaserver,
64 @item
65 simple programs for distributing databases between a KDC master and
66 slaves
67 @item
68 a password changing daemon @file{kpasswdd}, library functions for
69 changing passwords and a simple client
70 @item
71 some kind of administration system
72 @item
73 Kerberos V4 support in many of the applications.
74 @end itemize
75
76 @heading Bug reports
77
78 If you find bugs in this software, make sure it is a genuine bug and not
79 just a part of the code that isn't implemented.
80
81 Bug reports should be sent to @email{heimdal-bugs@@pdc.kth.se}. Please
82 include information on what machine and operating system (including
83 version) you are running, what you are trying to do, what happens, what
84 you think should have happened, an example for us to repeat, the output
85 you get when trying the example, and a patch for the problem if you have
86 one. Please make any patches with @code{diff -u} or @code{diff -c}.
87
88 Suggestions, comments and other non bug reports are also welcome.
89
90 @heading Mailing list
91
92 There are two mailing lists with talk about
93 Heimdal. @email{heimdal-announce@@sics.se} is a low-volume announcement
94 list, while @email{heimdal-discuss@@sics.se} is for general discussion.
95 Send a message to @email{majordomo@@sics.se} to subscribe.
96
97 @heading Heimdal source code, binaries and the manual
98
99 The source code for heimdal, links to binaries and the manual (this
100 document) can be found on our web-page at
101 @url{http://www.pdc.kth.se/heimdal/}.