keyctl_revoke.3

   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_REVOKE 3 "4 May 2006" Linux "Linux Key Management Calls"
  11 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  12 .SH NAME
  13 keyctl_revoke \- Revoke a key
  14 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  15 .SH SYNOPSIS
  16 .nf
  17 .B #include <keyutils.h>
  18 .sp
  19 .BI "long keyctl_revoke(key_serial_t " key ");"
  20 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  21 .SH DESCRIPTION
  22 .BR keyctl_revoke ()
  23 marks a key as being revoked.
  24 .P
  25 After this operation has been performed on a key, attempts to access it will
  26 meet with error
  27 .BR EKEYREVOKED .
  28 .P
  29 The caller must have
  30 .B write
  31 permission on a key to be able revoke it.
  32 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  33 .SH RETURN VALUE
  34 On success
  35 .BR keyctl_revoke ()
  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 specified key does not exist.
  46 .TP
  47 .B EKEYREVOKED
  48 The key has already been revoked.
  49 .TP
  50 .B EACCES
  51 The named key exists, but is not
  52 .B writable
  53 by the calling process.
  54 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  55 .SH LINKING
  56 This is a library function that can be found in
  57 .IR libkeyutils .
  58 When linking,
  59 .B -lkeyutils
  60 should be specified to the linker.
  61 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  62 .SH SEE ALSO
  63 .BR keyctl (1),
  64 .br
  65 .BR add_key (2),
  66 .br
  67 .BR keyctl (2),
  68 .br
  69 .BR request_key (2),
  70 .br
  71 .BR keyctl (3),
  72 .br
  73 .BR request-key (8)