[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: document taler-exchange-kyc-tester
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: document taler-exchange-kyc-tester |
Date: |
Tue, 09 Aug 2022 15:21:39 +0200 |
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 06879e0 document taler-exchange-kyc-tester
06879e0 is described below
commit 06879e018b91816acee4c51cc07a94b1189ca810
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Tue Aug 9 15:21:36 2022 +0200
document taler-exchange-kyc-tester
---
conf.py | 3 ++
design-documents/023-taler-kyc.rst | 3 ++
manpages/taler-exchange-kyc-tester.1.rst | 85 ++++++++++++++++++++++++++++++++
3 files changed, 91 insertions(+)
diff --git a/conf.py b/conf.py
index 9cc26dd..ccb6671 100644
--- a/conf.py
+++ b/conf.py
@@ -304,6 +304,9 @@ man_pages = [
("manpages/taler-exchange-drain.1", "taler-exchange-drain",
"drain profits from exchange", "GNU Taler contributors",
1),
+ ("manpages/taler-exchange-kyc-tester.1", "taler-exchange-kyc-tester",
+ "test KYC service integration", "GNU Taler contributors",
+ 1),
("manpages/taler-exchange-expire.1", "taler-exchange-expire",
"refund expired purses", "GNU Taler contributors",
1),
diff --git a/design-documents/023-taler-kyc.rst
b/design-documents/023-taler-kyc.rst
index 90f6109..85334d2 100644
--- a/design-documents/023-taler-kyc.rst
+++ b/design-documents/023-taler-kyc.rst
@@ -274,6 +274,9 @@ This section describes the new DB plugin functions.
* insert_legi (INSERT h_payto, provider_section),
returns legitimization_serial_id
+* get_legi (SELECT by legitimization_serial_id),
+ returns provider_section, status.
+
* start_legi (UPDATE based on h_payto, provider_section,
SETs provider_user_id, provider_legitimization_id)
diff --git a/manpages/taler-exchange-kyc-tester.1.rst
b/manpages/taler-exchange-kyc-tester.1.rst
new file mode 100644
index 0000000..2c3d5f4
--- /dev/null
+++ b/manpages/taler-exchange-kyc-tester.1.rst
@@ -0,0 +1,85 @@
+taler-exchange-kyc-tester(1)
+############################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-exchange-kyc-tester** - tool to test interaction with KYC provider
+
+Synopsis
+========
+
+**taler-exchange-kyc-tester**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
+[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-i** *SECTION_NAME* | **--initiate=**\ \ *SECTION_NAME*]
+[**-u** *ID* | **--user=**\ \ *ID*]
+[**-U** *ID* | **--legitimization=**\ \ *ID*]
+[**-P** | **--print-payto-hash**]
+[**-p** *HASH* | **--payto-hash=**\ \ *HASH*]
+[**-r** *NUMBER* | **--rowid=**\ \ *NUMBER*]
+[**-v** | **--version**]
+[**-w** | **--run-webservice**]
+
+
+Description
+===========
+
+**taler-exchange-kyc-tester** is used to test the interaction between a Taler
exchange and a KYC service. The tool can be used to manually trigger the
various steps of a KYC process and to observe the interaction with the
respective KYC service. It is supposted to help test the configuration of the
integration, and *not* required at all during production.
+
+To use it, you must first provide a configuration file with at least one KYC
service configured. Some other exchange-specific options, like the PORT for the
HTTP service and the BASE_URL under which the Taler exchange will run are also
required. You should be able to use exactly the same configuration file that
one would usually give to a Taler exchange. Starting with this, the tool
allows the simulation of a KYC process. Note that it will not write any
information to the database.
+
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the exchange to operate
+ from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **--loglevel=**\ \ *LOGLEVEL*
+ Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+ ``WARNING``, ``ERROR``.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+ Send logging output to *FILENAME*.
+
+**-i** *SECTION_NAME* \| **--initiate=**\ \ *SECTION_NAME*
+ Start a fresh KYC process using the KYC provider configured in SECTION_NAME
of the configuration. This will output the HTTP URL where the user has to
begin the KYC process to the command-line. This is usually the first thing to
do when using this tool. Outputs the KYC-logic specific user and legitimization
IDs, or NULL if not used by the KYC-logic at the initiation stage.
+
+**-u** *ID* \| **--user=**\ \ *ID*
+ Run the process with ID for the user identifier at the KYC provider. Not
useful in conjunction with **-i** as that option will override whatever value
is provided here.
+
+**-U** *ID* \| **--legitimization=**\ \ *ID*
+ Run the process with ID for the legitimization process identifier at the
KYC provider. Not useful in conjunction with **-i** as that option will
override whatever value is provided here.
+
+**-p** *HASH* \| **--payto-hash=**\ \ *HASH*
+ Run the process with HASH as the hash of the payto://-URI that identifies
the account or wallet triggering the KYC requirement. If not given, a fresh
random value is used. Rarely useful.
+
+**-P** \| **--print-payto-hash**
+ Print the HASH of the payto://-URI used for the KYC simulation this time.
Useful if the hash is needed for a subsequent use in conjunction with **-p**.
+
+**-r** *NUMBER* \| **--rowid=**\ \ *NUMBER*
+ Run the process with NUMBER as the database row for the legitimization
operation. Rarely useful, except maybe for debugging. Defaults to 42.
+
+**-v** \| **--version**
+ Print version information.
+
+**-w** \| **--run-webservice**
+ Run a simulated Taler exchange HTTP service on the configured port with the
``/kyc-proof/`` and ``/kyc-webhook/`` endpoints.
+
+
+See Also
+========
+
+taler-exchange-httpd(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: document taler-exchange-kyc-tester,
gnunet <=