source: openpam/trunk/doc/man/pam.3 @ 41

Last change on this file since 41 was 41, checked in by Dag-Erling Smørgrav, 19 years ago

Regenerate man pages for functions that have changed, and add man
pages for new functions. The man pages have been backdated to
minimize diffs.

Sponsored by: DARPA, NAI Labs

File size: 5.3 KB
Line 
1.\"-
2.\" Copyright (c) 2002 Networks Associates Technologies, 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.\" $Id$
35.\"
36.Dd February 4, 2002
37.Dt PAM 3
38.Os
39.Sh NAME
40.Nm pam_acct_mgmt ,
41.Nm pam_authenticate ,
42.Nm pam_chauthtok ,
43.Nm pam_close_session ,
44.Nm pam_end ,
45.Nm pam_error ,
46.Nm pam_get_authtok ,
47.Nm pam_get_data ,
48.Nm pam_get_item ,
49.Nm pam_get_user ,
50.Nm pam_getenv ,
51.Nm pam_getenvlist ,
52.Nm pam_info ,
53.Nm pam_open_session ,
54.Nm pam_prompt ,
55.Nm pam_putenv ,
56.Nm pam_set_data ,
57.Nm pam_set_item ,
58.Nm pam_setcred ,
59.Nm pam_setenv ,
60.Nm pam_start ,
61.Nm pam_strerror ,
62.Nm pam_verror ,
63.Nm pam_vinfo ,
64.Nm pam_vprompt
65.Nd Pluggable Authentication Modules
66.Sh LIBRARY
67.Lb libpam
68.Sh SYNOPSIS
69.In security/pam_appl.h
70.Ft int
71.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags"
72.Ft int
73.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
74.Ft int
75.Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
76.Ft int
77.Fn pam_close_session "pam_handle_t *pamh" "int flags"
78.Ft int
79.Fn pam_end "pam_handle_t *pamh" "int status"
80.Ft int
81.Fn pam_error "pam_handle_t *pamh" "const char *fmt" "..."
82.Ft int
83.Fn pam_get_authtok "pam_handle_t *pamh" "const char **authtok" "const char *prompt"
84.Ft int
85.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "void **data"
86.Ft int
87.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "const void **item"
88.Ft int
89.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt"
90.Ft char *
91.Fn pam_getenv "pam_handle_t *pamh" "const char *name"
92.Ft char **
93.Fn pam_getenvlist "pam_handle_t *pamh"
94.Ft int
95.Fn pam_info "pam_handle_t *pamh" "const char *fmt" "..."
96.Ft int
97.Fn pam_open_session "pam_handle_t *pamh" "int flags"
98.Ft int
99.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
100.Ft int
101.Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue"
102.Ft int
103.Fn pam_set_data "pam_handle_t *pamh" "const char *module_data_name" "void *data" "void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status)"
104.Ft int
105.Fn pam_set_item "pam_handle_t *pamh" "int item_type" "const void *item"
106.Ft int
107.Fn pam_setcred "pam_handle_t *pamh" "int flags"
108.Ft int
109.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
110.Ft int
111.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
112.Ft const char *
113.Fn pam_strerror "pam_handle_t *pamh" "int error_number"
114.Ft int
115.Fn pam_verror "pam_handle_t *pamh" "const char *fmt" "va_list ap"
116.Ft int
117.Fn pam_vinfo "pam_handle_t *pamh" "const char *fmt" "va_list ap"
118.Ft int
119.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
120.Sh DESCRIPTION
121Foo
122.Sh RETURN VALUES
123.Sh SEE ALSO
124.Xr pam_acct_mgmt 3 ,
125.Xr pam_authenticate 3 ,
126.Xr pam_chauthtok 3 ,
127.Xr pam_close_session 3 ,
128.Xr pam_end 3 ,
129.Xr pam_error 3 ,
130.Xr pam_get_authtok 3 ,
131.Xr pam_get_data 3 ,
132.Xr pam_get_item 3 ,
133.Xr pam_get_user 3 ,
134.Xr pam_getenv 3 ,
135.Xr pam_getenvlist 3 ,
136.Xr pam_info 3 ,
137.Xr pam_open_session 3 ,
138.Xr pam_prompt 3 ,
139.Xr pam_putenv 3 ,
140.Xr pam_set_data 3 ,
141.Xr pam_set_item 3 ,
142.Xr pam_setcred 3 ,
143.Xr pam_setenv 3 ,
144.Xr pam_start 3 ,
145.Xr pam_strerror 3 ,
146.Xr pam_verror 3 ,
147.Xr pam_vinfo 3 ,
148.Xr pam_vprompt 3 ,
149.Xr pam.conf 5
150.Sh STANDARDS
151.Rs
152.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
153.%D "June 1997"
154.Re
155.Sh AUTHORS
156The OpenPAM library and this manual page were developed for the
157FreeBSD Project by ThinkSec AS and NAI Labs, the Security Research
158Division of Network Associates, Inc.  under DARPA/SPAWAR contract
159N66001-01-C-8035
160.Pq Dq CBOSS ,
161as part of the DARPA CHATS research program.
Note: See TracBrowser for help on using the repository browser.