summaryrefslogtreecommitdiff
path: root/manpages/taler-auditor-exchange.1.rst
blob: 51549ec978e1e073e198ba92a3258623ea9126c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
taler-auditor-exchange(1)
##########################

.. only:: html

   Name
   ====

   **taler-auditor-exchange** - add or remove exchange from auditor’s list

Synopsis
========

**taler-auditor-exchange**
[**-h** | **––help**]
[**-r** | **––remove**]
[**-m** *MASTERKEY* | **––exchange-key=**\ ‌\ *MASTERKEY*]
[**-u** *EXCHANGE_URL* | **––auditor-url=**\ ‌\ *EXCHANGE_URL*]

Description
===========

**taler-auditor-exchange** 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.

**-m** *MASTERKEY* \| **––exchange-key=**\ ‌\ *MASTERKEY*
   Public key of the exchange in Crockford base32 encoding, for example
   as generated by gnunet-ecc -p.

**-h** \| **––help**
   Print short help on options.

**-u** *EXCHANGE_URL* \| **––auditor-url=**\ ‌\ *EXCHANGE_URL*
   URL of the exchange. The exchange’s HTTP API must be available at
   this address.

**-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!


Diagnostics
===========

**taler-auditor-exchange** will return 0 on success, 1 on usage errors, 3 on problems interacting with the database backend, 4 if exchange entry to be added is already in the database (or already missing when used with **-r**).


See Also
========

gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5)

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 verification
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 https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.