doc/man/gnunet-revocation.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" ``FDL-1.3''.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" ``GPL3''.
  18 .\"
  19 .\" A copy of the license is also available from the Free Software
  20 .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd March 15, 2012
  25 .Dt GNUNET-REVOCATION 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-revocation
  29 .Nd
  30 revoke private keys (of egos) in GNUnet
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl t Ar KEY | Fl \-test= Ns Ar KEY
  34 .Op Fl R Ar NAME | Fl \-revoke= Ns Ar NAME
  35 .Op Fl p | \-perform
  36 .Op Fl f Ar NAME | Fl \-filename= Ns Ar NAME
  37 .Op Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
  38 .Op Fl h | \-help
  39 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  40 .Op Fl v | \-version
  41 .Sh DESCRIPTION
  42 .Nm
  43 can be used to verify if a key has been revoked, to create a revocation certificate for later revocation, to instantly revoke a key and to use a pre-generated revocation certificate to revoke a key.
  44 Upon successful revocation, all peers will be informed about the invalidity of the key.
  45 As this is an expensive operation, GNUnet requires the issuer of the revocation to perform an expensive proof-of-work computation before they will be allowed to perform the revocation.
  46 gnunet-revocation will perform this computation.
  47 The computation can be performed ahead of time, with the resulting revocation certificate being stored in a file for later "instant" use.
  48 gnunet-revocation also makes is possible to resume the pre-calculation of a revocation --- simply abort a running proof-of-work calculation with CTRL-C, and the existing revocation certificate file will contain the status of the computation.
  49 Note that performing a revocation proof-of-work is deliberately VERY expensive.
  50 Depending on your CPU, the calculation can take days or weeks.
  51 .Bl -tag -width Ds
  52 .It Fl t Ar KEY | Fl \-test= Ns Ar KEY
  53 Check if the given KEY (ASCII\-encoded public key required) has been revoked.
  54 .It Fl R Ar NAME | Fl \-revoke= Ns Ar NAME
  55 Calculate or perform revocation for the ego with the given NAME.
  56 .It Fl p | \-perform
  57 Actually perform the revocation as soon as possible (do not just generate a revocation certificate, use it).
  58 Must be supplied to actually perform the revocation.
  59 .It Fl f Ar NAME | Fl \-filename= Ns Ar NAME
  60 Use NAME as the name of the file that is to contain the revocation certificate.
  61 Intermediate computation results will be stored here, as well as the final revocation certificate.
  62 When used together with \-p, this file will be inspected to see if it contains a valid certificate for instant revocation, in which case the revocation can be performed instantly.
  63 If the given file contains anything (a valid certificate, with or without the completed proof-of-work) there is no need to supply the "\-R" option or to still have the private key of the ego to perform the revocation.
  64 .It Fl c Ar FILENAME, Fl \-config= Ns Ar FILENAME
  65 Use the configuration file FILENAME.
  66 .It Fl h | \-help
  67 Print short help on options.
  68 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  69 Use LOGLEVEL for logging.
  70 Valid values are DEBUG, INFO, WARNING and ERROR.
  71 .It Fl v | \-version
  72 Print GNUnet version number.
  73 .El
  74 .Sh SEE ALSO
  75 The full documentation for gnunet is maintained as a Texinfo manual.
  76 If the
  77 .Xr info 1
  78 and gnunet programs are properly installed at your site, the command
  79 .Pp
  80 .Dl info gnunet
  81 .Pp
  82 should give you access to the complete handbook,
  83 .Pp
  84 .Dl info gnunet-c-tutorial
  85 .Pp
  86 will give you access to a tutorial for developers.
  87 .sp
  88 Depending on your installation, this information is also available in
  89 .Xr gnunet 7 and
  90 .Xr gnunet-c-tutorial 7 .
  91 .\".Sh HISTORY
  92 .\".Sh AUTHORS
  93 .Sh BUGS
  94 Report bugs by using
  95 .Lk https://bugs.gnunet.org
  96 or by sending electronic mail to
  97 .Aq Mt gnunet-developers@gnu.org .