kych

OAuth 2.0 API for Swiyu to enable Taler integration of Swiyu for KYC (experimental)
Log | Files | Refs | README | LICENSE

README (2422B)

      1 KYCH Documentation
      2 ==================
      3 
      4 This directory contains technical specifications and diagrams for the
      5 KYCH system.
      6 
      7 For integration with GNU Taler, see the taler-docs/ directory which
      8 contains reStructuredText documentation intended for the official
      9 GNU Taler documentation (https://docs.taler.net/).
     10 
     11 
     12 Files
     13 -----
     14 
     15   vc.md                   Verifiable Credential format specification (SD-JWT)
     16   vp.md                   Verifiable Presentation format specification
     17 
     18   kych_verifier_logo.svg  KYCH verifier logo
     19 
     20 
     21 Man Pages
     22 ---------
     23 
     24 The man page sources live with the rest of the documentation destined for
     25 docs.taler.net, in taler-docs/manpages/, and are built with Sphinx.  There
     26 is no second, hand-written copy.
     27 
     28   taler-docs/manpages/kych-oauth2-gateway.1.rst     The gateway daemon
     29   taler-docs/manpages/kych-client-management.1.rst  The client tool
     30   taler-docs/manpages/kych.conf.5.rst               The configuration file
     31 
     32 The website build renders them from the taler-docs repository.  To build
     33 just the man pages from this repository, using the minimal Sphinx
     34 configuration in sphinx-man/:
     35 
     36   sphinx-build -b man -c documentation/sphinx-man \
     37       documentation/taler-docs/manpages /tmp/kych-man
     38   man /tmp/kych-man/kych.conf.5
     39 
     40 The Debian package does exactly this at build time.  Note that the NAME
     41 line of each page comes from the man_pages entry in the Sphinx
     42 configuration rather than from the document itself, which is why every
     43 source wraps its own "Name" section in ".. only:: html".
     44 
     45 
     46 Sequence Diagrams
     47 -----------------
     48 
     49 The sequence_diagrams/ directory contains ASCII diagrams documenting
     50 the OAuth2 and credential verification flows:
     51 
     52   swiyu_taler_sequence_diagram.txt
     53       Complete end-to-end flow showing how a GNU Taler exchange
     54       interacts with KYCH and the SWIYU verifier for KYC verification.
     55 
     56   setup_sequence.txt
     57       Initial client setup and registration flow.
     58 
     59   authorize_sequence.txt
     60       OAuth2 authorization request and credential verification.
     61 
     62   token_sequence.txt
     63       Token exchange after successful verification.
     64 
     65   info_sequence.txt
     66       User information retrieval endpoint.
     67 
     68   notification_sequence.txt
     69       Webhook callback flow for verification status updates.
     70 
     71 
     72 Related Standards
     73 -----------------
     74 
     75   SD-JWT VC   https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/
     76   OpenID4VP   https://openid.net/specs/openid-4-verifiable-presentations-1_0.html