contrib/openpam/doc/man/openpam.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 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 .\" $Id$
  36 .\"
  37 .Dd December 18, 2011
  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_subst ,
  51 .Nm openpam_ttyconv ,
  52 .Nm pam_error ,
  53 .Nm pam_get_authtok ,
  54 .Nm pam_info ,
  55 .Nm pam_prompt ,
  56 .Nm pam_setenv ,
  57 .Nm pam_verror ,
  58 .Nm pam_vinfo ,
  59 .Nm pam_vprompt
  60 .Nd Pluggable Authentication Modules Library
  61 .Sh LIBRARY
  62 .Lb libpam
  63 .Sh SYNOPSIS
  64 .In security/openpam.h
  65 .Ft "int"
  66 .Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd"
  67 .Ft "void"
  68 .Fn openpam_free_data "pam_handle_t *pamh" "void *data" "int status"
  69 .Ft "void"
  70 .Fn openpam_free_envlist "char **envlist"
  71 .Ft "const char *"
  72 .Fn openpam_get_option "pam_handle_t *pamh" "const char *option"
  73 .Ft "void"
  74 .Fn openpam_log "int level" "const char *fmt" "..."
  75 .Ft "int"
  76 .Fn openpam_nullconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
  77 .Ft "char *"
  78 .Fn openpam_readline "FILE *f" "int *lineno" "size_t *lenp"
  79 .Ft "int"
  80 .Fn openpam_restore_cred "pam_handle_t *pamh"
  81 .Ft "int"
  82 .Fn openpam_set_option "pam_handle_t *pamh" "const char *option" "const char *value"
  83 .Ft "int"
  84 .Fn openpam_subst "const pam_handle_t *pamh" "char *buf" "size_t *bufsize" "const char *template"
  85 .Ft "int"
  86 .Fn openpam_ttyconv "int n" "const struct pam_message **msg" "struct pam_response **resp" "void *data"
  87 .Ft "int"
  88 .Fn pam_error "const pam_handle_t *pamh" "const char *fmt" "..."
  89 .Ft "int"
  90 .Fn pam_get_authtok "pam_handle_t *pamh" "int item" "const char **authtok" "const char *prompt"
  91 .Ft "int"
  92 .Fn pam_info "const pam_handle_t *pamh" "const char *fmt" "..."
  93 .Ft "int"
  94 .Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
  95 .Ft "int"
  96 .Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
  97 .Ft "int"
  98 .Fn pam_verror "const pam_handle_t *pamh" "const char *fmt" "va_list ap"
  99 .Ft "int"
 100 .Fn pam_vinfo "const pam_handle_t *pamh" "const char *fmt" "va_list ap"
 101 .Ft "int"
 102 .Fn pam_vprompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "va_list ap"
 103 .\"
 104 .\" $Id: openpam.man 320 2006-02-16 20:33:19Z des $
 105 .\"
 106 .Sh DESCRIPTION
 107 These functions are OpenPAM extensions to the PAM API.
 108 Those named
 109 .Fn pam_*
 110 are, in the author's opinion, logical and necessary extensions to the
 111 standard API, while those named
 112 .Fn openpam_*
 113 are either simple convenience functions, or functions intimately tied
 114 to OpenPAM implementation details, and therefore not well suited to
 115 standardization.
 116 .Sh SEE ALSO
 117 .Xr openpam_borrow_cred 3 ,
 118 .Xr openpam_free_data 3 ,
 119 .Xr openpam_free_envlist 3 ,
 120 .Xr openpam_get_option 3 ,
 121 .Xr openpam_log 3 ,
 122 .Xr openpam_nullconv 3 ,
 123 .Xr openpam_readline 3 ,
 124 .Xr openpam_restore_cred 3 ,
 125 .Xr openpam_set_option 3 ,
 126 .Xr openpam_subst 3 ,
 127 .Xr openpam_ttyconv 3 ,
 128 .Xr pam_error 3 ,
 129 .Xr pam_get_authtok 3 ,
 130 .Xr pam_info 3 ,
 131 .Xr pam_prompt 3 ,
 132 .Xr pam_setenv 3 ,
 133 .Xr pam_verror 3 ,
 134 .Xr pam_vinfo 3 ,
 135 .Xr pam_vprompt 3
 136 .Sh STANDARDS
 137 .Rs
 138 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 139 .%D "June 1997"
 140 .Re
 141 .Sh AUTHORS
 142 The OpenPAM library and this manual page were developed for the
 143 .Fx
 144 Project by ThinkSec AS and Network Associates Laboratories, the
 145 Security Research Division of Network Associates, Inc.\& under
 146 DARPA/SPAWAR contract N66001-01-C-8035
 147 .Pq Dq CBOSS ,
 148 as part of the DARPA CHATS research program.