| 1 | .\"- |
|---|
| 2 | .\" Copyright (c) 2002 Networks Associates Technology, Inc. |
|---|
| 3 | .\" All rights reserved. |
|---|
| 4 | .\" |
|---|
| 5 | .\" This software was developed for the FreeBSD Project by ThinkSec AS and |
|---|
| 6 | .\" NAI Labs, the Security Research Division of Network Associates, Inc. |
|---|
| 7 | .\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the |
|---|
| 8 | .\" 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: //depot/projects/openpam/doc/man/pam_open_session.3#11 $ |
|---|
| 35 | .\" |
|---|
| 36 | .Dd April 14, 2002 |
|---|
| 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 security/pam_appl.h |
|---|
| 46 | .Ft int |
|---|
| 47 | .Fn pam_open_session "pam_handle_t *pamh" "int flags" |
|---|
| 48 | .Sh DESCRIPTION |
|---|
| 49 | The |
|---|
| 50 | .Nm |
|---|
| 51 | sets up a user session for a previously |
|---|
| 52 | authenticated user. The session should later be torn down by a call to |
|---|
| 53 | .Xr pam_close_session 3 . |
|---|
| 54 | .Pp |
|---|
| 55 | The |
|---|
| 56 | .Va flags |
|---|
| 57 | argument is the binary or of zero or more of the following |
|---|
| 58 | values: |
|---|
| 59 | .Bl -tag -width 18n |
|---|
| 60 | .It Dv PAM_SILENT |
|---|
| 61 | Do not emit any messages. |
|---|
| 62 | .El |
|---|
| 63 | If any other bits are set, |
|---|
| 64 | .Nm |
|---|
| 65 | will return |
|---|
| 66 | .Dv PAM_SYMBOL_ERR . |
|---|
| 67 | .Sh RETURN VALUES |
|---|
| 68 | The |
|---|
| 69 | .Nm |
|---|
| 70 | function returns one of the following values: |
|---|
| 71 | .Bl -tag -width 18n |
|---|
| 72 | .It Bq Er PAM_ABORT |
|---|
| 73 | General failure. |
|---|
| 74 | .It Bq Er PAM_BUF_ERR |
|---|
| 75 | Memory buffer error. |
|---|
| 76 | .It Bq Er PAM_CONV_ERR |
|---|
| 77 | Conversation failure. |
|---|
| 78 | .It Bq Er PAM_PERM_DENIED |
|---|
| 79 | Permission denied. |
|---|
| 80 | .It Bq Er PAM_SERVICE_ERR |
|---|
| 81 | Error in service module. |
|---|
| 82 | .It Bq Er PAM_SESSION_ERR |
|---|
| 83 | Session failure. |
|---|
| 84 | .It Bq Er PAM_SYMBOL_ERR |
|---|
| 85 | Invalid symbol. |
|---|
| 86 | .It Bq Er PAM_SYSTEM_ERR |
|---|
| 87 | System error. |
|---|
| 88 | .El |
|---|
| 89 | .Sh SEE ALSO |
|---|
| 90 | .Xr pam 3 , |
|---|
| 91 | .Xr pam_close_session 3 , |
|---|
| 92 | .Xr pam_strerror 3 |
|---|
| 93 | .Sh STANDARDS |
|---|
| 94 | .Rs |
|---|
| 95 | .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" |
|---|
| 96 | .%D "June 1997" |
|---|
| 97 | .Re |
|---|
| 98 | .Sh AUTHORS |
|---|
| 99 | The |
|---|
| 100 | .Nm |
|---|
| 101 | function and this manual page were developed for the FreeBSD Project |
|---|
| 102 | by ThinkSec AS and NAI Labs, the Security Research Division of Network |
|---|
| 103 | Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 |
|---|
| 104 | .Pq Dq CBOSS , |
|---|
| 105 | as part of the DARPA CHATS research program. |
|---|
