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