NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | LINKING | SEE ALSO | COLOPHON

KEYCTL_INVALIDATE(3)     Linux Key Management Calls     KEYCTL_INVALIDATE(3)

NAME         top

       keyctl_invalidate - invalidate a key

SYNOPSIS         top

       #include <keyutils.h>

       long keyctl_invalidate(key_serial_t key);

DESCRIPTION         top

       keyctl_invalidate() invalidates a key.  The key is scheduled for
       immediate removal from all the keyrings that point to it, after which
       it will be deleted.  The key will be ignored by all searches once
       this function is called even if it is not yet fully dealt with.

       The caller must have search permission on a key to be able to
       invalidate it.

RETURN VALUE         top

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

ERRORS         top

       ENOKEY The key specified is invalid.

       EKEYEXPIRED
              The key specified has expired.

       EKEYREVOKED
              The key specified had been revoked.

       EACCES The key exists, but is not searchable by 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 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 2017-07-05.  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                            29 Aug 2013            KEYCTL_INVALIDATE(3)

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