2010-02-25 07:24:00 +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:24:00 +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:24:00 +00:00
|
|
|
.\"
|
ldd.1, localedef.1, add_key.2, chroot.2, clone.2, fork.2, futex.2, get_mempolicy.2, get_robust_list.2, getitimer.2, getpriority.2, ioctl.2, ioctl_ficlonerange.2, ioctl_fideduperange.2, kcmp.2, kill.2, lookup_dcookie.2, mmap.2, mount.2, open.2, pciconfig_read.2, perf_event_open.2, prctl.2, process_vm_readv.2, ptrace.2, quotactl.2, recv.2, setfsgid.2, setfsuid.2, sysinfo.2, umask.2, umount.2, unshare.2, utimensat.2, wait.2, assert.3, fmax.3, fmin.3, getauxval.3, inet_pton.3, malloc_hook.3, memmem.3, mkdtemp.3, mktemp.3, printf.3, strcasecmp.3, strcat.3, strtoul.3, strxfrm.3, console_codes.4, console_ioctl.4, lirc.4, tty.4, vcs.4, charmap.5, elf.5, locale.5, proc.5, repertoiremap.5, utmp.5, capabilities.7, cgroup_namespaces.7, cgroups.7, charsets.7, cp1251.7, cp1252.7, credentials.7, feature_test_macros.7, iso_8859-1.7, iso_8859-15.7, iso_8859-5.7, koi8-r.7, koi8-u.7, man-pages.7, mount_namespaces.7, namespaces.7, netlink.7, pid_namespaces.7, unix.7, user_namespaces.7, utf-8.7: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2016-07-17 16:07:58 +00:00
|
|
|
.TH ADD_KEY 2 2016-07-17 Linux "Linux Key Management Calls"
|
2010-02-25 07:24:00 +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
|
|
|
add_key \- add a key to the kernel's key management facility
|
2010-02-25 07:24:00 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
.B #include <keyutils.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "key_serial_t add_key(const char *" type ", const char *" description ,
|
2011-11-07 02:43:14 +00:00
|
|
|
.BI " const void *" payload ", size_t " plen ,
|
|
|
|
|
.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:24:00 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.BR add_key ()
|
2016-10-20 19:47:41 +00:00
|
|
|
creates or updates a key of the given
|
2010-02-25 07:24:00 +00:00
|
|
|
.I type
|
|
|
|
|
and
|
|
|
|
|
.IR description ,
|
2016-10-20 19:47:41 +00:00
|
|
|
instantiates it with the
|
2010-02-25 07:24:00 +00:00
|
|
|
.I payload
|
|
|
|
|
of length
|
|
|
|
|
.IR plen ,
|
2016-10-20 19:47:41 +00:00
|
|
|
attaches it to the nominated
|
|
|
|
|
.IR keyring ,
|
|
|
|
|
and return the key's serial number.
|
2010-02-25 07:24:00 +00:00
|
|
|
.P
|
2016-10-20 19:47:41 +00:00
|
|
|
The key type may reject the data if it is in the wrong format or
|
|
|
|
|
is in some other way invalid.
|
2010-02-25 07:24:00 +00:00
|
|
|
.P
|
|
|
|
|
If the destination
|
|
|
|
|
.I keyring
|
|
|
|
|
already contains a key that matches the specified
|
2016-10-20 19:47:41 +00:00
|
|
|
.IR type
|
|
|
|
|
and
|
|
|
|
|
.IR description ,
|
2010-02-25 07:24:00 +00:00
|
|
|
then, if the key type supports it, that key will be updated rather than a new
|
|
|
|
|
key being created; if not, a new key will be created and it will displace the
|
|
|
|
|
link to the extant key from the keyring.
|
|
|
|
|
.P
|
|
|
|
|
The destination
|
|
|
|
|
.I keyring
|
2016-10-20 19:47:41 +00:00
|
|
|
serial number may be that of a valid keyring for which the caller has
|
|
|
|
|
.I write
|
|
|
|
|
permission, or it may be one of the following special keyring IDs:
|
2010-02-25 07:24:00 +00:00
|
|
|
.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.
|
2016-10-20 19:47:41 +00:00
|
|
|
.SS Key types
|
2010-02-25 07:24:00 +00:00
|
|
|
There are a number of key types available in the core key management code, and
|
|
|
|
|
these can be specified to this function:
|
|
|
|
|
.TP
|
|
|
|
|
.B \*(lquser\*(rq
|
|
|
|
|
Keys of the user-defined key type may contain a blob of arbitrary data, and the
|
|
|
|
|
.I description
|
|
|
|
|
may be any valid string, though it is preferred that the description be
|
|
|
|
|
prefixed with a string representing the service to which the key is of interest
|
|
|
|
|
and a colon (for instance
|
|
|
|
|
.RB \*(lq afs:mykey \*(rq).
|
|
|
|
|
.TP
|
|
|
|
|
.B \*(lqkeyring\*(rq
|
|
|
|
|
Keyrings are special key types that may contain links to sequences of other
|
2012-05-05 03:10:16 +00:00
|
|
|
keys of any type.
|
2013-02-11 21:40:49 +00:00
|
|
|
If this interface is used to create a keyring, then a NULL
|
2010-02-25 07:24:00 +00:00
|
|
|
.I payload
|
|
|
|
|
should be specified, and
|
|
|
|
|
.I plen
|
|
|
|
|
should be zero.
|
|
|
|
|
.SH RETURN VALUE
|
2016-10-20 19:47:41 +00:00
|
|
|
On success,
|
2010-02-25 07:24:00 +00:00
|
|
|
.BR add_key ()
|
|
|
|
|
returns the serial number of the key it created or updated.
|
2016-10-20 19:47:41 +00:00
|
|
|
On error, \-1 is returned and
|
|
|
|
|
.I errno
|
|
|
|
|
is set to indicate the cause of the error.
|
2010-02-25 07:24:00 +00:00
|
|
|
.SH ERRORS
|
|
|
|
|
.TP
|
2016-08-07 16:49:42 +00:00
|
|
|
.B EACCES
|
|
|
|
|
The keyring wasn't available for modification by the user.
|
|
|
|
|
.TP
|
|
|
|
|
.B EINVAL
|
|
|
|
|
The payload data was invalid.
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
|
.B EKEYEXPIRED
|
|
|
|
|
The keyring has expired.
|
|
|
|
|
.TP
|
|
|
|
|
.B EKEYREVOKED
|
|
|
|
|
The keyring has been revoked.
|
|
|
|
|
.TP
|
2016-08-07 16:49:42 +00:00
|
|
|
.B ENOKEY
|
|
|
|
|
The keyring doesn't exist.
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
|
.B ENOMEM
|
|
|
|
|
Insufficient memory to create a key.
|
|
|
|
|
.TP
|
|
|
|
|
.B EDQUOT
|
|
|
|
|
The key quota for this user would be exceeded by creating this key or linking
|
|
|
|
|
it to the keyring.
|
2016-10-19 08:30:25 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
|
This system call first appeared in Linux 2.6.11.
|
|
|
|
|
.SH CONFORMING TO
|
|
|
|
|
This system call is a nonstandard Linux extension.
|
2016-10-19 08:29:31 +00:00
|
|
|
.SH NOTES
|
2010-02-25 07:24:00 +00:00
|
|
|
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 keyctl (2),
|
2015-04-22 12:04:54 +00:00
|
|
|
.BR request_key (2),
|
2015-04-22 12:06:47 +00:00
|
|
|
.BR keyctl (3),
|
2015-04-22 12:04:54 +00:00
|
|
|
.BR keyrings (7)
|
2016-10-20 06:47:31 +00:00
|
|
|
|
|
|
|
|
The kernel source files
|
|
|
|
|
.IR Documentation/security/keys.txt
|
|
|
|
|
and
|
|
|
|
|
.IR Documentation/security/keys-request-key.txt .
|