contrib/openpam/doc/man/pam_open_session.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 PAM_OPEN_SESSION 3
  39 .Os
  40 .Sh NAME
  41 .Nm pam_open_session
  42 .Nd open a user session
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .Ft "int"
  49 .Fn pam_open_session "pam_handle_t *pamh" "int flags"
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 sets up a user session for a previously
  54 authenticated user.
  55 The session should later be torn down by a call to
  56 .Xr pam_close_session 3 .
  57 .Pp
  58 The
  59 .Fa flags
  60 argument is the binary or of zero or more of the following
  61 values:
  62 .Bl -tag -width 18n
  63 .It Dv PAM_SILENT
  64 Do not emit any messages.
  65 .El
  66 .Pp
  67 If any other bits are set,
  68 .Nm
  69 will return
  70 .Dv PAM_SYMBOL_ERR .
  71 .Sh RETURN VALUES
  72 The
  73 .Nm
  74 function returns one of the following values:
  75 .Bl -tag -width 18n
  76 .It Bq Er PAM_ABORT
  77 General failure.
  78 .It Bq Er PAM_BUF_ERR
  79 Memory buffer error.
  80 .It Bq Er PAM_CONV_ERR
  81 Conversation failure.
  82 .It Bq Er PAM_PERM_DENIED
  83 Permission denied.
  84 .It Bq Er PAM_SERVICE_ERR
  85 Error in service module.
  86 .It Bq Er PAM_SESSION_ERR
  87 Session failure.
  88 .It Bq Er PAM_SYMBOL_ERR
  89 Invalid symbol.
  90 .It Bq Er PAM_SYSTEM_ERR
  91 System error.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr pam 3 ,
  95 .Xr pam_close_session 3 ,
  96 .Xr pam_strerror 3
  97 .Sh STANDARDS
  98 .Rs
  99 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 100 .%D "June 1997"
 101 .Re
 102 .Sh AUTHORS
 103 The
 104 .Nm
 105 function and this manual page were developed for the
 106 .Fx
 107 Project by
 108 ThinkSec AS and Network Associates Laboratories, the
 109 Security Research Division of Network Associates, Inc.\& under
 110 DARPA/SPAWAR contract N66001-01-C-8035
 111 .Pq Dq CBOSS ,
 112 as part of the DARPA CHATS research program.