2010-02-25 07:29:02 +00:00
|
|
|
.\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
|
|
|
|
.\" Written by David Howells (dhowells@redhat.com)
|
|
|
|
.\"
|
2013-03-10 09:29:47 +00:00
|
|
|
.\" %%%LICENSE_START(GPLv2+_SW_ONEPARA)
|
2010-02-25 07:29:02 +00:00
|
|
|
.\" This program is free software; you can redistribute it and/or
|
|
|
|
.\" modify it under the terms of the GNU General Public License
|
|
|
|
.\" as published by the Free Software Foundation; either version
|
|
|
|
.\" 2 of the License, or (at your option) any later version.
|
2013-03-10 09:28:55 +00:00
|
|
|
.\" %%%LICENSE_END
|
2010-02-25 07:29:02 +00:00
|
|
|
.\"
|
add_key.2, keyctl.2, request_key.2, stime.2, time.2, ctime.3, difftime.3, ftime.3, getspnam.3, mq_receive.3, mq_send.3, rtime.3, sem_wait.3, string.3, timeradd.3, tzset.3, rtc.4, core.5, icmp.7, time.7, zic.8: Updated .TH timestamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-02-25 09:43:57 +00:00
|
|
|
.TH REQUEST_KEY 2 2010-02-25 Linux "Linux Key Management Calls"
|
2010-02-25 07:29:02 +00:00
|
|
|
.SH NAME
|
intro.1, add_key.2, get_mempolicy.2, get_thread_area.2, intro.2, keyctl.2, mbind.2, request_key.2, set_thread_area.2, clock.3, cmsg.3, getcwd.3, getpw.3, intro.3, malloc.3, posix_memalign.3, shm_open.3, sleep.3, sysconf.3, intro.4, sd.4, intro.5, locale.5, slabinfo.5, intro.6, boot.7, bootparam.7, futex.7, glob.7, hier.7, intro.7, libc.7, locale.7, mq_overview.7, netlink.7, sem_overview.7, shm_overview.7, unix.7, intro.8: Global fix: Use consistent capitalization in NAME section
The line(s) in the NAME section should only use capitals
where English usage dictates that. Otherwise, use
lowercase throughout.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-10-21 06:29:13 +00:00
|
|
|
request_key \- request a key from the kernel's key management facility
|
2010-02-25 07:29:02 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <keyutils.h>
|
|
|
|
.sp
|
|
|
|
.BI "key_serial_t request_key(const char *" type ", const char *" description ,
|
2011-11-07 03:46:44 +00:00
|
|
|
.BI " const char *" callout_info ,
|
|
|
|
.BI " key_serial_t " keyring ");"
|
add_key.2, keyctl.2, request_key.2, offsetof.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_cleanup_push_defer_np.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_testcancel.3: Global formatting fix: balance .nf/.fi pairs
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-03-12 15:37:22 +00:00
|
|
|
.fi
|
2010-02-25 07:29:02 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.BR request_key ()
|
|
|
|
asks the kernel to find a key of the given
|
|
|
|
.I type
|
|
|
|
that matches the specified
|
|
|
|
.I description
|
|
|
|
and, if successful, to attach it to the nominated
|
|
|
|
.I keyring
|
|
|
|
and to return its serial number.
|
|
|
|
.P
|
|
|
|
.BR 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.
|
|
|
|
.P
|
|
|
|
If
|
|
|
|
.BR request_key ()
|
|
|
|
is called from a program invoked by
|
|
|
|
.BR 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.
|
|
|
|
.P
|
|
|
|
The keys in each keyring searched are checked for a match before any child
|
2012-05-05 03:10:16 +00:00
|
|
|
keyrings are recursed into.
|
|
|
|
Only keys that are
|
2010-02-25 07:29:02 +00:00
|
|
|
.B searchable
|
|
|
|
for the caller may be found, and only
|
|
|
|
.B searchable
|
|
|
|
keyrings may be searched.
|
|
|
|
.P
|
|
|
|
If the key is not found then, if
|
|
|
|
.I callout_info
|
2012-05-05 03:10:16 +00:00
|
|
|
is set, this function will attempt to look further afield.
|
|
|
|
In such a case, the
|
2010-02-25 07:29:02 +00:00
|
|
|
.I callout_info
|
eventfd.2, futex.2, mmap2.2, open.2, pciconfig_read.2, ptrace.2, reboot.2, request_key.2, sched_rr_get_interval.2, splice.2, stat.2, sync_file_range.2, syscalls.2, timer_create.2, vm86.2, pthread_attr_setscope.3, core.5, proc.5, aio.7, futex.7, netlink.7, time.7: Global fix: "userspace" ==> "user space" or "user-space"
Existing pages variously use "userspace or "user space".
But, "userspace" is not quite an English word.
So change "userspace" to "user space" or, when used
attributively, "user-space".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-10-21 06:04:42 +00:00
|
|
|
is passed to a user-space service such as
|
2010-02-25 07:29:02 +00:00
|
|
|
.B /sbin/request\-key
|
|
|
|
to generate the key.
|
|
|
|
.P
|
|
|
|
If that is unsuccessful also, then an error will be returned, and a temporary
|
|
|
|
negative key will be installed in the nominated
|
|
|
|
.IR keyring .
|
|
|
|
This will expire after a few seconds, but will cause subsequent
|
|
|
|
calls to
|
|
|
|
.BR request_key ()
|
|
|
|
to fail until it does.
|
|
|
|
.P
|
|
|
|
The
|
|
|
|
.I 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:
|
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_THREAD_KEYRING
|
|
|
|
This specifies the caller's thread-specific keyring.
|
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_PROCESS_KEYRING
|
|
|
|
This specifies the caller's process-specific keyring.
|
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_SESSION_KEYRING
|
|
|
|
This specifies the caller's session-specific keyring.
|
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_USER_KEYRING
|
|
|
|
This specifies the caller's UID-specific keyring.
|
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_USER_SESSION_KEYRING
|
|
|
|
This specifies the caller's UID-session keyring.
|
|
|
|
.P
|
|
|
|
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
|
|
|
|
.IR keyring .
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success
|
|
|
|
.BR request_key ()
|
|
|
|
returns the serial number of the key it found.
|
2013-02-11 21:44:29 +00:00
|
|
|
On error, the value \-1
|
2010-02-25 07:29:02 +00:00
|
|
|
will be returned and errno will have been set to an appropriate error.
|
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
2010-11-01 06:18:03 +00:00
|
|
|
.B EACCES
|
|
|
|
The keyring wasn't available for modification by the user.
|
|
|
|
.TP
|
|
|
|
.B EINTR
|
|
|
|
The request was interrupted by a signal.
|
|
|
|
.TP
|
|
|
|
.B EDQUOT
|
|
|
|
The key quota for this user would be exceeded by creating this key or linking
|
|
|
|
it to the keyring.
|
2010-02-25 07:29:02 +00:00
|
|
|
.TP
|
|
|
|
.B EKEYEXPIRED
|
|
|
|
An expired key was found, but no replacement could be obtained.
|
|
|
|
.TP
|
|
|
|
.B EKEYREJECTED
|
|
|
|
The attempt to generate a new key was rejected.
|
|
|
|
.TP
|
2010-11-01 06:18:03 +00:00
|
|
|
.B EKEYREVOKED
|
|
|
|
A revoked key was found, but no replacement could be obtained.
|
|
|
|
.TP
|
2010-02-25 07:29:02 +00:00
|
|
|
.B ENOMEM
|
|
|
|
Insufficient memory to create a key.
|
|
|
|
.TP
|
2010-11-01 06:18:03 +00:00
|
|
|
.B ENOKEY
|
|
|
|
No matching key was found.
|
2010-02-25 07:29:02 +00:00
|
|
|
.SH LINKING
|
|
|
|
Although this is a Linux system call, it is not present in
|
|
|
|
.I libc
|
|
|
|
but can be found rather in
|
|
|
|
.IR libkeyutils .
|
|
|
|
When linking,
|
|
|
|
.B -lkeyutils
|
|
|
|
should be specified to the linker.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR keyctl (1),
|
|
|
|
.BR add_key (2),
|
|
|
|
.BR keyctl (2),
|
|
|
|
.BR request-key (8)
|