~ubuntu-branches/ubuntu/wily/keyutils/wily

« back to all changes in this revision

Viewing changes to keyctl_set_timeout.3

  • Committer: Package Import Robot
  • Author(s): Matthias Klose
  • Date: 2014-10-16 11:45:19 UTC
  • mfrom: (1.1.7) (10.2.16 sid)
  • Revision ID: package-import@ubuntu.com-20141016114519-cqt8zwrg92c31m31
Tags: 1.5.9-5ubuntu1
Disable the tests, hanging on the distro buildd kernels (12.04 LTS).
Verified that the tests succeed with the 14.04 LTS kernels.
Addresses: LP: #1381973.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\"
2
 
.\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3
 
.\" Written by David Howells (dhowells@redhat.com)
4
 
.\"
5
 
.\" This program is free software; you can redistribute it and/or
6
 
.\" modify it under the terms of the GNU General Public License
7
 
.\" as published by the Free Software Foundation; either version
8
 
.\" 2 of the License, or (at your option) any later version.
9
 
.\"
10
 
.TH KEYCTL_SET_TIMEOUT 3 "4 May 2006" Linux "Linux Key Management Calls"
11
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
12
 
.SH NAME
13
 
keyctl_set_timeout \- Set the expiration timer on a key
14
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
15
 
.SH SYNOPSIS
16
 
.nf
17
 
.B #include <keyutils.h>
18
 
.sp
19
 
.BI "long keyctl_set_timeout(key_serial_t " key ", unsigned " timeout ");"
20
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
21
 
.SH DESCRIPTION
22
 
.BR keyctl_set_timeout ()
23
 
sets the expiration timer on a key to
24
 
.I timeout
25
 
seconds into the future.  Setting
26
 
.I timeout
27
 
to
28
 
.B zero
29
 
cancels the expiration, assuming the key hasn't already expired.
30
 
.P
31
 
When the key expires, further attempts to access it will be met with error
32
 
.BR EKEYEXPIRED .
33
 
.P
34
 
The caller must have
35
 
.B setattr
36
 
permission on a key to be able change its permissions mask.
37
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
38
 
.SH RETURN VALUE
39
 
On success
40
 
.BR keyctl_set_timeout ()
41
 
returns
42
 
.B 0 .
43
 
On error, the value
44
 
.B -1
45
 
will be returned and errno will have been set to an appropriate error.
46
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
47
 
.SH ERRORS
48
 
.TP
49
 
.B ENOKEY
50
 
The specified key does not exist.
51
 
.TP
52
 
.B EKEYEXPIRED
53
 
The specified key has already expired.
54
 
.TP
55
 
.B EKEYREVOKED
56
 
The specified key has been revoked.
57
 
.TP
58
 
.B EACCES
59
 
The named key exists, but does not grant
60
 
.B setattr
61
 
permission to the calling process.
62
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
63
 
.SH LINKING
64
 
This is a library function that can be found in
65
 
.IR libkeyutils .
66
 
When linking,
67
 
.B -lkeyutils
68
 
should be specified to the linker.
69
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
70
 
.SH SEE ALSO
71
 
.BR keyctl (1),
72
 
.br
73
 
.BR add_key (2),
74
 
.br
75
 
.BR keyctl (2),
76
 
.br
77
 
.BR request_key (2),
78
 
.br
79
 
.BR keyctl (3),
80
 
.br
81
 
.BR request-key (8)