Page History
...
Det første afsnit beskriver de den arkitekturmæssige begrundelser motivation for indførelse indførelsen af NSP Audit API.
Dernæst vises hvordan NSP Audit API rent praktisk indføres i en NSP komponent med konkrete eksempler på anvendelse. . Denne sektion er især relevant for udviklere, der skal bruge NSP Audit API i forbindelse med en konkret opgave.
Efterfølgende vises "effekten" af anvendelse af NSP Audit API - hvilke informationer logges, og hvor stammer de fra. Dette giver et overblik over, hvilke oplysninger, som anvender/udvikler selv er ansvarlig for at skaffe, og hvilke der bliver logget af NSP Audit API automatisk.
Til sidst Tilsidst inkluderes en "dokumentationsskabelon", der kan anvendes som input til de konkrete driftsmanualer for de NSP komponenter, der anvender NSP Audit API.
...
Kravene til indholdet af auditloggen er sammenfaldende henover NSP'ens services i forhold til information om hvornår og hvem, der har lavet foretaget en handling, som er auditloggetskal auditlogges.
Hvad, der skal auditlogges, er i høj grad op til den enkelte NSP komponent og de forretningsmæssige og juridiske krav, der omgiver denne.
Ensartetheden i forhold til granularitet og format for audit informationer vil lette letter det efterfølgende arbejde med disse - både i forhold til opfølgning og anvendelse og i forhold til den generelle håndtering og opbevaring.
NSP Audit API er derfor født ud af ønsket om:
- At gøre det let for NSP komponenter at auditlogge
- At sørge for at informationsniveauet i auditloggen er ensartet henover de forskellige komponenter
- At sørge for at strukturen i auditloggen er ensartet henover de forskellige komponenter
...
For at anvende NSP Audit API i en konkret NSP komponent i udviklingsmæssig sammenhæng, så er der et par tekniske øvelser, der skal være på plads. Da hovedparten af NSP'ens komponenter er bygget op på samme måde, så vil denne vejledning umiddelbart kunne anvendes i langt de fleste tilfælde. Antagelsen i denne vejledning er derfor at:
- Komponenten anvender Maven til styring af tredjeparts dependencies
- Komponenten afvikles på Wildfly (evt via et af NSP'ens Docker images)
...
Dernæst vises det med et praktisk eksempel hentet fra Dokumentdelingsservicen, hvordan NSP Audit API kan anvendes i koden applikationskode til at implementere relevant auditlogning.
Maven dependency
...
NSP Audit API adskiller sig ikke fra andre tredjeparts biblioteker i den forstand og kræver således blot, at følgende tilføjes til rækken af dependencies (NB! tjek versionsnummer i forhold til den gældende version) i konfigurationsfilen (pom.xml):
...
Provided scope i Maven benyttes til at udtrykke en afhængighed til et tredjeparts bibliotek, som ikke skal inkluderes i modulet selvlibrary uden dette inkluderes i det færdigbyggede modul (jar/war), men som i stedet antages at blive stillet til rådighed (provided) af de omgivelser, som modulet afvikles i.
Afviklingsomgivelserne for en NSP komponent er Wildfly (evt via et af NSP'ens Docker images). I det følgende afsnit vises, hvordan man sørger for, at Wildfly rent faktisk stiller NSP Audit API til rådighed for den anvendende komponent og derved opfylder kontrakten, som blev udtrykt i Maven konfigurationsfilen.
...
I forgående afsnit blev det fremhævet, at det ikke er en NSP komponents ansvar selv at inkludere NSP Audit API i dens færdigbyggede modul.
I stedet udtrykker komponenten, at den regner med, at de omgivelser, hvori den efterfølgende afvikles, stiller NSP Audit API til rådighed for denpå afviklingstidspunktet.
Afviklingsomgivelsern Afviklingsomgivelserne for en standard NSP komponent er Wildfly (evt via et af NSP'ens Docker images). På Wildfly findes en række tredjeparts biblioteker, der leveres med platformen - herunder også NSP Audit API.
Som default er de fleste af disse bibliotekter afskærmet og således ikke til rådighed for komponenten på afviklingstidspunktet - men via en særlig konfigurationsfil (som Wildfly forstår) kan det udtrykkes, at komponenten ønsker, at få adgang til et eller flere af disse biblioteker.
For at Wildfly kan stiller NSP Audit API til rådighed for en komponent skal filen /src/main/webapp/WEB-INF/jboss-deployment-structure.xml findes i Maven projektet og i det byggede modul og have følgende indhold:
...
Det er komponentens eget ansvar at sørge for, at der er sammenhæng mellem disse. Eventuelle versionsforskelle mellem det, som en komponent tror, at den inkluderefår stillet til rådighed, og det, som den rent faktisk inkluderer får stillet til rådighed, kan give en masse udfordringer og underlige fejl (NoSuchMethodException mv, ClassNotFoundException med flere), når komponenten afvikles og anvender NSP Audit API.
...
I ovenstående eksempel er det NSP Audit API version 1.0.1, der stilles til rådighed af den konkrete version af Wildfly, hvilket hænger fint sammen med det versionsnummer, der blev udtrykt i Maven afhængigheden (i pom.xml).
...
Når en komponent har fået sat afhængighed op til NSP Audit API, er den udvikleren klar til at begynde at anvende dette til auditlogningsformål.
...
- Oprettelse af en AuditBuilder til et kald (request) mod servicen, der ønsker at auditlogge
- Tilføjelse af konkrete auditloginformationer til konkret den oprettede AuditBuilder i forbindelse emd servicens udførelse af kald (request)med at servicen laver sit arbejde
Fordi AuditBuilder er koblet sammen med platformens håndtering af kald (request/response), er der ikke brug for at komponenten kalder en commit metode eller lign.
...
Dette opretter en Audit Builder som kan føres med rundt i komponenten og kaldes hver gang audit information i forbindelse med kaldet opstårservicen har brug for at auditlogge noget.
| Warning |
|---|
Det er vigtigt at denne linie udføres på den samme tråd som kalder komponentens Servlet metoder, annoterede WebMethod metoder eller lign. Dette sikrer at platformen kan koble builderen sammen med det request/response der er i gang. |
...
Alternativt kan man lave en ny NSP Audit Provider og få den loadet ved at placere provider-configuration filen dk.sds.nsp.audit.AuditProvider i en passende META-INF/services folder. Se Java Service Loader dokumentationen for detaljer.
I praksis vil der ikke være brug for dette, da fallback development provider i de fleste tilfælde er fuldt ud dækkende.
| Warning |
|---|
En leverance af en komponent til NSP må ikke indeholde en provider-configuration fil idet dette kunne påvirke andre komponenter på platformen. |
...
. |
Tilføjelse af konkrete auditloginformationer
...
Fælles for alle metoder er at de kræver følgende argumenter:
- component: Komponentens aftalte forkortelse. Ofte forkortelsen af det projekt som stod bag komponenten. F.eks. STS, DDS, SDM, DCC mv.
- context: Navnet på den context som komponenten er i lige nu. Det kunne f.eks. være hvilken service der er kaldt i komponenten, hvilken delkomponent der er i brug mv.
- type: En af de mulige værdier "SensitivePersonalInformation", "RegularPersonalInformation" eller "NonPersonalInformation". Alt efter om der er tale om følsomme personoplysninger, almindelige personoplysninger eller oplysninger der ikke er knyttet til en person. Det er vigtigt at der vælges den korrekte type da det har konsekvens for hvem der har adgang til data.
- key: En valgfri nøgle for den information der tilføjes. F.eks "cpr", "cvr", "samtykke" eller lign.
- value(s): Den eller de værdier der skal tilføjes til audit loggen.
...
Værdierne, der sendes med, er af typen Object. Metoden toString() bliver anvendt på de medsendte values objekter for at få dem serialiseret til er format, der kan logges. Som en undtagelse hertil skal nævnes values objekter af typen javax.json.JsonObject. Værdier af denne type håndteres specielt af NSP Audit API, der laver en pæn rendering i JSON format.
...
I de forgående afsnit blev det gennemgået, hvordan NSP Audit API kan anvendes i NSP komponenters kode for let at kunne auditlogge de informationer, som der i den enkelte komponent er blevet bestemt skal auditlogges.information.
I det følgende Det demonstreres gennem eksempler fra Dokumentdelingsservice, hvorledes anvendelsen af NSP Audit API kommer til udtryk i forhold til informationsniveau i den resulterende auditlog.
Herigennem bliver det muligt for udviklere af NSP komponenter at forstå, hvilke informationer, der stammer fra afviklingsplatformen (således givet ved brugen af NSP Audit API), og hvilke der stammer fra komponenten selv.
...
I det forgående kapitel blev Dokumentdelingsservicens fremsøgningsservice brugs som eksempel på at vise, hvordan en konkret NSP service havde implementeret auditlogning. Igennem afvikling af Dokumentdelingsservicens integrationstest kan vi vise eksempler på, hvordan auditloggen kommer til at se ud, når fremsøgningsservicen anvendes. For komplethedens skyld har vi inkluderet to kald af fremsøgningsservicen: Et, hvor en borger fremsøger sine egne dokumenter og et, hvor en sundhedsprofessionel gør det samme.
...
Det er kun den sektion, der hedder audit, som den anvendende komponent kan påvirke. Hvis man sammenligner indholdet af denne sektion med kodeeksemplet i forgående afsnit, så vil man kunne genkende de enkelte linjer: Hvert kald giver anledning til en struktur i listen af "information".
Det er værd at bemærke, at NSP Audit API selv sørger for at logge soap headers, indhold fra det medsendte idkort eller token samt diverse kvantitative metrikker vedr kaldet. Det behøver man således ikke selv at logge som anvender af API'et.
...
Når NSP Audit API anvendes, anbefales det at man for hver request angives hvilke audit informationer der logges ved at udfylde følgende skema:
| Komponent | Kontekst | Type | Nøgle | Information |
|---|---|---|---|---|
...