contrib/openpam/doc/man/pam_get_authtok.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 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 February 1, 2005
  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 sys/types.h
  46 .In security/pam_appl.h
  47 .Ft "int"
  48 .Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt"
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 function returns the cached authentication token,
  53 or prompts the user if no token is currently cached.
  54 Either way, a pointer to the authentication token is stored in the
  55 location pointed to by the
  56 .Fa authtok
  57 argument.
  58 .Pp
  59 The
  60 .Fa item
  61 argument must have one of the following values:
  62 .Bl -tag -width 18n
  63 .It Dv PAM_AUTHTOK
  64 Returns the current authentication token, or the new token
  65 when changing authentication tokens.
  66 .It Dv PAM_OLDAUTHTOK
  67 Returns the previous authentication token when changing
  68 authentication tokens.
  69 .El
  70 .Pp
  71 The
  72 .Fa prompt
  73 argument specifies a prompt to use if no token is cached.
  74 If it is
  75 .Dv NULL ,
  76 the
  77 .Dv PAM_AUTHTOK_PROMPT
  78 or
  79 .Dv PAM_OLDAUTHTOK_PROMPT
  80 item,
  81 as appropriate, will be used.
  82 If that item is also
  83 .Dv NULL ,
  84 a hardcoded default prompt will be used.
  85 .Pp
  86 If
  87 .Fa item
  88 is set to
  89 .Dv PAM_AUTHTOK
  90 and there is a non-null
  91 .Dv PAM_OLDAUTHTOK
  92 item,
  93 .Nm
  94 will ask the user to confirm the new token by
  95 retyping it.
  96 If there is a mismatch,
  97 .Nm
  98 will return
  99 .Dv PAM_TRY_AGAIN .
 100 .Pp
 101 .Sh RETURN VALUES
 102 The
 103 .Nm
 104 function returns one of the following values:
 105 .Bl -tag -width 18n
 106 .It Bq Er PAM_BUF_ERR
 107 Memory buffer error.
 108 .It Bq Er PAM_CONV_ERR
 109 Conversation failure.
 110 .It Bq Er PAM_SYSTEM_ERR
 111 System error.
 112 .It Bq Er PAM_TRY_AGAIN
 113 Try again.
 114 .El
 115 .Sh SEE ALSO
 116 .Xr pam 3 ,
 117 .Xr pam_get_item 3 ,
 118 .Xr pam_get_user 3 ,
 119 .Xr pam_strerror 3
 120 .Sh STANDARDS
 121 The
 122 .Nm
 123 function is an OpenPAM extension.
 124 .Sh AUTHORS
 125 The
 126 .Nm
 127 function and this manual page were developed for the
 128 .Fx
 129 Project by ThinkSec AS and Network Associates Laboratories, the
 130 Security Research Division of Network Associates, Inc.& under
 131 DARPA/SPAWAR contract N66001-01-C-8035
 132 .Pq Dq CBOSS ,
 133 as part of the DARPA CHATS research program.