dist/openpam/doc/man/pam_get_authtok.3

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