2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3 .\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
4 .\" All rights reserved.
6 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
7 .\" Network Associates Laboratories, the Security Research Division of
8 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9 .\" ("CBOSS"), as part of the DARPA CHATS research program.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. The name of the author may not be used to endorse or promote
20 .\" products derived from this software without specific prior written
23 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 .Nd retrieve authentication token
47 .In security/pam_appl.h
49 .Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt"
53 function returns the cached authentication token,
54 or prompts the user if no token is currently cached.
55 Either way, a pointer to the authentication token is stored in the
56 location pointed to by the
62 argument must have one of the following values:
65 Returns the current authentication token, or the new token
66 when changing authentication tokens.
68 Returns the previous authentication token when changing
69 authentication tokens.
74 argument specifies a prompt to use if no token is cached.
78 .Dv PAM_AUTHTOK_PROMPT
80 .Dv PAM_OLDAUTHTOK_PROMPT
82 as appropriate, will be used.
85 a hardcoded default prompt will be used.
86 Either way, the prompt is expanded using
89 passed to the conversation function.
93 is called from a module and the
97 option is set in the policy file, the value of that
98 option takes precedence over both the
101 .Dv PAM_AUTHTOK_PROMPT
103 .Dv PAM_OLDAUTHTOK_PROMPT
110 and there is a non-null
114 will ask the user to confirm the new token by
116 If there is a mismatch,
124 function returns one of the following values:
126 .It Bq Er PAM_BUF_ERR
128 .It Bq Er PAM_CONV_ERR
129 Conversation failure.
130 .It Bq Er PAM_SYSTEM_ERR
132 .It Bq Er PAM_TRY_AGAIN
136 .Xr openpam_subst 3 ,
144 function is an OpenPAM extension.
148 function and this manual page were developed for the
151 ThinkSec AS and Network Associates Laboratories, the
152 Security Research Division of Network Associates, Inc.\& under
153 DARPA/SPAWAR contract N66001-01-C-8035
155 as part of the DARPA CHATS research program.