summaryrefslogtreecommitdiffstats
path: root/pam-ck-connector/pam_ck_connector.8
blob: c05f749e92f8764073244ad03bd0c95a88fea927 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.\"     Title: pam_ck_connector
.\"    Author: David Zeuthen <davidz@redhat.com>
.\"      Date: 02/27/2007
.\"
.TH "PAM_CK_CONNECTOR" "8" "02/27/2007" "ConsoleKit Manual" "ConsoleKit Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
pam_ck_connector \- Register session with ConsoleKit
.SH "SYNOPSIS"
.HP 12
\fBpam_ck_connector.so\fR [debug]
.SH "DESCRIPTION"
.PP
The pam_ck_connector PAM module registers a login session with
the system-wide
.I ConsoleKit
daemon. This PAM module should be used with
caution; only local login managers such as
.B login(1)
should use this. Since the
.I ConsoleKit
daemon can accept both an
.B tty
and an X11 display the normal parameters set by PAM are not always
useful.

An application can therefore override these with the PAM environment
variables
.B CKCON_TTY,
.B CKCON_X11_DISPLAY
and
.B CKCON_X11_DISPLAY_DEVICE
(the application should remember to unset these before starting the
login session).

Also note that the
.I ConsoleKit
daemon may reject registration attempts if the given set of data are
inconsistent with each other. More more information, see the
.I ConsoleKit
documentation on the
.B OpenSessionWithParameters()
method call on the
.B org.freedesktop.ConsoleKit.Manager
D-Bus interface.

If registration with the
.I ConsoleKit
daemon succeeds, this PAM module will set the environment variable
.B XDG_SESSION_COOKIE
which is used to defined membership of a login session.

This PAM module has the side effect that it creates a connection to
the system message bus that is kept open until the session ends. This
is used by the
.I ConsoleKit
daemon to track the life-cycle of the
session and, as such, should the login manager crash, the session will
be properly unregistered.

.SH "OPTIONS"
.PP
.TP 3n
\fBdebug\fR
Print debug information.
.TP 3n
\fBnox11\fR
Do not create a session if PAM specifies an X11 display instead of a
/dev/tty terminal.
.fi
.RE
.sp
.SH "SEE ALSO"
.PP

\fBpam.conf\fR(5),
\fBpam.d\fR(8),
\fBpam\fR(8),
\fBdbus-daemon\fR(1)
.SH "AUTHOR"
.PP
pam_ck_connector was written by David Zeuthen <davidz@redhat.com>.