1. Introduktion

1.1. Formål

Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere driftsmæssige aspekter af komponenten.
Driftsvejledningen indeholder information om nap-reference-implementation med hensyn logning, konfiguration og eksterne afhængigheder.

1.2. Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for NAP SDK.

Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.

Ønskes mere information omkring arkitektur og design findes dette på NAP Ref.Impl. - Design og Arkitektur beskrivelse.

Ønskes mere information omkring installationsvejledning til anvender kan findes på NAP Ref.Impl. - Installationsvejledning.

Ønskes mere information omkring anvendelse kan dette findes på NAP Ref.Impl. - Guide til anvendere.

2. Service snitflade

Nap-refence overskriver kontekstroden i jboss-web.xml og forventer derfor, at være udstillet på /reference. se eventuelt https://svn.nspop.dk/svn/components/nap/nap-compose/trunk/haproxy/nap-haproxy.cfg for at se hvordan en ha-proxy konfigureres.

EndpointsFunktionalitet
/aftaler/{cpr}

Validerer den indkommende CPR samt SOR.
Efterfølgende kaldes Dokumentdelingsservice (DDS) med det angivne SOR nummer fra "X-OrganizationSor"-headeren, for at hente alle aftale dokumenter for patienten med det oplyste cpr nummer.

3. Overvågning snitflade

EndpointsFunktionalitet
/isAlive

Bruges af loadbalanceren for at tjekke at servicen er deployet. Returnerer en html side med deployment info.

Da denne service ikke er afhængige af database eller andre interne services, returnere den altid 200, hvis applikationen kører.

4. Login / logout (OIOSAML)

EndpointsFunktionalitet

/saml/SAMLAssertionConsumer

Validerer den indkommende OIOSAML token.

/saml/Logout

Brugeres til at validere autentifikations requests og registrere en brugers assertion i en threadlocal session.

5. Konfiguration

Konfiguration af NAP-reference sker i filerne "compose/configuration" mappen som er beskrevet i NAP Ref.Impl. - Installationsvejledning. I det følgende gennemgåes konfigurationsfilernes detaljer.

Følgende konfigurationsfiler skal være tilgængelige i classpath under deployment (loades fra applikationsserverens modules/dk/sds/nsp/nap/reference/facade/main).

Konfigurationsfiler
FilnavnBeskrivelse
log4j-nap-reference-facade.xml

Log4j opsætninger der følger gængs standard på NSP.

log4j-nspslalog.properties

SLALog opsætninger der følger gængs standard på NSP.

nap-facade.properties

Applikation properties 

# Path to the service provider certificate
keystorePath

# Password to the service provider certificate
keystorePassword

# XDS
xdsIti18Wsdl
xdsIti18Endpoint
xdIti43Wsdl
xdsIti43Endpoint

napref-test.jksJKS fil indeholdende Sundhedsdatastyrelsen nap reference funktionscertifikat certifikat. Skal være samme navn som keystore path i nap-facade.properties

Konfiguration af oiosaml sker i filerne "compose/configuration/oiosaml". 

Der findes en konfiguration til localhost-development, localhost-test1 og test (release til test1 miljøet). De forskellige konfigurationer adskiller sig primært i logout url og service provider url. 

Oiosaml konfigurationerne skal ligeledes være tilgængelig i oiosaml.home (oiosaml.home sættes med JAVA_OPTS i compose filerne og er sat til /pack/oiosaml) under deployment.

Konfigurationsfiler


oiosaml-sp.log4j.xml

lndeholder Log4j opsætninger der følger gængs standard på NSP.
oiosaml-sp.properties

# Properties used by oiosaml-j

# Reference to the location of the certificate used for signing SAML documents with - relative to ${oiosaml.home}

oiosaml-sp.certificate.location=

# Opaque/encrypted password to the certificate used for signing SAML documents
oiosaml-sp.certificate.password

# Required authentication level. 2=password, 3=certificate
oiosaml-sp.assurancelevel

# Name of the meta data file for the current service provider
common.saml2.metadata.sp.filename

# URI References to the current service provider
oiosaml-sp.uri.home

# Force login
#oiosaml-sp.authn.force

# Disable support for self-signed certificates by default
oiosaml-sp.selfsignedcertificates

# Disable revocation checking on OCES test certificats (because the CRL/OCSP endpoints are behind a firewall)
oiosaml-sp.crl.disable-in-oces-test


# Enable this setting to be eid compatible. Note this effects how AuthnRequests are generated
oiosaml-sp.eid.compatible

napref-test.jks

JKS fil indeholdende Sundhedsdatastyrelsen reference funktionscertifikat certifikat. 

Skal være samme navn som oiosaml-sp.certificate.location i oiosaml-sp.properties så fx ./certificate/napref-test.jks

metadata/idP/IdPMetadata.xmlOIOSAML identity provider metadata til konfiguration af OIOSAML filteret
metadata/SP/SPMetadata.xmlOIOSAML service provider metadata til konfiguration af OIOSAML filteret

Hele oiosaml-konfigurations-mappen skal udskiftes til de forskellige miljøer. Så fx for local host og test1 ser mapning således ud :

- ../configuration/oiosaml/localhost-development:/pack/oiosaml # localhost
- ../configuration/oiosaml/test1:/pack/oiosaml # test1

6. Logning

Alle logfiler er at finde i log/ under WildFly. Herunder findes en liste over alle logfiler med en beskrivelse af hvilke komponenter der skriver til dem. 

LogfilnavnKomponenter der skriver til denne
nap-ref-facade.lognap facade applikationen
nap-ref-sla.lognap facade aftale sla-log
oiosaml-sp.logOIOSAML log
oiosaml-sp-audit.logOIOSAML audit log

Ved default konfiguration findes applikations loggen i nap-ref-facade.log. 


7. Fejlhåndtering

Applikationsfejl bliver logget ved hjælp af log4j, med type ERROR, INFO, DEBUG alt efter hvor alvorlig fejlen er. 



  • No labels