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