doc/intro.texi

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