contrib/openpam/doc/man/pam_open_session.3

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