1.\"- 2.\" Copyright (c) 2002 Networks Associates Technology, Inc. 3.\" All rights reserved. 4.\" 5.\" This software was developed for the FreeBSD Project by ThinkSec AS and 6.\" NAI Labs, the Security Research Division of Network Associates, Inc. 7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the 8.\" DARPA CHATS research program. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. The name of the author may not be used to endorse or promote 19.\" products derived from this software without specific prior written 20.\" permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" $P4: //depot/projects/openpam/doc/man/pam_get_authtok.3#14 $ 35.\" 36.Dd May 2, 2002 37.Dt PAM_GET_AUTHTOK 3 38.Os 39.Sh NAME 40.Nm pam_get_authtok 41.Nd retrieve authentication token 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In security/pam_appl.h 46.Ft int 47.Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt" 48.Sh DESCRIPTION 49The 50.Nm 51function returns the cached authentication token, 52or prompts the user if no token is currently cached. Either way, a 53pointer to the authentication token is stored in the location pointed 54to by the 55.Va authtok 56argument. 57.Pp 58The 59.Va item 60argument must have one of the following values: 61.Bl -tag -width 18n 62.It Dv PAM_AUTHTOK 63Returns the current authentication token, or the new token 64when changing authentication tokens. 65.It Dv PAM_OLDAUTHTOK 66Returns the previous authentication token when changing 67authentication tokens. 68.El 69The 70.Va prompt 71argument specifies a prompt to use if no token is cached. 72If it is 73.Dv NULL , 74the 75.Dv PAM_AUTHTOK_PROMPT 76or 77.Dv PAM_OLDAUTHTOK_PROMPT 78item, 79as appropriate, will be used. If that item is also 80.Dv NULL , 81a hardcoded 82default prompt will be used. 83.Pp 84If 85.Va item 86is set to 87.Dv PAM_AUTHTOK 88and there is a non-null 89.Dv PAM_OLDAUTHTOK 90item, 91.Nm 92will ask the user to confirm the new token by 93retyping it. If there is a mismatch, 94.Nm 95will return 96.Dv PAM_TRY_AGAIN . 97.Pp 98.Sh RETURN VALUES 99The 100.Nm 101function returns one of the following values: 102.Bl -tag -width 18n 103.It Bq Er PAM_BUF_ERR 104Memory buffer error. 105.It Bq Er PAM_CONV_ERR 106Conversation failure. 107.It Bq Er PAM_SYSTEM_ERR 108System error. 109.It Bq Er PAM_TRY_AGAIN 110Try again. 111.El 112.Sh SEE ALSO 113.Xr pam 3 , 114.Xr pam_get_item 3 , 115.Xr pam_get_user 3 , 116.Xr pam_strerror 3 117.Sh STANDARDS 118The 119.Nm 120function is an OpenPAM extension. 121.Sh AUTHORS 122The 123.Nm 124function and this manual page were developed for the FreeBSD Project 125by ThinkSec AS and NAI Labs, the Security Research Division of Network 126Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 127.Pq Dq CBOSS , 128as part of the DARPA CHATS research program. 129