Home | History | Annotate | Line # | Download | only in man
pam_open_session.3 revision 1.5
      1 <<<<<<< pam_open_session.3
      2 .\"	$NetBSD: pam_open_session.3,v 1.5 2014/10/24 18:17:56 christos Exp $
      3 .\"
      4 =======
      5 >>>>>>> 1.1.1.4
      6 .\" Generated from pam_open_session.c by gendoc.pl
      7 .\" Id: pam_open_session.c 648 2013-03-05 17:54:27Z des 
      8 .Dd September 12, 2014
      9 .Dt PAM_OPEN_SESSION 3
     10 .Os
     11 .Sh NAME
     12 .Nm pam_open_session
     13 .Nd open a user session
     14 .Sh LIBRARY
     15 .Lb libpam
     16 .Sh SYNOPSIS
     17 .In sys/types.h
     18 .In security/pam_appl.h
     19 .Ft "int"
     20 .Fn pam_open_session "pam_handle_t *pamh" "int flags"
     21 .Sh DESCRIPTION
     22 The
     23 .Fn pam_open_session
     24 sets up a user session for a previously
     25 authenticated user.
     26 The session should later be torn down by a call to
     27 .Xr pam_close_session 3 .
     28 .Pp
     29 The
     30 .Fa flags
     31 argument is the binary or of zero or more of the following
     32 values:
     33 .Bl -tag -width 18n
     34 .It Dv PAM_SILENT
     35 Do not emit any messages.
     36 .El
     37 .Pp
     38 If any other bits are set,
     39 .Fn pam_open_session
     40 will return
     41 .Dv PAM_SYMBOL_ERR .
     42 .Sh RETURN VALUES
     43 The
     44 .Fn pam_open_session
     45 function returns one of the following values:
     46 .Bl -tag -width 18n
     47 .It Bq Er PAM_ABORT
     48 General failure.
     49 .It Bq Er PAM_BUF_ERR
     50 Memory buffer error.
     51 .It Bq Er PAM_CONV_ERR
     52 Conversation failure.
     53 .It Bq Er PAM_PERM_DENIED
     54 Permission denied.
     55 .It Bq Er PAM_SERVICE_ERR
     56 Error in service module.
     57 .It Bq Er PAM_SESSION_ERR
     58 Session failure.
     59 .It Bq Er PAM_SYMBOL_ERR
     60 Invalid symbol.
     61 .It Bq Er PAM_SYSTEM_ERR
     62 System error.
     63 .El
     64 .Sh SEE ALSO
     65 .Xr pam 3 ,
     66 .Xr pam_close_session 3 ,
     67 .Xr pam_strerror 3
     68 .Sh STANDARDS
     69 .Rs
     70 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
     71 .%D "June 1997"
     72 .Re
     73 .Sh AUTHORS
     74 The
     75 .Fn pam_open_session
     76 function and this manual page were
     77 developed for the
     78 .Fx
     79 Project by ThinkSec AS and Network Associates Laboratories, the
     80 Security Research Division of Network Associates, Inc.\& under
     81 DARPA/SPAWAR contract N66001-01-C-8035
     82 .Pq Dq CBOSS ,
     83 as part of the DARPA CHATS research program.
     84 .Pp
     85 The OpenPAM library is maintained by
     86 .An Dag-Erling Sm\(/orgrav Aq des (a] des.no .
     87