KEYCTL_INVALIDATE(2const)

NAME

KEYCTL_INVALIDATE - invalidate a key

LIBRARY

Standard C library (libc, -lc)

SYNOPSIS

#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

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

On success, 0 is returned.

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

VERSIONS

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

STANDARDS

Linux.

HISTORY

Linux 3.5.