KEYCTL_SET_TIMEOUT(2const) — Linux manual page

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

KEYCTL_SET_TIMEOUT(2const)                     KEYCTL_SET_TIMEOUT(2const)

NAME         top

       KEYCTL_SET_TIMEOUT - set the expiration timer on a key

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_SET_TIMEOUT, key_serial_t key, time_t t);

DESCRIPTION         top

       Set a timeout on a key.

       The ID of the key is specified in key.  The timeout value, in
       seconds from the current time, is specified in t.  The timeout is
       measured against the realtime clock.

       Specifying the timeout value as 0 clears any existing timeout on
       the key.

       The /proc/keys file displays the remaining time until each key
       will expire.  (This is the only method of discovering the timeout
       on a key.)

       The caller must either have the setattr permission on the key or
       hold an instantiation authorization token for the key (see
       request_key(2)).

       The key and any links to the key will be automatically garbage
       collected after the timeout expires.  Subsequent attempts to
       access the key will then fail with the error EKEYEXPIRED.

       This operation cannot be used to set timeouts on revoked, expired,
       or negatively instantiated keys.

RETURN VALUE         top

       On success, 0 is returned.

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

VERSIONS         top

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

STANDARDS         top

       Linux.

HISTORY         top

       Linux 2.6.16.

SEE ALSO         top

       keyctl(2), keyctl_set_timeout(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-08-21     KEYCTL_SET_TIMEOUT(2const)

Pages that refer to this page: keyctl(2)