text
stringlengths
0
234
in order to determine whether the buffer size was too small,
check to see if the return value of the operation is greater than
.ir arg4 .
.ip
the
.i arg5
argument is ignored.
.ip
this operation is exposed by
.i libkeyutils
via the function
.br keyctl_describe (3).
.tp
.b keyctl_clear
clear the contents of (i.e., unlink all keys from) a keyring.
.ip
the id of the key
(which must be of keyring type)
.\" or the error enotdir results
is provided in
.i arg2
(cast to
.ir key_serial_t ).
.\" according to documentation/security/keys.txt:
.\" this function can also be used to clear special kernel keyrings if they
.\" are appropriately marked if the user has cap_sys_admin capability. the
.\" dns resolver cache keyring is an example of this.
.ip
the caller must have
.i write
permission on the keyring.
.ip
the arguments
.ir arg3 ,
.ir arg4 ,
and
.ir arg5
are ignored.
.ip
this operation is exposed by
.i libkeyutils
via the function
.br keyctl_clear (3).
.tp
.br keyctl_link " (since linux 2.6.10)"
create a link from a keyring to a key.
.ip
the key to be linked is specified in
.ir arg2
(cast to
.ir key_serial_t );
the keyring is specified in
.ir arg3
(cast to
.ir key_serial_t ).
.ip
if a key with the same type and description is already linked in the keyring,
then that key is displaced from the keyring.
.ip
before creating the link,
the kernel checks the nesting of the keyrings and returns appropriate errors
if the link would produce a cycle
or if the nesting of keyrings would be too deep
(the limit on the nesting of keyrings is determined by the kernel constant
.br keyring_search_max_depth ,
defined with the value 6, and is necessary to prevent overflows
on the kernel stack when recursively searching keyrings).
.ip
the caller must have
.i link
permission on the key being added and
.i write
permission on the keyring.
.ip
the arguments
.ir arg4
and
.ir arg5
are ignored.
.ip
this operation is exposed by
.i libkeyutils
via the function
.br keyctl_link (3).
.tp
.br keyctl_unlink " (since linux 2.6.10)"
unlink a key from a keyring.
.ip
the id of the key to be unlinked is specified in
.i arg2
(cast to
.ir key_serial_t );
the id of the keyring from which it is to be unlinked is specified in
.i arg3
(cast to
.ir key_serial_t ).
.ip
if the key is not currently linked into the keyring, an error results.
.ip
the caller must have