1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
.\" Man page generated from reStructuredText.
.
.TH "TALER-EXCHANGE-KYC-TESTER" "1" "Nov 03, 2022" "0.9" "GNU Taler"
.SH NAME
taler-exchange-kyc-tester \- test KYC service integration
.
.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 SYNOPSIS
.sp
\fBtaler\-exchange\-kyc\-tester\fP
[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP]
[\fB\-h\fP\ |\ \fB\-\-help\fP]
[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP]
[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP]
[\fB\-i\fP\ \fISECTION_NAME\fP\ |\ \fB\-\-initiate=\fP\fISECTION_NAME\fP]
[\fB\-u\fP\ \fIID\fP\ |\ \fB\-\-user=\fP\fIID\fP]
[\fB\-U\fP\ \fIID\fP\ |\ \fB\-\-legitimization=\fP\fIID\fP]
[\fB\-P\fP\ |\ \fB\-\-print\-payto\-hash\fP]
[\fB\-p\fP\ \fIHASH\fP\ |\ \fB\-\-payto\-hash=\fP\fIHASH\fP]
[\fB\-r\fP\ \fINUMBER\fP\ |\ \fB\-\-rowid=\fP\fINUMBER\fP]
[\fB\-v\fP\ |\ \fB\-\-version\fP]
[\fB\-w\fP\ |\ \fB\-\-run\-webservice\fP]
.SH DESCRIPTION
.sp
\fBtaler\-exchange\-kyc\-tester\fP 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 \fInot\fP required at all during production.
.sp
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.
.INDENT 0.0
.TP
\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP
Use the configuration and other resources for the exchange to operate
from \fIFILENAME\fP\&.
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP
Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
\fBWARNING\fP, \fBERROR\fP\&.
.TP
\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP
Send logging output to \fIFILENAME\fP\&.
.TP
\fB\-i\fP \fISECTION_NAME\fP | \fB\-\-initiate=\fP\fISECTION_NAME\fP
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.
.TP
\fB\-u\fP \fIID\fP | \fB\-\-user=\fP\fIID\fP
Run the process with ID for the user identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP as that option will override whatever value is provided here.
.TP
\fB\-U\fP \fIID\fP | \fB\-\-legitimization=\fP\fIID\fP
Run the process with ID for the legitimization process identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP as that option will override whatever value is provided here.
.TP
\fB\-p\fP \fIHASH\fP | \fB\-\-payto\-hash=\fP\fIHASH\fP
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.
.TP
\fB\-P\fP | \fB\-\-print\-payto\-hash\fP
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 \fB\-p\fP\&.
.TP
\fB\-r\fP \fINUMBER\fP | \fB\-\-rowid=\fP\fINUMBER\fP
Run the process with NUMBER as the database row for the legitimization operation. Rarely useful, except maybe for debugging. Defaults to 42.
.TP
\fB\-v\fP | \fB\-\-version\fP
Print version information.
.TP
\fB\-w\fP | \fB\-\-run\-webservice\fP
Run a simulated Taler exchange HTTP service on the configured port with the \fB/kyc\-proof/\fP and \fB/kyc\-webhook/\fP endpoints.
.UNINDENT
.SH SEE ALSO
.sp
taler\-exchange\-httpd(1), taler.conf(5).
.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-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.
|
