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