challenger.conf.5.rst (4264B)
1 challenger.conf(5) 2 ################## 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **challenger.conf** - Challenger configuration file 10 11 12 Description 13 =========== 14 15 .. include:: ../frags/common-conf-syntax.rst 16 17 Files containing default values for many of the options described below 18 are installed under ``$PREFIX/share/challenger/config.d/``. 19 The configuration file given with **-c** to Challenger binaries 20 overrides these defaults. 21 22 A configuration file may include another, by using the ``@INLINE@`` directive, 23 for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to 24 include the entirety of ``sub.conf`` at that point in ``main.conf``. 25 26 Be extra careful when using ``challenger-config -V VALUE`` to change configuration 27 values: it will destroy all uses of ``@INLINE@`` and furthermore remove all 28 comments from the configuration file! 29 30 31 GLOBAL OPTIONS 32 -------------- 33 34 The following options are from the “[challenger]” section. 35 This is normally the only section in a challenger.conf file. 36 37 SERVE 38 Should the HTTP server listen on a UNIX domain socket (set option to "unix"), or on a TCP socket (set option to "tcp"), or be activated via systemd (set option to "systemd"). 39 40 PORT 41 Port on which the HTTP server listens, e.g. 9967. 42 Only used if ``SERVE`` is ``tcp``. 43 44 BIND_TO 45 Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1`` 46 for loopback. Can also be given as a hostname. We will bind to 47 the wildcard (dual-stack) if left empty. 48 Only used if ``SERVE`` is ``tcp``. 49 50 UNIXPATH 51 Which unix domain path should we bind to? 52 Only used if ``SERVE`` is ``unix``. 53 54 UNIXPATH_MODE = 660 55 What should be the file access permissions for ``UNIXPATH``? 56 Only used if ``SERVE`` is ``unix``. 57 58 DB 59 Plugin to use for the database, e.g. “postgres”. 60 61 VALIDATION_DURATION 62 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). 63 64 VALIDATION_EXPIRATION 65 How long is a validation allowed to take (time from 66 ``/setup`` to ``/token``). 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). 67 68 AUTH_COMMAND 69 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. 70 71 ADDRESS_TYPE 72 Type of the address that is being collected, returned as part of the ``address_type`` in the ``/info`` endpoint. Examples include ``email`` or ``phone``. 73 74 ADDRESS_HINT 75 Hint to show to users for entering the address. Should be an example address in the right format. 76 77 ADDRESS_RESTRICTIONS 78 JSON object with a map of keys (names of the fields of the address to be entered by the user) to objects with a "regex" (string) containing an extended Posix regular expression for allowed address field values, and a "hint"/"hint_i18n" giving a human-readable explanation to display if the value entered by the user does not match the regex. Keys that are not mapped to such an object have no restriction on the value provided by the user. Examples would be '{"email":{"hint":"valid e-mail address required","regex":"^[a-zA-Z0-9\_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"}' or '{"zip":{"hint":"numeric zip code required","regex":"^[0-9]+$"}'. 79 80 MESSAGE_TEMPLATE_FILE 81 Name of a file with a Mustach template to use to generate the challenge message for the customer. The template will be provided the PIN/TAN under ``{{pin}}``, the customer's address in JSON format under ``{{address}}`` and the URL of the challenger backend under ``{{challenger_url}}``. 82 83 BASE_URL 84 The base URL under which the challenger can be reached. 85 Provided to message templates to remind users where they 86 need to enter the challenge. 87 88 89 SEE ALSO 90 ======== 91 92 challenger-dbinit(1), challenger-httpd(1), challenger-config(1). 93 94 95 BUGS 96 ==== 97 98 Report bugs by using https://bugs.taler.net/ or by sending electronic 99 mail to <taler@gnu.org>.