path: root/man/taler.conf.5

.\" Man page generated from reStructuredText.
.
.TH "TALER.CONF" "5" "Aug 08, 2021" "0.8" "GNU Taler"
.SH NAME
taler.conf \- Taler configuration file
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
The configuration file is line\-oriented.
Blank lines and whitespace at the beginning and end of a line are ignored.
Comments start with \fB#\fP or \fB%\fP in the first column
(after any beginning\-of\-line whitespace) and go to the end of the line.
.sp
The file is split into sections.
Every section begins with “[SECTIONNAME]” and
contains a number of options of the form “OPTION=VALUE”.
There may be whitespace around the \fB=\fP (equal sign).
Section names and options are \fIcase\-insensitive\fP\&.
.sp
The values, however, are \fIcase\-sensitive\fP\&.
In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&.
Values can include whitespace by surrounding
the entire value with \fB"\fP (double quote).
Note, however, that there are no escape characters in such strings;
all characters between the double quotes (including other double quotes)
are taken verbatim.
.sp
Values that represent filenames can begin with a \fB/bin/sh\fP\-like
variable reference.
This can be simple, such as \fB$TMPDIR/foo\fP, or complex,
such as \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&.
See \fB[PATHS]\fP (below).
.sp
Values that represent a time duration are represented as a series of one or
more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP, \fB5 years 2 minutes\fP\&.
.sp
Values that represent an amount are in the usual amount syntax:
\fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&.
The \fBFRACTION\fP portion may extend up to 8 places.
.sp
Files containing default values for many of the options described below
are installed under \fB$TALER_PREFIX/share/taler/config.d/\fP\&.
The configuration file given with \fB\-c\fP to Taler binaries
overrides these defaults.
.sp
A configuration file may include another, by using the \fB@INLINE@\fP directive,
for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to
include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&.
.sp
Be extra careful when using \fBtaler\-config \-V VALUE\fP to change configuration
values: it will destroy all uses of \fB@INLINE@\fP and furthermore remove all
comments from the configuration file!
.SS GLOBAL OPTIONS
.sp
The following options are from the “[taler]” section and used by
virtually all Taler components.
.INDENT 0.0
.TP
.B CURRENCY
Name of the currency, e.g.\ “EUR” for Euro.
.UNINDENT
.sp
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:
.INDENT 0.0
.TP
.B TALER_HOME
Home directory of the user, usually “${HOME}”. Can be overwritten by
testcases by setting ${TALER_TEST_HOME}.
.TP
.B TALER_DATA_HOME
Where should Taler store its long\-term data.
Usually “${TALER_HOME}/.local/share/taler/”.
.TP
.B TALER_CONFIG_HOME
Where is the Taler configuration kept.
Usually “${TALER_HOME}/.config/taler/”.
.TP
.B TALER_CACHE_HOME
Where should Taler store cached data.
Usually “${TALER_HOME}/.cache/taler/”.
.TP
.B TALER_RUNTIME_DIR
Where should Taler store system runtime data (like UNIX domain
sockets). Usually “${TMP}/taler\-system\-runtime”.
.UNINDENT
.SS EXCHANGE OPTIONS
.sp
The following options are from the “[exchange]” section and used by most
exchange tools.
.INDENT 0.0
.TP
.B DB
Plugin to use for the database, e.g.\ “postgres”.
.TP
.B PORT
Port on which the HTTP server listens, e.g.\ 8080.
.TP
.B MASTER_PUBLIC_KEY
Crockford Base32\-encoded master public key, public version of the
exchange\(aqs long\-time offline signing key.
.TP
.B 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).
.TP
.B BASE_URL
The base URL under which the exchange can be reached.
Added to wire transfers to enable tracking by merchants.
.TP
.B AGGREGATOR_IDLE_SLEEP_INTERVAL
For how long should the aggregator sleep when it is idle
before trying to look for more work? Default is 60 seconds.
.TP
.B SIGNKEY_LEGAL_DURATION
For how long are signatures with signing keys legally valid?
.TP
.B MAX_KEYS_CACHING
For how long should clients cache \fB/keys\fP responses at most?
.TP
.B TERMS_DIR
Directory where the terms of service of the exchange operator can be fund.
The directory must contain sub\-directories for every supported language,
using the two\-character language code in lower case, e.g. "en/" or "fr/".
Each subdirectory must then contain files with the terms of service in
various formats.  The basename of the file of the current policy must be
specified under \fBTERMS_ETAG\fP\&.  The extension defines the mime type.
Supported extensions include "html", "htm", "txt", "pdf", "jpg", "jpeg",
"png" and "gif".  For example, using a \fBTERMS_ETAG\fP of "0", the structure
could be the following:
.INDENT 7.0
.IP \(bu 2
$TERMS_DIR/en/0.pdf
.IP \(bu 2
$TERMS_DIR/en/0.html
.IP \(bu 2
$TERMS_DIR/en/0.txt
.IP \(bu 2
$TERMS_DIR/fr/0.pdf
.IP \(bu 2
$TERMS_DIR/fr/0.html
.IP \(bu 2
$TERMS_DIR/de/0.txt
.UNINDENT
.TP
.B TERMS_ETAG
Basename of the file(s) in the \fBTERMS_DIR\fP with the current terms of service.
The value is also used for the "Etag" in the HTTP request to control
caching.  Whenever the terms of service change, the \fBTERMS_ETAG\fP MUST also
change, and old values MUST NOT be repeated.  For example, the date or
version number of the terms of service SHOULD be used for the Etag.  If
there are minor (e.g. spelling) fixes to the terms of service, the
\fBTERMS_ETAG\fP probably SHOULD NOT be changed. However, whenever users must
approve the new terms, the \fBTERMS_ETAG\fP MUST change.
.TP
.B PRIVACY_DIR
Works the same as \fBTERMS_DIR\fP, just for the privacy policy.
.TP
.B PRIVACY_ETAG
Works the same as \fBTERMS_ETAG\fP, just for the privacy policy.
.UNINDENT
.SS EXCHANGE OFFLINE SIGNING OPTIONS
.sp
The following options must be in the section "[exchange\-offline]".
.INDENT 0.0
.TP
.B MASTER_PRIV_FILE
Where to store the offline private key of the exchange.
Mandatory.
.TP
.B SECM_TOFU_FILE
Where to store the public keys of both crypto helper modules.
Used to persist the keys after the first invocation of the tool,
so that if they ever change in the future, this is detected and
the tool can abort.
Mandatory.
.TP
.B SECM_DENOM_PUBKEY
Public key of the (RSA) crypto helper module. Optional. If not given,
we will rely on TOFU.  Note that once TOFU has been established,
this option will also be ignored.
.TP
.B SECM_ESIGN_PUBKEY
Public key of the (EdDSA) crypto helper module. Optional. If not given,
we will rely on TOFU.  Note that once TOFU has been established,
this option will also be ignored.
.UNINDENT
.SS EXCHANGE RSA CRYPTO HELPER OPTIONS
.sp
The following options must be in the section "[taler\-exchange\-secmod\-rsa]".
.INDENT 0.0
.TP
.B LOOKAHEAD_SIGN
How long do we generate denomination and signing keys ahead of time?
.TP
.B OVERLAP_DURATION
How much should validity periods for coins overlap?
Should be long enough to avoid problems with
wallets picking one key and then due to network latency
another key being valid.  The \fBDURATION_WITHDRAW\fP period
must be longer than this value.
.TP
.B SM_PRIV_KEY
Where should the security module store its long\-term private key?
.TP
.B KEY_DIR
Where should the security module store the private keys it manages?
.TP
.B UNIXPATH
On which path should the security module listen for signing requests?
.UNINDENT
.sp
Note that the \fBtaler\-exchange\-secmod\-rsa\fP also evaluates the \fB[coin_*]\fP
configuration sections described below.
.SS EXCHANGE EDDSA CRYPTO HELPER OPTIONS
.sp
The following options must be in the section "[taler\-exchange\-secmod\-eddsa]".
.INDENT 0.0
.TP
.B LOOKAHEAD_SIGN
How long do we generate denomination and signing keys ahead of time?
.TP
.B OVERLAP_DURATION
How much should validity periods for coins overlap?
Should be long enough to avoid problems with
wallets picking one key and then due to network latency
another key being valid.  The \fBDURATION_WITHDRAW\fP period
must be longer than this value.
.TP
.B DURATION
For how long should EdDSA keys be valid for signing?
.TP
.B SM_PRIV_KEY
Where should the security module store its long\-term private key?
.TP
.B KEY_DIR
Where should the security module store the private keys it manages?
.TP
.B UNIXPATH
On which path should the security module listen for signing requests?
.UNINDENT
.SS EXCHANGE DATABASE OPTIONS
.sp
The following options must be in the section "[exchangedb]".
.INDENT 0.0
.TP
.B IDLE_RESERVE_EXPIRATION_TIME
After which time period should reserves be closed if they are idle?
.TP
.B LEGAL_RESERVE_EXPIRATION_TIME
After what time do we forget about (drained) reserves during garbage collection?
.UNINDENT
.SS EXCHANGE POSTGRES BACKEND DATABASE OPTIONS
.sp
The following options must be in section “[exchangedb\-postgres]” if the
“postgres” plugin was selected for the database.
.INDENT 0.0
.TP
.B CONFIG
How to access the database, e.g.\ “postgres:///taler” to use the
“taler” database. Testcases use “talercheck”.
.UNINDENT
.SS EXCHANGE ACCOUNT OPTIONS
.sp
An exchange (or merchant) can have multiple bank accounts. The following
options are for sections named “[exchange\-account\-SOMETHING]”. The \fBSOMETHING\fP is
arbitrary and should be chosen to uniquely identify the bank account for
the operator.  These options are used by the \fBtaler\-exchange\-aggregator\fP, \fBtaler\-exchange\-closer\fP, \fBtaler\-exchange\-transfer\fP and \fBtaler\-exchange\-wirewatch\fP tools.
.INDENT 0.0
.TP
.B PAYTO_URI
Specifies the payto://\-URL of the account. The general format is
\fBpayto://$METHOD/$DETAILS\fP\&.  Examples:
\fBpayto://x\-taler\-bank/localhost:8899/Exchange\fP or
\fBpayto://iban/GENODEF1SLR/DE67830654080004822650/\fP or
\fBpayto://iban/DE67830654080004822650/\fP (providing the BIC is optional).
Note: only the wire\-method is actually used from the URI.
.TP
.B ENABLE_DEBIT
Must be set to \fBYES\fP for the accounts that the
\fBtaler\-exchange\-aggregator\fP and \fBtaler\-exchange\-closer\fP should debit.
.TP
.B ENABLE_CREDIT
Must be set to \fBYES\fP for the accounts that the \fBtaler\-exchange\-wirewatch\fP
should check for credits. It is yet uncertain if the merchant
implementation may check this flag as well.
.UNINDENT
.sp
Additionally, for each enabled account there MUST be another matching section named “[exchange\-accountcredentials\-SOMETHING]”.  This section SHOULD be in a \fBsecret/\fP configuration file that is only readable for the \fBtaler\-exchange\-wirewatch\fP and \fBtaler\-exchange\-transfer\fP processes. It contains the credentials to access the bank account:
.INDENT 0.0
.TP
.B WIRE_GATEWAY_URL
URL of the wire gateway.  Typically of the form
\fBhttps://$HOSTNAME[:$PORT]/taler\-wire\-gateway/$USERNAME/\fP
where $HOSTNAME is the hostname of the system running the bank
(such as the Taler Python bank or the Nexus) and \fB$USERNAME\fP is
the username of the exchange\(aqs bank account (usually matching
the \fBUSERNAME\fP option used for authentication).  Example:
\fBhttps://bank.demo.taler.net/taler\-wire\-gateway/Exchange/\fP\&.
.TP
.B WIRE_GATEWAY_AUTH_METHOD
This option determines how the exchange (auditor/wirewatch/aggregator)
authenticates with the wire gateway.  Choices are \fBbasic\fP and \fBnone\fP\&.
.TP
.B USERNAME
User name for \fBbasic\fP authentication with the wire gateway.
.TP
.B PASSWORD
Password for \fBbasic\fP authentication with the wire gateway.
.UNINDENT
.SS EXCHANGE COIN OPTIONS
.sp
The following options must be in sections starting with \fB"[coin_]"\fP and are
largely used by \fBtaler\-exchange\-httpd\fP to determine the meta data for the
denomination keys.  Some of the options are used by the
\fBtaler\-exchange\-secmod\-rsa\fP to determine which RSA keys to create (and of
what key length).  Note that the section names must match, so this part of the
configuration MUST be shared between the RSA helper and the exchange.
Configuration values MUST NOT be changed in a running setup. Instead, if
parameters for a denomination type are to change, a fresh \fIsection name\fP should
be introduced (and the existing section should be deleted).
.INDENT 0.0
.TP
.B VALUE
Value of the coin, e.g.\ “EUR:1.50” for 1 Euro and 50 Cents (per
coin).
.TP
.B DURATION_WITHDRAW
How long should the same key be used for clients to withdraw coins of
this value?
.TP
.B DURATION_SPEND
How long do clients have to spend these coins?
.TP
.B DURATION_LEGAL
How long does the exchange have to keep records for this denomination?
.TP
.B FEE_WITHDRAW
What fee is charged for withdrawal?
.TP
.B FEE_DEPOSIT
What fee is charged for depositing?
.TP
.B FEE_REFRESH
What fee is charged for refreshing?
.TP
.B 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.
.TP
.B RSA_KEYSIZE
What is the RSA keysize modulos (in bits)?
.UNINDENT
.SS MERCHANT OPTIONS
.sp
The following options are from the “[merchant]” section and used by the
merchant backend.
.INDENT 0.0
.TP
.B DB
Plugin to use for the database, e.g._“postgres”.
.TP
.B PORT
Port on which the HTTP server listens, e.g.\ 8080.
.TP
.B LEGAL_PRESERVATION
How long do we keep data in the database for tax audits after the
transaction has completed?  Default is 10 years.
.TP
.B FORCE_AUDIT
Force the merchant to report every transaction to the auditor
(if the exchange has an auditor)?  Default is \fBNO\fP\&.
Do not change except for testing.
.UNINDENT
.SS MERCHANT POSTGRES BACKEND DATABASE OPTIONS
.sp
The following options must be in section “[merchantdb\-postgres]” if the
“postgres” plugin was selected for the database.
.INDENT 0.0
.TP
.B CONFIG
How to access the database, e.g.\ “postgres:///taler” to use the
“taler” database. Testcases use “talercheck”.
.UNINDENT
.SS KNOWN EXCHANGES (for merchants)
.sp
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 [merchant\-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.
.INDENT 0.0
.TP
.B EXCHANGE_BASE_URL
Base URL of the exchange, e.g.\ “\fI\%https://exchange.demo.taler.net/\fP”
.TP
.B MASTER_KEY
Crockford Base32 encoded master public key, public version of the
exchange\(aqs long\-time offline signing key.  Can be omitted, in that
case the exchange will NOT be trusted unless it is audited by
a known auditor.
Omitting \fBMASTER_KEY\fP can be useful if we do not trust the exchange
without an auditor, but should pre\-load the keys of this
particular exchange on startup instead of waiting for it to be
required by a client.
.TP
.B CURRENCY
Name of the currency for which this exchange is used, e.g.\ “KUDOS”.
The entire section is ignored if the currency does not match the currency
we use, which must be given in the \fB[taler]\fP section.
.UNINDENT
.SS KNOWN AUDITORS (for merchants)
.sp
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 “[merchant\-auditor\-$NAME]” must exist, where
\fB$NAME\fP is a merchant\-given name for the auditor. The following options
must be given in each “[merchant\-auditor\-$NAME]” section.
.INDENT 0.0
.TP
.B AUDITOR_BASE_URL
Base URL of the auditor, e.g.\ “\fI\%https://auditor.demo.taler.net/\fP”
.TP
.B AUDITOR_KEY
Crockford Base32 encoded auditor public key.
.TP
.B CURRENCY
Name of the currency for which this auditor is trusted, e.g.\ “KUDOS”
The entire section is ignored if the currency does not match the currency
we use, which must be given in the \fB[taler]\fP section.
.UNINDENT
.SS AUDITOR OPTIONS
.sp
The following options must be in section “[auditor]” for the Taler
auditor.
.INDENT 0.0
.TP
.B DB
Plugin to use for the database, e.g.\ “postgres”
.TP
.B AUDITOR_PRIV_FILE
Name of the file containing the auditor’s private key.
.TP
.B PUBLIC_KEY
Crockford Base32 encoded auditor public key.  Used by (online) auditor
processes that do not have access to the (offline) auditor private key file.
.TP
.B BASE_URL
Base URL of the auditor, e.g.\ “\fI\%https://auditor.demo.taler.net/\fP”
.UNINDENT
.SS AUDITOR POSTGRES BACKEND DATABASE OPTIONS
.sp
The following options must be in section “[auditordb\-postgres]” if the
“postgres” plugin was selected for the database.
.INDENT 0.0
.TP
.B CONFIG
How to access the database, e.g.\ "postgres:///taler" to use the
"taler" database. Testcases use “talercheck”.
.UNINDENT
.SH SEE ALSO
.sp
taler\-exchange\-dbinit(1), taler\-exchange\-httpd(1),
taler\-exchange\-offline(1), taler\-auditor\-offline(1).
.SH BUGS
.sp
Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic
mail to <\fI\%taler@gnu.org\fP>.
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
2014-2021 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.