gnunet-svn
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated: fix section 7.6

From: gnunet
Subject: [taler-docs] branch master updated: fix section 7.6
Date: Sun, 04 Feb 2024 10:44:59 +0100 
This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 7247f966 fix section 7.6
7247f966 is described below

commit 7247f9665a35c6d0241169059723869b0807d94f
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Sun Feb 4 10:44:47 2024 +0100

    fix section 7.6
---
 core/api-bank-wire.rst    |   2 +
 taler-exchange-manual.rst | 404 ++++------------------------------------------
 2 files changed, 37 insertions(+), 369 deletions(-)

diff --git a/core/api-bank-wire.rst b/core/api-bank-wire.rst
index eb7920f9..7c028388 100644
--- a/core/api-bank-wire.rst
+++ b/core/api-bank-wire.rst
@@ -13,6 +13,8 @@
   You should have received a copy of the GNU Affero General Public License 
along with
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 
+.. _taler-wire-gateway-http-api:
+
 ===========================
 Taler Wire Gateway HTTP API
 ===========================
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index ec209f76..79455fec 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -1,7 +1,7 @@
 ..
   This file is part of GNU TALER.
 
-  Copyright (C) 2014-2023 Taler Systems SA
+  Copyright (C) 2014-2024 Taler Systems SA
 
   TALER is free software; you can redistribute it and/or modify it under the
   terms of the GNU Affero General Public License as published by the Free 
Software
@@ -822,369 +822,32 @@ configuration of the online machine:
 Wire Gateway Setup
 ==================
 
-The Taler Wire Gateway is an API that connects the Taler exchange to
-the underlying core banking system.
+The :ref:`Taler Wire Gateway <taler-wire-gateway-http-api>` is an API that
+connects the Taler exchange to the underlying core banking system.  There are
+several implementations of wire gateways:
 
-LibEuFin is an implementation of the Wire Gateway API for the EBICS protocol.
-This section will walk through (1) installing and configuring LibEuFin and
-(2) connecting the Taler Exchange to LibEuFin.
+  * `Project deploymerization <https://git.taler.net/depolymerization.git>`_ 
implements a wire gateway on top of Bitcoin or Ethereum
+  * The :ref:`libeufin-bank <libeufin-bank>` provides a wire gateway interface 
on top of a regional currency bank
+  * The **taler-fakebank-run** command is an in-memory bank simulator with a 
wire gateway interface for testing
 
+.. FIXME :ref:`libeufin-nexus <libeufin-nexus>` is an implementation of the 
Wire Gateway API for the EBICS protocol. Add to list above once nexus 
implements the TWG directly!
 
-Installation and Basic Configuration
-------------------------------------
+Before continuing, you need to decide which wire gateway you want to use,
+and install and configure it on your system.  Afterwards, you need to
+have two key pieces of information from that setup:
 
-First, install the ``libeufin`` package.  This can be done on the 
``exchange-online``
-machine or a different one.
+  * The username and password to access the exchange's account in the system.
+  * The ``payto://`` URI of that account (see `RFC 8905 
<https://www.rfc-editor.org/rfc/rfc8905>`_).
 
-.. code-block:: shell-session
-
-  [root@exchange-online]# apt-get install -y libeufin
-
-The main component of LibEuFin is called the Nexus.  It implements a Web
-service that provides a JSON abstraction layer to access bank accounts.
-
-The HTTP port and database connection string can be edited in the 
configuration:
-
-.. code-block:: ini
-  :caption: /etc/libeufin/nexus.env
-
-  LIBEUFIN_NEXUS_PORT=5017
-  
LIBEUFIN_NEXUS_DB_CONNECTION=jdbc:sqlite:/var/lib/libeufin/nexus/nexus-db.sqlite3
-
-After configuring the database, you can start the service.
-The database is initialized automatically.
-
-
-.. code-block:: shell-session
-
-   [root@exchange-online]# systemctl enable libeufin-nexus
-   [root@exchange-online]# systemctl start libeufin-nexus
-
-You can now create a superuser account.  The command to
-create the superuser needs direct database access, thus
-the configuration file is sourced first, and the relevant
-environment variable is exported.
-
-.. code-block:: console
-
-  [root@exchange-online]# source /etc/libeufin/nexus.env
-  [root@exchange-online]# export LIBEUFIN_NEXUS_DB_CONNECTION
-  [root@exchange-online]# NEXUS_ADMIN_PW=$(tr -dc A-Za-z0-9 </dev/urandom | 
head -c 13)
-  [root@exchange-online]# libeufin-nexus superuser admin --password 
$NEXUS_ADMIN_PW
-
-If you omit ``--password $NEXUS_ADMIN_PW``, you will interactively be asked 
for a password.
-For simplicity, a superuser can as well act as a normal user, but an API
-to create less privileged users is offered.
-
-.. note::
-
-  User and permissions management in LibEuFin is still under development.
-  In particular, permissions for non-superusers are very limited at the moment.
-
-
-Connecting Nexus with an EBICS account
---------------------------------------
-
-The command line interface of the LibEuFin Nexus needs the following three
-values to be defined in the environment: ``LIBEUFIN_NEXUS_URL``,
-``LIBEUFIN_NEXUS_USERNAME``, and ``LIBEUFIN_NEXUS_PASSWORD``.  In this example,
-``LIBEUFIN_NEXUS_USERNAME`` should be set to ``admin``, and
-``LIBEUFIN_NEXUS_PASSWORD`` to the value hold in ``NEXUS_ADMIN_PW`` from the
-previous step (the ``libeufin-nexus superuser`` command).  The
-``LIBEUFIN_NEXUS_URL`` could be given as ``http://localhost:5017/``.
-
-Next, we create a EBICS *bank connection* that Nexus can use to communicate 
with the bank.
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli \
-      connections \
-        new-ebics-connection \
-          --ebics-url $EBICS_BASE_URL \
-          --host-id $EBICS_HOST_ID \
-          --partner-id $EBICS_PARTNER_ID \
-          --ebics-user-id $EBICS_USER_ID \
-          $CONNECTION_NAME
-
-If this step executes correctly, Nexus will have created all the cryptographic
-material that is needed on the client side; in this EBICS example, it created
-the signature and identification keys.  It is therefore advisable to *make
-a backup copy* of such keys.
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli \
-      connections \
-        export-backup \
-          --passphrase $SECRET \
-          --output-file $BACKUP_FILE \
-          $CONNECTION_NAME
-
-At this point, Nexus needs to both communicate its keys to the bank, and
-download the bank's keys.  This synchronization happens through the INI, HIA, 
and
-finally, HPB message types.
-
-After the electronic synchronization, the subscriber must confirm their keys
-by sending a physical mail to the bank.  The following command helps generating
-such letter:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli connections get-key-letter 
$CONNECTION_NAME out.pdf
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli \
-      connections \
-        connect \
-          $CONNECTION_NAME
-
-..
-  FIXME: Maybe is not 100% clear that 'connecting' means exchanging keys
-  with the bank?
-
-Once the connection is synchronized, Nexus needs to import locally the data
-corresponding to the bank accounts offered by the bank connection just made.
-The command below downloads the list of the bank accounts offered by 
``$CONNECTION_NAME``.
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli \
-      connections \
-        download-bank-accounts \
-          $CONNECTION_NAME
-
-It is now possible to list the accounts offered by the connection.
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli \
-      connections \
-        list-offered-bank-accounts \
-          $CONNECTION_NAME
-
-.. note::
-
-   The ``nexusBankAccountId`` field should at this step be ``null``,
-   as we have not yet imported the bank account and thus the account
-   does not yet have a local name.
-
-Nexus now needs an explicit import of the accounts it should manage.  This
-step is needed to let the user pick a custom name for such accounts.
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli \
-      connections \
-        import-bank-account \
-          --offered-account-id testacct01 \
-          --nexus-bank-account-id $LOCAL_ACCOUNT_NAME \
-          $CONNECTION_NAME
-
-Once a Nexus user imported a bank account (``$LOCAL_ACCOUNT_NAME``)
-under a certain connection (``$CONNECTION_NAME``), it is possible
-to accomplish the usual operations for any bank account: asking for the
-list of transactions, and making a payment.
-
-Testing: Requesting the transaction history
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The LibEuFin Nexus keeps a local copy of the bank account's transaction
-history.  Before querying transactions locally, it is necessary
-to request transactions for the bank account via the bank connection.
-
-This command asks Nexus to download the latest transaction reports/statements
-through the bank connection:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli accounts fetch-transactions 
$LOCAL_ACCOUNT_NAME
-
-.. note::
-
-   By default, the latest available transactions are fetched.  It is also
-   possible to specify a custom date range (or even all available transactions)
-   and the type of transactions to fetch (inter-day statements or intra-day
-   reports).
-
-..
-  FIXME: Possibly the date range filter is still missing, see #6243.
-
-Once Nexus has stored all the information in the database, the
-client can ask to actually see the transactions:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli accounts transactions 
$LOCAL_ACCOUNT_NAME
-
-Testing: Making payments
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-Payments pass through two phases: preparation and submission.  The preparation
-phase assigns the payment initiation a unique ID, which prevents accidental
-double submissions of payments in case of network failures or other
-disruptions.
-
-
-The following command prepares a payment:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli accounts prepare-payment \
-          --creditor-iban=$IBAN_TO_SEND_MONEY_TO \
-          --creditor-bic=$BIC_TO_SEND_MONEY_TO \
-          --creditor-name=$CREDITOR_NAME \
-          --payment-amount=$AMOUNT \
-          --payment-subject=$SUBJECT \
-          $LOCAL_ACCOUNT_NAME
-
-Note: the ``$AMOUNT`` value needs the format ``X.Y:CURRENCY``; for example
-``EUR:10``, or ``EUR:1.01``.
-
-The previous command should return a value (``$UUID``) that uniquely
-identifies the prepared payment in the Nexus system.  That is needed
-in the next step, to **send the payment instructions to the bank**:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli accounts submit-payments \
-        --payment-uuid $UUID \
-        $LOCAL_ACCOUNT_NAME
-
-Automatic scheduling
-^^^^^^^^^^^^^^^^^^^^
-
-With an EBICS bank connection, the LibEuFin Nexus needs to regularly query for
-new transactions and (re-)submit prepared payments.
-
-It is possible to schedule these tasks via an external task scheduler such as
-cron(8).  However, the nexus also has an internal task scheduling mechanism for
-accounts.
-
-
-The following three commands create a schedule for submitting payments hourly,
-fetching transactions (intra-day reports) every 5 minutes, and (inter-day 
statements)
-once at 11pm every day:
-
-.. code-block:: console
-
-   [root@exchange-online]# libeufin-cli accounts task-schedule 
$LOCAL_ACCOUNT_NAME \
-       --task-type="submit" \
-       --task-name='submit-payments-hourly' \
-       --task-cronspec='0 0 *'
-
-   [root@exchange-online]# libeufin-cli accounts task-schedule 
$LOCAL_ACCOUNT_NAME \
-       --task-type="fetch" \
-       --task-name='fetch-5min' \
-       --task-cronspec='0 */5 *' \
-       --task-param-level=report \
-       --task-param-range-type=latest
-
-   [root@exchange-online]# libeufin-cli accounts task-schedule 
$LOCAL_ACCOUNT_NAME \
-       --task-type="fetch" \
-       --task-name='fetch-daily' \
-       --task-cronspec='0 0 23' \
-       --task-param-level=statement \
-       --task-param-range-type=latest
-
-The cronspec has the following format, which is slightly non-standard due to
-the ``SECONDS`` field
-
-.. code-block:: none
-
-  SECONDS MINUTES HOURS DAY-OF-MONTH[optional] MONTH[optional] 
DAY-OF-WEEK[optional]
-
-
-Creating a Taler facade
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Facades are additional abstraction layers that can serve
-specific purposes.  For example, one application might need
-a filtered version of the transaction history, or it might
-want to refuse payments that do not conform to certain rules.
-
-At this moment, only the *Taler facade type* is implemented
-in the Nexus, and the command below instantiates one under a
-existing bank account / connection pair.  You can freely
-assign an identifier for the ``$FACADE_NAME`` below:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli facades new-taler-wire-gateway-facade \
-      --currency EUR \
-      --facade-name $FACADE_NAME \
-      $CONNECTION_NAME \
-      $LOCAL_ACCOUNT_NAME
-
-At this point, the additional :doc:`taler-wire-gateway API 
<core/api-bank-wire>`
-becomes offered by the Nexus.  The purpose is to let a Taler exchange rely on
-Nexus to manage its bank account.
-
-The base URL of the facade that can be used by the Taler exchange
-as the Taler Wire Gateway base URL can be seen by listing the facades:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli facades list
-
-Managing Permissions and Users
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This guide has so far assumed that a superuser is accessing the LibEuFin Nexus.
-However, it is advisable that the Nexus is accessed with users that only have a
-minimal set of permissions.
-
-The Nexus currently only has support for giving non-superusers access to Taler
-wire gateway facades.
-
-To create a new user, use the ``users`` subcommand of the CLI:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli users list
-  # [ ... shows available users ... ]
-
-  [root@exchange-online]# libeufin-cli users create $USERNAME
-  # [ ... will prompt for password ... ]
-
-Permissions are managed with the ``permissions`` subcommand.
-The following commands grant permissions to view the transaction history
-and create payment initiations with a Taler wire gateway facade:
-
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli permissions grant \
-     user $USERNAME \
-     facade $FACADENAME \
-     facade.talerwiregateway.history
-
-  [root@exchange-online]# libeufin-cli permissions grant \
-     user $USERNAME \
-     facade $FACADENAME \
-     facade.talerwiregateway.transfer
-
-..
-  FIXME: The two commands above output an empty JSON object
-  when successful.  Possibly, we should suppress that (just like
-  the other commands do).
-
-The list of all granted permissions can be reviewed:
-
-.. code-block:: console
-
-  [root@exchange-online]# libeufin-cli permissions list
-
-
-.. _Bank-account:
+.. _exchange-bank-account-configuration:
 
 Exchange Bank Account Configuration
 -----------------------------------
 
 An exchange must be configured with the right settings to access its bank
-account via a Taler Wire Gateway.  An exchange can be configured to use
-multiple bank accounts by using multiple Wire Gateways.  Typically only one
-Wire Gateway is used.
+account via a :ref:`Taler wire gateway <taler-wire-gateway-http-api>`.  An
+exchange can be configured to use multiple bank accounts by using multiple
+wire gateways.  Typically only one wire gateway is used.
 
 To configure a bank account in Taler, we need to furnish two pieces of
 information:
@@ -1195,8 +858,8 @@ information:
    an IBAN or
    ``payto://x-taler-bank/localhost:8080/2`` for the 2nd bank account a
    the Taler bank demonstrator running at ``localhost`` on port 8080.
-   The first part of the URI following ``payto://`` (“iban” or
-   “x-taler-bank”) is called the wire method.
+   The first part of the URI following ``payto://`` (``iban`` or
+   ``x-taler-bank``) is called the wire method.
 
 -  The ``taler-exchange-wirewatch`` and ``taler-exchange-transfer``
    tools needs to be provided resources for authentication
@@ -1205,20 +868,22 @@ information:
    for HTTP basic authentication.
 
 
-A Taler Wire Gateway is configured in a configuration section that follows the
-pattern ``exchange-account-$id``, where ``$id`` is an internal identifier for
-the bank account accessed by the exchange.  The basic information for an
+Each Taler wire gateway is configured in a configuration section that follows
+the pattern ``exchange-account-$id``, where ``$id`` is an internal identifier
+for the bank account accessed by the exchange.  The basic information for an
 account should be put in ``/etc/taler/conf.d/exchange-business.conf``.  The
 secret credentials to access the Taler Wire Gateway API should be put into a
 corresponding ``exchange-accountcredentials-$id`` section in
 ``/etc/taler/secrets/exchange-accountcredentials.conf``.  The latter file
-should already be only readable for the ``taler-exchange-wire`` user.  Other
-exchange processes should not have access to this information.
+should be only readable for the ``taler-exchange-wire`` user.  Only the
+``taler-exchange-wirewatch`` and ``taler-exchange-transfer`` services should
+run as the ``taler-exchange-wire`` user.  Other exchange processes do not need
+to have access to the account credentials.
 
 You can configure multiple accounts for an exchange by creating sections
-starting with “exchange-account-” for the section name. You can ENABLE for
-each account whether it should be used, and for what (incoming or outgoing
-wire transfers):
+starting with ``exchange-account-`` for the section name. You must specify
+``ENABLE_``-settings for each account whether it should be used, and for what
+(incoming or outgoing wire transfers):
 
 .. code-block:: ini
   :caption: /etc/taler/conf.d/exchange-business.conf
@@ -1253,15 +918,15 @@ wire transfers):
   # LibEuFin expects basic auth.
   WIRE_GATEWAY_AUTH_METHOD = basic
 
-  # Username and password set in LibEuFin.
+  # Username and password to access the Taler wire gateway.
   USERNAME = ...
   PASSWORD = ...
 
-  # Base URL of the wire gateway set up with LibEuFin.
+  # Base URL of the Taler wire gateway.
   WIRE_GATEWAY_URL = ...
 
 
-Such a Wire Gateway configuration can be tested with the following commands:
+Such a wire gateway configuration can be tested with the following commands:
 
 .. code-block:: shell-session
 
@@ -1270,7 +935,8 @@ Such a Wire Gateway configuration can be tested with the 
following commands:
    [root@exchange-online]# taler-exchange-wire-gateway-client \
      --section exchange-accountcredentials-1 --credit-history
 
-
+On success, you will see some of your account's transaction history (or an
+empty history), while on failure you should see an error message.
 
 .. _LegalSetup:
 
@@ -1821,7 +1487,7 @@ The ``enable-account`` step is important to must be used 
to sign the
 correct address to wire funds to.  Note that for each bank account, additional
 options **must** be set in the configuration file to tell the exchange how to
 access the bank account. The offline tool *only* configures the externally
-visible portions of the setup.  The chapter on `Bank account <_Bank-account>`_ 
configuration has further details.
+visible portions of the setup.  The chapter on `bank account configuration 
<_exchange-bank-account-configuration>`_ has further details.
 
 taler-exchange-offline accepts additional options to configure the use of the
 account. For example, additional options can be used to add currency

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
reply via email to
[Prev in Thread] Current Thread [Next in Thread]