keyctl_join_session_keyring(3) — Linux manual page



NAME         top

       keyctl_join_session_keyring - join a different session keyring

SYNOPSIS         top

       #include <keyutils.h>

       key_serial_t keyctl_join_session_keyring(const char *name);

DESCRIPTION         top

       keyctl_join_session_keyring() changes the session keyring to which a
       process is subscribed.

       If name is NULL then a new anonymous keyring will be created, and the
       process will be subscribed to that.

       If name points to a string, then if a keyring of that name is
       available, the process will attempt to subscribe to that keyring,
       giving an error if that is not permitted; otherwise a new keyring of
       that name is created and attached as the session keyring.

       To attach to an extant named keyring, the keyring must have search
       permission available to the calling process.

RETURN VALUE         top

       On success keyctl_join_session_keyring() returns the serial number of
       the key it found or created.  On error, the value -1 will be returned
       and errno will have been set to an appropriate error.

ERRORS         top

       ENOMEM Insufficient memory to create a key.

       EDQUOT The key quota for this user would be exceeded by creating this
              key or linking it to the keyring.

       EACCES The named keyring exists, but is not searchable by the calling

LINKING         top

       This is a library function that can be found in libkeyutils.  When
       linking, -lkeyutils should be specified to the linker.

SEE ALSO         top

       keyctl(1), add_key(2), keyctl(2), request_key(2), keyctl(3),
       keyrings(7), keyutils(7), session-keyring(7), user-session-keyring(7)

COLOPHON         top

       This page is part of the keyutils (key management utilities) project.
       Information about the project can be found at [unknown -- if you
       know, please contact] If you have a bug report for
       this manual page, send it to  This page was
       obtained from the project's upstream Git repository
       on 2020-11-01.  (At that time, the date of the most recent commit
       that was found in the repository was 2020-07-07.)  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

Linux                            20 Feb 2014  KEYCTL_JOIN_SESSION_KEYRING(3)

Pages that refer to this page: keyctl(2)keyctl(3)session-keyring(7)