keyctl_set_reqkey_keyring(3) — Linux manual page

KEYCTL_..._KEYRING(3)  Linux Key Management Calls  KEYCTL_..._KEYRING(3)

NAME

       keyctl_set_reqkey_keyring - set the implicit destination keyring

SYNOPSIS

       #include <keyutils.h>

       long keyctl_set_reqkey_keyring(int reqkey_defl);

DESCRIPTION

       keyctl_set_reqkey_keyring() sets the default destination for
       implicit key requests for the current thread and returns the old
       setting.

       After this operation has been issued, keys acquired by implicit
       key requests, such as might be performed by open() on an AFS or
       NFS filesystem, will be linked by default to the specified
       keyring by this function.

       The valid values of reqkey_defl are:

       KEY_REQKEY_DEFL_NO_CHANGE
              This makes no change to the current setting.

       KEY_REQKEY_DEFL_THREAD_KEYRING
              This makes the thread-specific keyring the default
              destination.

       KEY_REQKEY_DEFL_PROCESS_KEYRING
              This makes the process-specific keyring the default
              destination.

       KEY_REQKEY_DEFL_SESSION_KEYRING
              This makes the session keyring the default destination.

       KEY_REQKEY_DEFL_USER_KEYRING
              This makes the UID-specific keyring the default
              destination.

       KEY_REQKEY_DEFL_USER_SESSION_KEYRING
              This makes the UID-specific session keyring the default
              destination.

       KEY_REQKEY_DEFL_DEFAULT
              This selects the default behaviour which is to use the
              thread-specific keyring if there is one, otherwise the
              process-specific keyring if there is one, otherwise the
              session keyring if there is one, otherwise the UID-
              specific session keyring.

       This setting is inherited across fork() and exec().

RETURN VALUE

       On success keyctl_set_reqkey_keyring() returns the serial number
       of the keyring which was the previous default for the current
       thread.  On error, the value -1 will be returned and errno will
       have been set to an appropriate error.

ERRORS

       EINVAL The value of reqkey_defl is invalid.

LINKING

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

SEE ALSO

       keyctl(1), add_key(2), keyctl(2), request_key(2), keyctl(3),
       keyutils(7), keyrings(7), request-key(8)

COLOPHON

       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 man-pages@man7.org] If you have a
       bug report for this manual page, send it to
       keyrings@linux-nfs.org.  This page was obtained from the
       project's upstream Git repository
       ⟨http://git.kernel.org/pub/scm/linux/kernel/git/dhowells/keyutils.git⟩
       on 2024-06-14.  (At that time, the date of the most recent commit
       that was found in the repository was 2023-03-20.)  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                          4 May 2006          KEYCTL_..._KEYRING(3)

Pages that refer to this page: keyctl(2), keyctl(3)

---