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

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

Man page stubs.

Sponsored by: DARPA, NAI Labs

File size: 4.9 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.Nd Pluggable Authentication Modules
63.Sh LIBRARY
64.Lb libfetch
65.Sh SYNOPSIS
66.In security/pam_appl.h
67.Ft int
68.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags"
69.Ft int
70.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
71.Ft int
72.Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
73.Ft int
74.Fn pam_close_session "pam_handle_t *pamh" "int flags"
75.Ft int
76.Fn pam_end "pam_handle_t *pamh" "int status"
77.Ft int
78.Fn pam_error "pam_handle_t *pamh" "const char *fmt" "..."
79.Ft int
80.Fn pam_get_authtok "pam_handle_t *pamh" "char **authtok" "const char *prompt"
81.Ft int
82.Fn pam_get_data "pam_handle_t *pamh" "const char *module_data_name" "void **data"
83.Ft int
84.Fn pam_get_item "pam_handle_t *pamh" "int item_type" "void **item"
85.Ft int
86.Fn pam_get_user "pam_handle_t *pamh" "char **user" "const char *prompt"
87.Ft char *
88.Fn pam_getenv "pam_handle_t *pamh" "const char *name"
89.Ft char **
90.Fn pam_getenvlist "pam_handle_t *pamh"
91.Ft int
92.Fn pam_info "pam_handle_t *pamh" "const char *fmt" "..."
93.Ft int
94.Fn pam_open_session "pam_handle_t *pamh" "int flags"
95.Ft int
96.Fn pam_prompt "pam_handle_t *pamh" "char **resp" "int echo" "const char *fmt" "..."
97.Ft int
98.Fn pam_putenv "pam_handle_t *pamh" "const char *namevalue"
99.Ft int
100.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)"
101.Ft int
102.Fn pam_set_item "pam_handle_t *pamh" "int item_type" "const void *item"
103.Ft int
104.Fn pam_setcred "pam_handle_t *pamh" "int flags"
105.Ft int
106.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
107.Ft int
108.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
109.Ft const char *
110.Fn pam_strerror "pam_handle_t *pamh" "int error_number"
111.Sh DESCRIPTION
112Foo
113.Sh RETURN VALUES
114.Sh SEE ALSO
115.Xr pam_acct_mgmt 4 ,
116.Xr pam_authenticate 4 ,
117.Xr pam_chauthtok 4 ,
118.Xr pam_close_session 4 ,
119.Xr pam_end 4 ,
120.Xr pam_error 4 ,
121.Xr pam_get_authtok 4 ,
122.Xr pam_get_data 4 ,
123.Xr pam_get_item 4 ,
124.Xr pam_get_user 4 ,
125.Xr pam_getenv 4 ,
126.Xr pam_getenvlist 4 ,
127.Xr pam_info 4 ,
128.Xr pam_open_session 4 ,
129.Xr pam_prompt 4 ,
130.Xr pam_putenv 4 ,
131.Xr pam_set_data 4 ,
132.Xr pam_set_item 4 ,
133.Xr pam_setcred 4 ,
134.Xr pam_setenv 4 ,
135.Xr pam_start 4 ,
136.Xr pam_strerror 4 ,
137.Xr pam.conf 5
138.Sh STANDARDS
139.Rs
140.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
141.%D "June 1997"
142.Re
143.AUTHORS
144The OpenPAM library and this manual page were developed for the
145FreeBSD Project by ThinkSec AS and NAI Labs, the Security Research
146Division of Network Associates, Inc.  under DARPA/SPAWAR contract
147N66001-01-C-8035
148.Pq .Dq CBOSS ,
149as part of the DARPA CHATS research program.
Note: See TracBrowser for help on using the repository browser.