| 1 |
.\" Title: pam_ck_connector |
| 2 |
.\" Author: David Zeuthen <[email protected]> |
| 3 |
.\" Date: 02/27/2007 |
| 4 |
.\" |
| 5 |
.TH "PAM_CK_CONNECTOR" "8" "02/27/2007" "ConsoleKit Manual" "ConsoleKit Manual" |
| 6 |
.\" disable hyphenation |
| 7 |
.nh |
| 8 |
.\" disable justification (adjust text to left margin only) |
| 9 |
.ad l |
| 10 |
.SH "NAME" |
| 11 |
pam_ck_connector \- Register session with ConsoleKit |
| 12 |
.SH "SYNOPSIS" |
| 13 |
.HP 12 |
| 14 |
\fBpam_ck_connector.so\fR [debug] |
| 15 |
.SH "DESCRIPTION" |
| 16 |
.PP |
| 17 |
The pam_ck_connector PAM module registers a login session with |
| 18 |
the system-wide |
| 19 |
.I ConsoleKit |
| 20 |
daemon. This PAM module should be used with |
| 21 |
caution; only local login managers such as |
| 22 |
.B login(1) |
| 23 |
should use this. Since the |
| 24 |
.I ConsoleKit |
| 25 |
daemon can accept both an |
| 26 |
.B tty |
| 27 |
and an X11 display the normal parameters set by PAM are not always |
| 28 |
useful. |
| 29 |
|
| 30 |
An application can therefore override these with the PAM environment |
| 31 |
variables |
| 32 |
.B CKCON_TTY, |
| 33 |
.B CKCON_X11_DISPLAY |
| 34 |
and |
| 35 |
.B CKCON_X11_DISPLAY_DEVICE |
| 36 |
(the application should remember to unset these before starting the |
| 37 |
login session). |
| 38 |
|
| 39 |
Also note that the |
| 40 |
.I ConsoleKit |
| 41 |
daemon may reject registration attempts if the given set of data are |
| 42 |
inconsistent with each other. More more information, see the |
| 43 |
.I ConsoleKit |
| 44 |
documentation on the |
| 45 |
.B OpenSessionWithParameters() |
| 46 |
method call on the |
| 47 |
.B org.freedesktop.ConsoleKit.Manager |
| 48 |
D-Bus interface. |
| 49 |
|
| 50 |
If registration with the |
| 51 |
.I ConsoleKit |
| 52 |
daemon succeeds, this PAM module will set the environment variable |
| 53 |
.B XDG_SESSION_COOKIE |
| 54 |
which is used to defined membership of a login session. |
| 55 |
|
| 56 |
This PAM module has the side effect that it creates a connection to |
| 57 |
the system message bus that is kept open until the session ends. This |
| 58 |
is used by the |
| 59 |
.I ConsoleKit |
| 60 |
daemon to track the life-cycle of the |
| 61 |
session and, as such, should the login manager crash, the session will |
| 62 |
be properly unregistered. |
| 63 |
|
| 64 |
.SH "OPTIONS" |
| 65 |
.PP |
| 66 |
.TP 3n |
| 67 |
\fBdebug\fR |
| 68 |
Print debug information. |
| 69 |
.TP 3n |
| 70 |
\fBnox11\fR |
| 71 |
Do not create a session if PAM specifies an X11 display instead of a |
| 72 |
/dev/tty terminal. |
| 73 |
.fi |
| 74 |
.RE |
| 75 |
.sp |
| 76 |
.SH "SEE ALSO" |
| 77 |
.PP |
| 78 |
|
| 79 |
\fBpam.conf\fR(5), |
| 80 |
\fBpam.d\fR(8), |
| 81 |
\fBpam\fR(8), |
| 82 |
\fBdbus-daemon\fR(1) |
| 83 |
.SH "AUTHOR" |
| 84 |
.PP |
| 85 |
pam_ck_connector was written by David Zeuthen <[email protected]>. |