summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2018-11-03 21:28:52 +0100
committerChristian Grothoff <christian@grothoff.org>2018-11-03 21:28:52 +0100
commitebc8ae68bee955d8df658afac85c9a0cbea716d0 (patch)
tree19c8aa82affcd5fe098d72226ab87b51728249eb /doc
parenta57080651d9666c8d3d2acc8e872178b7022a7b0 (diff)
downloadexchange-ebc8ae68bee955d8df658afac85c9a0cbea716d0.tar.gz
exchange-ebc8ae68bee955d8df658afac85c9a0cbea716d0.tar.bz2
exchange-ebc8ae68bee955d8df658afac85c9a0cbea716d0.zip
implement taler-auditor-exchange
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/taler-auditor-exchange.134
-rw-r--r--doc/taler-auditor-sign.14
3 files changed, 38 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index b3c52716..09793ddc 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,6 +4,7 @@ SUBDIRS = .
man_MANS = \
taler-auditor.1 \
+ taler-auditor-exchange.1 \
taler-auditor-sign.1 \
taler-bank-transfer.1 \
taler-config-generate.1 \
diff --git a/doc/taler-auditor-exchange.1 b/doc/taler-auditor-exchange.1
new file mode 100644
index 00000000..c26cad7d
--- /dev/null
+++ b/doc/taler-auditor-exchange.1
@@ -0,0 +1,34 @@
+.TH TALER\-AUDITOR\-EXCHANGE 1 "Nov 3, 2018" "GNU Taler"
+
+.SH NAME
+taler\-auditor\-exchange \- add or remove exchange from auditor's list
+
+.SH SYNOPSIS
+.B taler\-auditor\-exchange [--remove] -m EXCHANGE_KEY -u EXCHANGE_URL
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBtaler\-auditor\-exchange\fP is a command line tool to be used by an auditor to add or remove an exchange from the list of exchange's audited by the auditor. You must add an exchange to that list before signing denomination keys with taler\-auditor\-sign or trying to audit it with taler\-auditor or taler\-wire\-auditor. Afterwards the exchange will be visible via the /exchanges API of the taler\-auditor\-httpd.
+
+.SH OPTIONS
+.B
+.IP "\-m MASTERKEY, \-\-exchange-key=MASTERKEY"
+Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p.
+.B
+.IP "\-h, \-\-help"
+Print short help on options.
+.B
+.IP "\-u URL, \-\-auditor-url=URL"
+URL of the exchange. The exchange's HTTP API must be available at this address.
+.B
+.IP "\-r, \-\-remove"
+Instead of adding the exchange, remove it. Note that this will drop ALL data associated with that exchange, including existing auditing information. So use with extreme care!
+
+.SH BUGS
+We should optionally verify the correctness of this exchange's base URL and that it matches the master public key (note that the exchange may still be offline, so it should be possible to bypass such a verfication step). Furthermore, if we do verification, as a (less secure) convenience option, we should make \-m optional and obtain it from the base URL.
+
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
+
+.SH "SEE ALSO"
+\fBtaler\-auditor\-sign\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
diff --git a/doc/taler-auditor-sign.1 b/doc/taler-auditor-sign.1
index f0f90a5b..e5883dbc 100644
--- a/doc/taler-auditor-sign.1
+++ b/doc/taler-auditor-sign.1
@@ -11,6 +11,8 @@ taler\-auditor\-sign \- Sign exchange denomination as auditor.
.SH DESCRIPTION
\fBtaler\-auditor\-sign\fP is a command line tool to be used by an auditor to sign that he is aware of certain keys being used by a exchange. Using this signature, the auditor affirms that he will verify that the exchange is properly accounting for those coins.
+The exchange for which keys were signed must have been added to the auditor using taler\-auditor\-exchange first!
+
.SH OPTIONS
.B
.IP "\-a FILE, \-\-auditor-key=FILE"
@@ -35,4 +37,4 @@ File where the auditor should write the EdDSA signature.
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
-\fBtaler\-exchange\-keyup\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
+\fBtaler\-auditor\-exchange\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)