xref: /freebsd/crypto/heimdal/kpasswd/kpasswdd.8 (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1.\" Copyright (c) 1997, 2000 - 2005 Kungliga Tekniska Högskolan
2.\" (Royal Institute of Technology, Stockholm, Sweden).
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\"
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" 3. Neither the name of the Institute nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd April 19, 1999
33.Dt KPASSWDD 8
34.Os HEIMDAL
35.Sh NAME
36.Nm kpasswdd
37.Nd Kerberos 5 password changing server
38.Sh SYNOPSIS
39.Nm
40.Bk -words
41.Op Fl Fl addresses= Ns Ar address
42.Op Fl Fl check-library= Ns Ar library
43.Op Fl Fl check-function= Ns Ar function
44.Oo Fl k Ar kspec \*(Ba Xo
45.Fl Fl keytab= Ns Ar kspec
46.Xc
47.Oc
48.Oo Fl r Ar realm \*(Ba Xo
49.Fl Fl realm= Ns Ar realm
50.Xc
51.Oc
52.Oo Fl p Ar string \*(Ba Xo
53.Fl Fl port= Ns Ar string
54.Xc
55.Oc
56.Op Fl Fl version
57.Op Fl Fl help
58.Ek
59.Sh DESCRIPTION
60.Nm
61serves request for password changes. It listens on UDP port 464
62(service kpasswd) and processes requests when they arrive. It changes
63the database directly and should thus only run on the master KDC.
64.Pp
65Supported options:
66.Bl -tag -width Ds
67.It Fl Fl addresses= Ns Ar address
68For each till the argument is given, add the address to what kpasswdd
69should listen too.
70.It Fl Fl check-library= Ns Ar library
71If your system has support for dynamic loading of shared libraries,
72you can use an external function to check password quality. This
73option specifies which library to load.
74.It Fl Fl check-function= Ns Ar function
75This is the function to call in the loaded library. The function
76should look like this:
77.Pp
78.Ft const char *
79.Fn passwd_check "krb5_context context" "krb5_principal principal" "krb5_data *password"
80.Pp
81.Fa context
82is an initialized context;
83.Fa principal
84is the one who tries to change passwords, and
85.Fa password
86is the new password. Note that the password (in
87.Fa password->data )
88is not zero terminated.
89.It Fl k Ar kspec , Fl Fl keytab= Ns Ar kspec
90Keytab to get authentication key from.
91.It Fl r Ar realm , Fl Fl realm= Ns Ar realm
92Default realm.
93.It Fl p Ar string , Fl Fl port= Ns Ar string
94Port to listen on (default service kpasswd - 464).
95.El
96.Sh DIAGNOSTICS
97If an error occurs, the error message is returned to the user and/or
98logged to syslog.
99.Sh BUGS
100The default password quality checks are too basic.
101.Sh SEE ALSO
102.Xr kpasswd 1 ,
103.Xr kdc 8
104.\".Sh ENVIRONMENT
105.\".Sh FILES
106.\".Sh EXAMPLES
107.\".Sh SEE ALSO
108.\".Sh STANDARDS
109.\".Sh HISTORY
110.\".Sh AUTHORS
111