Sync usage with man page.
[netbsd-mini2440.git] / crypto / dist / heimdal / kpasswd / kpasswdd.8
blob342d9954ba7f2d6e175e7c12519ceab2fbeec706
1 .\" $Heimdal: kpasswdd.8 14481 2005-01-05 18:07:44Z lha $
2 .\" $NetBSD: kpasswdd.8,v 1.8 2008/03/22 08:37:03 mlelstv Exp $
3 .\"
4 .Dd April 19, 1999
5 .Dt KPASSWDD 8
6 .Os
7 .Sh NAME
8 .Nm kpasswdd
9 .Nd Kerberos 5 password changing server
10 .Sh SYNOPSIS
11 .Nm
12 .Bk -words
13 .Op Fl -addresses= Ns Ar address
14 .Op Fl -check-library= Ns Ar library
15 .Op Fl -check-function= Ns Ar function
16 .Oo Fl k Ar kspec \*(Ba Xo
17 .Fl -keytab= Ns Ar kspec
18 .Xc
19 .Oc
20 .Oo Fl r Ar realm \*(Ba Xo
21 .Fl -realm= Ns Ar realm
22 .Xc
23 .Oc
24 .Oo Fl p Ar string \*(Ba Xo
25 .Fl -port= Ns Ar string
26 .Xc
27 .Oc
28 .Op Fl -version
29 .Op Fl -help
30 .Ek
31 .Sh DESCRIPTION
32 .Nm
33 serves request for password changes. It listens on UDP port 464
34 (service kpasswd) and processes requests when they arrive. It changes
35 the database directly and should thus only run on the master KDC.
36 .Pp
37 Supported options:
38 .Bl -tag -width Ds
39 .It Fl -addresses= Ns Ar address
40 For each till the argument is given, add the address to what kpasswdd
41 should listen too.
42 .It Fl -check-library= Ns Ar library
43 If your system has support for dynamic loading of shared libraries,
44 you can use an external function to check password quality. This
45 option specifies which library to load.
46 .It Fl -check-function= Ns Ar function
47 This is the function to call in the loaded library. The function
48 should look like this:
49 .Pp
50 .Ft const char *
51 .Fn passwd_check "krb5_context context" "krb5_principal principal" "krb5_data *password"
52 .Pp
53 .Fa context
54 is an initialized context;
55 .Fa principal
56 is the one who tries to change passwords, and
57 .Fa password
58 is the new password. Note that the password (in
59 .Fa password->data )
60 is not zero terminated.
61 .It Fl k Ar kspec , Fl -keytab= Ns Ar kspec
62 Keytab to get authentication key from.
63 .It Fl r Ar realm , Fl -realm= Ns Ar realm
64 Default realm.
65 .It Fl p Ar string , Fl -port= Ns Ar string
66 Port to listen on (default service kpasswd - 464).
67 .El
68 .Sh DIAGNOSTICS
69 If an error occurs, the error message is returned to the user and/or
70 logged to syslog.
71 .Sh BUGS
72 The default password quality checks are too basic.
73 .Sh SEE ALSO
74 .Xr kpasswd 1 ,
75 .Xr kdc 8
76 .\".Sh ENVIRONMENT
77 .\".Sh FILES
78 .\".Sh EXAMPLES
79 .\".Sh SEE ALSO
80 .\".Sh STANDARDS
81 .\".Sh HISTORY
82 .\".Sh AUTHORS