dist/openpam/doc/man/openpam.3

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