REQUEST_KEY
REQUEST_KEY
NAMESYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
LINKING
SEE ALSO
COLOPHON
NAME
request_key − request a key from the kernel’s key management facility
SYNOPSIS
#include <keyutils.h>
key_serial_t
request_key(const char *type, const char
*description,
const char *callout_info,
key_serial_t keyring);
DESCRIPTION
request_key() asks the kernel to find a key of the given type that matches the specified description and, if successful, to attach it to the nominated keyring and to return its serial number.
request_key() first recursively searches all the keyrings attached to the calling process in the order thread-specific keyring, process-specific keyring and then session keyring for a matching key.
If request_key() is called from a program invoked by request_key() on behalf of some other process to generate a key, then the keyrings of that other process will be searched next, using that other process’s UID, GID, groups, and security context to control access.
The keys in each keyring searched are checked for a match before any child keyrings are recursed into. Only keys that are searchable for the caller may be found, and only searchable keyrings may be searched.
If the key is not found, then, if callout_info is set, this function will attempt to look further afield. In such a case, the callout_info is passed to a user-space service such as /sbin/request−key to generate the key.
If that is unsuccessful also, then an error will be returned, and a temporary negative key will be installed in the nominated keyring. This will expire after a few seconds, but will cause subsequent calls to request_key() to fail until it does.
The
keyring serial number may be that of a valid keyring
to which the caller has write permission, or it may be a
special keyring ID:
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.
If a key is created, no matter whether it’s a valid key or a negative key, it will displace any other key of the same type and description from the destination keyring.
RETURN VALUE
On success request_key() 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.
ERRORS
|
EACCES |
The keyring wasn’t available for modification by the user. | ||
|
EINTR |
The request was interrupted by a signal. | ||
|
EDQUOT |
The key quota for this user would be exceeded by creating this key or linking it to the keyring. |
EKEYEXPIRED
An expired key was found, but no replacement could be obtained.
EKEYREJECTED
The attempt to generate a new key was rejected.
EKEYREVOKED
A revoked key was found, but no replacement could be obtained.
|
ENOMEM |
Insufficient memory to create a key. |
|||
|
ENOKEY |
No matching key was found. |
LINKING
Although this is a Linux system call, it is not present in libc but can be found rather in libkeyutils. When linking, -lkeyutils should be specified to the linker.
SEE ALSO
keyctl(1), add_key(2), keyctl(2), request-key(8)
COLOPHON
This page is part of release 3.69 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at http://www.kernel.org/doc/man−pages/.
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
