keyctl_invalidate man page

keyctl_invalidate — Invalidate a key

Synopsis

#include <keyutils.h>

long keyctl_invalidate(key_serial_t key);

Description

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

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

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

This is a library function that can be found in libkeyutils. When linking, -lkeyutils should be specified to the linker.

See Also

keyctl(1),
add_key(2),
keyctl(2),
request_key(2),
keyctl(3),
keyutils(7),
keyrings(7)

Referenced By

keyctl(3).

29 Aug 2013 Linux Linux Key Management Calls