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