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

« back to all changes in this revision

Viewing changes to keyctl_invalidate.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) 2013 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_INVALIDATE 3 "29 Aug 2013" Linux "Linux Key Management Calls"
11
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
12
 
.SH NAME
13
 
keyctl_invalidate \- Invalidate a key
14
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
15
 
.SH SYNOPSIS
16
 
.nf
17
 
.B #include <keyutils.h>
18
 
.sp
19
 
.BI "long keyctl_invalidate(key_serial_t " key ");"
20
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
21
 
.SH DESCRIPTION
22
 
.BR keyctl_invalidate ()
23
 
invalidates a
24
 
.IR key .
25
 
The key is scheduled for immediate removal from all the keyrings that point to
26
 
it, after which it will be deleted.  The key will be ignored by all searches
27
 
once this function is called even if it is not yet fully dealt with.
28
 
.P
29
 
The caller must have
30
 
.B search
31
 
permission on a key to be able to invalidate it.
32
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
33
 
.SH RETURN VALUE
34
 
On success
35
 
.BR keyctl_invalidate ()
36
 
returns
37
 
.BR 0 .
38
 
On error, the value
39
 
.B -1
40
 
will be returned and errno will have been set to an appropriate error.
41
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
42
 
.SH ERRORS
43
 
.TP
44
 
.B ENOKEY
45
 
The key specified is invalid.
46
 
.TP
47
 
.B EKEYEXPIRED
48
 
The key specified has expired.
49
 
.TP
50
 
.B EKEYREVOKED
51
 
The key specified had been revoked.
52
 
.TP
53
 
.B EACCES
54
 
The key exists, but is not
55
 
.B searchable
56
 
by the calling process.
57
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
58
 
.SH LINKING
59
 
This is a library function that can be found in
60
 
.IR libkeyutils .
61
 
When linking,
62
 
.B -lkeyutils
63
 
should be specified to the linker.
64
 
.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
65
 
.SH SEE ALSO
66
 
.BR keyctl (1),
67
 
.br
68
 
.BR add_key (2),
69
 
.br
70
 
.BR keyctl (2),
71
 
.br
72
 
.BR request_key (2),
73
 
.br
74
 
.BR keyctl (3),
75
 
.br
76
 
.BR request-key (8)