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