summaryrefslogtreecommitdiffstats
path: root/man2/request_key.2
diff options
context:
space:
mode:
Diffstat (limited to 'man2/request_key.2')
-rw-r--r--man2/request_key.278
1 files changed, 39 insertions, 39 deletions
diff --git a/man2/request_key.2 b/man2/request_key.2
index 89815c4ed..0487d3546 100644
--- a/man2/request_key.2
+++ b/man2/request_key.2
@@ -77,23 +77,23 @@ permission, or it may be one of the following special keyring IDs:
.TP
.B KEY_SPEC_THREAD_KEYRING
This specifies the caller's thread-specific keyring (see
-.BR thread\-keyring (7)).
+.MR thread\-keyring 7 ).
.TP
.B KEY_SPEC_PROCESS_KEYRING
This specifies the caller's process-specific keyring (see
-.BR process\-keyring (7)).
+.MR process\-keyring 7 ).
.TP
.B KEY_SPEC_SESSION_KEYRING
This specifies the caller's session-specific keyring (see
-.BR session\-keyring (7)).
+.MR session\-keyring 7 ).
.TP
.B KEY_SPEC_USER_KEYRING
This specifies the caller's UID-specific keyring (see
-.BR user\-keyring (7)).
+.MR user\-keyring 7 ).
.TP
.B KEY_SPEC_USER_SESSION_KEYRING
This specifies the caller's UID-session keyring (see
-.BR user\-session\-keyring (7)).
+.MR user\-session\-keyring 7 ).
.P
When the
.I dest_keyring
@@ -109,7 +109,7 @@ More precisely, when the kernel tries to determine to which keyring the
newly constructed key should be linked,
it tries the following keyrings,
beginning with the keyring set via the
-.BR keyctl (2)
+.MR keyctl 2
.B KEYCTL_SET_REQKEY_KEYRING
operation and continuing in the order shown below
until it finds the first keyring that exists:
@@ -127,28 +127,28 @@ since Linux 2.6.29).
The thread-specific keyring
.RB ( KEY_REQKEY_DEFL_THREAD_KEYRING ;
see
-.BR thread\-keyring (7)).
+.MR thread\-keyring 7 ).
.IP \[bu]
The process-specific keyring
.RB ( KEY_REQKEY_DEFL_PROCESS_KEYRING ;
see
-.BR process\-keyring (7)).
+.MR process\-keyring 7 ).
.IP \[bu]
The session-specific keyring
.RB ( KEY_REQKEY_DEFL_SESSION_KEYRING ;
see
-.BR session\-keyring (7)).
+.MR session\-keyring 7 ).
.IP \[bu]
The session keyring for the process's user ID
.RB ( KEY_REQKEY_DEFL_USER_SESSION_KEYRING ;
see
-.BR user\-session\-keyring (7)).
+.MR user\-session\-keyring 7 ).
This keyring is expected to always exist.
.IP \[bu]
The UID-specific keyring
.RB ( KEY_REQKEY_DEFL_USER_KEYRING ;
see
-.BR user\-keyring (7)).
+.MR user\-keyring 7 ).
This keyring is also expected to always exist.
.\" mtk: Are there circumstances where the user sessions and UID-specific
.\" keyrings do not exist?
@@ -182,7 +182,7 @@ This keyring is also expected to always exist.
.\" such as KEYCTL_GET_SECURITY, KEYCTL_READ and KEYCTL_REVOKE, won't.
.P
If the
-.BR keyctl (2)
+.MR keyctl 2
.B KEYCTL_SET_REQKEY_KEYRING
operation specifies
.B KEY_REQKEY_DEFL_DEFAULT
@@ -253,7 +253,7 @@ Internally, the kernel also records the PID of the process that called
.RE
.IP (3)
The kernel creates a process that executes a user-space service such as
-.BR request\-key (8)
+.MR request\-key 8
with a new session keyring that contains a link to the authorization key, V.
.\" The request\-key(8) program can be invoked in circumstances *other* than
.\" when triggered by request_key(2). For example, upcalls from places such
@@ -300,18 +300,18 @@ The program spawned in the previous step:
.RS
.IP \[bu] 3
Assumes the authority to instantiate the key U using the
-.BR keyctl (2)
+.MR keyctl 2
.B KEYCTL_ASSUME_AUTHORITY
operation (typically via the
-.BR keyctl_assume_authority (3)
+.MR keyctl_assume_authority 3
function).
.IP \[bu]
Obtains the callout data from the payload of the authorization key V
(using the
-.BR keyctl (2)
+.MR keyctl 2
.B KEYCTL_READ
operation (or, more commonly, the
-.BR keyctl_read (3)
+.MR keyctl_read 3
function) with a key ID value of
.BR KEY_SPEC_REQKEY_AUTH_KEY ).
.IP \[bu]
@@ -328,10 +328,10 @@ can be accessed using the special key ID
.\" * This feature is provided, but not used at the moment.
.\" * A key added to that ring is then owned by the requester
Instantiation is performed using the
-.BR keyctl (2)
+.MR keyctl 2
.B KEYCTL_INSTANTIATE
operation (or, more commonly, the
-.BR keyctl_instantiate (3)
+.MR keyctl_instantiate 3
function).
At this point, the
.BR request_key ()
@@ -351,7 +351,7 @@ to fail until it does.
The purpose of this negatively instantiated key is to prevent
(possibly different) processes making repeated requests
(that require expensive
-.BR request\-key (8)
+.MR request\-key 8
upcalls) for a key that can't (at the moment) be positively instantiated.
.P
Once the key has been instantiated, the authorization key
@@ -359,7 +359,7 @@ Once the key has been instantiated, the authorization key
is revoked, and the destination keyring
.RB ( KEY_SPEC_REQUESTOR_KEYRING )
is no longer accessible from the
-.BR request\-key (8)
+.MR request\-key 8
program.
.P
If a key is created, then\[em]regardless of whether it is a valid key or
@@ -392,7 +392,7 @@ points outside the process's accessible address space.
.TP
.B EINTR
The request was interrupted by a signal; see
-.BR signal (7).
+.MR signal 7 .
.TP
.B EINVAL
The size of the string (including the terminating null byte) specified in
@@ -460,7 +460,7 @@ $ sudo sh
.P
This entry specifies that when a new "user" key with the prefix
"mtk:" must be instantiated, that task should be performed via the
-.BR keyctl (1)
+.MR keyctl 1
command's
.B instantiate
operation.
@@ -478,7 +478,7 @@ and the session keyring
of the requestor (i.e., the caller of
.BR request_key ()).
See
-.BR request\-key.conf (5)
+.MR request\-key.conf 5
for details of these
.I %
specifiers.
@@ -496,7 +496,7 @@ $ \fBgrep \[aq]2dddaf50\[aq] /proc/keys\fP
.in
.P
For another example of the use of this program, see
-.BR keyctl (2).
+.MR keyctl 2 .
.SS Program source
\&
.\" SRC BEGIN (t_request_key.c)
@@ -535,20 +535,20 @@ main(int argc, char *argv[])
.SH SEE ALSO
.ad l
.nh
-.BR keyctl (1),
-.BR add_key (2),
-.BR keyctl (2),
-.BR keyctl (3),
-.BR capabilities (7),
-.BR keyrings (7),
-.BR keyutils (7),
-.BR persistent\-keyring (7),
-.BR process\-keyring (7),
-.BR session\-keyring (7),
-.BR thread\-keyring (7),
-.BR user\-keyring (7),
-.BR user\-session\-keyring (7),
-.BR request\-key (8)
+.MR keyctl 1 ,
+.MR add_key 2 ,
+.MR keyctl 2 ,
+.MR keyctl 3 ,
+.MR capabilities 7 ,
+.MR keyrings 7 ,
+.MR keyutils 7 ,
+.MR persistent\-keyring 7 ,
+.MR process\-keyring 7 ,
+.MR session\-keyring 7 ,
+.MR thread\-keyring 7 ,
+.MR user\-keyring 7 ,
+.MR user\-session\-keyring 7 ,
+.MR request\-key 8
.P
The kernel source files
.I Documentation/security/keys/core.rst