keyctl_set_timeout(3) — Linux manual page


KEYCTL_SET_TIMEOUT(3)  Linux Key Management Calls  KEYCTL_SET_TIMEOUT(3)

NAME         top

       keyctl_set_timeout - set the expiration timer on a key

SYNOPSIS         top

       #include <keyutils.h>

       long keyctl_set_timeout(key_serial_t key, unsigned timeout);

DESCRIPTION         top

       keyctl_set_timeout() sets the expiration timer on a key to
       timeout seconds into the future.  Setting timeout to zero cancels
       the expiration, assuming the key hasn't already expired.

       When the key expires, further attempts to access it will be met
       with error EKEYEXPIRED.

       The caller must have setattr permission on a key to be able to
       change its permissions mask.

RETURN VALUE         top

       On success keyctl_set_timeout() returns 0 .  On error, the value
       -1 will be returned and errno will have been set to an
       appropriate error.

ERRORS         top

       ENOKEY The specified key does not exist.

              The specified key has already expired.

              The specified key has been revoked.

       EACCES The named key exists, but does not grant setattr
              permission to the calling process.

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)

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 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

Linux                          4 May 2006          KEYCTL_SET_TIMEOUT(3)

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