KEYCTL_INVALIDATE(2const) — Linux manual page

KEYCTL_INVALIDATE(2const)                       KEYCTL_INVALIDATE(2const)

NAME         top

       KEYCTL_INVALIDATE - invalidate 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_INVALIDATE, key_serial_t key);

DESCRIPTION         top

       Mark a key as invalid.

       The ID of the key to be invalidated is specified in key.

       To invalidate a key, the caller must have search permission on the
       key.

       This operation marks the key as invalid and schedules immediate
       garbage collection.  The garbage collector removes the invalidated
       key from all keyrings and deletes the key when its reference count
       reaches zero.  After this operation, the key will be ignored by
       all searches, even if it is not yet deleted.

       Keys that are marked invalid become invisible to normal key
       operations immediately, though they are still visible in
       /proc/keys (marked with an 'i' flag) until they are actually
       removed.

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_invalidate(3).

STANDARDS         top

       Linux.

HISTORY         top

       Linux 3.5.

SEE ALSO         top

       keyctl(2), keyctl_invalidate(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_INVALIDATE(2const)

Pages that refer to this page: keyctl(2)

HTML rendering created 2025-02-02 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.