keyctl_set_timeout (3)

Leading comments

Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
Written by David Howells (dhowells@redhat.com)

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version
2 of the License, or (at your option) any later version.

(The comments found at the beginning of the groff file "man3/keyctl_set_timeout.3".)

NAME

keyctl_set_timeout - Set the expiration timer on a key

SYNOPSIS

#include <keyutils.h>

long keyctl_set_timeout(key_serial_t key, unsigned timeout);

DESCRIPTION

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 change its permissions mask.

RETURN VALUE

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

ENOKEY

The specified key does not exist.

EKEYEXPIRED

The specified key has already expired.

EKEYREVOKED

The specified key has been revoked.

EACCES

The named key exists, but does not grant setattr permission to 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)