contrib/openpam/doc/man/openpam.3

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