Questo semplice client web, realizzato con Django, è utile per sperimentare velocemente le chiamate verso il Gateway FSE 2.0.
Al momento è possibile effettuare le chiamate di validazione che esegue un controllo formale sul file CDA inviato e di pubblicazione.

Questo non è un software ufficiale del progetto FSE 2.0

NB attualmente il servizio di pubblicazione è un mock up che esegue solo alcuni controlli, tra questi il fatto che il CDA sia stato precedentemente validato. Pertanto è necessario validare il CDA prima di poterlo pubblicare

Il file prima dell'invio viene iniettato all'interno di un pdf di test così come richiesto dalle specifiche.

• (Unofficial) FSE GTW Web Client
  • Certificati
  • Configurazione
  • Esecuzione
  • Esecuzione locale
  • Esecuzione container
    • Pull immagine
    • Build immagine

Per poter collegarsi alla piattaforma è necessario avere a disposizione la coppia di certificati x509 di autenticazione e di firma.
I certificati devono essere ognuno in un unico file con la chiave concatenata al certificato in formato pem.

    -----BEGIN PRIVATE KEY-----
    ......
    -----END PRIVATE KEY-----
    -----BEGIN CERTIFICATE-----
    ......
    -----END CERTIFICATE-----

Se si dispone dei file p12 è possibile ottenere le 2 componenti dei certificati mediante il comando openssl:

    openssl pkcs12 -nodes -in nomefile.p12

e specificando la password di importazione.
NB se openssl dovesse dare un errore di formato non compatible sul certificato provare ad aggiungere il parametro -legacy

ATTENZIONE

Non esporre pubblicamente il servizio

Prima di poter eseguire il programma è necessario creare un file settings.py all'interno della directory gtwclient, è possibile modificare e/o copiare il file gtwclient/settings-sample.py

È possibile valorizzare la variabile d'ambiente GTW_BASE_URL per specificare l'url dell'istanza del gateway da puntare, il valore di default punta all'istanza di validazione del Gateway.

È possibile valorizzare la variabile GTW_DUMP_REQUEST per ottenere il dump dell'ultima richiesta http e dell'ultimo pdf inviato al gateway. La richiesta e il file vengono salvati in 2 file: last_request.txt e last_pdf.pdf

Nel caso di build del container è possibile mettere le variabili nel file env-container.

Ci sono 2 modalità di esecuazione del client:

• come progetto Django sul proprio pc
• come container

È necessario python >= 3.8 si consiglia l'utilizzo di un virtual environment

    python -m venv venv
    . venv/bin/activate

• installazione dipendenze:

    pip install -r requirements.txt
  

• inizializzazione database (la configurazione standard creerà un database sqlite locale):

    ./manage.py migrate
  

• certificati: è possibile inserire i certificati all'interno di file o farne l'upload da pagina web.

  • Configurazione file:
    • mettere il file client_auth contenente i certificati di autenticazione nella directory base (quella contenente manage.py)
    • mettere il file client_sign contenente i certificati di firma nella directory base
  • Upload certificati:
    • È possibile fare l'upload dei certificati incollandoli nella pagina Caricamento certificati

a questo punto è sufficiente avviare è possibile avviare il server di sviluppo con:

    ./manage.py runserver

questo farà partire il server di sviluppo sulla porta 8000 ci si potrà quindi collegare a http://localhost:8000

Per l'esposizione del servizio verso l'esterno è necessario:

• nel file settings.py

  • Cambiare la variabile DEBUG a False
  • Generare una nuova stringa SECRET_KEY

    • è possibile farlo con:

        python -c "import secrets;print(secrets.token_hex())"
      

• lanciare il programma con gunicorn (già installato tra le dipendenze) dalla directory base

    gunicorn -b 0.0.0.0:4000 -w4  --access-logfile - --error-logfile - -t16 gtwclient.wsgi
  

È possibile utilizzare il package disponibile nel repository:

1. Pull dell'immagine

    docker pull ghcr.io/zukka77/gtwclient:main
   

   oppure, nel caso si utilizzi podman

    podman pull ghcr.io/zukka77/gtwclient:main
   

2. Esecuzione del container:

   • Certificati su file:
     Per l'esecuzione è necessario passare i certificati al container, ciò avviene attraverso l'environment di esecuzione nelle variabili CLIENT_AUTH e CLIENT_SIGN

            docker run --rm -ti -e CLIENT_AUTH="$(cat client_auth)" -e CLIENT_SIGN="$(cat client_sign)" -p 4000:4000 ghcr.io/zukka77/gtwclient:main  
     

     o in alternativa:

            podman run --rm -ti -e CLIENT_AUTH="$(cat client_auth)" -e CLIENT_SIGN="$(cat client_sign)" -p 4000:4000 ghcr.io/zukka77/gtwclient:main  
     

     dove il file client_auth contiene i certificati di autenticazione, e il file client_sign contiene i certificati di firma.

   • Upload certificati:
     nel caso si decida di fare upload dei certificati non è necessario passarli nell'environment

            docker run --rm -ti -p 4000:4000 ghcr.io/zukka77/gtwclient:main
     

     o in alternativa:

            podman run --rm -ti  -p 4000:4000 ghcr.io/zukka77/gtwclient:main
     

     NB se si sceglie di fare upload dei certificati sarà necessario caricarli ad ogni avvio del container.

Oppure nel source tree è presente il Dockerfile per la generazione di un container.
È possibile eseguire il build con il comando:

    docker build . -t gtwclient:latest

gtwclient:latest è un nome di esempio è possibile scegliere il nome che si preferisce.
Se si utilizza podman e buildah al posto di docker è possible eseguire il build con:

    buildah bud -t gtwclient:latest

Per passare i certificati al container, attraverso l'environment di esecuzione si utilizzano le variabili CLIENT_AUTH e CLIENT_SIGN:

    docker run --rm -ti -e CLIENT_AUTH="$(cat client_auth)" -e CLIENT_SIGN="$(cat client_sign)" -p 4000:4000 gtwclient

o in alternativa:

    podman run --rm -ti -e CLIENT_AUTH="$(cat client_auth)" -e CLIENT_SIGN="$(cat client_sign)" -p 4000:4000 gtwclient

dove client_auth contiene i certificati di autenticazione, client_sign contiene i certificati di firma.

Se si decide di effettuare l'upload dei certificati è possibile avviare i container senza specificare le variabili d'ambiente:

    docker run --rm -ti -p 4000:4000 gtwclient

o in alternativa:

    podman run --rm -ti -p 4000:4000 gtwclient

A questo punto sarà possibile collegarsi al client su http://localhost:4000