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