2010-02-25 07:24:00 +00:00
|
|
|
.\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
|
2016-10-27 08:16:04 +00:00
|
|
|
.\" Written by David Howells (dhowells@redhat.com)
|
|
|
|
.\" and Copyright (C) 2016 Michael Kerrisk <mtk.man-pages@gmail.com>
|
2010-02-25 07:24:00 +00:00
|
|
|
.\"
|
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
|
|
|
.\"
|
getent.1, iconv.1, ldd.1, locale.1, localedef.1, memusage.1, memusagestat.1, pldd.1, sprof.1, time.1, _syscall.2, accept.2, add_key.2, adjtimex.2, bind.2, bpf.2, capget.2, chown.2, chroot.2, clock_getres.2, clone.2, connect.2, copy_file_range.2, epoll_ctl.2, epoll_wait.2, eventfd.2, fanotify_init.2, fanotify_mark.2, fcntl.2, fsync.2, futex.2, getcpu.2, getdents.2, getgid.2, getgroups.2, getpid.2, gettid.2, gettimeofday.2, getuid.2, getxattr.2, inotify_add_watch.2, inotify_init.2, ioctl_fat.2, ioctl_ns.2, ioctl_userfaultfd.2, ioprio_set.2, kcmp.2, kexec_load.2, keyctl.2, listxattr.2, lseek.2, madvise.2, memfd_create.2, migrate_pages.2, mount.2, mprotect.2, mremap.2, msgctl.2, msgop.2, nfsservctl.2, open_by_handle_at.2, perf_event_open.2, pipe.2, pivot_root.2, pkey_alloc.2, poll.2, posix_fadvise.2, prctl.2, readahead.2, readdir.2, readlink.2, reboot.2, recvmmsg.2, removexattr.2, rename.2, request_key.2, s390_guarded_storage.2, s390_runtime_instr.2, s390_sthyi.2, sched_setaffinity.2, sched_setattr.2, sched_setparam.2, seccomp.2, select.2, select_tut.2, semctl.2, sendmmsg.2, set_thread_area.2, setgid.2, setns.2, setuid.2, setxattr.2, shmctl.2, sigaction.2, signalfd.2, sigsuspend.2, socket.2, socketpair.2, spu_run.2, stat.2, statx.2, subpage_prot.2, syscalls.2, sysctl.2, tee.2, timer_create.2, timerfd_create.2, truncate.2, uname.2, unshare.2, userfaultfd.2, ustat.2, vmsplice.2, write.2, CPU_SET.3, __ppc_get_timebase.3, alloca.3, argz_add.3, asprintf.3, backtrace.3, basename.3, bsd_signal.3, bstring.3, bswap.3, bzero.3, cacos.3, cacosh.3, catan.3, catanh.3, catgets.3, clock_getcpuclockid.3, cmsg.3, confstr.3, ctermid.3, ctime.3, des_crypt.3, dl_iterate_phdr.3, dlinfo.3, dlsym.3, duplocale.3, end.3, endian.3, errno.3, exec.3, exit.3, ferror.3, fgetws.3, fmemopen.3, fnmatch.3, fopencookie.3, fputws.3, frexp.3, ftw.3, get_nprocs_conf.3, get_phys_pages.3, getaddrinfo.3, getaddrinfo_a.3, getdate.3, getgrouplist.3, getifaddrs.3, getline.3, getlogin.3, getmntent.3, getnameinfo.3, getopt.3, getpass.3, getprotoent_r.3, getpwnam.3, getservent_r.3, getsubopt.3, glob.3, gnu_get_libc_version.3, hsearch.3, if_nameindex.3, index.3, inet.3, inet_net_pton.3, inet_pton.3, insque.3, isatty.3, iswblank.3, iswspace.3, lockf.3, makecontext.3, mallinfo.3, malloc.3, malloc_hook.3, malloc_info.3, mallopt.3, matherr.3, mbrtowc.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mcheck.3, memchr.3, mq_getattr.3, mq_notify.3, newlocale.3, nl_langinfo.3, offsetof.3, perror.3, posix_spawn.3, printf.3, pthread_attr_init.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_getattr_default_np.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_mutexattr_setrobust.3, pthread_rwlockattr_setkind_np.3, pthread_setaffinity_np.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_sigmask.3, putenv.3, qsort.3, rand.3, random.3, readdir.3, regex.3, resolver.3, rpmatch.3, rtime.3, scanf.3, sem_wait.3, setaliasent.3, setbuf.3, stpcpy.3, stpncpy.3, strcat.3, strchr.3, strcmp.3, strcpy.3, strdup.3, strerror.3, strfromd.3, strfry.3, strftime.3, string.3, strlen.3, strnlen.3, strsep.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, system.3, termios.3, trunc.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscat.3, wcscpy.3, wcslen.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wcsstr.3, wcstok.3, wcstombs.3, wcwidth.3, wprintf.3, xcrypt.3, console_codes.4, dsp56k.4, full.4, initrd.4, lirc.4, loop.4, st.4, tty.4, vcs.4, charmap.5, core.5, host.conf.5, locale.5, proc.5, repertoiremap.5, resolv.conf.5, termcap.5, tmpfs.5, tzfile.5, aio.7, capabilities.7, cgroup_namespaces.7, cgroups.7, charsets.7, complex.7, epoll.7, fanotify.7, feature_test_macros.7, inotify.7, ip.7, locale.7, man-pages.7, man.7, namespaces.7, pid_namespaces.7, pkeys.7, pthreads.7, rtld-audit.7, sched.7, signal.7, sock_diag.7, socket.7, tcp.7, udp.7, unicode.7, user_namespaces.7, utf-8.7, zdump.8, zic.8: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2019-03-06 14:11:03 +00:00
|
|
|
.TH ADD_KEY 2 2019-03-06 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
|
2016-10-27 07:47:56 +00:00
|
|
|
.B #include <sys/types.h>
|
2010-02-25 07:24:00 +00:00
|
|
|
.B #include <keyutils.h>
|
2017-08-15 06:37:56 +00:00
|
|
|
.PP
|
2010-02-25 07:24:00 +00:00
|
|
|
.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
|
2017-08-15 06:37:56 +00:00
|
|
|
.PP
|
2016-10-21 07:42:23 +00:00
|
|
|
No glibc wrapper is provided for this system call; see NOTES.
|
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 ,
|
2016-11-08 10:44:59 +00:00
|
|
|
and returns the key's serial number.
|
add_key.2, bpf.2, fcntl.2, futex.2, listxattr.2, perf_event_open.2, prctl.2, request_key.2, sigaltstack.2, __ppc_set_ppr_med.3, __ppc_yield.3, getw.3, setbuf.3, setjmp.3, lirc.4, core.5, securetty.5, inode.7, keyrings.7, process-keyring.7, user-keyring.7, ld.so.8: srcfix: use .PP instead of .P
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2017-08-17 23:13:44 +00:00
|
|
|
.PP
|
2016-11-15 08:43:58 +00:00
|
|
|
The key may be rejected if the provided data is in the wrong format or
|
|
|
|
it is invalid in some other way.
|
add_key.2, bpf.2, fcntl.2, futex.2, listxattr.2, perf_event_open.2, prctl.2, request_key.2, sigaltstack.2, __ppc_set_ppr_med.3, __ppc_yield.3, getw.3, setbuf.3, setjmp.3, lirc.4, core.5, securetty.5, inode.7, keyrings.7, process-keyring.7, user-keyring.7, ld.so.8: srcfix: use .PP instead of .P
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2017-08-17 23:13:44 +00:00
|
|
|
.PP
|
2010-02-25 07:24:00 +00:00
|
|
|
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 ,
|
2016-11-02 21:01:13 +00:00
|
|
|
then, if the key type supports it,
|
2016-12-17 13:26:53 +00:00
|
|
|
.\" FIXME The aforementioned phrases begs the question:
|
|
|
|
.\" which key types support this?
|
2016-11-02 21:01:13 +00:00
|
|
|
that key will be updated rather than a new key being created;
|
|
|
|
if not, a new key (with a different ID) will be created
|
|
|
|
and it will displace the link to the extant key from the keyring.
|
2016-11-06 21:09:01 +00:00
|
|
|
.\" FIXME Perhaps elaborate the implications here? Namely, the new
|
2016-11-25 09:02:36 +00:00
|
|
|
.\" key will have a new ID, and if the old key was a keyring that
|
2017-02-10 09:22:03 +00:00
|
|
|
.\" is consequently unlinked, then keys that it was anchoring
|
2016-12-17 13:26:53 +00:00
|
|
|
.\" will have their reference count decreased by one (and may
|
|
|
|
.\" consequently be garbage collected). Is this all correct?
|
add_key.2, bpf.2, fcntl.2, futex.2, listxattr.2, perf_event_open.2, prctl.2, request_key.2, sigaltstack.2, __ppc_set_ppr_med.3, __ppc_yield.3, getw.3, setbuf.3, setjmp.3, lirc.4, core.5, securetty.5, inode.7, keyrings.7, process-keyring.7, user-keyring.7, ld.so.8: srcfix: use .PP instead of .P
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2017-08-17 23:13:44 +00:00
|
|
|
.PP
|
2010-02-25 07:24:00 +00:00
|
|
|
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
|
2016-12-13 11:22:20 +00:00
|
|
|
permission.
|
|
|
|
Alternatively, it may be one of the following special keyring IDs:
|
2016-12-17 13:26:53 +00:00
|
|
|
.\" FIXME . Perhaps have a separate page describing special keyring IDs?
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_THREAD_KEYRING
|
2016-10-27 06:05:24 +00:00
|
|
|
This specifies the caller's thread-specific keyring
|
|
|
|
.RB ( thread-keyring (7)).
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_PROCESS_KEYRING
|
2016-10-27 06:05:24 +00:00
|
|
|
This specifies the caller's process-specific keyring
|
|
|
|
.RB ( process-keyring (7)).
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_SESSION_KEYRING
|
2016-10-27 06:05:24 +00:00
|
|
|
This specifies the caller's session-specific keyring
|
|
|
|
.RB ( session-keyring (7)).
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_USER_KEYRING
|
2016-10-27 06:05:24 +00:00
|
|
|
This specifies the caller's UID-specific keyring
|
|
|
|
.RB ( user-keyring (7)).
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
|
|
|
.B KEY_SPEC_USER_SESSION_KEYRING
|
2016-10-27 06:05:24 +00:00
|
|
|
This specifies the caller's UID-session keyring
|
|
|
|
.RB ( user-session-keyring (7)).
|
2016-10-20 19:47:41 +00:00
|
|
|
.SS Key types
|
2016-10-21 10:25:23 +00:00
|
|
|
The key
|
|
|
|
.I type
|
|
|
|
is a string that specifies the key's type.
|
|
|
|
Internally, the kernel defines a number of key types that are
|
|
|
|
available in the core key management code.
|
2016-11-03 21:39:00 +00:00
|
|
|
Among the types that are available for user-space use
|
2016-10-21 10:25:23 +00:00
|
|
|
and can be specified as the
|
|
|
|
.I type
|
|
|
|
argument to
|
2016-11-03 21:39:00 +00:00
|
|
|
.BR add_key ()
|
|
|
|
are the following:
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
2016-10-21 10:12:51 +00:00
|
|
|
.I """keyring"""
|
2010-02-25 07:24:00 +00:00
|
|
|
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.
|
2016-12-13 11:22:20 +00:00
|
|
|
If this interface is used to create a keyring, then
|
2010-02-25 07:24:00 +00:00
|
|
|
.I payload
|
2016-12-13 11:22:20 +00:00
|
|
|
should be NULL and
|
2010-02-25 07:24:00 +00:00
|
|
|
.I plen
|
|
|
|
should be zero.
|
2016-10-21 10:13:15 +00:00
|
|
|
.TP
|
2016-12-13 11:14:11 +00:00
|
|
|
.IR """user"""
|
|
|
|
This is a general purpose key type whose payload may be read and updated
|
|
|
|
by user-space applications.
|
|
|
|
The key is kept entirely within kernel memory.
|
|
|
|
The payload for keys of this type is a blob of arbitrary data
|
|
|
|
of up to 32,767 bytes.
|
|
|
|
.TP
|
2016-10-21 10:13:15 +00:00
|
|
|
.IR """logon""" " (since Linux 3.3)"
|
|
|
|
.\" commit 9f6ed2ca257fa8650b876377833e6f14e272848b
|
|
|
|
This key type is essentially the same as
|
|
|
|
.IR """user""" ,
|
2016-12-13 11:22:20 +00:00
|
|
|
but it does not permit the key to read.
|
2016-11-03 21:39:00 +00:00
|
|
|
This is suitable for storing payloads
|
2016-10-21 10:13:15 +00:00
|
|
|
that you do not want to be readable from user space.
|
2017-08-15 06:37:56 +00:00
|
|
|
.PP
|
2016-11-03 21:39:00 +00:00
|
|
|
This key type vets the
|
2016-10-21 10:13:15 +00:00
|
|
|
.I description
|
|
|
|
to ensure that it is qualified by a "service" prefix,
|
|
|
|
by checking to ensure that the
|
|
|
|
.I description
|
|
|
|
contains a ':' that is preceded by other characters.
|
2016-10-27 07:28:37 +00:00
|
|
|
.TP
|
|
|
|
.IR """big_key""" " (since Linux 3.13)"
|
|
|
|
.\" commit ab3c3587f8cda9083209a61dbe3a4407d3cada10
|
|
|
|
This key type is similar to
|
|
|
|
.IR """user""" ,
|
add_key.2, alloc_hugepages.2, execve.2, fanotify_init.2, getrlimit.2, listxattr.2, mmap.2, shmget.2, malloc.3, random.4, st.4, bootparam.7, epoll.7, keyrings.7, pipe.7, xattr.7: Use non-breaking space for measurement units
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2017-08-18 10:28:20 +00:00
|
|
|
but may hold a payload of up to 1\ MiB.
|
2016-11-15 08:44:14 +00:00
|
|
|
If the key payload is large enough,
|
2016-12-13 11:22:20 +00:00
|
|
|
then it may be stored encrypted in tmpfs
|
|
|
|
(which can be swapped out) rather than kernel memory.
|
2016-11-03 21:39:00 +00:00
|
|
|
.PP
|
|
|
|
For further details on these key types, see
|
|
|
|
.BR keyrings (7).
|
2010-02-25 07:24:00 +00:00
|
|
|
.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
|
2016-10-24 10:55:28 +00:00
|
|
|
.B EDQUOT
|
|
|
|
The key quota for this user would be exceeded by creating this key or linking
|
|
|
|
it to the keyring.
|
|
|
|
.TP
|
2016-11-15 08:44:30 +00:00
|
|
|
.B EFAULT
|
2016-11-16 07:59:18 +00:00
|
|
|
One or more of
|
|
|
|
.IR type ,
|
|
|
|
.IR description ,
|
|
|
|
and
|
|
|
|
.I payload
|
|
|
|
points outside process's accessible address space.
|
2016-11-15 08:44:30 +00:00
|
|
|
.TP
|
2016-08-07 16:49:42 +00:00
|
|
|
.B EINVAL
|
2016-10-27 12:08:47 +00:00
|
|
|
The size of the string (including the terminating null byte) specified in
|
|
|
|
.I type
|
|
|
|
or
|
|
|
|
.I description
|
|
|
|
exceeded the limit (32 bytes and 4096 bytes respectively).
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
2016-08-07 16:49:42 +00:00
|
|
|
The payload data was invalid.
|
2010-02-25 07:24:00 +00:00
|
|
|
.TP
|
2016-10-21 10:13:15 +00:00
|
|
|
.B EINVAL
|
|
|
|
.IR type
|
|
|
|
was
|
|
|
|
.IR """logon"""
|
|
|
|
and the
|
|
|
|
.I description
|
|
|
|
was not qualified with a prefix string of the form
|
|
|
|
.IR """service:""" .
|
|
|
|
.TP
|
2010-02-25 07:24:00 +00:00
|
|
|
.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.
|
2016-11-15 08:44:40 +00:00
|
|
|
.TP
|
|
|
|
.B EPERM
|
|
|
|
The
|
|
|
|
.I type
|
2016-11-16 07:59:18 +00:00
|
|
|
started with a period (\(aq.\(aq).
|
2016-11-16 10:17:05 +00:00
|
|
|
Key types that begin with a period are reserved to the implementation.
|
2016-11-15 08:44:40 +00:00
|
|
|
.TP
|
|
|
|
.B EPERM
|
|
|
|
.I type
|
|
|
|
was
|
|
|
|
.I """keyring"""
|
|
|
|
and the
|
|
|
|
.I description
|
2016-11-16 07:59:18 +00:00
|
|
|
started with a period (\(aq.\(aq).
|
2016-11-16 10:17:05 +00:00
|
|
|
Keyrings with descriptions (names)
|
|
|
|
that begin with a period are reserved to the implementation.
|
2016-10-19 08:30:25 +00:00
|
|
|
.SH VERSIONS
|
2016-11-03 18:05:38 +00:00
|
|
|
This system call first appeared in Linux 2.6.10.
|
2016-10-19 08:30:25 +00:00
|
|
|
.SH CONFORMING TO
|
|
|
|
This system call is a nonstandard Linux extension.
|
2016-10-19 08:29:31 +00:00
|
|
|
.SH NOTES
|
2016-10-21 07:42:23 +00:00
|
|
|
No wrapper for this system call is provided in glibc.
|
|
|
|
A wrapper is provided in the
|
|
|
|
.IR libkeyutils
|
|
|
|
package.
|
|
|
|
When employing the wrapper in that library, link with
|
|
|
|
.IR \-lkeyutils .
|
2016-10-27 08:16:04 +00:00
|
|
|
.SH EXAMPLE
|
|
|
|
The program below creates a key with the type, description, and payload
|
|
|
|
specified in its command-line arguments,
|
|
|
|
and links that key into the session keyring.
|
|
|
|
The following shell session demonstrates the use of the program:
|
2017-08-15 06:37:56 +00:00
|
|
|
.PP
|
2016-10-27 08:16:04 +00:00
|
|
|
.in +4n
|
2017-08-15 06:37:56 +00:00
|
|
|
.EX
|
2016-10-27 08:16:04 +00:00
|
|
|
$ \fB./a.out user mykey "Some payload"\fP
|
|
|
|
Key ID is 64a4dca
|
|
|
|
$ \fBgrep \(aq64a4dca\(aq /proc/keys\fP
|
|
|
|
064a4dca I--Q--- 1 perm 3f010000 1000 1000 user mykey: 12
|
2017-08-15 06:37:56 +00:00
|
|
|
.EE
|
2016-10-27 08:16:04 +00:00
|
|
|
.in
|
|
|
|
.SS Program source
|
|
|
|
\&
|
2017-08-15 06:37:56 +00:00
|
|
|
.EX
|
2016-10-27 08:16:04 +00:00
|
|
|
#include <sys/types.h>
|
|
|
|
#include <keyutils.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
int
|
|
|
|
main(int argc, char *argv[])
|
|
|
|
{
|
|
|
|
key_serial_t key;
|
|
|
|
|
|
|
|
if (argc != 4) {
|
locale.1, memusage.1, pldd.1, _syscall.2, add_key.2, bind.2, bpf.2, chown.2, clone.2, copy_file_range.2, eventfd.2, execve.2, futex.2, getdents.2, getrlimit.2, ioctl_fat.2, ioctl_ns.2, kcmp.2, kexec_load.2, keyctl.2, listxattr.2, lseek.2, membarrier.2, memfd_create.2, mmap.2, mprotect.2, msgop.2, open_by_handle_at.2, perf_event_open.2, pipe.2, readdir.2, readlink.2, readv.2, recvmmsg.2, request_key.2, sched_setaffinity.2, seccomp.2, select.2, select_tut.2, sendmmsg.2, setns.2, signalfd.2, spu_run.2, stat.2, sysctl.2, tee.2, timer_create.2, timerfd_create.2, truncate.2, uname.2, unshare.2, userfaultfd.2, ustat.2, wait.2, CPU_SET.3, __ppc_get_timebase.3, argz_add.3, asprintf.3, backtrace.3, basename.3, bswap.3, bzero.3, cacos.3, cacosh.3, catan.3, catanh.3, catgets.3, clock_getcpuclockid.3, confstr.3, ctime.3, dl_iterate_phdr.3, dlinfo.3, duplocale.3, encrypt.3, end.3, endian.3, fgetws.3, fmemopen.3, fopencookie.3, fputws.3, frexp.3, ftw.3, get_nprocs_conf.3, get_phys_pages.3, getaddrinfo.3, getaddrinfo_a.3, getdate.3, getgrouplist.3, getifaddrs.3, getline.3, getlogin.3, getopt.3, getpass.3, getprotoent_r.3, getpwnam.3, getservent_r.3, getsubopt.3, glob.3, gnu_get_libc_version.3, hsearch.3, if_nameindex.3, index.3, inet.3, inet_net_pton.3, inet_pton.3, insque.3, iswblank.3, iswspace.3, makecontext.3, mallinfo.3, malloc_hook.3, malloc_info.3, mallopt.3, matherr.3, mbrtowc.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mcheck.3, memchr.3, mq_getattr.3, mq_notify.3, newlocale.3, nl_langinfo.3, offsetof.3, perror.3, posix_spawn.3, printf.3, pthread_attr_init.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_create.3, pthread_getattr_default_np.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_mutexattr_setrobust.3, pthread_setaffinity_np.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_sigmask.3, qsort.3, rand.3, readdir.3, regex.3, rpmatch.3, rtime.3, scanf.3, sem_wait.3, setaliasent.3, setbuf.3, stpcpy.3, stpncpy.3, strcat.3, strchr.3, strcpy.3, strdup.3, strerror.3, strfromd.3, strftime.3, strlen.3, strnlen.3, strsep.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, termios.3, tsearch.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscat.3, wcscpy.3, wcslen.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wcsstr.3, wcstok.3, wcstombs.3, wcwidth.3, wprintf.3, console_codes.4, dsp56k.4, full.4, initrd.4, loop.4, vcs.4, charmap.5, core.5, elf.5, locale.5, proc.5, repertoiremap.5, sysfs.5, termcap.5, aio.7, bpf-helpers.7, cgroups.7, charsets.7, complex.7, fanotify.7, feature_test_macros.7, inotify.7, locale.7, man-pages.7, man.7, pkeys.7, pthreads.7, rtld-audit.7, sock_diag.7, unix.7, user_namespaces.7, utf-8.7: Use '\e' rather than '\\' to get a backslash
Quoting Branden:
*roff escape sequences may sometimes look like C escapes, but that
is misleading. *roff is in part a macro language and that means
recursive expansion to arbitrary depths.
You can get away with "\\" in a context where no macro expansion
is taking place, but try to spell a literal backslash this way in
the argument to a macro and you will likely be unhappy with
results.
Try viewing the attached file with "man -l".
"\e" is the preferred and portable way to get a portable "escape
literal" going back to CSTR #54, the original Bell Labs troff
paper.
groff(7) discusses the issue:
\\ reduces to a single backslash; useful to delay its
interpretation as escape character in copy mode. For a
printable backslash, use \e, or even better \[rs], to be
independent from the current escape character.
As of groff 1.22.4, groff_man(7) does as well:
\e Widely used in man pages to represent a backslash output
glyph. It works reliably as long as the .ec request is
not used, which should never happen in man pages, and it
is slightly more portable than the more exact ‘\(rs’
(“reverse solidus”) escape sequence.
People not concerned with portability to extremely old troffs should
probably just use \(rs (or \[rs]), as it means "the backslash
glyph", not "the glyph corresponding to whatever the current escape
character is".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2019-02-27 11:57:17 +00:00
|
|
|
fprintf(stderr, "Usage: %s type description payload\en",
|
2016-10-27 08:16:04 +00:00
|
|
|
argv[0]);
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
|
|
|
|
|
|
|
key = add_key(argv[1], argv[2], argv[3], strlen(argv[3]),
|
|
|
|
KEY_SPEC_SESSION_KEYRING);
|
2016-11-08 23:36:21 +00:00
|
|
|
if (key == \-1) {
|
|
|
|
perror("add_key");
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
2016-10-27 08:16:04 +00:00
|
|
|
|
locale.1, memusage.1, pldd.1, _syscall.2, add_key.2, bind.2, bpf.2, chown.2, clone.2, copy_file_range.2, eventfd.2, execve.2, futex.2, getdents.2, getrlimit.2, ioctl_fat.2, ioctl_ns.2, kcmp.2, kexec_load.2, keyctl.2, listxattr.2, lseek.2, membarrier.2, memfd_create.2, mmap.2, mprotect.2, msgop.2, open_by_handle_at.2, perf_event_open.2, pipe.2, readdir.2, readlink.2, readv.2, recvmmsg.2, request_key.2, sched_setaffinity.2, seccomp.2, select.2, select_tut.2, sendmmsg.2, setns.2, signalfd.2, spu_run.2, stat.2, sysctl.2, tee.2, timer_create.2, timerfd_create.2, truncate.2, uname.2, unshare.2, userfaultfd.2, ustat.2, wait.2, CPU_SET.3, __ppc_get_timebase.3, argz_add.3, asprintf.3, backtrace.3, basename.3, bswap.3, bzero.3, cacos.3, cacosh.3, catan.3, catanh.3, catgets.3, clock_getcpuclockid.3, confstr.3, ctime.3, dl_iterate_phdr.3, dlinfo.3, duplocale.3, encrypt.3, end.3, endian.3, fgetws.3, fmemopen.3, fopencookie.3, fputws.3, frexp.3, ftw.3, get_nprocs_conf.3, get_phys_pages.3, getaddrinfo.3, getaddrinfo_a.3, getdate.3, getgrouplist.3, getifaddrs.3, getline.3, getlogin.3, getopt.3, getpass.3, getprotoent_r.3, getpwnam.3, getservent_r.3, getsubopt.3, glob.3, gnu_get_libc_version.3, hsearch.3, if_nameindex.3, index.3, inet.3, inet_net_pton.3, inet_pton.3, insque.3, iswblank.3, iswspace.3, makecontext.3, mallinfo.3, malloc_hook.3, malloc_info.3, mallopt.3, matherr.3, mbrtowc.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mcheck.3, memchr.3, mq_getattr.3, mq_notify.3, newlocale.3, nl_langinfo.3, offsetof.3, perror.3, posix_spawn.3, printf.3, pthread_attr_init.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_create.3, pthread_getattr_default_np.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_mutexattr_setrobust.3, pthread_setaffinity_np.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_sigmask.3, qsort.3, rand.3, readdir.3, regex.3, rpmatch.3, rtime.3, scanf.3, sem_wait.3, setaliasent.3, setbuf.3, stpcpy.3, stpncpy.3, strcat.3, strchr.3, strcpy.3, strdup.3, strerror.3, strfromd.3, strftime.3, strlen.3, strnlen.3, strsep.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, termios.3, tsearch.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscat.3, wcscpy.3, wcslen.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wcsstr.3, wcstok.3, wcstombs.3, wcwidth.3, wprintf.3, console_codes.4, dsp56k.4, full.4, initrd.4, loop.4, vcs.4, charmap.5, core.5, elf.5, locale.5, proc.5, repertoiremap.5, sysfs.5, termcap.5, aio.7, bpf-helpers.7, cgroups.7, charsets.7, complex.7, fanotify.7, feature_test_macros.7, inotify.7, locale.7, man-pages.7, man.7, pkeys.7, pthreads.7, rtld-audit.7, sock_diag.7, unix.7, user_namespaces.7, utf-8.7: Use '\e' rather than '\\' to get a backslash
Quoting Branden:
*roff escape sequences may sometimes look like C escapes, but that
is misleading. *roff is in part a macro language and that means
recursive expansion to arbitrary depths.
You can get away with "\\" in a context where no macro expansion
is taking place, but try to spell a literal backslash this way in
the argument to a macro and you will likely be unhappy with
results.
Try viewing the attached file with "man -l".
"\e" is the preferred and portable way to get a portable "escape
literal" going back to CSTR #54, the original Bell Labs troff
paper.
groff(7) discusses the issue:
\\ reduces to a single backslash; useful to delay its
interpretation as escape character in copy mode. For a
printable backslash, use \e, or even better \[rs], to be
independent from the current escape character.
As of groff 1.22.4, groff_man(7) does as well:
\e Widely used in man pages to represent a backslash output
glyph. It works reliably as long as the .ec request is
not used, which should never happen in man pages, and it
is slightly more portable than the more exact ‘\(rs’
(“reverse solidus”) escape sequence.
People not concerned with portability to extremely old troffs should
probably just use \(rs (or \[rs]), as it means "the backslash
glyph", not "the glyph corresponding to whatever the current escape
character is".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2019-02-27 11:57:17 +00:00
|
|
|
printf("Key ID is %lx\en", (long) key);
|
2016-10-27 08:16:04 +00:00
|
|
|
|
|
|
|
exit(EXIT_SUCCESS);
|
|
|
|
}
|
2017-08-15 06:37:56 +00:00
|
|
|
.EE
|
2010-02-25 07:24:00 +00:00
|
|
|
.SH SEE ALSO
|
2016-11-02 02:59:30 +00:00
|
|
|
.ad l
|
|
|
|
.nh
|
2010-02-25 07:24:00 +00:00
|
|
|
.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),
|
2016-10-21 08:11:18 +00:00
|
|
|
.BR keyrings (7),
|
2017-09-06 19:06:48 +00:00
|
|
|
.BR keyutils (7),
|
2016-11-02 02:59:30 +00:00
|
|
|
.BR persistent\-keyring (7),
|
|
|
|
.BR process\-keyring (7),
|
|
|
|
.BR session\-keyring (7),
|
|
|
|
.BR thread\-keyring (7),
|
|
|
|
.BR user\-keyring (7),
|
|
|
|
.BR user\-session\-keyring (7)
|
2017-08-15 06:37:56 +00:00
|
|
|
.PP
|
2016-10-20 06:47:31 +00:00
|
|
|
The kernel source files
|
2017-09-11 03:03:50 +00:00
|
|
|
.IR Documentation/security/keys/core.rst
|
|
|
|
and
|
|
|
|
.IR Documentation/keys/request\-key.rst
|
|
|
|
(or, before Linux 4.13, in the files
|
|
|
|
.\" commit b68101a1e8f0263dbc7b8375d2a7c57c6216fb76
|
2016-10-20 06:47:31 +00:00
|
|
|
.IR Documentation/security/keys.txt
|
|
|
|
and
|
2017-09-11 03:03:50 +00:00
|
|
|
.\" commit 3db38ed76890565772fcca3279cc8d454ea6176b
|
|
|
|
.IR Documentation/security/keys\-request\-key.txt ).
|