keyctl_search() recursively searches the keyring for a key of the
specified type and description.
If found, the key will be attached to the destination keyring (if
given), and its serial number will be returned.
The source keyring must grant search permission to the caller, and
for a key to be found, it must also grant search permission to the
caller. Child keyrings will be only be recursively searched if they
grant search permission to the caller as well.
If the destination keyring is zero, no attempt will be made to forge
a link to the key, and just the serial number will be returned.
If the destination keyring is given, then the link may only be formed
if the found key grants the caller link permission and the
destination keyring grants the caller write permission.
If the search is successful, and if the destination keyring already
contains a link to a key that matches the specified type and
description, then that link will be replaced by a link to the found
The source keyring and destination keyring serial numbers may be
those of valid keyrings to which the caller has appropriate
permission, or they may be special keyring IDs:
This specifies the caller's thread-specific keyring.
This specifies the caller's process-specific keyring.
This specifies the caller's session-specific keyring.
This specifies the caller's UID-specific keyring.
This specifies the caller's UID-session keyring.
ENOKEY One of the keyrings doesn't exist, no key was found by the
search, or the only key found by the search was a negative
One of the keyrings is a valid key that isn't a keyring.
One of the keyrings has expired, or the only key found was
One of the keyrings has been revoked, or the only key found
ENOMEM Insufficient memory to expand the destination keyring.
EDQUOT The key quota for this user would be exceeded by creating a
link to the found key in the destination keyring.
EACCES The source keyring didn't grant search permission, the
destination keyring didn't grant write permission or the found
key didn't grant link permission to the caller.
This page is part of the keyutils (key management utilities) project.
Information about the project can be found at [unknown -- if you
know, please contact firstname.lastname@example.org] If you have a bug report for
this manual page, send it to email@example.com. This page was
obtained from the project's upstream Git repository
on 2017-03-13. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-to-
date source for the page, or you have corrections or improvements to
the information in this COLOPHON (which is not part of the original
manual page), send a mail to firstname.lastname@example.org
Linux 4 May 2006 KEYCTL_SEARCH(3)