share/man/man3lib/libpam.3lib

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBPAM 3LIB "Mar 24, 2004"
   7 .SH NAME
   8 libpam \- PAM (Pluggable Authentication Module) library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lpam\fR [ \fIlibrary\fR... ]
  13 #include <\fBsecurity/pam_appl.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 Functions in this library provide routines for the Pluggable Authentication
  20 Module (PAM).
  21 .SH INTERFACES
  22 .sp
  23 .LP
  24 The shared object \fBlibpam.so.1\fR provides the public interfaces defined
  25 below. See \fBIntro\fR(3) for additional information on shared object
  26 interfaces.
  27 .sp
  28
  29 .sp
  30 .TS
  31 l l
  32 l l .
  33 \fBpam_acct_mgmt\fR     \fBpam_authenticate\fR
  34 \fBpam_chauthtok\fR     \fBpam_close_session\fR
  35 \fBpam_end\fR   \fBpam_get_data\fR
  36 \fBpam_get_item\fR      \fBpam_get_user\fR
  37 \fBpam_getenv\fR        \fBpam_getenvlist\fR
  38 \fBpam_open_session\fR  \fBpam_putenv\fR
  39 \fBpam_set_data\fR      \fBpam_set_item\fR
  40 \fBpam_setcred\fR       \fBpam_start\fR
  41 \fBpam_strerror\fR
  42 .TE
  43
  44 .SH FILES
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB/lib/libpam.so.1\fR\fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 shared object
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB/etc/pam.conf\fR\fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 configuration file
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB/usr/lib/security/pam_dial_auth.so.1\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 authentication management  \fBPAM\fR module for dialups
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB/usr/lib/security/pam_sample.so.1\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 sample \fBPAM\fR module
  83 .RE
  84
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for description of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 box;
  94 c | c
  95 l | l .
  96 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  97 _
  98 MT Level        MT-Safe with exceptions
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBpvs\fR(1),  \fBIntro\fR(3),  \fBpam\fR(3PAM), \fBpam.conf\fR(4),
 105 \fBattributes\fR(5), \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 106 \fBpam_authtok_store\fR(5), \fBpam_dial_auth\fR(5), \fBpam_dhkeys\fR(5),
 107 \fBpam_passwd_auth\fR(5), \fBpam_sample\fR(5),
 108 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), \fBpam_unix_session\fR(5)
 109 .SH NOTES
 110 .sp
 111 .LP
 112 The functions in \fBlibpam\fR are MT-Safe only if each thread within the
 113 multithreaded application uses its own \fBPAM\fR handle.
 114 .sp
 115 .LP
 116 The \fBpam_unix\fR(5) module is no longer supported. Similar functionality is
 117 provided by \fBpam_authtok_check\fR(5), \fBpam_authtok_get\fR(5),
 118 \fBpam_authtok_store\fR(5), \fBpam_dhkeys\fR(5), \fBpam_passwd_auth\fR(5),
 119 \fBpam_unix_account\fR(5), \fBpam_unix_auth\fR(5), and
 120 \fBpam_unix_session\fR(5).