summaryrefslogtreecommitdiff
path: root/man/taler-auditor-offline.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/taler-auditor-offline.1')
-rw-r--r--man/taler-auditor-offline.1131
1 files changed, 11 insertions, 120 deletions
diff --git a/man/taler-auditor-offline.1 b/man/taler-auditor-offline.1
index cd06e750..59c473b9 100644
--- a/man/taler-auditor-offline.1
+++ b/man/taler-auditor-offline.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "TALER-AUDITOR-OFFLINE" "1" "Jan 27, 2021" "0.8pre0" "GNU Taler"
+.TH "TALER-AUDITOR-OFFLINE" "1" "Apr 26, 2021" "0.8" "GNU Taler"
.SH NAME
taler-auditor-offline \- Taler auditor certifies that it audits a Taler exchange
.
@@ -38,7 +38,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP]
[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP]
[\fB\-v\fP\ |\ \fB––version\fP]
-[subcommand …]
+[subcommand ...]
.SH DESCRIPTION
.sp
\fBtaler\-auditor\-offline\fP is a command\-line tool to be used by an auditor to
@@ -47,7 +47,7 @@ signature, the auditor affirms that he will verify that the exchange is
properly accounting for coins of those denominations. The tool takes a list
of subcommands as arguments which are then processed sequentially.
.sp
-The tool includes two subcommands to interact \fIonline\fP with the exchange’s
+The tool includes two subcommands to interact \fIonline\fP with the exchange\(aqs
REST APIs. The \fBdownload\fP subcommand downloads current public keys from the
running exchange. Note that this only includes keys that the exchange
operator has previously validated using the \fBtaler\-exchange\-offline\fP tool.
@@ -55,10 +55,10 @@ The resulting data serves as input to the \fBsign\fP and \fBshow\fP subcommands.
.sp
The \fBupload\fP subcommand uploads the signatures created with the private key to
the exchange. It handles the output of all subcommands (except \fBdownload\fP).
-The \fBdownload\fP and \fBupload\fP subcommands must naturally be run “online” and do not
-require access to the auditor’s private key, which should be kept offline.
+The \fBdownload\fP and \fBupload\fP subcommands must naturally be run "online" and do not
+require access to the auditor\(aqs private key, which should be kept offline.
.sp
-All other subcommands are intended to be run “offline”. However, especially
+All other subcommands are intended to be run "offline". However, especially
when testing, it is of course possible to run the subcommands online as well.
Generally, subcommands read inputs (beyond command\-line arguments)
from \fBstdin\fP\&. However, they may also consume outputs of previous
@@ -88,8 +88,8 @@ Print version information.
.SH CONFIGURATION
.sp
The exchange and the \fBtaler\-auditor\-httpd\fP must both be provided with
-the auditor’s public key, such that they can validate messages signed
-by the auditor. To obtain the auditor’s public key, use:
+the auditor\(aqs public key, such that they can validate messages signed
+by the auditor. To obtain the auditor\(aqs public key, use:
.INDENT 0.0
.INDENT 3.5
.sp
@@ -102,13 +102,13 @@ $ taler\-auditor\-offline setup
.UNINDENT
.sp
Note that if the private key file already exists, the above will simply output
-the existing key. Passing additional arguments after setup (including “\-“)
+the existing key. Passing additional arguments after setup (including "\-")
will cause the output to be encapsulated in JSON.
.sp
Relevant configuration options for \fBtaler\-auditor\-offline\fP are:
.INDENT 0.0
.IP \(bu 2
-\fB[auditor/AUDITOR_PRIV_FILE]\fP — where to store the private key
+\fB[auditor/AUDITOR_PRIV_FILE]\fP \-\-\- where to store the private key
.UNINDENT
.SH SUBCOMMANDS
.SS setup
@@ -143,115 +143,6 @@ directly.
.sp
It outputs the signatures over \fIall\fP denomination and signing keys
present in the input, in a format suitable for the \fBupload\fP subcommand.
-.SS revoke\-denomination
-.sp
-This subcommand signs a revocation message for a denomination key.
-.sp
-The hash of the denomination public key must be given in the usual
-base32\-encoding as the first and only argument to the subcommand.
-.sp
-It outputs the signature affirming the revocation of the denomination key,
-in a format suitable for the \fBupload\fP subcommand.
-.SS revoke\-signkey
-.sp
-This subcommand signs a revocation message for an exchange online signing key.
-.sp
-The online signing public key must be given in the usual
-base32\-encoding as the first and only argument to the subcommand.
-.sp
-It outputs the signature affirming the revocation of the online signing key,
-in a format suitable for the \fBupload\fP subcommand.
-.SS enable\-auditor
-.sp
-This subcommand
-informs an exchange that an auditor is to be activated. Afterwards, the
-exchange will accept inputs from that auditor’s \fBtaler\-auditor\-offline\fP
-tool. Note that the auditor also must add the exchange to the list of
-exchanges that it audits via \fBtaler\-auditor\-exchange\fP\&. Furthermore, the
-exchange’s database will need to be provided to the auditor. This subcommand
-only informs the exchange about the auditor, but does not perform those
-additional mandatory steps for a working auditor.
-.sp
-The auditor’s public key must be given in the usual base32\-encoding as the
-first argument.
-.sp
-The auditor’s REST API base URL must be given as the second argument. The tool
-performs a minimal sanity check, namely that the URL begins with “http”
-(this also allows “https”), but as it runs offline does not perform any further
-validation!
-.sp
-The third argument must be a human\-readable name for the auditor. This may
-be shown to users and should identify the auditor’s business entity. If
-the name includes spaces, the argument should be quoted.
-.sp
-The subcommand takes no inputs from \fBstdin\fP or other subcommands.
-.sp
-It outputs the signature affirming the addition of the auditor,
-in a format suitable for the \fBupload\fP subcommand.
-.SS disable\-auditor
-.sp
-This subcommand
-informs an exchange that an auditor is to be deactivated. Afterwards, the
-exchange will refuse inputs from that auditor’s \fBtaler\-auditor\-offline\fP
-tool.
-.sp
-The auditor’s public key must be given in the usual base32\-encoding as the
-first argument.
-.sp
-The subcommand takes no inputs from \fBstdin\fP or other subcommands.
-.sp
-It outputs the signature affirming the removal of the auditor,
-in a format suitable for the \fBupload\fP subcommand.
-.SS enable\-account
-.sp
-This subcommand
-informs an exchange that it should advertise a bank account as belonging to
-the exchange on its \fB/wire\fP endpoint. Note that this does \fInot\fP ensure that
-the exchange will use this bank account for incoming or outgoing wire
-transfers! For this, the \fBtaler\-exchange\-transfer\fP and
-\fBtaler\-exchange\-wirewatch\fP tools must be configured. Furthermore, the bank
-account information advertised could theoretically differ from that which
-these tool actually use, for example if the public bank account is only a
-front for the actual internal business acounts.
-.sp
-The \fBpayto://\fP URI (RFC 8905) of the exchange’s bank account must be given
-as the first argument to the subcommand.
-.sp
-The subcommand takes no inputs from \fBstdin\fP or other subcommands.
-.sp
-It outputs the signature affirming the addition of the wire account,
-in a format suitable for the \fBupload\fP subcommand.
-.SS disable\-account
-.sp
-This subcommand
-informs an exchange that it should stop advertising a bank account as
-belonging to the exchange on its \fB/wire\fP endpoint.
-.sp
-The \fBpayto://\fP URI (RFC 8905) of the exchange’s (former) bank account must be
-given as the first argument to the subcommand.
-.sp
-The subcommand takes no inputs from \fBstdin\fP or other subcommands.
-.sp
-It outputs the signature affirming the deletion of the wire account, in a
-format suitable for the \fBupload\fP subcommand.
-.SS wire\-fee
-.sp
-This subcommand informs an exchange about the desired wire fee (and closing fee)
-structure for particular wire method and a calendar year (!). The tool does not
-permit changing wire fees during a calendar year. Also, once the wire fee has been
-set for a calendar year, it cannot be changed.
-.sp
-The subcommand takes the year, wire\-method (see RFC 8905, examples include
-\fBx\-taler\-bank\fP or \fBiban\fP), wire fee and closing fee as arguments.
-Instead of a year, the string \fBnow\fP can be given for the current year
-(this is mostly useful for test cases). The wire\-method should follow the
-GANA registry as given in RFC 8905. The fees must be given in the usual
-Taler format of \fBCURRENCY:NUMBER.FRACTION\fP\&.
-.sp
-The subcommand takes no inputs from \fBstdin\fP or other subcommands.
-.sp
-It outputs the signature affirming the wire fees, in a format suitable for the
-\fBupload\fP subcommand.
.SS upload
.sp
This subcommand uploads outputs from other subcommands (except \fBdownload\fP and \fBshow\fP)
@@ -342,6 +233,6 @@ mail to <\fI\%taler@gnu.org\fP>.
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
-2014-2020 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+2014-2021 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.