kych

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

README (2207B)

      1 SWIYU Verifier Local Setup
      2 ==========================
      3 
      4 Scripts and configuration for running the SWIYU Generic Verifier locally
      5 for development. The verifier is a Java Spring Boot application that
      6 implements OpenID4VP (OID4VP) credential verification.
      7 
      8 The upstream verifier source code is maintained separately. This directory
      9 provides convenience scripts for local development with KYCH.
     10 
     11 
     12 Prerequisites
     13 -------------
     14 
     15   - Java 21
     16   - Maven 3.x
     17   - PostgreSQL
     18   - SWIYU verifier source code (clone from upstream)
     19 
     20 
     21 Database Setup
     22 --------------
     23 
     24     ./install_db.sh
     25 
     26 To remove:
     27 
     28     ./uninstall_db.sh
     29 
     30 
     31 Configuration
     32 -------------
     33 
     34 Copy the template and fill in your values:
     35 
     36     cp application-local-dockerless.yml.template application-local-dockerless.yml
     37 
     38 Key configuration options:
     39 
     40     application:
     41       external-url: ""              # Public URL of the verifier
     42       client_id: ""                 # Verifier DID
     43       signing_key: ""               # PEM-encoded signing key
     44       client-metadata-file: "classpath:/client_metadata.json"
     45 
     46     spring:
     47       datasource:
     48         url: "jdbc:postgresql://localhost:5432/verifier_db"
     49         username: "verifier_user"
     50         password: "secret"
     51 
     52     webhook:
     53       callback-uri: ""              # KYCH gateway notification endpoint
     54 
     55 
     56 Running
     57 -------
     58 
     59 Start the verifier:
     60 
     61     ./run.sh
     62 
     63 Build and run:
     64 
     65     ./run.sh clean
     66 
     67 Run with debugger (port 5005):
     68 
     69     ./run.sh -d
     70 
     71 
     72 API Request Examples
     73 --------------------
     74 
     75 The api_requests/ directory contains example scripts and payloads:
     76 
     77   post_management_api_verifications.sh
     78       Create a new verification request.
     79 
     80   get_management_api_verifications.sh
     81       Retrieve verification status.
     82 
     83   request_over_18.json
     84       Example verification request using Presentation Exchange.
     85 
     86 
     87 Files
     88 -----
     89 
     90   run.sh                              Start the verifier
     91   install_db.sh                       Create PostgreSQL database
     92   uninstall_db.sh                     Drop PostgreSQL database
     93   application-local-dockerless.yml.template
     94                                       Configuration template
     95   client_metadata.json                OpenID4VP client metadata
     96   api_requests/                       Example API requests