1. Introduktion

Formål

Dette dokument er rettet mod systemadministratorer og driftspersoner, som skal kunne håndtere de driftsmæssige aspekter af komponenterne.
Driftsvejledningen indeholder information om hensyn til eksterne afhængigheder, placering af logfiler og konfigurationsfiler.

Sammenhæng med øvrige dokumenter

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

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 Platform - Design og Arkitektur beskrivelse.

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

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

Nap-lobby-web

Hvordan fungerer servicen

Single page application med følgende routes:

Route	Funktionalitet
/projects	Laver et kald til nap-administration og viser en projektoversigt. I tilfælde af http fejl vises dette til brugeren.
/admin/projects	Laver et kald til nap-administration og viser en projektoversigt. I tilfælde af http fejl vises dette til brugeren. Viser admin funktionalitet
/admin/projects/edit/{id}	Tilføj redigere i et projekt
/help	Viser informationer om, hvordan der kan oprettes en NSP support sag.

Konfiguration

configurations.json mappes til /pack/webapp/assets/

Key	Value
projectsEndpoint	Projekt endpoint
serverUrl	Relative path til nap-admin
sessionEndpoint	Session endpoint
logOutEndpoint	OIOSAML logout url på facaden

Håndtering af fejlsituationer og logning

nap-lobby-web er en stateless webapplikation, og der er derfor ingen logning i dette komponent. Fejl vil blive skrevet ud i konsollen. I tilfælde af http fejl bliver klienten præsenteret med en fejl.

Nap-administration

Snitflade

Servicen kalder en database med projekter og udstiller dem på en REST snitfalde.

Endpoints	Funktionalitet
/projekter/{id}	Validerer den indkommende SAMLAssertion, kalder databasen og henter Projekt(er) baseret på det cvr nummer som er tilknyttet brugerkonteksten.
/webapps/{id}	Validerer den indkommende SAMLAssertion, kalder databasen og henter WebApp(er).

Overvågningssnitflade

Endpoints

Funktionalitet

/isAlive

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

Hvis der kan oprettes forbindelse til den database, der er konfigureret i datasource "jboss/datasources/admin", returneres der statuskode 200, ellers statuskode 500.

Login / logout (OIOSAML)

Endpoints	Funktionalitet
/saml/SAMLAssertionConsumer	Validerer den indkommende OIOSAML token.
/saml/Logout	Brugeres til at validere autentifikations requests og registrere en brugers assertion i en threadlocal session.

Konfiguration

Konfiguration af NAP-reference sker i filerne "compose/configuration" mappen som er beskrevet i NAP Platform - 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/admin/main).

Konfigurationsfiler

Filnavn

Indhold

nap-admin-compose-ds.xml

Datasource beskrivelse.

Vigtigt med jndi navn "java:jboss/datasources/nap-lobby-facade" da dette skal matse persistence.xml

log4j-napadmin.xml

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

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

Der findes en konfiguration til develop / test / 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 - overrides setting in brs-common.properties 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
Sundhedsdatastyrelsens nap reference funktionscertifikat	JKS fil indeholdende Sundhedsdatastyrelsen reference funktionscertifikat certifikat. Skal være samme navn som oiosaml-sp.certificate.location i oiosaml-sp.properties
metadata/idP/IdPMetadata.xml	OIOSAML identity provider metadata til konfiguration af OIOSAML filteret
metadata/SP/SPMetadata.xml	OIOSAML service provider metadata til konfiguration af OIOSAML filteret

Database

Adgang til nap-admin databasen styres gennem filen "nap-admin-ds.xml" - Denne skal matche det NSP miljø hvor komponenten afvikles i.

Aktiviteter

For at NAP-admin kan deployes skal der være initieret en tabel i den database, der er defineret i nap-admin-ds.xml, da hibernate vil tjekke at database schemaet matcher entiteterne i applikationen.

Følgende scripts skal derfor køres:

Filnavn	Beskrivelse
create_db_example.sql	Opretter Database
V1__create_tables.sql	Opretter Tabeller
V2__insert_data_localhost.sql	Indsætter projekt data med url pegende på localhost (skal opdateres til url svarende til givende miljø)
V3__update_developer_project_icon.sql	Indsætter projekt ikon for developer projekt
V4__update_test_project_icon.sql	Indsætter projekt ikon for nap-testweb projekt
V5__update_nap_ref_web_project_icon.sql	Indsætter projekt ikon for nap-reference-web
V6__insert_default_user.sql	Indsætter default bruger som projektadministrator

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.

Logfilnavn	Komponenter der skriver til denne
nap-admin.log	applikationslog
oiosaml-sp.log	OIOSAML log
oiosaml-sp-audit.log	OIOSAML audit log

Fejlhåndtering

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

Nap-test-web

Hvordan fungerer servicen

Nap-test-web fungerer som test-suite til værtsystemer.

Den tester, at kommunikationen over broen fungerer som den skal, og der er således ingen konfiguration, opsætning eller logning.

Håndtering af fejlsituationer og logning

nap-test-web er en stateless webapplikation, og der er derfor ingen logning i denne komponent. Fejl vil dog blive skrevet ud i konsollen. I tilfælde af http fejl bliver klienten præsenteret med en fejl.

Logging

Log4j konfigurationen skal findes i log4j-napadmin.xml på classpath.

Ved default konfiguration skrives alle modul-relaterede fejl til nap-admin.log

Fejlhåndtering

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

Nap-java-host

Er et dummy læge praksis system, som ikke kræver nogen drift.