|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | LINKING | SEE ALSO | COLOPHON |
KEYCTL_GET_KEYRING_ID(3) Linux Key Management Calls KEYCTL_GET_KEYRING_ID(3)
keyctl_get_keyring_ID - get the ID of a special keyring
#include <keyutils.h>
key_serial_t keyctl_get_keyring_ID(key_serial_t key,
int create);
keyctl_get_keyring_ID() maps a special key or keyring ID to the
serial number of the key actually representing that feature. The
serial number will be returned if that key exists.
If the key or keyring does not yet exist, then if create is non-zero,
the key or keyring will be created if it is appropriate to do so.
The following special key IDs may be specified as key:
KEY_SPEC_THREAD_KEYRING
This specifies the caller's thread-specific keyring.
KEY_SPEC_PROCESS_KEYRING
This specifies the caller's process-specific keyring.
KEY_SPEC_SESSION_KEYRING
This specifies the caller's session-specific keyring.
KEY_SPEC_USER_KEYRING
This specifies the caller's UID-specific keyring.
KEY_SPEC_USER_SESSION_KEYRING
This specifies the caller's UID-session keyring.
KEY_SPEC_REQKEY_AUTH_KEY
This specifies the authorisation key created by request_key()
and passed to the process it spawns to generate a key.
If a valid keyring ID is passed in, then this will simply be returned
if the key exists; an error will be issued if it doesn't exist.
On success keyctl_get_keyring_ID() returns the serial number of the
key it found. On error, the value -1 will be returned and errno will
have been set to an appropriate error.
ENOKEY No matching key was found.
ENOMEM Insufficient memory to create a key.
EDQUOT The key quota for this user would be exceeded by creating this
key or linking it to the keyring.
This is a library function that can be found in libkeyutils. When
linking, -lkeyutils should be specified to the linker.
keyctl(1), add_key(2), keyctl(2), request_key(2), keyctl(3),
keyrings(7), keyutils(7)
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 man-pages@man7.org] If you have a bug report for
this manual page, send it to keyrings@linux-nfs.org. This page was
obtained from the project's upstream Git repository
⟨http://git.kernel.org/pub/scm/linux/kernel/git/dhowells/keyutils.git⟩
on 2017-07-05. 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 man-pages@man7.org
Linux 4 May 2006 KEYCTL_GET_KEYRING_ID(3)
Pages that refer to this page: keyctl(2), keyctl(3)