KEYCTL_JOIN_SESSION_KEYRING(2const) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | VERSIONS | STANDARDS | HISTORY | SEE ALSO | COLOPHON

KEYCTL_JOIN_SESSION_KEYRING(2const)   KEYCTL_JOIN_SESSION_KEYRING(2const)

NAME         top

       KEYCTL_JOIN_SESSION_KEYRING - replace the session keyring this
       process subscribes to with a new one

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <linux/keyctl.h>  /* Definition of KEY* constants */
       #include <sys/syscall.h>   /* Definition of SYS_* constants */
       #include <unistd.h>

       long syscall(SYS_keyctl, KEYCTL_JOIN_SESSION_KEYRING,
                    char *_Nullable desc);

DESCRIPTION         top

       Replace the session keyring this process subscribes to with a new
       session keyring.

       If desc is NULL, an anonymous keyring with the description "_ses"
       is created and the process is subscribed to that keyring as its
       session keyring, displacing the previous session keyring.

       Otherwise, desc is treated as the description (name) of a keyring,
       and the behavior is as follows:

       •  If a keyring with a matching description exists, the process
          will attempt to subscribe to that keyring as its session
          keyring if possible; if that is not possible, an error is
          returned.  In order to subscribe to the keyring, the caller
          must have search permission on the keyring.

       •  If a keyring with a matching description does not exist, then a
          new keyring with the specified description is created, and the
          process is subscribed to that keyring as its session keyring.

RETURN VALUE         top

       On success, the ID of the joined session keyring.

       On error, -1 is returned, and errno is set to indicate the error.

VERSIONS         top

       A wrapper is provided in the libkeyutils library:
       keyctl_join_session_keyring(3).

STANDARDS         top

       Linux.

HISTORY         top

       Linux 2.6.10.

SEE ALSO         top

       keyctl(2), keyctl_join_session_keyring(3)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.10.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2025-02-02.  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 man-pages 6.10            2024-08K-E2Y1CTL_JOIN_SESSION_KEYRING(2const)

Pages that refer to this page: keyctl(2)KEYCTL_SETPERM(2const)