source: openpam/trunk/doc/man/pam_get_authtok.3 @ 119

Last change on this file since 119 was 119, checked in by des, 12 years ago

Regenerate.

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