Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootPlatformsservices (NAP) - Leverancebeskrivelse
includeroottrue


Warning
NAP projektet er ikke aktivt og NAP er derfor ikke pt. under support og vedligehold.
NAP er ikke opdateret til at understøtte MitID/NemLogin3 og det er derfor ikke længere
muligt at anvende den nuværende version på testmiljøerne.
En evt. genoptagelse af NAP projektet vil afhænge af konkret efterspørgsel.
Kontakt evt. Sundhedsdatastyrelsen ved interesse i NAP.

Table of Contents


Introduktion

...

Kom i gang med NAP som projektudvikler

Hvis man vil For at oprette et nyt projekt som skal ind i NAP 'en er de overordnede der 3 trin:

  1. Hent og byg NapJavaHost
  2. Udvikling af dit projekt
  3. Publicering af dit projekt på test miljøerne

I følgende beskrives opsætningstrinene for at komme i gang med NAP platformen mere detaljeret.

Nap-host-java

Start med at hente bygge nap-host-java I den executable der skal bruges.

Windows

Mac OS X

Linux

(NapJavaHost - kildekode) med java 13 jdk  via følgende kommando `mvn clean install`. Kør så efterfølgende applikationen med  `java -jar ./target/NapHostJava-fat.jar`.


Når nap-host-java åbnes, vil der blive præsenteret en login dialog.  

...

Applikationen viser 4 faner, hvor 3 af dem har screenshots som billeder (for at simulere et værtssytem), men den sidste fane fanen "Afprøvningsløsning", indeholder en chromium browser som åbner nap-lobby-web, som viser de .

Her fra kan brugerens tilgængelig projekter ses.

Indtast et cpr nummer på en test person (Eksempelvis "2708599967", som er et hyppigt anvendt test cpr nummer), herefter kan der browses rundt i fanerne.

...

Hvis dette projekt trykkes på, vil nap-java-host åbne en, hvilken som helst applikation der hostes på http://localhost:4600.

For at anvende se eksempler på anvendelse af kontekstbroen til at kommunikere med hostsystemet kan ses mere henvises til NAP SDK - Guide til anvendere samt NAP Ref.Impl. - Guide til anvendere.

Publicering af dit projekt

Når dit projekt er klar til at blive testet i NSPs testmiljøer skal du have registret dit personlige / din virksomheds moces test certifikat som administrator i NAP.

...

Efterfølgende kan du bruge det certifikat til at logge ind på TILFØJ NAP-ADMIN NEMID URL 

NAP test1

hvorfra du kan til føje tilføje metadata omkring dit projekt.

NapJavaHost understøtter tilføjelse af nye moces certifikater, hvis moces certifkaterne kun har 1 enkelt registreret autorisation.

Derfor kan du tilføje dit certifikat i nap-javahost-host, login på test1 i NapJavaHost, og se om projektet er tilgængeligt for dig og virker som forventet. 

Kom igang med NAP som værtssystem-/ LPS udvikler

I det følgende beskrives, hvordan man som værtssystem-/ LPS udvikler, skal integrerer NAP platformen ind i det respektive sit system. 

Integrationen med NAP

...

I det nedenstående vil eksemplerne tage udgangspunkt i JavaFXJava, og der kan derfor også tages udgangspunkt i nap-host-java, hvis der er brug for inspiration.

nap-java-host på SVN.

Opsætning af kommunikation med SDK.

...

Code Block
languagejfx
titleNAPBridge implementering
public class NAPBridge {
        private JSObject bridgehandler;

        /**
         * Transforming a JSON string into a NAPMessage and sending it to subscribers.
         * The handle to send messages to this host.
         * @param rawEventString A raw string representation of the NAP message
         */
        public void send(String rawEventString) {
            try {
                System.out.println(this.getClass().getName() + " send(): " + rawEventString);
                NAPMessage msg = objectMapper.readValue(rawEventString, NAPMessage.class);
                notifyListeners(msg);
            } catch (IOException ioException) {
                System.out.println(this.getClass().getName() + " " + ioException);
            }
        }

        /**
         * Sets the bridge to act as a callback.
         * This handle will be used to send messages out from the host.
         * @param bridge handler JSObject representing the callback handle.
         */
        public void setCallback(JSObject bridgehandler) {
            System.out.println(this.getClass().getName() + " setCallBack(): " +  bridgehandler);
            this.bridgehandler = bridgehandler;
        }
    }
}

Et JS objekt, som bridge variablen, gør at man kan eksekvere javascript metoder og undersøge javascript properties. 

...

Send(), er et håndtag til at sende beskeder til hosten, der gør brug af et internt subscribe pattern, som notificere notificerer dem, som lytter. En implementering af dem der lytterobserver / listener, kunne se således ud:

Code Block
languagejfx
titleIndkommende NAP beskeder
private void handleBridgeCallBacks(NAPMessage napMessage) {
        switch (napMessage.getEvent().getNAPEventType()) {
            case PatientOpen:
                sendCurrentPatient(txfCPR.getText(), napMessage.getDate(), napMessage.getId());
                break;
            // ONLY Sent by NAP Lobby and Nap Test WEB
            case WebAppSelected:
                handleWebAppSelected(napMessage);
                // ONLY Sent by NAP Lobby and Nap Test WEB
                break;
            case ProjectsRetrieved:
                filterProjectsRetrievedAndSendMessage(napMessage);
                break;
            case SessionClose:
                handleSessionClose(napMessage);
                break;
            case SessionError:
                handleSessionError(napMessage);
                break;
            default:
                System.err.println("Unexpected event type: " + napMessage.getEvent().getNAPEventType());
        }
}

...

Når der skal sendes en NAP besked fra værts applikation, kan der så gøres brug af bridgen. Call() tager imod en string, som angiver hvilken metode man vil kalde, her "handle", da det er den variable som SDK'et lytter på. Metoden sender  Metoden tager en string som parameter, hvori indholdet repræsentere er en JSON struktur med indholdet af der repræsenterer en NAPMessage.

Code Block
languagejfx
titleBrug af Nap Bridge
 if(napBridge.bridge != null) {
     this.napBridge.bridge.call("handle", eventRawJSONString);
 }

...

Projektet har til hensigt at teste , at der kan sendes og modtages beskender igennem NAP SDK'erneværtssystemers integration af NAP. Der udstilles en test suite indeholdende en test, der sender en NAP besked for samtlige events.

Der er separate tests cases, som kan køres enkeltvis eller samlet. Den er derfor oplagt til at teste et værksystems implementering af eventkataloget.

Dette afprøvningsprojekt ligger både på test1 og test2 og kan åbnes fra lobbyen i det givne miljø.

Webappen med det givne id, kan så efterfølgende hentes på adminurl/webapp/id på hosten og åbnes i den indlejrede browser.

Test1: INDSÆT URL

Test2: INDSÆT URL

Test1: https://test1-nap.insp.nspop.dk:8443/testweb/

Bemærk, at testene fejler, hvis ikke applikationen er indlejret i en host, som har implementeret NAP bridge.Produktion: INDSÆT URL

NAP Lobby Web

Når kommunikationen er opsat med SDK'erne, er det nu klart til at vise alle de projekter der er tildelt.

...

For at se de projekter der er tilgængelige, skal NAP Lobby Web åbnes i det nuværende system.

Dette gøres ved at få WebView'et til at indlæse en af nedenstående URL'er til nap-lobby-web.

Test1: INDSÆT URL

Test2: INDSÆT URL

.

Sikkerbrowser opstart

Sikker Browser opstart af Nap Lobby Web følger protokollen "Sikker browser opstart version 2".

Lignende implementationer kan ses i FMK-online og læses her https://wiki.fmk.netic.dk/lib/exe/fetch.php?media=fmk:fmko:guide_til_anvendere_af_sbov2_1_2.pdf og her for eGraviditet *Graviditetsmappe Web Facade - Guide til anvendere.

Anvendelse af Sikker Browseropstart i fagsystem

En forudsætning for at kunne tilgå Nap Lobby Web via Sikker Browseropstart er, at fagsystem har dannet et SOSI idkort, der repræsenterer brugerens login-session på fagsystemet. Trækning og signering af SOSI idkort er er ikke beskrevet her, men er dokumenteret i https://www.digitaliser.dk/resource/456411/artefact/SOSIprogrammersguide.doc?artefact=true&PID=456417.

Givet at fagsystemet har dannet et idkort for brugeren, er de nødvendige skridt for at tilgå Nap Lobby Web via Sikker Browseropstart i kort form:

  1. Idkortet omveksles til en SAML assertion via et webservicekald til SOSI STS. 2 http://test1.ekstern-test.nspop.dk:8080/sts/services/Sosi2OIOSaml 
  2. Den modtagne SAML assertion indlejres i et SAML Response.
  3. Fagsystemet udstiller en webapplikation for brugeren, som brugerens browser dirigeres til.
  4. Denne webapplikation sender et response til brugerens browser, som indeholder en HTML 5 FORM, som automatisk POST’es til FMK-online ved load. Denne FORM indeholder ovennævnte SAML assertion i base64 enkoded form. 
  5. https://test1-nap.insp.nspop.dk:8443/lobby/saml/SAMLAssertionConsumer accepterer den POST’ede SAML assertion, og brugeren er nu logget ind.

Disse skridt er beskrevet i større detalje i det følgende.

Den relevante API er generelt beskrevet i https://www.digitaliser.dk/resource/456411/artefact/SOSIprogrammersguide.doc?artefact=true&PID=456417.

Desuden findes et implementerings eksempel i https://svn.nspop.dk/src/components/nap/nap-host-java/trunk/.

Omveksling af SOSI idkort til SAML-assertion

SOSI idkortet omveksles til en SAML-assertion via et webservice-kald til STS. Se https://www.nspop.dk/display/public/web/STS+-+Medarbejder-Billetomveksling for beskrivelse af omveksling fra SOSI idkort til SAML assertion (afsnit 7 beskriver overordnet den relevante omveksling, afsnit 8 indeholder links til eksempelkode: IDcardToOIOSAMLExample.java.

Der skal ved omveksling angives et ”audience”.

Den relevante værdi for audience er for NSPs testmiljøer en af følgende:

  1. https://saml.test1-nap.insp.nspop.dk/lobby

  2. https://saml.test2-nap.insp.nspop.dk/lobby

Indlejring af SAML-assertion i SAML-response

Den modtagne SAML assertion skal efterfølgende indsættes i en SAML Response xml-struktur. Det opbyggede SAML Response skal have følgende form.

<samlp:Status>
 <samlp:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
 </samlp:Status>
 <saml:EncryptedAssertion
xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">...</saml:EncryptedAssertion>
</samlp:Response

saml:EncryptedAssertion elementet repræsenterer svaret fra omvekslingen af idkort til SAML assertion i STS, og er her vist i forkortet form.

Post af SAML-response fra webapplikation i fagsystem

For at tilgå Nap Lobby Web via Sikker Browseropstart, skal brugerens browser POST’e en HTML FORM med det opbyggede SAML Response til eGradivitet.

Dette kan fx opnås ved at fagsystemet udstiller en webapplikation, der kan returnere et response med et onload script, der POST’er formen. Dette response kan opbygges således:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html, charset=utf-8" />
<title>SAML 2.0 POST</title>
</head>
<body onload='document.forms[0].submit()'>
<form action='https://test1-nap.insp.nspop.dk:8443/lobby/saml/SAMLAssertionConsumer' method='post'>
<input type='hidden' name='SAMLResponse' value='wrappedSamlResponse'/></form>
</body>
</html>

SAMLResponse-parameterens tilhørende value er her vist forkortet i form, men skal indeholde en base64 enkodet repræsentation af det opbyggede SAML Response.

Indholdet af action attributten afspejler hvilket miljø, der ønskes brugt (test eller produktion).

Action attributten kan starte med en af følgende url’er,

Test 1: https://test1-nap.insp.nspop.dk:8443/lobby/saml/SAMLAssertionConsumer

Test 2: https://test2-nap.insp.nspop.dk:8443/lobby/saml/SAMLAssertionConsumer

Opstart af andre projekter fra Nap Lobby Web

Samme procedure for Sikker browser opstart gør sig gældende for andre afprøvningsprojekter, fx Nap Reference Web,  hvor urlen slutter på /saml/SAMLAssertionConsumer. 

Når et projekt klikkes i Lobby sendes en besked af typen WebAppSelected se https://www.nspop.dk/display/public/web/NAP+SDK+-+Guide+til+anvendere hvor i audience og url er beskrevet.

Opstart som standalone

Lobbyen kan også åbnes om standalone på Test1: https://test1-nap.insp.nspop.dk:8443/lobby

Hvor det er muligt at logge ind med moces certifikater. Dette er egnet til projektadministratorer for at oprette et projekt ellere redigere et projekt.Produktion: INDSÆT URL