taler/exchange
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: rewrite.

Browse Source
This commit is contained in:
ng0 2019-05-07 14:34:49 +00:00
parent 6e33de941e
commit 0d8f503543
No known key found for this signature in database
GPG Key ID: E22F9BBFEE348588
8 changed files with 564 additions and 487 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
doc/taler-auditor-exchange.1
View File

@ -1,34 +1,45 @@
.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"
.Dd November 3, 2018
.Dd TALER-AUDITOR-EXCHANGE 1
.Os
.Sh NAME
.Nm taler-auditor-exchange
.Nd
add or remove exchange from auditor's list
.Sh SYNOPSIS
.Nm
.Op Fl h | \-help
.Op Fl r | \-remove
.Op Fl m Ar MASTERKEY | Fl \-exchange-key= Ns Ar MASTERKEY
.Op Fl u Ar EXCHANGE_URL | Fl \-auditor-url= Ns Ar EXCHANGE_URL
.Sh DESCRIPTION
.Nm
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.
.Bl -tag -width Ds
.It Fl m Ar MASTERKEY | Fl \-exchange-key= Ns Ar MASTERKEY
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p.
.It Fl 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)
.It Fl u Ar EXCHANGE_URL | Fl \-auditor-url= Ns Ar EXCHANGE_URL
URL of the exchange.
The exchange's HTTP API must be available at this address.
.It Fl 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 SEE ALSO
.Xr gnunet-ecc 1 ,
.Xr taler-auditor-sign 1 ,
.Xr taler.conf 5
.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
.Fl
m
optional and obtain it from the base URL.
.Pp
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org .

80
doc/taler-auditor-sign.1
View File

@ -1,40 +1,46 @@
.TH TALER\-AUDITOR\-SIGN 1 "Mar 15, 2016" "GNU Taler"
.SH NAME
taler\-auditor\-sign \- Sign exchange denomination as auditor.
.SH SYNOPSIS
.B taler\-auditor\-sign
.RI [ options ]
.br
.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.
.Dd
.Dt TALER\-AUDITOR\-SIGN 1 "Mar 15, 2016" "GNU Taler"
.Os
.Sh NAME
.Nm taler\-auditor\-sign
.Nd
Sign exchange denomination as auditor.
.Sh SYNOPSIS
.Nm
.Op Fl a Ar FILE | Fl \-auditor-key= Ns Ar FILE
.Op Fl h | \-help
.Op Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY
.Op Fl u Ar URL | Fl \-auditor-url= Ns Ar URL
.Op Fl r Ar FILE | Fl \-exchange-request= Ns Ar FILE
.Op Fl o Ar FILE | Fl \-output= Ns Ar FILE
.Sh DESCRIPTION
.Nm
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.
.Pp
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"
Location of the private EdDSA auditor key. If it does not exist, it will be created.
.B
.IP "\-h, \-\-help"
.Bl -tag -width Ds
.It Fl a Ar FILE | Fl \-auditor-key= Ns Ar FILE
Location of the private EdDSA auditor key.
If it does not exist, it will be created.
.It Fl h | \-help
Print short help on options.
.B
.IP "\-m KEY, \-\-exchange-key=KEY"
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p.
.B
.IP "\-u URL, \-\-auditor-url=URL"
URL of the auditor. Provides informative link for the user to learn more about the auditor.
.B
.IP "\-r FILE, \-\-exchange-request=FILE"
File with the exchange's denomination key signing request as generated by taler\-exchange\-keyup \-o.
.B
.IP "\-o FILE, \-\-output=FILE"
.It Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p.
.It Fl u Ar URL | Fl \-auditor-url= Ns Ar URL
URL of the auditor.
Provides informative link for the user to learn more about the auditor.
.It Fl r Ar FILE | Fl \-exchange-request= Ns Ar FILE
File with the exchange's denomination key signing request as generated by taler-exchange-keyup -o.
.It Fl o Ar FILE | Fl \-output= Ns Ar FILE
File where the auditor should write the EdDSA signature.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-auditor\-exchange\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
.Sh SEE ALSO
.Xr gnunet-ecc 1 ,
.Xr taler-auditor-exchange 1 ,
.Xr taler-exchange-keyup 1 ,
.Xr taler.conf 5
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org .

70
doc/taler-auditor.1
View File

@ -1,29 +1,43 @@
.TH TALER\-AUDITOR 1 "Mar 20, 2017" "GNU Taler"
.SH NAME
taler\-auditor \- Audit exchange.
.SH SYNOPSIS
.B taler\-auditor -m MASTER_KEY
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-auditor\fP is a command line tool to be used by an auditor to audit an exchange's database and calculate the current financial state of the exchange (including revenue, amount expected in escrow and risk exposure). The audit is incremental. The first audit must be performed with the \-r option to initialize the tables. The tool reports inconsistencies in the balance or incorrect cryptographic signatures found in the database. It does NOT check with the bank to see that the incoming and outgoing wire transfers that the bank claims to have matches the exchange's database.
.SH OPTIONS
.B
.IP "\-h, \-\-help"
.Dd March 20, 2017
.Dt TALER-AUDITOR 1
.Os
.Sh NAME
.Nm taler-auditor
.Nd
Audit exchange
.Sh SYNOPSIS
.Nm
.Op Fl h | \-help
.Op Fl m Ar MASTER_KEY | Fl \-exchange-key= Ns Ar MASTER_KEY
.Op Fl r | \-reset
.Sh DESCRIPTION
.Nm
is a command line tool to be used by an auditor to audit an exchange's database and calculate the current financial state of the exchange (including revenue, amount expected in escrow and risk exposure).
The audit is incremental.
The first audit must be performed with the
.Fl r
option to initialize the tables.
The tool reports inconsistencies in the balance or incorrect cryptographic signatures found in the database.
It does NOT check with the bank to see that the incoming and outgoing wire transfers that the bank claims to have matches the exchange's database.
Its options are as follows.
.Bl -tag -wdith Ds
.It Fl h | \-help
Print short help on options.
.B
.IP "\-m KEY, \-\-exchange-key=KEY"
Public master key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p. If this option is missing, taler\-auditor will use the MASTER_PUBLIC_KEY value from the "exchange" section of the configuration.
.B
.IP "\-r, \-\-reset"
Reset the audit, starts everything from the beginning. Useful for testing and required for the first audit to setup auditor's tables. Note that if (just) the exchange key changes, the \-r option should not be used again.
.SH BUGS
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)
.It Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY
Public master key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p.
If this option is missing, taler-auditor will use the MASTER_PUBLIC_KEY value from the "exchange" section of the configuration.
.It Fl r | \-reset
Reset the audit, starts everything from the beginning.
Useful for testing and required for the first audit to setup auditor's tables.
Note that if (just) the exchange key changes, the
.Fl r
option should not be used again.
.Sh SEE ALSO
.Xr gnunet-ecc 1 ,
.Xr taler-auditor-sign 1 ,
.Xr taler.conf 5
.Sh BUGS
Report bugs by using
.Lk https://bugs.gnunet.org
or by sending electronic mail to
.Aq Mt taler@gnu.org .

91
doc/taler-bank-transfer.1
View File

@ -1,50 +1,55 @@
.TH TALER\-BANK\-TRANSFER 1 "Dec 14, 2017" "GNU Taler"
.SH NAME
taler\-bank\-transfer \- Trigger a transfer at the bank
.SH SYNOPSIS
.B taler\-bank\-transfer
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-bank\-transfer\fP is a command line tool to trigger bank transfers.
.SH OPTIONS
.B
.IP "\-a VALUE, \-\-amount=VALUE"
Amount to transfer. Given in the Taler\-typical format of CURRENCY:VALUE.FRACTION
.B
.IP "\-b URL, \-\-bank=URL"
.Dd December 14, 2017
.Dt TALER-BANK-TRANSFER 1
.Os
.Sh NAME
.Nm taler-bank-transfer
.Nd
trigger a transfer at the bank
.Sh SYNOPSIS
.Nm
.Op Fl a Ar VALUE | Fl \-amount= Ns Ar VALUE
.Op Fl b Ar URL | Fl \-bank= Ns Ar URL
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
.Op Fl h | \-help
.Op Fl D Ar ACCOUNT | Fl \-debit= Ns Ar ACCOUNT
.Op Fl C Ar ACCOUNT | Fl \-credit= Ns Ar ACCOUNT
.Op Fl s Ar STRING | Fl \-subject= Ns Ar STRING
.Op Fl u Ar USERNAME | Fl \-user= Ns Ar USERNAME
.Op Fl p Ar PASSPHRASE | Fl \-pass= Ns Ar PASSPHRASE
.Op Fl v | \-version
.Sh DESCRIPTION
.Nm
is a command line tool to trigger bank transfers.
.Bl -tag -width Ds
.It Fl a Ar VALUE | Fl \-amount= Ns Ar VALUE
Amount to transfer.
Given in the Taler\-typical format of CURRENCY:VALUE.FRACTION
.It Fl b Ar URL | Fl \-bank= Ns Ar URL
URL at which the bank is operation.
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Use the given configuration file.
.B
.IP "\-h, \-\-help"
.It Fl h | \-help
Print short help on options.
.B
.IP "\-D ACCOUNT, \-\-debit=ACCOUNT"
The money should be debited from ACCOUNT. Specifies the number of the account.
.B
.IP "\-C ACCOUNT, \-\-credit=ACCOUNT"
The money should be credited to ACCOUNT. Specifies the number of the account.
.B
.IP "\-s STRING, \-\-subject=STRING"
.It Fl D Ar ACCOUNT | Fl \-debit= Ns Ar ACCOUNT
The money should be debited from ACCOUNT.
Specifies the number of the account.
.It Fl C Ar ACCOUNT | Fl \-credit= Ns Ar ACCOUNT
The money should be credited to ACCOUNT.
Specifies the number of the account.
.It Fl s Ar STRING | Fl \-subject= Ns Ar STRING
Use STRING for the wire transfer subject.
.B
.IP "\-u USERNAME, \-\-user=USERNAME"
.It Fl u Ar USERNAME | Fl \-user= Ns Ar USERNAME
Specifies the username for authentication.
.B
.IP "\-p PASSPHRASE, \-\-pass=PASSPHRASE"
.It Fl p Ar PASSPHRASE | Fl \-pass= Ns Ar PASSPHRASE
Specifies the pass phrase for authentication.
.B
.IP "\-v, \-\-version"
.It Fl v | \-version
Print version information.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-bank\-manage\fP(1), \fBtaler.conf\fP(5)
.El
.Sh SEE ALSO
.Xr taler-bank-manage 1 ,
.Xr taler.conf 5
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org

119
doc/taler-config-generate.1
View File

@ -1,63 +1,74 @@
.TH TALER\-CONFIG\-GENERATE 1 "May 5, 2016" "GNU Taler"
.SH NAME
taler\-config\-generate \- tool to simplify Taler configuration generation
.SH SYNOPSIS
.B taler\-config\-generate
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-config\-generate\fP can be used to generate configuration files for the Taler exchange or Taler merchants
.SH OPTIONS
.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Location where to write the generated configuration. Existing file will be updated, not overwritten.
.B
.IP "\-C CURRENCY, \-\-currency=CURRENCY"
.Dd May 5, 2016
.Dt TALER-CONFIG-GENERATE 1
.Os
.Sh NAME
.Nm taler-config-generate
.Nd
tool to simplify Taler configuration generation
.Os
.Sh SYNOPSIS
.Nm
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
.Op Fl C Ar CURRENCY | Fl \-currency= Ns Ar CURRENCY
.Op Fl e | \-exchange
.Op Fl f Ar AMOUNT | \-wirefee= Ns Ar AMOUNT
.Op Fl m | \-merchant
.Op Fl t | \-trusted
.Op Fl w Ar WIREFORMAT | Fl \-wire Ar WIREFORMAT
.Op Fl j Ar JSON | Fl \-wire-json-merchant= Ns Ar JSON
.Op Fl J Ar JSON | Fl \-wire-json-exchange= Ns Ar JSON
.Op Fl \-bank-uri
.Op Fl \-exchange-bank-account
.Op Fl \-merchant-bank-account
.Op Fl h | \-help
.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
.Op Fl v | \-version
.Sh DESCRIPTION
.Nm
can be used to generate configuration files for the Taler exchange or Taler merchants.
.Bl -tag -width Ds
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
Location where to write the generated configuration.
Existing file will be updated, not overwritten.
.It Fl C Ar CURRENCY | Fl \-currency= Ns Ar CURRENCY
Which currency should we use in the configuration.
.B
.IP "\-e, \-\-exchange"
.It Fl e | \-exchange
Generate configuration for a Taler exchange.
.B
.IP "\-f AMOUNT, \-\-wirefee=AMOUNT"
.It Fl f Ar AMOUNT | \-wirefee= Ns Ar AMOUNT
Setup wire transfer fees for the next 5 years for the exchange (for all wire methods).
.B
.IP "\-m, \-\-merchant"
.It Fl m | \-merchant
Generate configuration for a Taler merchant.
.B
.IP "\-t, \-\-trusted"
Setup current exchange as trusted with current merchant. Generally only useful when configuring for testcases.
.B
.IP "\-w WIREFORMAT, \-\-wire WIREFORMAT"
.It Fl t | \-trusted
Setup current exchange as trusted with current merchant.
Generally only useful when configuring for testcases.
.It Fl w Ar WIREFORMAT | Fl \-wire Ar WIREFORMAT
Specifies which wire format to use (i.e. "test" or "sepa")
.B
.IP "\-j JSON, \-\-wire-json-merchant=JSON"
.It Fl j Ar JSON | Fl \-wire-json-merchant= Ns Ar JSON
Wire configuration to use for the merchant.
.B
.IP "\-J JSON, \-\-wire-json-exchange=JSON"
.It Fl J Ar JSON | Fl \-wire-json-exchange= Ns Ar JSON
Wire configuration to use for the exchange.
.B
.IP "\-\-bank-uri"
Alternative to specify wire configuration to use for the exchange and merchant for the "test" wire method. Only useful if WIREFORMAT was set to "test". Specifies the URI of the bank.
.B
.IP "\-\-exchange-bank-account"
Alternative to specify wire configuration to use for the exchange for the "test" wire method. Only useful if WIREFORMAT was set to "test". Specifies the bank account number of the exchange.
.B
.IP "\-\-merchant-bank-account"
Alternative to specify wire configuration to use for the merchant for the "test" wire method. Only useful if WIREFORMAT was set to "test". Specifies the bank account number of the merchant.
.B
.IP "\-h, \-\-help"
.It Fl \-bank-uri
Alternative to specify wire configuration to use for the exchange and merchant for the "test" wire method.
Only useful if WIREFORMAT was set to "test".
Specifies the URI of the bank.
.It Fl \-exchange-bank-account
Alternative to specify wire configuration to use for the exchange for the "test" wire method.
Only useful if WIREFORMAT was set to "test".
Specifies the bank account number of the exchange.
.It Fl \-merchant-bank-account
Alternative to specify wire configuration to use for the merchant for the "test" wire method.
Only useful if WIREFORMAT was set to "test".
Specifies the bank account number of the merchant.
.It Fl h | \-help
Shows this man page.
.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
.B
.IP "\-v, \-\-version"
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
.It Fl v | \-version
Print GNUnet version number.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
.El
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org .

63
doc/taler-exchange-aggregator.1
View File

@ -1,32 +1,37 @@
.TH TALER\-EXCHANGE\-AGGREGATOR 1 "Mar 30, 2016" "GNU Taler"
.SH NAME
taler\-exchange\-aggregator \- Aggregate and execute exchange transactions
.SH SYNOPSIS
.B taler\-exchange\-aggregator
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-exchange\-aggregator\fP is a command line tool to run pending transactions from the Taler exchange.
.SH OPTIONS
.B
.IP "\-d DIRNAME, \-\-exchange-dir=DIRNAME"
Use the configuration and other resources for the exchange to operate from DIRNAME.
.B
.IP "\-h, \-\-help"
.Dd Mar 30, 2016
.Dt TALER-EXCHANGE-AGGREGATOR 1
.Os
.Sh NAME
.Nm taler-exchange-aggregator
.Nd
Aggregate and execute exchange transactions
.Sh SYNOPSIS
.Nm
.Op Fl d Ar DIRNAME | Fl \-exchange-dir= Ns Ar DIRNAME
.Op Fl h | \-help
.Op Fl t | \-test
.Op Fl v | \-version
.Sh DESCRIPTION
.Nm
is a command line tool to run pending transactions from the Taler exchange.
.Bl -tag -width Ds
.It Fl d Ar DIRNAME | Fl \-exchange-dir= Ns Ar DIRNAME
Use the configuration and other resources for the exchange to operate from
.Ar DIRNAME .
.It Fl h | \-help
Print short help on options.
.B
.IP "\-t, \-\-test"
.It Fl t | \-test
Run in test mode and exit when idle.
.B
.IP "\-v, \-\-version"
.It Fl v | \-version
Print version information.
.B
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-httpd\fP(1), \fBtaler.conf\fP(5)
.El
.Sh SEE ALSO
.Xr taler-exchange-dbinit 1 ,
.Xr taler-exchange-keyup 1 ,
.Xr taler-exchange-httpd 1 ,
.Xr taler.conf 5 .
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org .

79
doc/taler-exchange-benchmark.1
View File

@ -1,41 +1,44 @@
.TH TALER\-EXCHANGE\-BENCHMARK 1 "Jul 25, 2018" "GNU Taler"
.SH NAME
taler\-exchange\-benchmark \- Measure exchange performance.
.SH SYNOPSIS
.B taler\-exchange\-benchmark
.RI [ options ]
.br
.SH DESCRIPTION
\fBtaler\-exchange\-benchmark\fP is a command line tool to measure the time spent to serve withdrawals/deposits/refreshes. It usually needs a dedicate configuration file where all the services - the exchange and the (fake)bank - listen to URLs not subject to any reverse proxy, as say Nginx. Moreover, the benchmark runs on a "volatile" database, that means that table are always erased during a single benchmark run.
.SH OPTIONS
.B
.IP "\-c CONFIG_FILENAME, \-\-config=CONFIG_FILENAME"
.Dd July 25, 2018
.Dt TALER-EXCHANGE-BENCHMARK 1
.Os
.Sh NAME
.Nm taler-exchange-benchmark
.Nd
Measure exchange performance
.Sh SYNOPSIS
.Nm
.Op Fl c Ar CONFIG_FILENAME | Fl \-config= Ns Ar CONFIG_FILENAME
.Op Fl b Ar BANK_URL | Fl --bank-url= Ns Ar BANK_URL
.Op Fl n Ar HOWMANY_COINS | Fl \-coins-number= Ns Ar HOWMANY_COINS
.Op Fl l Ar LOGLEVEL | Fl \-log\-level= Ns Ar LOGLEVEL
.Op Fl h | \-help
.Sh DESCRIPTION
.Nm
is a command line tool to measure the time spent to serve withdrawals/deposits/refreshes.
It usually needs a dedicate configuration file where all the services - the exchange and the (fake)bank - listen to URLs not subject to any reverse proxy, as say Nginx.
Moreover, the benchmark runs on a "volatile" database, that means that table are always erased during a single benchmark run.
.Bl -tag -width Ds
.It Fl c Ar CONFIG_FILENAME | Fl \-config= Ns Ar CONFIG_FILENAME
(Mandatory) Use CONFIG_FILENAME.
.B
.IP "\-b BANK_URL, --bank-url=BANK_URL"
(Mandatory) The URL where the fakebank listens at. Must match the host component in the exchange's escrow account "payto" URL.
.B
.IP "\-n HOWMANY_COINS, \-\-coins-number=HOWMANY_COINS"
Defaults to 1. Specifies how many coins this benchmark should withdraw and spend. After being spent, each coin will be refreshed with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1; future versions of this tool should offer this parameter as a CLI option.
.B
.IP "\-l LOGLEVEL, \-\-log\-level=LOGLEVEL"
.It Fl b Ar BANK_URL | Fl --bank-url= Ns Ar BANK_URL
(Mandatory) The URL where the fakebank listens at.
Must match the host component in the exchange's escrow account "payto" URL.
.It Fl n Ar HOWMANY_COINS | Fl \-coins-number= Ns Ar HOWMANY_COINS
Defaults to 1.
Specifies how many coins this benchmark should withdraw and spend.
After being spent, each coin will be refreshed with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1; future versions of this tool should offer this parameter as a CLI option.
.It Fl l Ar LOGLEVEL | Fl \-log\-level= Ns Ar LOGLEVEL
GNUnet-compatible log level, takes values "ERROR/WARNING/INFO/DEBUG"
.B
.IP "\-h, \-\-help"
.It Fl h | \-help
Prints a compiled-in help text.
.B
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-httpd\fP(1), \fBtaler.conf\fP(5)
.El
.Sh SEE ALSO
.Xr taler-exchange-dbinit 1 ,
.Xr taler-exchange-keyup 1 ,
.Xr taler-exchange-httpd 1 ,
.Xr taler.conf 5
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org .

406
doc/taler.conf.5
View File

@ -1,226 +1,248 @@
.TH TALER.CONF 5 "Mar 20, 2018" "GNU Taler"
.SH NAME
taler.conf \- Taler configuration file.
.SH SYNOPSIS
.B taler.conf
.SH DESCRIPTION
The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments. Files containing default values for many of the options described below are installed under $TALER\_PREFIX/share/taler/config.d/. The configuration file given with \-c to Taler binaries overrides these defaults.
.SH GLOBAL OPTIONS
.\" -*- mode: nroff -*-
.Dd March 20, 2018
.Dt TALER.CONF 5
.Os
.Sh NAME
.Nm taler.conf
.Nd
Taler configuration file.
.Sh DESCRIPTION
The basic structure of the configuration file is the following.
The file is split into sections.
Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE".
Empty lines and lines beginning with a "#" are treated as comments.
Files containing default values for many of the options described below are installed under $TALER\_PREFIX/share/taler/config.d/.
The configuration file given with
.Fl c
to Taler binaries overrides these defaults.
.Ss GLOBAL OPTIONS
The following options are from the "[taler]" section and used by virtually all Taler components.
.IP CURRENCY
.Bl -tag -width Ds
.It CURRENCY
Name of the currency, i.e. "EUR" for Euro.
The "[PATHS]" section is special in that it contains paths that can be referenced using "$" in other configuration values that specify filenames. For Taler, it commonly contains the following paths:
.IP TALER_HOME
Home directory of the user, usually "${HOME}". Can be overwritten by testcases by setting ${TALER_TEST_HOME}.
.IP TALER_DATA_HOME
.El
.Pp
The "[PATHS]" section is special in that it contains paths that can be referenced using "$" in other configuration values that specify filenames.
For Taler, it commonly contains the following paths:
.Bl -tag -width Ds
.It TALER_HOME
Home directory of the user, usually "${HOME}".
Can be overwritten by testcases by setting ${TALER_TEST_HOME}.
.It TALER_DATA_HOME
Where should Taler store its long-term data. Usually "${TALER_HOME}/.local/share/taler/"
.IP TALER_CONFIG_HOME
Where is the Taler configuration kept. Usually "${TALER_HOME}/.config/taler/"
.IP TALER_CACHE_HOME
Where should Taler store cached data. Usually "${TALER_HOME}/.cache/taler/"
.IP TALER_RUNTIME_DIR
Where should Taler store system runtime data (like UNIX domain sockets). Usually "${TMP}/taler-system-runtime".
.SH EXCHANGE OPTIONS
The following options are from the "[exchange]" section and used by most exchange tools:
.IP DB
.It TALER_CONFIG_HOME
Where is the Taler configuration kept.
Usually "${TALER_HOME}/.config/taler/"
.It TALER_CACHE_HOME
Where should Taler store cached data.
Usually "${TALER_HOME}/.cache/taler/"
.It TALER_RUNTIME_DIR
Where should Taler store system runtime data (like UNIX domain sockets).
Usually "${TMP}/taler-system-runtime".
.El
.Ss EXCHANGE OPTIONS
The following options are from the "[exchange]" section and used by most exchange tools.
.Bl -tag -width Ds
.It DB
Plugin to use for the database, i.e. "postgres"
.IP PORT
.It PORT
Port on which the HTTP server listens, i.e. 8080.
.IP MASTER_PUBLIC_KEY
.It MASTER_PUBLIC_KEY
Crockford Base32-encoded master public key, public version of the exchange\'s long\-time offline signing key.
.IP MASTER_PRIV_FILE
Location of the master private key on disk. Only used by tools that can be run offline (as the master key is for offline signing).
.IP BASE_URL
Specifies the base URL under which the exchange can be reached. Added to wire transfers to enable tracking by merchants.
.IP SIGNKEY_DURATION
.It MASTER_PRIV_FILE
Location of the master private key on disk.
Only used by tools that can be run offline (as the master key is for offline signing).
.It BASE_URL
Specifies the base URL under which the exchange can be reached.
Added to wire transfers to enable tracking by merchants.
.It SIGNKEY_DURATION
For how long is a signing key valid?
.IP LEGAL_DURATION
.It LEGAL_DURATION
For how long are signatures with signing keys legally valid?
.IP LOOKAHEAD_SIGN
.It LOOKAHEAD_SIGN
How long do we generate denomination and signing keys ahead of time?
.IP LOOKAHEAD_PROVIDE
.It LOOKAHEAD_PROVIDE
How long into the future do we provide signing and denomination keys to clients?
.SH EXCHANGE POSTGRES BACKEND DATABASE OPTIONS
The following options must be in section "[exchangedb\-postgres]" if the "postgres" plugin was selected for the database:
.IP CONFIG
How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use "talercheck".
.SH MERCHANT OPTIONS
The following options are from the "[merchant]" section and used by the merchant backend:
.IP DB
.El
.Ss EXCHANGE POSTGRES BACKEND DATABASE OPTIONS
The following options must be in section "[exchangedb\-postgres]" if the "postgres" plugin was selected for the database.
.Bl -tag -width Ds
.It CONFIG
How to access the database, i.e. "postgres:///taler" to use the "taler" database.
Testcases use "talercheck".
.El
.Ss MERCHANT OPTIONS
The following options are from the "[merchant]" section and used by the merchant backend.
.Bl -tag -width Ds
.It DB
Plugin to use for the database, i.e. "postgres"
.IP PORT
.It PORT
Port on which the HTTP server listens, i.e. 8080.
.IP WIRE_TRANSFER_DELAY
How quickly do we want the exchange to send us money? Note that wire transfer fees will be higher if we ask for money to be wired often. Given as a relative time, i.e. "5 s"
.IP DEFAULT_MAX_WIRE_FEE
Maximum wire fee we are willing to accept from exchanges. Given as a Taler amount, i.e. "EUR:0.1"
.IP DEFAULT_MAX_DEPOSIT_FEE
Maximum deposit fee we are willing to cover. Given as a Taler amount, i.e. "EUR:0.1"
.SH MERCHANT POSTGRES BACKEND DATABASE OPTIONS
The following options must be in section "[merchantdb\-postgres]" if the "postgres" plugin was selected for the database:
.IP CONFIG
How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use "talercheck".
.SH MERCHANT INSTANCES
The merchant configuration must specify a set of instances, containing at least the "default" instance. The following options must be given in each "[instance-NAME]" section:
.IP KEYFILE
.It WIRE_TRANSFER_DELAY
How quickly do we want the exchange to send us money?
Note that wire transfer fees will be higher if we ask for money to be wired often.
Given as a relative time, i.e. "5 s"
.It DEFAULT_MAX_WIRE_FEE
Maximum wire fee we are willing to accept from exchanges.
Given as a Taler amount, i.e. "EUR:0.1"
.It DEFAULT_MAX_DEPOSIT_FEE
Maximum deposit fee we are willing to cover.
Given as a Taler amount, i.e. "EUR:0.1"
.El
.Ss MERCHANT POSTGRES BACKEND DATABASE OPTIONS
The following options must be in section "[merchantdb\-postgres]" if the "postgres" plugin was selected for the database.
.Bl -tag -width Ds
.It CONFIG
How to access the database, i.e. "postgres:///taler" to use the "taler" database.
Testcases use "talercheck".
.El
.Ss MERCHANT INSTANCES
The merchant configuration must specify a set of instances, containing at least the "default" instance.
The following options must be given in each "[instance-NAME]" section.
.Bl -tag -width Ds
.It KEYFILE
Name of the file where the instance\'s private key is to be stored, i.e. "${TALER_CONFIG_HOME}/merchant/instance/name.priv"
.IP NAME
.It NAME
Human-readable name of the instance, i.e. "Kudos Inc."
Additionally, for instances that support tipping, the following options are required:
.IP TIP_EXCHANGE
.El
Additionally, for instances that support tipping, the following options are required.
.Bl -tag -width Ds
.It TIP_EXCHANGE
Base-URL of the exchange that holds the reserve for tipping, i.e. "https://exchange.demo.taler.net/"
.IP TIP_EXCHANGE_PRIV_FILENAME
.It TIP_EXCHANGE_PRIV_FILENAME
Filename with the private key granting access to the reserve, i.e. "${TALER_CONFIG_HOME}/merchant/reserve/tip.priv"
.SH KNOWN EXCHANGES (for merchants and wallets)
The merchant configuration can include a list of known exchanges if the merchant wants to specify that certain exchanges are explicitly trusted. For each trusted exchange, a section [exchange-NAME] must exist, where NAME is a merchant-given name for the exchange. The following options must be given in each "[exchange-NAME]" section:
.IP BASE_URL
.El
.Ss KNOWN EXCHANGES (for merchants and wallets)
The merchant configuration can include a list of known exchanges if the merchant wants to specify that certain exchanges are explicitly trusted.
For each trusted exchange, a section [exchange-NAME] must exist, where NAME is a merchant-given name for the exchange.
The following options must be given in each "[exchange-NAME]" section.
.Bl -tag -width Ds
.It BASE_URL
Base URL of the exchange, i.e. "https://exchange.demo.taler.net/"
.IP MASTER_KEY
.It MASTER_KEY
Crockford Base32 encoded master public key, public version of the exchange\'s long\-time offline signing key
.IP CURRENCY
.It CURRENCY
Name of the currency for which this exchange is trusted, i.e. "KUDOS"
.SH KNOWN AUDITORS (for merchants and wallets)
The merchant configuration can include a list of known exchanges if the merchant wants to specify that certain auditors are explicitly trusted. For each trusted exchange, a section [auditor-NAME] must exist, where NAME is a merchant-given name for the exchange. The following options must be given in each "[auditor-NAME]" section:
.IP BASE_URL
.El
.Ss KNOWN AUDITORS (for merchants and wallets)
The merchant configuration can include a list of known exchanges if the merchant wants to specify that certain auditors are explicitly trusted.
For each trusted exchange, a section [auditor-NAME] must exist, where NAME is a merchant-given name for the exchange.
The following options must be given in each "[auditor-NAME]" section.
.Bl -tag -width Ds
.It BASE_URL
Base URL of the auditor, i.e. "https://auditor.demo.taler.net/"
.IP AUDITOR_KEY
.It AUDITOR_KEY
Crockford Base32 encoded auditor public key.
.IP CURRENCY
.It CURRENCY
Name of the currency for which this auditor is trusted, i.e. "KUDOS"
.SH ACCOUNT OPTIONS (for exchanges and merchants)
An exchange (or merchant) can have multiple bank accounts. The following options are for sections named "[account-SOMETHING]". The SOMETHING is arbitrary and should be chosen to uniquely identify the bank account for the operator. Additional authentication options may need to be specified in the account section depending on the PLUGIN used.
.IP URL
Specifies the payto://-URL of the account. The general format is payto://METHOD/DETAILS. This option is used for exchanges and merchants.
.IP WIRE_RESPONSE
Specifies the name of the file in which the /wire response for this account should be located. Used by the Taler exchange service and the taler\-exchange\-wire tool and the taler\-merchant\-httpd (to generate the files).
.IP PLUGIN
Name of the plugin can be used to access the account (i.e. "taler-bank" or "ebics"). Used by the merchant backend for back office operations (i.e. to identify incoming wire transfers) and by the exchange.
.IP ENABLE_DEBIT
Must be set to YES for the accounts that the taler\-exchange\-aggregator should debit. Not used by merchants.
.IP ENABLE_CREDIT
Must be set to YES for the accounts that the taler\-exchange\-wirewatch should check for credits. (It is yet uncertain if the merchant implementation may check this flag as well.)
.IP HONOR_instance
.El
.Ss ACCOUNT OPTIONS (for exchanges and merchants)
An exchange (or merchant) can have multiple bank accounts.
The following options are for sections named "[account-SOMETHING]".
The SOMETHING is arbitrary and should be chosen to uniquely identify the bank account for the operator.
Additional authentication options may need to be specified in the account section depending on the PLUGIN used.
.Bl -tag -width Ds
.It URL
Specifies the payto://-URL of the account.
The general format is payto://METHOD/DETAILS.
This option is used for exchanges and merchants.
.It WIRE_RESPONSE
Specifies the name of the file in which the /wire response for this account should be located.
Used by the Taler exchange service and the taler\-exchange\-wire tool and the taler\-merchant\-httpd (to generate the files).
.It PLUGIN
Name of the plugin can be used to access the account (i.e. "taler-bank" or "ebics").
Used by the merchant backend for back office operations (i.e. to identify incoming wire transfers) and by the exchange.
.It ENABLE_DEBIT
Must be set to YES for the accounts that the taler\-exchange\-aggregator should debit.
Not used by merchants.
.It ENABLE_CREDIT
Must be set to YES for the accounts that the taler\-exchange\-wirewatch should check for credits.
It is yet uncertain if the merchant implementation may check this flag as well.
.It HONOR_instance
Must be set to YES for the instances (where "instance" is the section name of the instance) of the merchant backend that should allow incoming wire transfers for this bank account.
.IP ACTIVE_instance
Must be set to YES for the instances (where "instance" is the section name of the instance) of the merchant backend that should use this bank account in new offers/contracts. Setting ACTIVE_instance to YES requires also setting ENABLE_instance to YES.
.SH TALER-BANK AUTHENTICATION OPTIONS (for accounts)
The following authentication options are supported by the "taler-bank" wire plugin. They must be specified in the "[account-]" section that uses the "taler-bank" plugin.
.IP TALER_BANK_AUTH_METHOD
Authentication method to use. "none" or "basic" are currently supported.
.IP USERNAME
Username to use for authentication. Used with the "basic" authentication method.
.IP PASSWORD
Password to use for authentication. Used with the "basic" authentication method.
.SH EBICS AUTHENTICATION OPTIONS
The following authentication options are supported by the "ebics" wire plugin. They must be specified in the "[account-]" section that uses the "ebics" plugin.
.IP NONE
.It ACTIVE_instance
Must be set to YES for the instances (where "instance" is the section name of the instance) of the merchant backend that should use this bank account in new offers/contracts.
Setting ACTIVE_instance to YES requires also setting ENABLE_instance to YES.
.El
.Ss TALER-BANK AUTHENTICATION OPTIONS (for accounts)
The following authentication options are supported by the "taler-bank" wire plugin.
They must be specified in the "[account-]" section that uses the "taler-bank" plugin.
.Bl -tag -width Ds
.It TALER_BANK_AUTH_METHOD
Authentication method to use.
"none" or "basic" are currently supported.
.It USERNAME
Username to use for authentication.
Used with the "basic" authentication method.
.It PASSWORD
Password to use for authentication.
Used with the "basic" authentication method.
.Ss EBICS AUTHENTICATION OPTIONS
The following authentication options are supported by the "ebics" wire plugin.
They must be specified in the "[account-]" section that uses the "ebics" plugin.
.Bl -tag -width Ds
.It NONE
Currently the "ebics" implementation is incomplete and does not support authentication.
.SH EXCHANGE WIRE FEE OPTIONS
For each supported wire method (i.e. "x-taler-bank" or "sepa"), sections named "[fees-METHOD]" state the (aggregate) wire transfer fee and the reserve closing fees charged by the exchange. Note that fees are specified using the name of the wire method, not by the plugin name. You need to replace "YEAR" in the option name by the calendar year for which the fee should apply. Usually, fees should be given for serveral years in advance.
.IP WIRE-FEE-YEAR
Aggregate wire transfer fee merchants are charged in YEAR. Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
.IP CLOSING-FEE-YEAR
Reserve closing fee customers are charged in YEAR. Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
.SH EXCHANGE COIN OPTIONS
The following options must be in sections starting with "[coin_]" and are used by taler\-exchange\-keyup to create denomination keys:
.IP VALUE
.El
.Ss EXCHANGE WIRE FEE OPTIONS
For each supported wire method (i.e. "x-taler-bank" or "sepa"), sections named "[fees-METHOD]" state the (aggregate) wire transfer fee and the reserve closing fees charged by the exchange.
Note that fees are specified using the name of the wire method, not by the plugin name.
You need to replace "YEAR" in the option name by the calendar year for which the fee should apply.
Usually, fees should be given for serveral years in advance.
.Bl -tag -width Ds
.It WIRE-FEE-YEAR
Aggregate wire transfer fee merchants are charged in YEAR.
Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
.It CLOSING-FEE-YEAR
Reserve closing fee customers are charged in YEAR.
Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
.El
.Ss EXCHANGE COIN OPTIONS
The following options must be in sections starting with "[coin_]" and are used by taler\-exchange\-keyup to create denomination keys.
.Bl -tag -width Ds
.It VALUE
Value of the coin, i.e. "EUR:1.50" for 1 Euro and 50 Cents (per coin).
.IP DURATION_OVERLAP
.It DURATION_OVERLAP
How much should validity periods for these coins overlap?
.IP DURATION_WITHDRAW
.It DURATION_WITHDRAW
How long should the same key be used for clients to withdraw coins of this value?
.IP DURATION_SPEND
.It DURATION_SPEND
How long do clients have to spend these coins?
.IP FEE_WITHDRAW
.It FEE_WITHDRAW
What fee is charged for withdrawl?
.IP FEE_DEPOSIT
.It FEE_DEPOSIT
What fee is charged for depositing?
.IP FEE_REFRESH
.It FEE_REFRESH
What fee is charged for refreshing?
.IP FEE_REFUND
What fee is charged for refunds? When a coin is refunded, the deposit fee is returned. Instead, the refund fee is charged to the customer.
.IP RSA_KEYSIZE
.It FEE_REFUND
What fee is charged for refunds?
When a coin is refunded, the deposit fee is returned.
Instead, the refund fee is charged to the customer.
.It RSA_KEYSIZE
What is the RSA keysize modulos (in bits)?
.SH AUDITOR OPTIONS
The following options must be in section "[auditor]" for the Taler auditor:
.IP DB
.El
.Ss AUDITOR OPTIONS
The following options must be in section "[auditor]" for the Taler auditor.
.Bl -tag -width Ds
.It DB
Plugin to use for the database, i.e. "postgres"
.IP AUDITOR_PRIV_FILE
.It AUDITOR_PRIV_FILE
Name of the file containing the auditor's private key
.SH AUDITOR POSTGRES BACKEND DATABASE OPTIONS
The following options must be in section "[auditordb\-postgres]" if the "postgres" plugin was selected for the database:
.IP CONFIG
How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use "talercheck".
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
.SH "SEE ALSO"
\fBtaler\-exchange\-httpd\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-wire(1)
.El
.Ss AUDITOR POSTGRES BACKEND DATABASE OPTIONS
The following options must be in section "[auditordb\-postgres]" if the "postgres" plugin was selected for the database.
.Bl -tag -width Ds
.It CONFIG
How to access the database, i.e. "postgres:///taler" to use the "taler" database.
Testcases use "talercheck".
.El
.Sh SEE ALSO
.Xr taler-exchange-dbinit 1 ,
.Xr taler-exchange-httpd 1 ,
.Xr taler-exchange-keyup 1 ,
.Xr taler-exchange-wire 1 .
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs/
or by sending electronic mail to
.Aq Mt taler@gnu.org .