KEYCTL\_SET\_TIMEOUT(3) Linux Key Management Calls KEYCTL\_SET\_TIMEOUT(3)

# [NAME](#NAME)

keyctl\_set\_timeout - set the expiration timer on a key

# [SYNOPSIS](#SYNOPSIS)

```
#include <keyutils.h>

long keyctl_set_timeout(key_serial_t key, unsigned timeout);
```

# [DESCRIPTION](#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 to change its permissions mask.

# [RETURN VALUE](#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](#ERRORS)

[**ENOKEY**](#ENOKEY)

The specified key does not exist.

[**EKEYEXPIRED**](#EKEYEXPIRED)

The specified key has already expired.

[**EKEYREVOKED**](#EKEYREVOKED)

The specified key has been revoked.

[**EACCES**](#EACCES)

The named key exists, but does not grant **setattr** permission to the calling process.

# [LINKING](#LINKING)

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

# [SEE ALSO](#SEE_ALSO)

[**keyctl**(1)](/man/os/keyutils/keyctl.1), [**add\_key**(2)](/man/os/keyutils/add_key.2), [**keyctl**(2)](/man/os/keyutils/keyctl.2), [**request\_key**(2)](/man/os/keyutils/request_key.2), [**keyctl**(3)](/man/os/keyutils/keyctl.3), [**keyrings**(7)](/man/os/keyutils/keyrings.7), [**keyutils**(7)](/man/os/keyutils/keyutils.7)

4 May 2006 Linux

---

Document: keyctl_set_timeout(3) from keyutils 1.6.3-r41 (Chainguard OS)
Source: https://kernel.googlesource.com/pub/scm/linux/kernel/git/dhowells/keyutils.git
