Dette dokument beskriver NSP Audit API til auditlogning på NSP.

Det første afsnit beskriver den arkitekturmæssige motivation for 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 inkluderes en "dokumentationsskabelon", der kan anvendes som input til de konkrete driftsmanualer for de NSP komponenter, der anvender NSP Audit API.

1. Arkitekturoverblik og motivation for NSP Audit API

Auditlogning er en capability, som er nødvendig for mange af NSP'ens komponenter: Af juridiske hensyn er det nødvendigt at kunne følge op på hvem, der har gjort hvad og hvornår henover NSP'ens service portefølje.

Det giver mening at auditloggen opsamles og gemmes centralt henover alle NSP'ens komponenter, idet beskaffenheden af disse logs stiller særlige krav til opbevaring og håndtering.

Kravene til indholdet af auditloggen er sammenfaldende henover NSP'ens services i forhold til information om hvornår og hvem, der har foretaget en handling, som skal 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 letter det efterfølgende arbejde med disse - både i forhold til opfølgning og i forhold til den generelle håndtering og opbevaring.

NSP Audit API er derfor født ud af ønsket om:

  1. At gøre det let for NSP komponenter at auditlogge
  2. At sørge for at informationsniveauet i auditloggen er ensartet henover de forskellige komponenter
  3. At sørge for at strukturen i auditloggen er ensartet henover de forskellige komponenter

NSP Audit API stiller rammer og funktioner til rådighed for NSP komponenterne, så de bliver i stand til at løse problemet omkring audit logning.

NSP Audit API overview

2. Anvendelse af NSP Audit API i NSP 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 dependencies
  • Komponenten afvikles på Wildfly (evt via et af NSP'ens Docker images)

I de følgende afsnit gennemgåes først, hvordan en komponent forberedes til at kunne anvende NSP Audit API ved at udtrykke både en kodemæssig og en afviklingsmæssig afhængighed til NSP Audit API.

Dernæst vises det med et praktisk eksempel hentet fra Dokumentdelingsservicen, hvordan NSP Audit API kan anvendes i applikationskode til at implementere relevant auditlogning.

2.1. Maven dependency

Langt de fleste NSP komponenter anvender Maven til at holde styr på afhængigheder til tredjeparts biblioteker.

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):

<dependency>
    <groupId>dk.sds.nsp.audit</groupId>
    <artifactId>audit-api</artifactId>
    <version>1.0.1</version>
    <scope>provided</scope>
</dependency>

Det er vigtigt at notere sig, at afhængigheden til NSP Audit API skal have provided scope.

Provided scope i Maven benyttes til at udtrykke en afhængighed til et library 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.

2.2. Wildfly dependency

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 på afviklingstidspunktet.

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:

<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <!-- NSP komponenter styrer selv logning -->
        <exclude-subsystems>
            <subsystem name="logging"/>
        </exclude-subsystems>

        <!-- Denne komponent anvender NSP Audit API -->
        <dependencies>
            <module name="dk.sds.nsp.audit"/>
        </dependencies>
    </deployment>
</jboss-deployment-structure>

Det er vigtigt af forstå, at der ikke nødvendigvis er sammenhæng mellem det versionsnummer af NSP Audit API, som bliver udtrykt i Maven afhængigheden, og den version af NSP Audit API, der bliver stillet til rådighed af Wildfly.

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 får stillet til rådighed, og det, som den rent faktisk får stillet til rådighed, kan give en masse udfordringer og underlige fejl (NoSuchMethodException, ClassNotFoundException med flere), når komponenten afvikles og anvender NSP Audit API.

I praksis kan man tjekke versionen af NSP Audit API, der bliver stillet til rådighed af Wildfly, på følgende måde:

Tjek af version af NSP Audit API i Wildfly
root@7e07691acb13:~# cd /tmp
root@7e07691acb13:/tmp# jar xf /pack/wildfly8/modules/system/layers/base/dk/sds/nsp/audit/main/audit-api.jar
root@7e07691acb13:/tmp# cat META-INF/MANIFEST.MF
Manifest-Version: 1.0
Implementation-Title: NSP Audit API
Implementation-Version: 
Archiver-Version: Plexus Archiver
Built-By: root
Created-By: Apache Maven 3.5.4
Build-Jdk: 1.8.0_275
Specification-Version: 1.0.1

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).

2.3. Udvikling af auditlogning vha NSP Audit API

Når en komponent har fået sat afhængighed op til NSP Audit API, er udvikleren klar til at begynde at anvende dette til auditlogningsformål.

Anvendelse af NSP Audit API kan deles op i to punkter:

  1. Oprettelse af en AuditBuilder til et kald (request) mod servicen, der ønsker at auditlogge
  2. Tilføjelse af konkrete auditloginformationer til den oprettede AuditBuilder i forbindelse 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.

Der skal derfor ikke gøres mere end de to nævnte punkter. Disse gennemgåes i det følgende.

2.3.1. Oprettelse af AuditBuilder

Anvendelse af NSP Audit API er meget simpel. For hver request som komponenten modtager skal følgende linie kaldes:

AuditBuilder auditBuilder = Audit.createAuditBuilder();

Dette opretter en Audit Builder som kan føres med rundt i komponenten og kaldes hver gang servicen har brug for at auditlogge noget.

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.

Når man kalder createAuditBuilder metoden i NSP Audit API'et anvender denne Java Service Loader systemet til at finde en NSP Audit Provider.

Når komponenten afvikles i drift på NSP platformen, vil der være en provider tilgængelig som rent faktisk står for at logge audit informationerne for hvert request. Det er driftens ansvar at sørge for, at dette sker

Under udvikling er det dog stadig muligt at bruge NSP Audit API idet den indeholder en fallback development provider. Denne provider skriver en advarsel til stderr om at den ikke må bruges i et driftet NSP miljø, men foretager sig ellers ikke noget pr. default. Hvis man sætter følgende system property vil den skrive hver audit information ud på stdout som et JSON objekt:

dk.sds.nsp.audit.DevelopmentAuditProvider.enabled=true

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.

En leverance af en komponent til NSP må ikke indeholde en provider-configuration fil idet dette kunne påvirke andre komponenter på platformen.

2.3.2. Tilføjelse af konkrete auditloginformationer

En AuditBuilder har 4 forskellige metoder til at tilføje audit information.

Den eneste forskel mellem metoderne er, hvordan den eller de valgte værdier er pakket ind.

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.


public void addAuditInformation(String component, String context, TypeOfInformation type, String key, Object value);
public void addAuditInformation(String component, String context, TypeOfInformation type, String key, Supplier<?> value);
public void addAuditInformation(String component, String context, TypeOfInformation type, String key, Object... values);
public void addAuditInformation(String component, String context, TypeOfInformation type, String key, Iterable<?> values);

I forhold til hvilke værdier, der skal auditlogges, så er det op til den enkelte komponent at afklare det juridske behov i det konkrete tilfælde.

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.

2.3.3. Dokumentdelingsservice: Eksempel på implementation af auditlogning via NSP Audit API

I de forgående afsnit blev det gennemgået, hvordan en AuditBuilder skal oprettes og håndteres i en NSP komponent, der ønsker at auditlogge, og hvorledes auditloginformationer kan tilføjes i løbet af servicens behandling af et kald.

I dette afsnit kigger vi på konkrete eksempler på dette taget fra Dokumentdelingsservice.

Dokumentdelingsservice gør det muligt for anvendere at fremsøge lister af dokumenter for borgere med forskelligt indhold f.eks. aftaler, laboratoriesvar og stamkort. Der er behov for at auditlogge hvem, der har tilgået disse informationer hvornår. Denne fremsøgningsservice kan anvendes både af borgere (IDWS snitflade) samt af sundhedsprofessionelle (DGWS snitflade).

Uanset om anvenderen er en borger eller en sundhedsprofessionel anvendes klassen DDSRegistryQueryImpl til at implementere selve fremsøgninglogikken - herunder også auditlogning af svaret:

Fremsøgningslogik for Dokumentdelingsservice - herunder auditloging
public class DDSRegistryQueryImpl {
	static Logger logger = Logger.getLogger(DDSRegistryQueryImpl.class);

	@Autowired
	private AuditLogning auditLogning;

	...

	public AdhocQueryResponse documentRegistryRegistryStoredQuery(AdhocQueryRequest adhocQueryRequestBody, DDSContext context) throws Exception {
		try {
			final AdhocQueryRequestWrapper adhocQueryRequestWrapper = new AdhocQueryRequestWrapper(adhocQueryRequestBody, context);
			String patientId = adhocQueryRequestWrapper.getPatientId();			
			...			
			AuditBuilder auditBuilder = Audit.createAuditBuilder();
			auditLogning.auditLogIti18Response(auditBuilder, patientId, context.getActingUserCivilRegistrationNumber(), context.getResponsibleUserCivilRegistrationNumber(), adhocQueryRequestBody.getAdhocQuery(), response);
			return response;
		} catch (NegativeConsentException e) {
			return AdhocQueryResponseWrapper.createNegativeConsentResponse();
		}
	}

Som det kan ses, så oprettes AuditBuilderen først og dernæst sendes denne samme med parametre fra kaldet og fra kaldskonteksten (CPR nummeret på den kaldende og ansvarlige person) ned i en hjælpeklasse AuditLogning, som Dokumentdelingsservicen anvender til kommunikation med Audit API.

I det følgende ses den kaldte metode auditLogIti18Response:

AuditLogning klasse til anvendelse af AuditAPI
public class AuditLogning {

	public static final String KEY_PATIENT_CPR = "patient-cpr";
	public static final String KEY_USER_CPR = "bruger-cpr";
	public static final String KEY_USER_ON_BEHALF_OF_CPR = "on-behalf-of-cpr";
	public static final String KEY_DOCUMENT_ENTRY = "document_entry";


	private static final String ITI_18_CONTEXT = "documentRegistryAdhocQuery";
	private static final String ITI_43_CONTEXT = "documentRepositoryRetrieveDocumentSet";

	private static final String DOCUMENTENTRY_HOMECOMMUNITY_ID = "homecommunityid";
	private static final String DOCUMENTENTRY_REPOSITORY_ID = "repositoryid";
	private static final String DOCUMENTENTRY_DOCUMENT_ID = "documentid";
	private static final String DOCUMENTENTRY_TYPECODE = "typecode";
	private static final String KEY_QUERY_TYPECODE = "queryTypecode";

	private String componentName;

	public AuditLogning() {
		this("DDS");
	}
	
	public AuditLogning(String componentName) {
		this.componentName = componentName;
	}

	public void auditLogIti18Response(AuditBuilder auditBuilder, String patientCpr, String requestingUserCpr, String requestingUserOnBehalfOfCpr, AdhocQueryType adhocQueryType, AdhocQueryResponse adhocQueryResponse) {

		auditBuilder.addAuditInformation(componentName, ITI_18_CONTEXT, TypeOfInformation.RegularPersonalInformation, KEY_PATIENT_CPR, patientCpr);
		if (requestingUserCpr != null) {
			auditBuilder.addAuditInformation(componentName, ITI_18_CONTEXT, TypeOfInformation.RegularPersonalInformation, KEY_USER_CPR, requestingUserCpr);
		}
		if (requestingUserOnBehalfOfCpr != null) {
			auditBuilder.addAuditInformation(componentName, ITI_18_CONTEXT, TypeOfInformation.RegularPersonalInformation, KEY_USER_ON_BEHALF_OF_CPR, requestingUserOnBehalfOfCpr);
		}

		if (adhocQueryType != null && adhocQueryType.getSlot() != null) {
			ValueListType vlt = XDSValueFinder.getSearchParameterTypeCode(adhocQueryType.getSlot());
			if (vlt != null && vlt.getValue() != null) {
				auditBuilder.addAuditInformation(componentName, ITI_18_CONTEXT, TypeOfInformation.NonPersonalInformation, KEY_QUERY_TYPECODE, vlt.getValue());
			}
		}
		
		if (adhocQueryResponse.getRegistryObjectList() != null && adhocQueryResponse.getRegistryObjectList().getIdentifiable() != null) {
			Iterator<JAXBElement<? extends oasis.names.tc.ebxml_regrep.xsd.rim._3.IdentifiableType>> identifiables = adhocQueryResponse.getRegistryObjectList().getIdentifiable().iterator();
			int count = 0;
			while (identifiables.hasNext()) {
				JAXBElement<? extends oasis.names.tc.ebxml_regrep.xsd.rim._3.IdentifiableType> identifiable = identifiables.next();
				ExtrinsicObjectType documentEntry = XDSValueFinder.getAsDocumentEntry(identifiable);
				DocumentEntryExternalId documentEntryExternalId = XDSValueFinder.getDocumentEntryExternalId(documentEntry);
				String typeCode = XDSValueFinder.getTypeCodeValueInClassificiationList(documentEntry.getClassification());
				addDocumentEntryAsAuditLogValue(auditBuilder, ITI_18_CONTEXT, count++, documentEntryExternalId, typeCode);
			}
		}
	}

	public void addDocumentEntryAsAuditLogValue(AuditBuilder auditBuilder, String context, int count, String homeCommunityId, String repositoryId, String documentId, String typeCode) {
		
		if (homeCommunityId != null) {
			auditBuilder.addAuditInformation(componentName, context, TypeOfInformation.SensitivePersonalInformation, formatKey(KEY_DOCUMENT_ENTRY, count, DOCUMENTENTRY_HOMECOMMUNITY_ID), homeCommunityId);
		}
		auditBuilder.addAuditInformation(componentName, context, TypeOfInformation.SensitivePersonalInformation, formatKey(KEY_DOCUMENT_ENTRY, count, DOCUMENTENTRY_REPOSITORY_ID), repositoryId);
		auditBuilder.addAuditInformation(componentName, context, TypeOfInformation.SensitivePersonalInformation, formatKey(KEY_DOCUMENT_ENTRY, count, DOCUMENTENTRY_DOCUMENT_ID), documentId);

		if (typeCode != null) {
			auditBuilder.addAuditInformation(componentName, context, TypeOfInformation.SensitivePersonalInformation, formatKey(KEY_DOCUMENT_ENTRY, count, DOCUMENTENTRY_TYPECODE), typeCode);
		}
	}
	
	public String formatKey(String prefix, int count, String postfix) {
		return prefix+"."+count+"."+postfix;
	}

Som det kan ses i det ovenstående, så kaldes addAuditInformation flere gange i forbindelse med en søgning. Anvendelse af konstanter sørger for, at parametrene componentName og context sendes ensartet videre til NSP Audit API.

Ved hver tilføjelse af auditinformation tages der aktivt stilling til oplysningernes følsomhed.

I Dokumentdelingsservicen auditlogges hele svaret dvs. alle de elementer, der fremsøges. I eksemplet ovenfor konstrueres en nøgle udfra bla en tæller (count) for at auditloggen kan indeholde en liste.

3. Effekt af NSP Audit API i NSP komponenter

I de forgående afsnit blev det gennemgået, hvordan NSP Audit API kan anvendes i NSP komponenters kode for let at kunne auditlogge information.

I det følgende 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.

3.1. Eksempel på auditlogninger fra Dokumentdelingsservice

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.

Som det ses i eksemplerne nedenfor, så er auditlog-linjerne delt ind i forskellige sektioner.

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.

3.1.1. En borger fremsøger egne dokumenter gennem dokumentdelingsservice (IDWS)

Ved at autentificere sig med en IDWS billet har en borger mulighed for at fremsøge sine egne dokumenter via Dokumentdelingsservicen. Kaldet rammer fremsøgningslogikken som blev vist i forgående kapitel, og følgende information ender i auditloggen:

Auditlogning fra fremsøgning på Dokumentdelingsservice af borger
{
   "time":"2021-10-13T14:21:38.115Z",
   "category":"dk.sds.nsp.audit.log.dds",
   "audit":{
      "timestamp":"2021-10-13T16:21:37.531+02:00",
      "components":[
         {
            "component":"DDS",
            "contexts":[
               {
                  "context":"documentRegistryAdhocQuery",
                  "information":[
                     {
                        "key":"patient-cpr",
                        "type":"RPI",
                        "value":"0207761919"
                     },
                     {
                        "key":"bruger-cpr",
                        "type":"RPI",
                        "value":"0207761919"
                     },
                     {
                        "key":"queryTypecode",
                        "type":"NPI",
                        "values":[
                           "('39289-4^^2.16.840.1.113883.6.1')"
                        ]
                     },
                     {
                        "key":"document_entry.0.homecommunityid",
                        "type":"SPI",
                        "value":""
                     },
                     {
                        "key":"document_entry.0.repositoryid",
                        "type":"SPI",
                        "value":"1.3.6.1.4.1.21367.2010.1.2.1125"
                     },
                     {
                        "key":"document_entry.0.documentid",
                        "type":"SPI",
                        "value":"0207761919.6052203964123326052.1537974544003"
                     },
                     {
                        "key":"document_entry.0.typecode",
                        "type":"SPI",
                        "value":"39289-4"
                     },
                     {
                        "key":"document_entry.1.homecommunityid",
                        "type":"SPI",
                        "value":""
                     },
                     {
                        "key":"document_entry.1.repositoryid",
                        "type":"SPI",
                        "value":"1.3.6.1.4.1.21367.2010.1.2.1125"
                     },
                     {
                        "key":"document_entry.1.documentid",
                        "type":"SPI",
                        "value":"5619531150207761919.6052203964123326052.1537974544003"
                     },
                     {
                        "key":"document_entry.1.typecode",
                        "type":"SPI",
                        "value":"39289-4"
                     },
                     {
                        "key":"document_entry.2.homecommunityid",
                        "type":"SPI",
                        "value":""
                     },
                     {
                        "key":"document_entry.2.repositoryid",
                        "type":"SPI",
                        "value":"1.3.6.1.4.1.21367.2010.1.2.1125"
                     },
                     {
                        "key":"document_entry.2.documentid",
                        "type":"SPI",
                        "value":"0207761919.678401000016005.10001"
                     },
                     {
                        "key":"document_entry.2.typecode",
                        "type":"SPI",
                        "value":"39289-4"
                     }
                  ]
               }
            ]
         }
      ]
   },
   "access":{
      "code":200,
      "duration":462,
      "httpHeaders":{
         "Content-Type":"application/soap+xml; charset=UTF-8"
      },
      "httpHost":"localhost",
      "idCardAttributes":{
         "dk:gov:saml:attribute:AssuranceLevel":"3",
         "dk:gov:saml:attribute:CprNumberIdentifier":"0207761919",
         "dk:gov:saml:attribute:SpecVer":"DK-SAML-2.0"
      },
      "method":"POST",
      "path":"/ddsregistry/idws",
      "query":"",
      "port":9090,
      "protocol":"http",
      "reqSize":13124,
      "resSize":22971,
      "soapHeaders":{
         "Audience":"https://audience.nspop.dk/dds",
         "Issuer":"TEST2-NSP-STS",
         "NameID":"C=DK,O=Ingen organisatorisk tilknytning,CN=Lars Larsen,Serial=PID:9208-2002-2-663031557285",
         "w3Action":"action",
         "w3MessageID":"urn:uuid:b1622648-c82e-4adc-b9fb-4c9a51b1df1d",
         "w3To":"http://localhost:9090/ddsregistry/idws"
      },
      "threadId":"default task-3",
      "time":"2021-10-13T16:21:37.531+02:00",
      "stats":{
         "handlerDuration":118,
         "RequestContentDuration":1,
         "ResponseContentDuration":0,
         "SecurityProtocolRequestDuration":10,
         "SecurityProtocolResponseDuration":101,
         "bufferAllocated":false,
         "usedBuffers":2,
         "activeBuffersInPool":2,
         "idleBuffersInPool":4
      }
   }
}


3.1.2. En sundhedsprofessionel fremsøger en borgers dokumenter gennem dokumentdelingsservice (DGWS)

Ved at autentificere sig med et SOSI idkort (DGWS) har en sundhedsprofessionel mulighed for at fremsøge en borgers dokumenter via Dokumentdelingsservicen. Kaldet rammer fremsøgningslogikken som blev vist i forgående kapitel, og følgende information ender i auditloggen:

Auditlogging fra fremsøgning på Dokumentdelingsservice (sundhedsprofessionel)
{
   "time":"2021-10-13T14:04:07.387Z",
   "category":"dk.sds.nsp.audit.log.dds",
   "audit":{
      "timestamp":"2021-10-13T16:04:06.861+02:00",
      "components":[
         {
            "component":"DDS",
            "contexts":[
               {
                  "context":"documentRegistryAdhocQuery",
                  "information":[
                     {
                        "key":"patient-cpr",
                        "type":"RPI",
                        "value":"0106501010"
                     },
                     {
                        "key":"bruger-cpr",
                        "type":"RPI",
                        "value":"0804769723"
                     },
                     {
                        "key":"on-behalf-of-cpr",
                        "type":"RPI",
                        "value":"0804769723"
                     },
                     {
                        "key":"document_entry.0.homecommunityid",
                        "type":"SPI",
                        "value":""
                     },
                     {
                        "key":"document_entry.0.repositoryid",
                        "type":"SPI",
                        "value":"1.3.6.1.4.1.21367.2010.1.2.1125"
                     },
                     {
                        "key":"document_entry.0.documentid",
                        "type":"SPI",
                        "value":"0106501010.842938295.10000002"
                     },
                     {
                        "key":"document_entry.0.typecode",
                        "type":"SPI",
                        "value":"39289-4"
                     },
                     {
                        "key":"document_entry.1.homecommunityid",
                        "type":"SPI",
                        "value":""
                     },
                     {
                        "key":"document_entry.1.repositoryid",
                        "type":"SPI",
                        "value":"1.3.6.1.4.1.21367.2010.1.2.1125"
                     },
                     {
                        "key":"document_entry.1.documentid",
                        "type":"SPI",
                        "value":"0106501010.842938295.10000003"
                     },
                     {
                        "key":"document_entry.1.typecode",
                        "type":"SPI",
                        "value":"39289-4"
                     },
                     {
                        "key":"document_entry.2.homecommunityid",
                        "type":"SPI",
                        "value":""
                     },
                     {
                        "key":"document_entry.2.repositoryid",
                        "type":"SPI",
                        "value":"1.3.6.1.4.1.21367.2010.1.2.1125"
                     },
                     {
                        "key":"document_entry.2.documentid",
                        "type":"SPI",
                        "value":"0106501010.678401000016005.10000001"
                     },
                     {
                        "key":"document_entry.2.typecode",
                        "type":"SPI",
                        "value":"39289-4"
                     },
                     {
                        "key":"document_entry.3.homecommunityid",
                        "type":"SPI",
                        "value":"1.2.208.176.8.1.12"
                     },
                     {
                        "key":"document_entry.3.repositoryid",
                        "type":"SPI",
                        "value":"1.2.208.176.43210.8.10.12"
                     },
                     {
                        "key":"document_entry.3.documentid",
                        "type":"SPI",
                        "value":"1.2.208.176.43210.8.10.12^27434a41-cf20-4fb4-bdd7-c4bd7fc98cf2"
                     },
                     {
                        "key":"document_entry.3.typecode",
                        "type":"SPI",
                        "value":"52460-3"
                     },
                     {
                        "key":"document_entry.4.homecommunityid",
                        "type":"SPI",
                        "value":"1.2.208.176.8.1.12"
                     },
                     {
                        "key":"document_entry.4.repositoryid",
                        "type":"SPI",
                        "value":"1.2.208.176.43210.8.10.12"
                     },
                     {
                        "key":"document_entry.4.documentid",
                        "type":"SPI",
                        "value":"1.2.208.176.43210.8.10.12^fe950ffa-30e6-4f1d-b364-bd30e3b7a66b"
                     },
                     {
                        "key":"document_entry.4.typecode",
                        "type":"SPI",
                        "value":"PDC"
                     }
                  ]
               }
            ]
         }
      ]
   },
   "access":{
      "code":200,
      "duration":489,
      "httpHeaders":{
         "Content-Type":"application/soap+xml; charset=UTF-8"
      },
      "httpHost":"localhost",
      "idCardAttributes":{
         "medcom:CareProviderID":"33257872",
         "medcom:CareProviderName":"Sundhedsdatastyrelsen",
         "medcom:ITSystemName":"Test",
         "medcom:UserAuthorizationCode":"CBTH1",
         "medcom:UserOccupation":"Læge",
         "medcom:UserRole":"7170",
         "sosi:AuthenticationLevel":"4",
         "sosi:IDCardID":"ndbdsjE8LrtpFqHmzKL0Xw==",
         "sosi:IDCardType":"user",
         "sosi:IDCardVersion":"1.0.1"
      },
      "method":"POST",
      "path":"/ddsregistry",
      "query":"",
      "port":9090,
      "protocol":"http",
      "reqSize":9626,
      "resSize":33100,
      "soapHeaders":{
         "Issuer":"TEST2-NSP-STS",
         "MessageID":"AAABfHn3qv7YTBlq290B5FNPU0k=",
         "NameID":"SubjectDN={CN=Casper Rasmussen + SERIALNUMBER=CVR:33257872-RID:40718906, O=Sundhedsdatastyrelsen // CVR:33257872, C=DK},IssuerDN={CN=TRUST2408 Systemtest XXXIV CA, O=TRUST2408, C=DK},CertSerial={1604229135}",
         "w3Action":"urn:ihe:iti:2007:RegistryStoredQuery",
         "w3MessageID":"urn:uuid:07b2fb66-19c4-4bc7-8630-e427cebff032",
         "w3To":"http://localhost:9090/ddsregistry"
      },
      "threadId":"default task-58",
      "time":"2021-10-13T16:04:06.861+02:00",
      "stats":{
         "handlerDuration":33,
         "RequestContentDuration":3,
         "ResponseContentDuration":0,
         "SecurityProtocolRequestDuration":18,
         "SecurityProtocolResponseDuration":0,
         "bufferAllocated":false,
         "usedBuffers":2,
         "activeBuffersInPool":2,
         "idleBuffersInPool":4
      }
   }
}


4. Driftsdokumentation for NSP komponenter, der anvender NSP Audit API

Alle NSP komponenter skal i følge kravene dokumentere deres auditlogninger i driftsdokumentationen.

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:

KomponentKontekstTypeNøgleInformation





For hvert request kan man angive et skema med en række for hver audit information der logges. Følgende er et eksempel fra STS'en:

KomponentKontekstTypeNøgleInformation
STSSecurityTokenRequestIkke personligcvrCVR nummeret for den kaldende organisation
STSSecurityTokenRequestFølsommecprCPR nummeret på den person der skal have udsted et id kort.

Hvert kald til NSP Audit APIs addAuditInformation metode bør reflekteres i tabellen.

  • No labels