xref: /freebsd/contrib/openpam/doc/man/openpam.3 (revision ae83180158c4c937f170e31eff311b18c0286a93)
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.\" 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 June 30, 2002
37.Dt OPENPAM 3
38.Os
39.Sh NAME
40.Nm openpam_borrow_cred ,
41.Nm openpam_free_data ,
42.Nm openpam_get_option ,
43.Nm openpam_log ,
44.Nm openpam_nullconv ,
45.Nm openpam_restore_cred ,
46.Nm openpam_set_option ,
47.Nm openpam_ttyconv ,
48.Nm pam_error ,
49.Nm pam_get_authtok ,
50.Nm pam_info ,
51.Nm pam_prompt ,
52.Nm pam_setenv ,
53.Nm pam_verror ,
54.Nm pam_vinfo ,
55.Nm pam_vprompt
56.Nd Pluggable Authentication Modules Library
57.Sh LIBRARY
58.Lb libpam
59.Sh SYNOPSIS
60.In security/openpam.h
61.Ft int
62.Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd"
63.Ft void
64.Fn openpam_free_data "pam_handle_t *pamh" "void *data" "int status"
65.Ft const char *
66.Fn openpam_get_option "pam_handle_t *pamh" "const char *option"
67.Ft void
68.Fn openpam_log "int level" "const char *fmt" "..."
69.Ft int
70.Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
71.Ft int
72.Fn openpam_restore_cred "pam_handle_t *pamh"
73.Ft int
74.Fn openpam_set_option "pam_handle_t *pamh" "const char *option" "const char *value"
75.Ft int
76.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
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" "int item" "const char **authtok" "const char *prompt"
81.Ft int
82.Fn pam_info "pam_handle_t *pamh" "const char *fmt" "..."
83.Ft int
84.Fn pam_prompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
85.Ft int
86.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
87.Ft int
88.Fn pam_verror "pam_handle_t *pamh" "const char *fmt" "va_list ap"
89.Ft int
90.Fn pam_vinfo "pam_handle_t *pamh" "const char *fmt" "va_list ap"
91.Ft int
92.Fn pam_vprompt "pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
93.\"
94.\" $P4: //depot/projects/openpam/doc/man/openpam.man#1 $
95.\"
96.Sh DESCRIPTION
97These functions are OpenPAM extensions to the PAM API.  Those named
98.Fn pam_*
99are, in the author's opinion, logical and necessary extensions to the
100standard API, while those named
101.Fn openpam_*
102are either simple convenience functions, or functions intimately tied
103to OpenPAM implementation details, and therefore not well suited to
104standardization.
105.Sh SEE ALSO
106.Xr openpam_borrow_cred 3 ,
107.Xr openpam_free_data 3 ,
108.Xr openpam_get_option 3 ,
109.Xr openpam_log 3 ,
110.Xr openpam_nullconv 3 ,
111.Xr openpam_restore_cred 3 ,
112.Xr openpam_set_option 3 ,
113.Xr openpam_ttyconv 3 ,
114.Xr pam_error 3 ,
115.Xr pam_get_authtok 3 ,
116.Xr pam_info 3 ,
117.Xr pam_prompt 3 ,
118.Xr pam_setenv 3 ,
119.Xr pam_verror 3 ,
120.Xr pam_vinfo 3 ,
121.Xr pam_vprompt 3
122.Sh STANDARDS
123.Rs
124.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
125.%D "June 1997"
126.Re
127.Sh AUTHORS
128The OpenPAM library and this manual page were developed for the
129FreeBSD Project by ThinkSec AS and Network Associates Laboratories,
130the Security Research Division of Network Associates, Inc.  under
131DARPA/SPAWAR contract N66001-01-C-8035
132.Pq Dq CBOSS ,
133as part of the DARPA CHATS research program.
134