...

• Type: SOAP Webservice

• Filnavn: idsas-registration.war

• Url: <serverurl>/idsas-registration

• Status-url: <serverurl>/idsas-registration/status

• DKS-config: <serverurl>/idsas-registration/20230601/dksconfig
• DKS-config: <serverurl>/idsas-registration/20240124/dksconfig
  
  

• Type: SOAP Webservice

• Filnavn: idsas-lookup.war

• Url: <serverurl>/idsas-lookup

• Status-url: <serverurl>/idsas-lookup/status

• DKS-config: <serverurl>/idsas-lookup/20230601/dksconfig
• DKS-config: <serverurl>/idsas-lookup/20240124/dksconfig

• Type: SOAP Webservice

• Filnavn: idsas-salt.war

• Url: <serverurl>/idsas-salt

• Status-url: <serverurl>/idsas-salt/status

• DKS-config: <serverurl>/idsas-salt/dksconfig
  
  
• Type: Webservlet
• Filnavn: idsas-operations.war
• Url: <serverurl>/idsas-operations

• Status-url: <serverurl>/idsas-operations/status

• Version-url: <serverurl>/idsas-operations/version

...

Moduldefinitionerne for hver service findes i kildekoden under:

/idsas<idsas-web-warmodule>/etc/modules/dk/nsp/idsas/configuration/main/module.xml

I idsas-registration.properties kan følgende properties defineres:

I idsas-lookup.properties kan følgende properties defineres:

I idsas-salt.properties kan følgende properties defineres:

...

Property

...

Beskrivelse

...

Påkrævet

...

Default værdi

...

Navn på jboss datasource (defineret i idsas-ds.xml)

...

Ja

...

Angiver det endpoint, som DCC'en skal kalde. Dette kommer til at fremgå af den XML, der returneres i /dksconfig.

...

Ja

I idsas-operations.properties kan følgende properties defineres:

...

Property

...

Beskrivelse

...

Påkrævet

...

Default værdi

...

Navn på jboss datasource (defineret i idsas-ds.xml)

...

Ja

...

Den tilladte varighed af cleanup jobbet. Angives som duration i ISO-8601 formattet; dog bør kun sekunder angives.

...

Nej

...

PT15S (15 sekunder)

...

Antal rækker der ryddes op pr. iteration i cleanup jobbet.

...

Nej

...

10000

...

Hvor mange år gammel en række skal være før den må ryddes op af cleanup jobbet. Angives som duration i ISO-8601 formattet; dog kan kun år angives.

...

Nej

...

P5Y (5 år)

I idsas-lookup.properties kan følgende properties defineres:

I idsas-salt.properties kan følgende properties defineres:

I idsas-operations.properties kan følgende properties defineres:

I idsas-patient-id-salt.properties skal følgende property defineres. De bliver kun indlæst fra "lookup"-servicen (tidligere også fra registration):

log4j konfiguration

Log4j konfiguration for begge services findes i samme wildfly modul som servicekonfigurationen

Se yderligere opsætning i installationsvejledningen.

Salt til hashing af patientId'ere

Til hashing af patientId'ere i databasen, anvendes den salt som er angivet i konfigurations-filen "idsas-patient-id-salt.properties". Salten angives som to tekststrenge; en prefix og en postfix. 

Det er vigtigt, at denne salt er stabil og aldrig ændrer sig, efter at den er blevet valgt.

Servicen kan ikke starten op, hvis salten ikke er korrekt angivet.

Der er ingen særlige krav til salten, ud over at den er stabil.

Følgende SQL kan bruges til at genskabe hash-værdien givet de to salt-værdier og patientId'et (som her i eksemplet er sat til "1111111118").

select sha2(concat('saltprefix', '1111111118', 'saltpostfix'), 256);

Overvågning

Alle IDSAS services udstiller en overvågningsside, som findes i listen af komponenter.

Fortolkning af overvågningsside

Overvågningssiderne returnerer enten:

• HTTP 200, hvis servicen i øjeblikket kører fint.
• HTTP 503, hvis der er opstået en fejl der kræver indgriben.

Audit-logning

Hvert servicekald medfører en ny indgang i auditloggen, som kan være udfyldt med følgende komponenter, afhængig af konteksten:

{
  "time": "2023-06-12T11:42:23.664Z",
  "category": "dk.sds.nsp.audit.log.idsas",
  "audit": {
    "timestamp": "2023-06-12T13:42:22.972+02:00",
    "components": [
      {
        "component": "IDSAS",
        "contexts": [
          {
            "context": "createBlurring",
            "information": [
              {
                "key": "cpr",
                "type": "RPI",
                "value": "1234567890"
              },
              {
                "key": "cvr",
                "type": "NPI",
                "value": "33257872"
              }
            ]
          }
        ]
      }
    ]
  },
  "access": {
    "code": 200,
    "duration": 95,
    "httpHeaders": {
      "Content-Type": "text/xml;charset=UTF-8",
      "SOAPAction": "CreateBlurring"
    },
    "httpHost": "localhost",
    "idCardAttributes": {
      "medcom:CareProviderID": "33257872",
      "medcom:CareProviderName": "Sundhedsdatastyrelsen",
      "medcom:ITSystemName": "Service Consumer Test",
      "medcom:UserAuthorizationCode": "6QF17",
      "medcom:UserRole": "7170",
      "sosi:AuthenticationLevel": "4",
      "sosi:IDCardID": "SIjvZBkfZ1yAWSpYFcLpvw==",
      "sosi:IDCardType": "user",
      "sosi:IDCardVersion": "1.0.1"
    },
    "method": "POST",
    "path": "/idsas/20230601/service",
    "query": "",
    "port": 8080,
    "protocol": "http",
    "reqSize": 7204,
    "resSize": 211,
    "soapHeaders": {
      "FlowID": "72111931-fe3b-4956-bea3-20e8c5be9ce0",
      "Issuer": "TEST1-NSP-STS",
      "MessageID": "76315a15-0fb2-4df7-9e3e-53a3b28fb700",
      "NameID": "urn:uuid:46559bb9-d720-48b7-b9bd-c280915768d0"
    },
    "threadId": "default task-1",
    "time": "2023-06-12T13:42:22.968+02:00",
    "stats": {
      "handlerDuration": 583,
      "RequestContentDuration": 41,
      "ResponseContentDuration": 0,
      "SecurityProtocolRequestDuration": 368,
      "SecurityProtocolResponseDuration": 0,
      "bufferAllocated": true,
      "usedBuffers": 1,
      "activeBuffersInPool": 1,
      "idleBuffersInPool": 0
    }
  }
}

Whitelisting af anvendere

De enkelte anvenderes ID skal whitelistes til at bruge IDSAS. Et ID vil typisk være et CVR.

Der er pt. en type af whitelisting, BLURRING, med mulighed for at der tilføjes flere i fremtiden. For at kunne oprette en sløring, skal anvenderens CVR være whitelistet med netop denne type.

Der findes en tabel whitelist i databasen til dette formål.

SQL til at indsætte whitelisting af anvender kan se ud på følgende måde:

Note-feltet kan fx anvendes til at referere en supportsag eller lignende for sporingshensyn. Kun actor_id og type er obligatorisk.

Oprettelse/fornyelse af salt

Oprettelse/fornyelse af salt sker via et HTTP GET kald til <serverurl>/idsas-operations/renew-salt

Dette kald skal laves for at oprette det første salt, og efterfølgende for at forny saltet, når der er behov.

Baggrundsjobs

Overvågning af baggrundsjobs

Der findes et status og et alarm-endpoint for hver baggrundsjob. De har følgende url'er:

• <serverurl>/idsas-operations/cleanup-blurrings/status
• <serverurl>/idsas-operations/cleanup-blurrings/alarm
• <serverurl>/idsas-operations/cleanup-blurrings-deceased/status
• <serverurl>/idsas-operations/cleanup-blurrings-deceased/alarm

De to status-endpoints kan svare følgende

• • Http-kode 200 og Database: OK 
  • Http-kode 500 og Database: Unavailable

De to alarm-endpoints er som udgangspunkt tomme og returnerer 200, men kan give en alarm-besked og status 500, hvis jobbet er i problemer.

Oprydningsjob af gamle sløringer

Oprydningsjobbet startes via et HTTP GET kald til <serverurl>/idsas-operations/cleanup-blurrings

Alarm-endpointet er som udgangspunkt tom og returnerer status 200, med mindre noget er gået galt. Status-siden rapporterer om komp

Jobbet kaldes for at påbegynde en oprydning af inaktive sløringer, og vil slette alle registrerede sløringer, som har være inaktive i mindst 5 år.

Jobbet køres i iterationer af en konfigureret størrelse, og terminerer enten når der ikke er flere inaktive sløringer der skal slettes, eller når jobbet har kørt i en konfigureret varighed.

Det vil fremgå af servicens overvågningsside om oprydningen blev færdig:

Oprydningsjob af sløringer for afdøde personer

Oprydningsjobbet startes via et HTTP GET kald til <serverurl>/idsas-operations/cleanup-blurrings-deceased

Jobbet kaldes for at påbegynde en oprydning af sløringer for afdøde personer, og vil slette alle registrerede sløringer 1 år efter personerne er afgået ved døden.

Jobbet køres i iterationer af en konfigureret størrelse, og terminerer enten når der ikke er flere sløringer for afdøde der skal slettes, eller når jobbet har kørt i en konfigureret varighed.

Det vil fremgå af servicens overvågningsside om oprydningen blev færdig:

Aktivering af Kafka-consumer

Jobbet

I idsas-patient-id-salt.properties skal følgende property defineres:

...

Property

...

Beskrivelse

...

Påkrævet

...

Default værdi

...

Salt til hashing af patientId'ere. Se afsnittet længere nede.

...

Ja

log4j konfiguration

Log4j konfiguration for begge services findes i samme wildfly modul som servicekonfigurationen

Se yderligere opsætning i installationsvejledningen.

Salt til hashing af patientId'ere

Til hashing af patientId'ere i databasen, anvendes den salt som er angivet i property "idsas.patient.id.salt". Salten angives som en base64-encoded tekststreng.

Det er vigtigt, at denne salt er stabil og aldrig ændrer sig, efter at den er blevet valgt.

Servicen kan ikke starten op, hvis salten ikke er korrekt angivet.

Der er ingen særlige krav til salten, ud over at den er stabil.

Man kan fx bruge openssl til at genererer en salt:

openssl rand -base64 16

Overvågning

Alle IDSAS services udstiller en overvågningsside, som findes i listen af komponenter.

Fortolkning af overvågningsside

Overvågningssiderne returnerer enten:

• HTTP 200, hvis servicen i øjeblikket kører fint.
• HTTP 503, hvis der er opstået en fejl der kræver indgriben.

Audit-logning

Hvert servicekald medfører en ny indgang i auditloggen, som kan være udfyldt med følgende komponenter, afhængig af konteksten:

...

Komponent

...

Kontekst

...

Type

...

Nøgle

...

Information

...

{
  "time": "2023-06-12T11:42:23.664Z",
  "category": "dk.sds.nsp.audit.log.idsas",
  "audit": {
    "timestamp": "2023-06-12T13:42:22.972+02:00",
    "components": [
      {
        "component": "IDSAS",
        "contexts": [
          {
            "context": "createBlurring",
            "information": [
              {
                "key": "cpr",
                "type": "RPI",
                "value": "1234567890"
              },
              {
                "key": "cvr",
                "type": "NPI",
                "value": "33257872"
              }
            ]
          }
        ]
      }
    ]
  },
  "access": {
    "code": 200,
    "duration": 95,
    "httpHeaders": {
      "Content-Type": "text/xml;charset=UTF-8",
      "SOAPAction": "CreateBlurring"
    },
    "httpHost": "localhost",
    "idCardAttributes": {
      "medcom:CareProviderID": "33257872",
      "medcom:CareProviderName": "Sundhedsdatastyrelsen",
      "medcom:ITSystemName": "Service Consumer Test",
      "medcom:UserAuthorizationCode": "6QF17",
      "medcom:UserRole": "7170",
      "sosi:AuthenticationLevel": "4",
      "sosi:IDCardID": "SIjvZBkfZ1yAWSpYFcLpvw==",
      "sosi:IDCardType": "user",
      "sosi:IDCardVersion": "1.0.1"
    },
    "method": "POST",
    "path": "/idsas/20230601/service",
    "query": "",
    "port": 8080,
    "protocol": "http",
    "reqSize": 7204,
    "resSize": 211,
    "soapHeaders": {
      "FlowID": "72111931-fe3b-4956-bea3-20e8c5be9ce0",
      "Issuer": "TEST1-NSP-STS",
      "MessageID": "76315a15-0fb2-4df7-9e3e-53a3b28fb700",
      "NameID": "urn:uuid:46559bb9-d720-48b7-b9bd-c280915768d0"
    },
    "threadId": "default task-1",
    "time": "2023-06-12T13:42:22.968+02:00",
    "stats": {
      "handlerDuration": 583,
      "RequestContentDuration": 41,
      "ResponseContentDuration": 0,
      "SecurityProtocolRequestDuration": 368,
      "SecurityProtocolResponseDuration": 0,
      "bufferAllocated": true,
      "usedBuffers": 1,
      "activeBuffersInPool": 1,
      "idleBuffersInPool": 0
    }
  }
}

Whitelisting af anvendere

De enkelte anvenderes ID skal whitelistes til at bruge IDSAS. Et ID kan enten være et CVR eller navnet på et system, alt efter hvad der whitelistes til.

Der er to typer af whitelisting; BLURRING og SALT.

• For at kunne oprette en sløring, skal anvenderens CVR være whitelistet med typen BLURRING.
• For at kunne hente et salt, skal anvendersystemets navn være whitelistet med typen SALT.

Der findes en tabel whitelist i databasen til dette formål.

SQL til at indsætte whitelisting af anvender kan se ud på følgende måde:

Note-feltet kan fx anvendes til at referere en supportsag eller lignende for sporingshensyn. Kun actor_id og type er obligatorisk.

Baggrundsjobs

Oprettelse/fornyelse af salt

Oprettelse/fornyelse af salt sker via et HTTP GET kald til <serverurl>/idsas-operations/renew-salt

Dette kald skal laves for at oprette det første salt, og efterfølgende for at forny saltet, når der er behov.

Oprydningsjob

Oprydningsjobbet startes via et HTTP GET kald til <serverurl>/idsas-operations/cleanupkafka-blurringsconsume

Jobbet kaldes for at påbegynde en oprydning af inaktive sløringerlæsning af beskeder fra Kafka-køen, og vil slette alle registrerede sløringer, som har være inaktive i mindst 5 årpersistere de ændringer, der modtages.

Jobbet køres i iterationer af en konfigureret størrelse, og terminerer enten når der ikke er flere inaktive sløringer der skal slettes, eller når jobbet har kørt i en konfigureret varighedlæser hvad der er tilgængeligt i køen med den angivne timeout (se konfigurationen), og committer nyt offset efter succesfuld persistering til databasen.

Det vil fremgå af servicens overvågningsside om oprydningen blev færdig:jobbet kørende, er kørt færdigt eller om der er sket fejl: