text
stringlengths
0
234
destination keyring (that is, the keyring with the id specified in the
.i arg2
argument) are also allowed.
.re
.ip
note that a restriction can be configured only once for the specified keyring;
once a restriction is set, it can't be overridden.
.ip
the argument
.i arg5
is ignored.
.\" fixme document keyctl_restrict_keyring, added in linux 4.12
.\" commit 6563c91fd645556c7801748f15bc727c77fcd311
.\" author: mat martineau <mathew.j.martineau@linux.intel.com>
.\" see documentation/security/keys.txt
.sh return value
for a successful call, the return value depends on the operation:
.tp
.b keyctl_get_keyring_id
the id of the requested keyring.
.tp
.b keyctl_join_session_keyring
the id of the joined session keyring.
.tp
.b keyctl_describe
the size of the description (including the terminating null byte),
irrespective of the provided buffer size.
.tp
.b keyctl_search
the id of the key that was found.
.tp
.b keyctl_read
the amount of data that is available in the key,
irrespective of the provided buffer size.
.tp
.b keyctl_set_reqkey_keyring
the id of the previous default keyring
to which implicitly requested keys were linked
(one of
.br key_reqkey_defl_user_* ).
.tp
.b keyctl_assume_authority
either 0, if the id given was 0,
or the id of the authorization key matching the specified key,
if a nonzero key id was provided.
.tp
.b keyctl_get_security
the size of the lsm security label string
(including the terminating null byte),
irrespective of the provided buffer size.
.tp
.b keyctl_get_persistent
the id of the persistent keyring.
.tp
.b keyctl_dh_compute
the number of bytes copied to the buffer, or, if
.i arg4
is 0, the required buffer size.
.tp
all other operations
zero.
.pp
on error, \-1 is returned, and
.i errno
is set to indicate the error.
.sh errors
.tp
.b eacces
the requested operation wasn't permitted.
.tp
.b eagain
.i operation
was
.b keyctl_dh_compute
and there was an error during crypto module initialization.
.tp
.b edeadlk
.i operation
was
.br keyctl_link
and the requested link would result in a cycle.
.tp
.b edeadlk
.i operation
was
.br keyctl_restrict_keyring
and the requested keyring restriction would result in a cycle.
.tp
.b edquot
the key quota for the caller's user would be exceeded by creating a key or
linking it to the keyring.
.tp
.b eexist
.i operation
was
.br keyctl_restrict_keyring
and keyring provided in
.i arg2
argument already has a restriction set.
.tp