diff options
Diffstat (limited to 'man/challenger.conf.5')
| -rw-r--r-- | man/challenger.conf.5 | 59 |
1 files changed, 56 insertions, 3 deletions
diff --git a/man/challenger.conf.5 b/man/challenger.conf.5 index efeb216a..44a65180 100644 --- a/man/challenger.conf.5 +++ b/man/challenger.conf.5 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH "CHALLENGER.CONF" "5" "Apr 16, 2023" "0.9" "GNU Taler" -.SH NAME -challenger.conf \- Challenger configuration file . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.TH "CHALLENGER.CONF" "5" "May 18, 2023" "0.9" "GNU Taler" +.SH NAME +challenger.conf \- Challenger configuration file .SH DESCRIPTION .sp The configuration file is line\-oriented. @@ -65,6 +65,46 @@ 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 +The “[PATHS]” section is special in that it contains paths that can be +referenced using “$” in other configuration values that specify +\fIfilenames\fP\&. Note that configuration options that are not specifically +retrieved by the application as \fIfilenames\fP will not see “$”\-expressions +expanded. To expand “$”\-expressions when using \fBtaler\-config\fP, you must pass +the \fB\-f\fP command\-line option. +.sp +The system automatically pre\-populates the “[PATHS]” section with a few values +at run\-time in addition to the values that are in the actual configuration +file. These automatically generated values refer to installation properties +from \fI\%GNU autoconf\fP\&. The +values are usually dependent on an \fBINSTALL_PREFIX\fP which is determined by +the \fB\-\-prefix\fP option given to configure. The canonical values are: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP \(bu 2 +LIBEXECDIR = $INSTALL_PREFIX/taler/libexec/ +.IP \(bu 2 +DOCDIR = $INSTALL_PREFIX/share/doc/taler/ +.IP \(bu 2 +ICONDIR = $INSTALL_PREFIX/share/icons/ +.IP \(bu 2 +LOCALEDIR = $INSTALL_PREFIX/share/locale/ +.IP \(bu 2 +PREFIX = $INSTALL_PREFIX/ +.IP \(bu 2 +BINDIR = $INSTALL_PREFIX/bin/ +.IP \(bu 2 +LIBDIR = $INSTALL_PREFIX/lib/taler/ +.IP \(bu 2 +DATADIR = $INSTALL_PREFIX/share/taler/ +.UNINDENT +.UNINDENT +.UNINDENT +.sp +Note that on some platforms, the given paths may differ depending +on how the system was compiled or installed, the above are just the +canonical locations of the various resources. +.sp Files containing default values for many of the options described below are installed under \fB$PREFIX/share/challenger/config.d/\fP\&. The configuration file given with \fB\-c\fP to Challenger binaries @@ -106,6 +146,19 @@ Only used if \fBSERVE\fP is \fBunix\fP\&. .TP .B DB Plugin to use for the database, e.g.\ “postgres”. +.TP +.B VALIDATION_DURATION +How long is a validation challenge valid. After this time period, a fresh random challenge code will be generated and the retry limit counter (against guessing attacks) will be reset (to 3). +.TP +.B VALIDATION_EXPIRATION +How long is a validation allowed to take (time from +\fB/setup\fP to \fB/token\fP). After this time, the garbage collection process can delete all associated data. (Note that tokens will always allow access to 1h after they have been issued, regardless of when the validation expires). +.TP +.B AUTH_COMMAND +Which command should we execute to transmit the challenge code to the address. The address is given as the first argument, while the message to send is provided on stdin. Templates (possibly without the necessary credentials) for such commands are provided as challenger\-send\-email.sh, challenger\-send\-post.sh and challenger\-send\-sms.sh. +.TP +.B ADDRESS_TYPE +Type of the address that is being collected, returned as part of the \fBaddress_type\fP in the \fB/info\fP endpoint. Examples include \fBemail\fP or \fBphone\fP\&. .UNINDENT .SH SEE ALSO .sp |