1 .\" Copyright (C) 2014 Red Hat, Inc. All Rights Reserved.
2 .\" Written by David Howells (dhowells@redhat.com)
4 .\" %%%LICENSE_START(GPLv2+_SW_ONEPARA)
5 .\" This program is free software; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License
7 .\" as published by the Free Software Foundation; either version
8 .\" 2 of the License, or (at your option) any later version.
11 .TH USER-KEYRING 7 2020-08-13 Linux "Linux Programmer's Manual"
13 user-keyring \- per-user keyring
15 The user keyring is a keyring used to anchor keys on behalf of a user.
16 Each UID the kernel deals with has its own user keyring that
17 is shared by all processes with that UID.
18 The user keyring has a name (description) of the form
22 is the user ID of the corresponding user.
24 The user keyring is associated with the record that the kernel maintains
26 It comes into existence upon the first attempt to access either the
28 .BR user\-session\-keyring (7),
30 .BR session\-keyring (7).
31 The keyring remains pinned in existence so long as there are processes
32 running with that real UID or files opened by those processes remain open.
33 (The keyring can also be pinned indefinitely by linking it
34 into another keyring.)
36 Typically, the user keyring is created by
40 The user keyring is not searched by default by
44 creates a session keyring, it adds to it a link to the user
45 keyring so that the user keyring will be searched when the session keyring is.
47 A special serial number value,
48 .BR KEY_SPEC_USER_KEYRING ,
49 is defined that can be used in lieu of the actual serial number of
50 the calling process's user keyring.
54 utility, '\fB@u\fP' can be used instead of a numeric key ID in
57 User keyrings are independent of
64 excepting that the keyring is destroyed when the UID record is destroyed when
65 the last process pinning it exits.
67 If it is necessary for a key associated with a user to exist beyond the UID
68 record being garbage collected\(emfor example, for use by a
71 .BR persistent\-keyring (7)
72 should be used instead.
74 If a user keyring does not exist when it is accessed, it will be created.
81 .BR persistent\-keyring (7),
82 .BR process\-keyring (7),
83 .BR session\-keyring (7),
84 .BR thread\-keyring (7),
85 .BR user\-session\-keyring (7),