2016-11-01 15:44:54 +00:00
|
|
|
.\"
|
|
|
|
.\" Copyright (C) 2014 Red Hat, Inc. All Rights Reserved.
|
|
|
|
.\" Written by David Howells (dhowells@redhat.com)
|
|
|
|
.\"
|
2016-11-02 11:24:22 +00:00
|
|
|
.\" %%%LICENSE_START(GPLv2+_SW_ONEPARA)
|
2016-11-01 15:44:54 +00:00
|
|
|
.\" This program is free software; you can redistribute it and/or
|
2016-11-08 08:24:22 +00:00
|
|
|
.\" modify it under the terms of the GNU General Public License
|
2016-11-01 15:44:54 +00:00
|
|
|
.\" as published by the Free Software Foundation; either version
|
2016-11-08 08:24:22 +00:00
|
|
|
.\" 2 of the License, or (at your option) any later version.
|
2016-11-02 11:24:22 +00:00
|
|
|
.\" %%%LICENSE_END
|
2016-11-01 15:44:54 +00:00
|
|
|
.\"
|
add_key.2, execve.2, fork.2, fsync.2, getrandom.2, getrlimit.2, getxattr.2, inotify_add_watch.2, ioctl.2, ioctl_fat.2, kcmp.2, keyctl.2, link.2, listxattr.2, lseek.2, madvise.2, mincore.2, mlock.2, nanosleep.2, poll.2, posix_fadvise.2, read.2, readv.2, recv.2, request_key.2, select.2, send.2, setxattr.2, sigaction.2, stat.2, statfs.2, syscall.2, tkill.2, truncate.2, unlink.2, vfork.2, write.2, __ppc_set_ppr_med.3, aio_suspend.3, backtrace.3, bcmp.3, bcopy.3, bzero.3, exec.3, fopen.3, fts.3, ftw.3, getline.3, getmntent.3, getopt.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, memset.3, random.3, random_r.3, resolver.3, scandir.3, scanf.3, sem_post.3, sem_wait.3, setjmp.3, sleep.3, strerror.3, strverscmp.3, system.3, random.4, core.5, intro.5, resolv.conf.5, slabinfo.5, environ.7, ip.7, keyrings.7, man.7, persistent-keyring.7, pipe.7, process-keyring.7, random.7, session-keyring.7, signal-safety.7, signal.7, thread-keyring.7, unix.7, user-keyring.7, user-session-keyring.7, ld.so.8: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2017-03-13 20:14:49 +00:00
|
|
|
.TH "SESSION-KEYRING" 7 2017-03-13 Linux "Linux Programmer's Manual"
|
2016-11-01 15:44:54 +00:00
|
|
|
.SH NAME
|
2016-11-01 17:26:22 +00:00
|
|
|
session-keyring \- session shared process keyring
|
2016-11-01 15:44:54 +00:00
|
|
|
.SH DESCRIPTION
|
2016-11-01 18:08:09 +00:00
|
|
|
The session keyring is a keyring used to anchor keys on behalf of a process.
|
|
|
|
It is typically created by
|
|
|
|
.BR pam_keyinit (8)
|
2016-11-02 12:19:34 +00:00
|
|
|
when a user logs in and a link will be added that refers to the
|
2016-11-01 18:08:09 +00:00
|
|
|
.BR user-keyring (7).
|
2016-11-02 21:09:37 +00:00
|
|
|
Optionally, PAM may revoke the session keyring on logout.
|
|
|
|
(In typical configurations, PAM does do this revocation.)
|
2016-11-07 21:50:47 +00:00
|
|
|
The session keyring has the name (description)
|
|
|
|
.IR _ses .
|
2016-11-02 12:19:34 +00:00
|
|
|
|
|
|
|
A special serial number value,
|
|
|
|
.BR KEY_SPEC_SESSION_KEYRING ,
|
|
|
|
is defined that can be used in lieu of the actual serial number of
|
|
|
|
the calling process's session keyring.
|
|
|
|
|
|
|
|
From the
|
|
|
|
.BR keyctl (1)
|
|
|
|
utility, '\fB@s\fP' can be used instead of a numeric key ID in
|
2016-11-01 15:44:54 +00:00
|
|
|
much the same way.
|
2016-11-02 12:19:34 +00:00
|
|
|
|
2016-11-01 18:08:09 +00:00
|
|
|
A process's session keyring is inherited across
|
|
|
|
.BR clone (2),
|
|
|
|
.BR fork (2),
|
|
|
|
and
|
2016-11-02 12:19:34 +00:00
|
|
|
.BR vfork (2).
|
|
|
|
The session keyring
|
|
|
|
is preserved across
|
|
|
|
.BR execve (2),
|
|
|
|
even when the executable is set-user-ID or set-group-ID or has capabilities.
|
|
|
|
The session keyring is destroyed when the last process that
|
2016-11-01 15:44:54 +00:00
|
|
|
refers to it exits.
|
2016-11-02 12:19:34 +00:00
|
|
|
|
|
|
|
If a process doesn't have a session keyring when it is accessed, then,
|
|
|
|
under certain circumstances, the
|
|
|
|
.BR user-session-keyring (7)
|
|
|
|
will be attached as the session keyring
|
|
|
|
and under others a new session keyring will be created.
|
2016-11-02 21:09:37 +00:00
|
|
|
(See
|
|
|
|
.BR user-session-keyring (7)
|
|
|
|
for further details.)
|
2016-11-01 20:45:39 +00:00
|
|
|
.SS Special operations
|
2016-11-02 12:19:34 +00:00
|
|
|
The
|
|
|
|
.I keyutils
|
|
|
|
library provides the following special operations for manipulating
|
2016-11-01 15:44:54 +00:00
|
|
|
session keyrings:
|
2016-11-02 02:52:46 +00:00
|
|
|
.TP
|
|
|
|
.BR keyctl_join_session_keyring (3)
|
2016-11-02 12:19:34 +00:00
|
|
|
This operation allows the caller to change the session keyring
|
|
|
|
that it subscribes to.
|
|
|
|
The caller can join an existing keyring with a specified name (description),
|
|
|
|
create a new keyring with a given name,
|
|
|
|
or ask the kernel to create a new "anonymous"
|
|
|
|
session keyring with the name "_ses".
|
|
|
|
(This function is an interface to the
|
|
|
|
.BR keyctl (2)
|
|
|
|
.B KEYCTL_JOIN_SESSION_KEYRING
|
|
|
|
operation.)
|
2016-11-02 02:52:46 +00:00
|
|
|
.TP
|
|
|
|
.BR keyctl_session_to_parent (3)
|
2016-11-02 12:19:34 +00:00
|
|
|
This operation allows the caller to make the parent process's
|
|
|
|
session keyring to the same as its own.
|
2016-11-01 17:45:14 +00:00
|
|
|
For this to succeed, the parent process must have
|
2016-11-01 15:44:54 +00:00
|
|
|
identical security attributes and must be single threaded.
|
2016-11-02 12:19:34 +00:00
|
|
|
(This function is an interface to the
|
|
|
|
.BR keyctl (2)
|
|
|
|
.B KEYCTL_SESSION_TO_PARENT
|
|
|
|
operation.)
|
|
|
|
.PP
|
|
|
|
These operations are also exposed through the
|
|
|
|
.BR keyctl (1)
|
|
|
|
utility as:
|
|
|
|
|
|
|
|
.nf
|
|
|
|
.in +4n
|
|
|
|
keyctl session
|
|
|
|
keyctl session - [<prog> <arg1> <arg2> ...]
|
|
|
|
keyctl session <name> [<prog> <arg1> <arg2> ...]
|
|
|
|
.in
|
|
|
|
.fi
|
|
|
|
|
2016-11-01 15:44:54 +00:00
|
|
|
and:
|
2016-11-02 12:19:34 +00:00
|
|
|
|
|
|
|
.nf
|
|
|
|
.in +4n
|
|
|
|
keyctl new_session
|
|
|
|
.in
|
|
|
|
.fi
|
2016-11-01 15:44:54 +00:00
|
|
|
.SH SEE ALSO
|
2016-11-01 17:12:21 +00:00
|
|
|
.ad l
|
|
|
|
.nh
|
2016-11-01 15:44:54 +00:00
|
|
|
.BR keyctl (1),
|
|
|
|
.BR keyctl (3),
|
|
|
|
.BR keyctl_join_session_keyring (3),
|
|
|
|
.BR keyctl_session_to_parent (3),
|
|
|
|
.BR keyrings (7),
|
2016-11-01 17:12:21 +00:00
|
|
|
.BR persistent\-keyring (7),
|
|
|
|
.BR process\-keyring (7),
|
|
|
|
.BR thread\-keyring (7),
|
|
|
|
.BR user\-keyring (7),
|
|
|
|
.BR user\-session\-keyring (7),
|
|
|
|
.BR pam_keyinit (8)
|