1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav 4.\" All rights reserved. 5.\" 6.\" This software was developed for the FreeBSD Project by ThinkSec AS and 7.\" Network Associates Laboratories, the Security Research Division of 8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 9.\" ("CBOSS"), as part of the DARPA CHATS research program. 10.\" 11.\" Redistribution and use in source and binary forms, with or without 12.\" modification, are permitted provided that the following conditions 13.\" are met: 14.\" 1. Redistributions of source code must retain the above copyright 15.\" notice, this list of conditions and the following disclaimer. 16.\" 2. Redistributions in binary form must reproduce the above copyright 17.\" notice, this list of conditions and the following disclaimer in the 18.\" documentation and/or other materials provided with the distribution. 19.\" 3. The name of the author may not be used to endorse or promote 20.\" products derived from this software without specific prior written 21.\" permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" $P4$ 36.\" 37.Dd December 21, 2007 38.Dt OPENPAM 3 39.Os 40.Sh NAME 41.Nm openpam_borrow_cred , 42.Nm openpam_free_data , 43.Nm openpam_free_envlist , 44.Nm openpam_get_option , 45.Nm openpam_log , 46.Nm openpam_nullconv , 47.Nm openpam_readline , 48.Nm openpam_restore_cred , 49.Nm openpam_set_option , 50.Nm openpam_ttyconv , 51.Nm pam_error , 52.Nm pam_get_authtok , 53.Nm pam_info , 54.Nm pam_prompt , 55.Nm pam_setenv , 56.Nm pam_verror , 57.Nm pam_vinfo , 58.Nm pam_vprompt 59.Nd Pluggable Authentication Modules Library 60.Sh LIBRARY 61.Lb libpam 62.Sh SYNOPSIS 63.In security/openpam.h 64.Ft "int" 65.Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd" 66.Ft "void" 67.Fn openpam_free_data "pam_handle_t *pamh" "void *data" "int status" 68.Ft "void" 69.Fn openpam_free_envlist "char **envlist" 70.Ft "const char *" 71.Fn openpam_get_option "pam_handle_t *pamh" "const char *option" 72.Ft "void" 73.Fn openpam_log "int level" "const char *fmt" "..." 74.Ft "int" 75.Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data" 76.Ft "char *" 77.Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp" 78.Ft "int" 79.Fn openpam_restore_cred "pam_handle_t *pamh" 80.Ft "int" 81.Fn openpam_set_option "pam_handle_t *pamh" "const char *option" "const char *value" 82.Ft "int" 83.Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data" 84.Ft "int" 85.Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..." 86.Ft "int" 87.Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt" 88.Ft "int" 89.Fn pam_info "const pam_handle_t *pamh" "const char *fmt" "..." 90.Ft "int" 91.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..." 92.Ft "int" 93.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite" 94.Ft "int" 95.Fn pam_verror "const pam_handle_t *pamh" "const char *fmt" "va_list ap" 96.Ft "int" 97.Fn pam_vinfo "const pam_handle_t *pamh" "const char *fmt" "va_list ap" 98.Ft "int" 99.Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap" 100.\" 101.\" $Id: openpam.man 320 2006-02-16 20:33:19Z des $ 102.\" 103.Sh DESCRIPTION 104These functions are OpenPAM extensions to the PAM API. 105Those named 106.Fn pam_* 107are, in the author's opinion, logical and necessary extensions to the 108standard API, while those named 109.Fn openpam_* 110are either simple convenience functions, or functions intimately tied 111to OpenPAM implementation details, and therefore not well suited to 112standardization. 113.Sh SEE ALSO 114.Xr openpam_borrow_cred 3 , 115.Xr openpam_free_data 3 , 116.Xr openpam_free_envlist 3 , 117.Xr openpam_get_option 3 , 118.Xr openpam_log 3 , 119.Xr openpam_nullconv 3 , 120.Xr openpam_readline 3 , 121.Xr openpam_restore_cred 3 , 122.Xr openpam_set_option 3 , 123.Xr openpam_ttyconv 3 , 124.Xr pam_error 3 , 125.Xr pam_get_authtok 3 , 126.Xr pam_info 3 , 127.Xr pam_prompt 3 , 128.Xr pam_setenv 3 , 129.Xr pam_verror 3 , 130.Xr pam_vinfo 3 , 131.Xr pam_vprompt 3 132.Sh STANDARDS 133.Rs 134.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 135.%D "June 1997" 136.Re 137.Sh AUTHORS 138The OpenPAM library and this manual page were developed for the 139.Fx 140Project by ThinkSec AS and Network Associates Laboratories, the 141Security Research Division of Network Associates, Inc.\& under 142DARPA/SPAWAR contract N66001-01-C-8035 143.Pq Dq CBOSS , 144as part of the DARPA CHATS research program. 145