Consolidate RST install docs into larger files
[krb5.git] / doc / kadmin / README
1 There are several different admin protocols in our source tree.
2
3 a) V4 server protocol - not documented
4
5 b) Old kadmin protocol - which was in the beta code (kadmin/v5passwdd)
6
7 c) Newer kadm5 gssrpc based code (kadmin/server)
8
9 d) Simple password changing protocol implemented in our kadmin server
10 with client in clients/kpasswd. 
11
12
13
14 This file will attempt to link the files in this directory with where
15 the code is used in the source tree.
16
17
18 - kpasswd.protocol: Describes the password changing protocol in
19                         src/kadmin/v5passwdd. 
20                         include/adm.h has some defintions.
21
22                     Client and server provided
23
24 - kadmin.protocol: Describes other administrative protocol options that 
25                         src/kadmin/v5passwdd supports
26
27                     No client in the source tree uses it.
28
29 - draft-ietf-cat-kerb-chg-password-02.txt: Describes the 
30                     password changing service that 
31                     clients/kpasswd uses through krb5_change_password() 
32                     located in lib/krb5/os/changepw.c
33
34                     kadmin/server/schpw.c implements this as part of
35                     the kadmin server.
36
37                     This is version 1 of the protocol. Version 2 is
38                     in the IETF draft stage and is very different. 
39
40                     Currently: Version 1 is supported - but we may not 
41                     be implementing the TCP handling aspects.
42
43 - ../doc/kadm5: Describes the current protocol. 
44
45                     kadmin/passwd (which is not installed) uses
46                     the kadm5 protocol for password changing.