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.\" Network Associates Laboratories, the Security Research Division of 7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 8.\" ("CBOSS"), as part of the 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$ 35.\" 36.Dd June 30, 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 69.Pp 70The 71.Va prompt 72argument specifies a prompt to use if no token is cached. 73If it is 74.Dv NULL , 75the 76.Dv PAM_AUTHTOK_PROMPT 77or 78.Dv PAM_OLDAUTHTOK_PROMPT 79item, 80as appropriate, will be used. If that item is also 81.Dv NULL , 82a hardcoded 83default prompt will be used. 84.Pp 85If 86.Va item 87is set to 88.Dv PAM_AUTHTOK 89and there is a non-null 90.Dv PAM_OLDAUTHTOK 91item, 92.Nm 93will ask the user to confirm the new token by 94retyping it. If there is a mismatch, 95.Nm 96will return 97.Dv PAM_TRY_AGAIN . 98.Pp 99.Sh RETURN VALUES 100The 101.Nm 102function returns one of the following values: 103.Bl -tag -width 18n 104.It Bq Er PAM_BUF_ERR 105Memory buffer error. 106.It Bq Er PAM_CONV_ERR 107Conversation failure. 108.It Bq Er PAM_SYSTEM_ERR 109System error. 110.It Bq Er PAM_TRY_AGAIN 111Try again. 112.El 113.Sh SEE ALSO 114.Xr pam 3 , 115.Xr pam_get_item 3 , 116.Xr pam_get_user 3 , 117.Xr pam_strerror 3 118.Sh STANDARDS 119The 120.Nm 121function is an OpenPAM extension. 122.Sh AUTHORS 123The 124.Nm 125function and this manual page were developed for the FreeBSD Project 126by ThinkSec AS and Network Associates Laboratories, the Security 127Research Division of Network Associates, Inc. under DARPA/SPAWAR 128contract N66001-01-C-8035 129.Pq Dq CBOSS , 130as part of the DARPA CHATS research program. 131