xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_chauthtok.3 (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1.\"	$NetBSD: pam_chauthtok.3,v 1.4 2013/12/27 20:10:20 christos Exp $
2.\"
3.\" Generated from pam_chauthtok.c by gendoc.pl
4.\" Id: pam_chauthtok.c 648 2013-03-05 17:54:27Z des
5.Dd September 7, 2013
6.Dt PAM_CHAUTHTOK 3
7.Os
8.Sh NAME
9.Nm pam_chauthtok
10.Nd perform password related functions within the PAM framework
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.Ft "int"
17.Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
18.Sh DESCRIPTION
19The
20.Fn pam_chauthtok
21function attempts to change the authentication token
22for the user associated with the pam context specified by the
23.Fa pamh
24argument.
25.Pp
26The
27.Fa flags
28argument is the binary or of zero or more of the following
29values:
30.Bl -tag -width 18n
31.It Dv PAM_SILENT
32Do not emit any messages.
33.It Dv PAM_CHANGE_EXPIRED_AUTHTOK
34Change only those authentication tokens that have expired.
35.El
36.Pp
37If any other bits are set,
38.Fn pam_chauthtok
39will return
40.Dv PAM_SYMBOL_ERR .
41.Sh RETURN VALUES
42The
43.Fn pam_chauthtok
44function returns one of the following values:
45.Bl -tag -width 18n
46.It Bq Er PAM_ABORT
47General failure.
48.It Bq Er PAM_AUTHTOK_DISABLE_AGING
49Authentication token aging disabled.
50.It Bq Er PAM_AUTHTOK_ERR
51Authentication token failure.
52.It Bq Er PAM_AUTHTOK_LOCK_BUSY
53Authentication token lock busy.
54.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
55Failed to recover old authentication token.
56.It Bq Er PAM_BUF_ERR
57Memory buffer error.
58.It Bq Er PAM_CONV_ERR
59Conversation failure.
60.It Bq Er PAM_PERM_DENIED
61Permission denied.
62.It Bq Er PAM_SERVICE_ERR
63Error in service module.
64.It Bq Er PAM_SYMBOL_ERR
65Invalid symbol.
66.It Bq Er PAM_SYSTEM_ERR
67System error.
68.It Bq Er PAM_TRY_AGAIN
69Try again.
70.El
71.Sh SEE ALSO
72.Xr pam 3 ,
73.Xr pam_strerror 3
74.Sh STANDARDS
75.Rs
76.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
77.%D "June 1997"
78.Re
79.Sh AUTHORS
80The
81.Fn pam_chauthtok
82function and this manual page were
83developed for the
84.Fx
85Project by ThinkSec AS and Network Associates Laboratories, the
86Security Research Division of Network Associates, Inc.\& under
87DARPA/SPAWAR contract N66001-01-C-8035
88.Pq Dq CBOSS ,
89as part of the DARPA CHATS research program.
90.Pp
91The OpenPAM library is maintained by
92.An Dag-Erling Sm\(/orgrav Aq des@des.no .
93