MINIHANKE PAKKUMUS
Raamhange: „Ehitisregistri arendusteenus 2“ (181147)
Minihange: „E-ehituse platvormi autentimise ja autoriseerimise mikroteenuse arendus“
PAKKUMUS
Pakkumus vastavalt 17.04.2020 hinnapäringule.
Töö nimetus Aeg töötundides Maksumus Maksumus
ilma KM-ta (EUR) KM-ga (EUR)
E-ehituse platvormi 530 26 500 31 800
autentimise ja
autoriseerimise
mikroteenuse arendus
Tööde üleandmine 45päeva lepingu sõlmimisest.
Lugupidamisega,
Kaido Heinsalu
Tieto Estonia AS
/allkirjastatud digitaalselt/
Hankeleping nr 18/1.9-8/20-169-1
Tallinnas, 13.05.2020
Majandus- ja Kommunikatsiooniministeerium, registrikood 70003158, asukoht Suur –
Ameerika 1, Tallinn 10122, mida esindab põhimääruse alusel kantsler Ando Leppiman
(edaspidi Tellija),
ja
Tieto Estonia Aktsiaselts, registrikood 10137025, asukoht A. H. Tammsaare tee 47, Tallinn
11316, mida esindab põhikirja alusel juhatuse liige Anneli Heinsoo, (edaspidi Täitja), keda
edaspidi nimetatakse üheskoos ka Pooled ja eraldi Pool, sõlmivad käesoleva hankelepingu
(edaspidi Leping) alljärgnevas:
1. Üldsätted
1.1. Leping sõlmitakse Tellija korraldatud riigihanke „Ehitisregistri arendusteenus 2”,
viitenumber 181147, tulemusena 22.06.2017 sõlmitud raamlepingu nr 1.9-8/17-285-1
(edaspidi Raamleping) alusel.
1.2. Lepingu dokumendid koosnevad käesolevast Lepingust, Lepingu lisadest,
Raamlepingust ning Lepingu võimalikest muudatustest, milles lepitakse kokku pärast
Lepingule allakirjutamist.
1.3. Pooltel on õigus Lepingu muutmises kokku leppida üksnes Raamlepingus sätestatud
tingimuste piires, v.a juhul, kui muutmise tulemusena on hankelepingu tingimused
Tellija jaoks Raamlepingus sätestatud tingimustest soodsamad.
1.4. Käesoleva Lepingu allakirjutamise hetkel on Lepingule lisatud:
Lisa 1 – Lähteülesanne;
Lisa 2 – Pakkumus;
Lisa 3 – Volikiri.
2. Lepingu ese ja Töö teostamise tähtaeg
2.1. Lepingu esemeks on ehitisregistris e-ehituse platvormi autentimise ja autoriseerimise
mikroteenuse arendus (edaspidi Töö) Lepingu Lisas 1 ja Lisas 2 esitatud tingimustel.
2.2. Täitja kohustub Töö üle andma hiljemalt 45 päeva jooksul peale lepingu allkirjastamist.
3. Täitja kohustused
3.1. Täitja on kohustatud:
3.1.1. lähtuma Töö tegemisel Tellija kirjalikult esitatud nõuetest, Raamlepingu tingimustest
ning Lepingu Lisas 1 toodud Tööde ja tegevuste loetelust;
3.1.2. esitama Tellija nõudmisel ülevaateid, aruandeid ja asjakohast teavet Töö teostamise
käigust;
3.1.3. andma Tellijale tasuta täiendavaid selgitusi Töö kohta enne Töö vastuvõtmist Tellija
poolt.
4. Tasu suurus
4.1. Lepingu kogumaksumus, arvestades Töö mahtu (530 töötundi) ja ühe töötunni hinda (50
eurot) on 26500 eurot käibemaksuta ning koos käibemaksuga 31800 eurot.
1
5. Poolte volitatud esindajad
5.1. Tellija volitatud esindaja Lepingu tingimuste täitmisel, kontrollimisel ja vastuvõtmisel on
Verner Eiber, telefon +372 6256496, e-post
[email protected].
5.2. Tellija volitatud esindajal on õigus esindada Tellijat kõikides Lepinguga seotud
küsimustes, välja arvatud Lepingu muutmine, tähtajalise Lepingu ühepoolne lõpetamine
ning leppetrahvi, viivise ja/või kahjude hüvitamise nõude esitamine.
5.3. Täitja volitatud esindaja Lepingu tingimuste täitmisel, kontrollimisel, hinnapakkumuste
esitamisel ja Tööde üleandmisel on Raul Meriloo, telefon +372 5014718, e-post
[email protected].
5.4. Juhul, kui Tellija või Täitja asendab oma esindaja teisega, teatab ta sellest teisele Poolele
koheselt kirjalikult.
6. Poolte allkirjad:
Tellija: Täitja:
/allkirjastatud digitaalselt/ /allkirjastatud digitaalselt/
Ando Leppiman Anneli Heinsoo
kantsler juhatuse liige
2
Lisa 1
E-ehituse platvormi autentimise ja autoriseerimise mikroteenuse
arendus
Lähteülesanne
Lühendid:
API – (application programming interface) rakendustarkvara liides
AT – (Access Token) Sisaldab sisse logimise seansi, tuvastab kasutaja
EHR – Ehitisregister
IP – (Internet protocol address) seadme identifikaator
jm – ja muud
Keycloak – Avatud tarkvara autentimiseks
MKM – Majandus- ja Kommunikatsiooni ministeerium
KC – (Keycloak) avatud lähtekoodiga identiteedi ja juurdepääsuhalduslahendus
ptk - peatükk
RS – Redux store
Redis – Remote Dictionary Server
SP – (Sherepoint) dokumentide hoidmise tarkvara
TARA – Riigi autentimisteenus
TEHIK – Tervise ja Heaolu Infosüsteemide Keskus
UI – (user interface) Kasutajaliides
vt – vaata
Eesmärk: arendada välja ja viia toodangu keskkonda e-ehituse mikroteenuste autoriseerimise ja
autentimise teenused ning täiendada autoriseerimise teenustega e-ehituse UI juurkomponenti.
Sissejuhatus
E-ehituse autentimise ja autoriseerimise teenuste detailanalüüs kirjeldab e-ehituse uue,
mikroteenustel baseeruva platvormi autentimise ja autoriseerimise teenused. Käesolev
lähteülesanne tuleneb detailanalüüsi dokumendist (vt Lisad Kasutajaõiguse süsteemi detailanalüüs)
ja täiendustest, mis on vajalikud, et tagada EHR olemasoleva Java rakenduse ja uue mikroteenustel
põhinevate rakenduste koostöö mikroteenustele ülemineku etapil ehk seni, kuni on kasutusel EHR
Java rakenduse autentimise ja autoriseerimise lahendus. Seega käesoleval lähteülesandel baseeruv
lahendus töötab seni, kuni kasutatakse samaaegselt EHR uut ja vanemat rakendust. Kasutajad,
kasutajate rollid võetakse lahenduse töötamise ajal vanast e olemasolevast Java rakendusest ja
Oracle andmebaasist. Uute rakenduste käivitamiseks kasutatakse uusi, detailanalüüsis kirjeldatud
rolle. Vanasse rakendusse lisatakse vanade ja uute rollide seosed.
EHR Java rakenduse arendustööde nõuded
1. Sulgeda olemas olevad Isikukoodi, mobiil ID autentimise teenused ja teenuste käivitamise
lingid.
2. Muuta olemasolev TARA autentimise teenus vastavaks ptk „Sisselogimine vana rakenduse
kaudu. Käesolevas dokumendis toodud lahendus ei erine suures osas detailanalüüsis toodud
lahendusest. Kui detailanalüüsis on kirjeldatud uue UI kaudu sisselogimist ehk browseri
rakendus saab teha otse päringu Keycloak-i siis vanas rakenduses tuleb otsepäring asendada
serveris töötava rakenduse päringuga. (vt Kasutajaõiguste süsteemi detailanaüüsi ptk 8.3,
toodud ära ptk Lisad). Detailanalüüsis kirjeldatud isikuhalduse teenust praeguses etapis
eraldi ei looda vaid see integreeritakse vanasse Java rakendusse.
3. Luua asutuse (rolli) vahetamise teenus, mis on kirjeldatud ptk „Rollivahetus vana rakenduse
kaudu“. Suures osas kattub funktsionaalsus Kasutajaõiguste süsteemi detailanalüüsis toodud
ptk. 8.4 „Asutuse vahetamine“ (toodud ära ptk Lisad).
4. Lisada vanasse rakenduse ja uue rakenduse asutuste (rollide) seosed, nii et rolli valik vanas
rakenduses oskaks määrata õiget rolli uues rakenduses vt lisatud dokument „EHRi uue ja
vana süsteemi kokkuviimine“.
5. Muuta olemasolev vana rakenduse logout teenus vastavaks ptk „Kasutaja väljumine vanast
rakendusest“
6. Lisatakse meetod, mis salvestab kasutaja browseri IP, mida kasutatakse Redise key loomisel.
Vajadus on tagada andmevahetus uue UI ja vana Java rakenduse vahel ka umbisikulistele
kasutajatele, kellel puudub Java rakenduses sessioon ja unikaalse Redis võtmena kasutatakse
kasutaja browseri IP-d.
7. Lisatakse meetod, mis uue UI väljakutsumisel salvestab vajalikud parameetrid vastava API
kaudu vt „Java rakendusest e-ehituse UI root komponendi väljakutsumine“
8. Muudetakse olemasoleva arhiveerimise komponendi väljakutsumist ja viiakse see
käivitatavaks e-ehituse UI root komponendist
Keycloak paigaldamise nõuded
Seadistada Keycloak e-ehituse toodangu ja test klastritesse ja modifitseerida TEHIK poolt pakutud
lisamooduleid TARA integratsiooniks ja rollide kasutamiseks.
1. Paigaldada Keycloak jaoks riigipilve PostgreSQL VM ja andmebaas.
2. Paigaldada Keycloak (https://koodivaramu.eesti.ee/tehik/sso/blob/master/docs/server-
setup-k8s.md) ja Realm (https://koodivaramu.eesti.ee/tehik/sso/blob/master/docs/realm-
setup.md) kasutades TEHIKu näidet lisamoodulitega paigaldamisest.
3. Lisada kasutajale atribuudid tema asutuste ja aktiivse asutuse salvestamiseks.
4. Konfigureerida kasutaja info Mapper tokenisse vajaliku info lisamiseks.
5. Seadistada TARA liidestus kasutades TEHIKu poolt pakutud lisamooduleid.
https://koodivaramu.eesti.ee/tehik/sso
E-ehituse Root komponendi1 arenduse nõuded
1
e-ehituse root komponent on komponent mille kaudu käivitatakse uus UI ja see asub:
https://git.mkm.ee/ehr/ehr-k8s-pipeline/ehr-ui
Arenduse eesmärk on täiendada UI root komponenti sisseloginud kasutaja andmed, „tokenite“ ja
käivitusparameetritega.
1. Lisada Redux (https://redux.js.org/) store (RS), milles hakatakse hoidma komponentide
parameetreid, seisundeid, tokeneid jm infot, mis on vajalikud kogu e-ehituse UI
komponentide omavaheliseks suhtluseks.
2. Lisada meetodid, mis salvestavad Access ja Refresh Tokenid RS-i.
3. Lisada meetodid, mis salvestavad kasutaja andmed ning kasutaja rolli ja asutuse andmed RS-
i, kus need on kättesaadavad kõigile ülejäänud komponentidele.
4. Lisada meetod, mis uuendab aegumisel Access Tokenit RS-is.
5. Lisada meetod, mis komponendi laadimisel pärib API teenusest käivitusparameetrid vt „Java
rakendusest e-ehituse UI root komponendi väljakutsumine“.
6. Luua API, mis vahendab parameetreid uue UI ja vana Java rakenduse vahel vt „Java
rakendusest e-ehituse UI root komponendi väljakutsumine“.
Arhiveerimise komponendi muutmine
Arenduse eesmärk on viia olemasolev arhiveerimise komponent vastavusse käesolevas arenduses
loodud teenustele.
1. Muuta arhiveerimise UI komponent2 käivitatavaks UI root komponendist
2. Muuta arhiveerimise API komponendi autoriseerimise tokeniks EHR root komponendi Redux
stores olev Access Token.
3. Lisada Keycloak-i kõik arhiveerimise rakenduse autoriseerimiseks vajaminevad rollid,
privileegid, ressursid jm objektid.
Üldised nõuded
Arendustes tuleb järgida:
1. E-ehituse platvormi mittefunktsionaalsed nõuded
2. E-ehituse platvormi tarkvaraline arhitektuur
3. Arendusprotsessi läbiviimise juhend
4. Koostada juhend arendajatele, milles on kirjeldatud EHR autoriseerimise mooduliga
integreerimist ja selle kasutamist
a. Kuidas kirjeldada Keycloakis uusi kaitsmist vajavaid ressursse;
b. Kuidas Keycloakis lisada rolle, privileege;
c. Kuidas kasutada EHR Access Tokenit ja selles olevat infot;
d. Kuidas luua ja testida kaitsmist vajavaid ressursse;
e. Kuidas kasutada EHR root komponenti ja selles olevaid parameetreid.
2
Arhiveerimise UI komponent: https://git.mkm.ee/ehr/ehr-k8s-pipeline/ehr-arhiiv-ui on kasutusel toodangus
ja käivitub EHR Java rakendusest.
sd Create_user_if_not_exists
Browser EHR Java KeyCloak TARA
Login()
Authenticate()
TARA_Login()
Ask_Credentials()
:Credentials
:User Info
Create_user_if_not_exists()
:Acess Token
Ask_user_info(Access Token)
:user_info
Create_session(user_info)
Update_user
(User_info, Role)
:Access Token
:Access_Token, User_info
Sisselogimine vana rakenduse kaudu
1. Browser login nupp algatab Login() päringu.
2. Java rakendus teeb Authenticate() päringu Keycloak-i3.
3. KeyCloak kasutab välist IDP providerit, et kasutaja sisse logida ja saada tagasi kasutaja
andmed.
4. Juhul, kui kasutaja andmeid KC-s pole siis luuakse uus kasutaja. Juhul, kui mõnest eelnevast
sisselogimisest on andmed olemas siis kasutatakse neid andmeid Access Tokeni loomiseks
5. KC tagastab Java rakendusele Access Tokeni (AT) ja Refresh Tokeni (RT), milles on kasutaja
andmed ja roll
6. Java rakendus, küsib AT-ga KC-st kasutaja andmed ja loob nende alusel sessiooni
7. Java rakendus võrdleb tokenis olevat rolli kasutaja vaikimisi rolliga Oracle andmebaasis, kui
rollid ei võrdu siis on vaja luua uus AT
8. Java rakendus uuendab vajadusel kasutaja andmed KC-s ja loob uue AT ja RT.
9. Java rakendus saadab browserile kehtiva AT ja RT ja kuvab kasutaja andmed
3
Nüüd ja edaspidi tuleb Keycloakiga suhtluseks kasutada Keycloack API-t.
Rollivahetus vana rakenduse kaudu
1. Kasutaja vahetab browseris rolli ja browser algatab rollivahetuse e “asutuse vahetuse” Java
rakenduses.
2. Java rakendus vahetab kasutaja rolli vanas rakenduses ja uuendab kasutaja andmed KC-s ning
küsib uue AT ja RT.
3. Java rakendus tagastab browserile uue AT ja RT ja kuvab uue rolli.
Kasutaja väljumine vanast rakendusest
1. Browseris Logout nupp algatab Logout() päringu.
2. Java rakendus saadab KC-le sessiooni lõpetamise teate ja lõpetab Java rakenduses sessiooni.
Java rakendusest e-ehituse UI root komponendi väljakutsumine
Uus UI kutsutakse Java rakendusest välja ja käivitatakse Iframes. Alati käivitub uue UI (React) kõige
ülemine ehk root komponent, mis omakorda käivitab teised komponendid. Root komponendi
väljakutsumisel on vaja edastada Java rakendusest komponendile parameetrid, mis tagatakse
järgmisel joonisel toodud arhitektuuriga.
Töövoog UI väljakutsumisel on järgmine:
1. Java rakendus salvestab vajaminevad parameetrid (näiteks käivitamist vajava komponendi
nime) Component Parameters API teenuse abil Redis andmebaasi KeyValue paaridena. Et
tagada unikaalne ID, millega paarid üles leida, kasutatakse peakey-ks kasutaja browseri IP
aadressi. Key-d luuakse aeguvatena, ehk kehtivad max 60 sek ja seejärel kustuvad.
2. Java rakendus kutsub välja Iframe, mis omakorda käivitab root komponendi. Iframe käivituse
URL-s peab sisalduma kasutaja Access Token.
3. Root komponent teeb päringu kasutaja andmete saamiseks Keycloak-st.
4. Root komponent teeb Get päringu Component Parameters API teenusest kasutades UserID.
Teenus kustutab peale esmast lugemist kasutajale loodud võtmed ehk iga kord kui kasutaja
avab UI siis parameetrite edastamise võtmed salvestatakse API POST päringuga ja
kustutatakse API GET päringuga. Juhul, kui parameetrite tagastamisel tekkib viga kuvatakse
kasutajale veateade ja Iframe suletakse.
5. Root komponent käivitab vastavalt parameetritele vajaliku alamkomponendi. Näiteks kui on
vaja käivitada arhiveerimise UI siis parameetrites sisaldub arhiveerimise komponendi
nimetus ning root komponent käivitab selle nimetuse alusel arhiveerimise komponendi.
soaml UI väljakutsumise arhitektuur
«agent» «participant»
React UI root call Iframe EHR Java user autent
component
«use»
GET SET
PARAMS params
HTTPS HTTPS
«participant»
Component
GET Call
parameters API POST Call
Params
Params
GET, SET Params
«flow»
«entity»
REDIS
Lisad
Failid asuvad MKMi SPs:
1. EHRi uue ja vana süsteemi kokkuviimine
2. Kasutajaõiguste süsteemi detailanalüüs
3. EHRi rollide privileegide tabel
4. E-ehituse platvormi tarkvaraline arhitektuur
5. E-ehituse platvormi mittefunktsionaalsed nõuded
6. Arendusprotsessi läbiviimise juhend
MINIHANKE PAKKUMUS
Raamhange: „Ehitisregistri arendusteenus 2“ (181147)
Minihange: „E-ehituse platvormi autentimise ja autoriseerimise mikroteenuse arendus“
PAKKUMUS
Pakkumus vastavalt 17.04.2020 hinnapäringule.
Töö nimetus Aeg töötundides Maksumus Maksumus
ilma KM-ta (EUR) KM-ga (EUR)
E-ehituse platvormi 530 26 500 31 800
autentimise ja
autoriseerimise
mikroteenuse arendus
Tööde üleandmine 45päeva lepingu sõlmimisest.
Lugupidamisega,
Kaido Heinsalu
Tieto Estonia AS
/allkirjastatud digitaalselt/
Hankeleping nr 18/1.9-8/20-169-1
Tallinnas, 13.05.2020
Majandus- ja Kommunikatsiooniministeerium, registrikood 70003158, asukoht Suur –
Ameerika 1, Tallinn 10122, mida esindab põhimääruse alusel kantsler Ando Leppiman
(edaspidi Tellija),
ja
Tieto Estonia Aktsiaselts, registrikood 10137025, asukoht A. H. Tammsaare tee 47, Tallinn
11316, mida esindab põhikirja alusel juhatuse liige Anneli Heinsoo, (edaspidi Täitja), keda
edaspidi nimetatakse üheskoos ka Pooled ja eraldi Pool, sõlmivad käesoleva hankelepingu
(edaspidi Leping) alljärgnevas:
1. Üldsätted
1.1. Leping sõlmitakse Tellija korraldatud riigihanke „Ehitisregistri arendusteenus 2”,
viitenumber 181147, tulemusena 22.06.2017 sõlmitud raamlepingu nr 1.9-8/17-285-1
(edaspidi Raamleping) alusel.
1.2. Lepingu dokumendid koosnevad käesolevast Lepingust, Lepingu lisadest,
Raamlepingust ning Lepingu võimalikest muudatustest, milles lepitakse kokku pärast
Lepingule allakirjutamist.
1.3. Pooltel on õigus Lepingu muutmises kokku leppida üksnes Raamlepingus sätestatud
tingimuste piires, v.a juhul, kui muutmise tulemusena on hankelepingu tingimused
Tellija jaoks Raamlepingus sätestatud tingimustest soodsamad.
1.4. Käesoleva Lepingu allakirjutamise hetkel on Lepingule lisatud:
Lisa 1 – Lähteülesanne;
Lisa 2 – Pakkumus;
Lisa 3 – Volikiri.
2. Lepingu ese ja Töö teostamise tähtaeg
2.1. Lepingu esemeks on ehitisregistris e-ehituse platvormi autentimise ja autoriseerimise
mikroteenuse arendus (edaspidi Töö) Lepingu Lisas 1 ja Lisas 2 esitatud tingimustel.
2.2. Täitja kohustub Töö üle andma hiljemalt 45 päeva jooksul peale lepingu allkirjastamist.
3. Täitja kohustused
3.1. Täitja on kohustatud:
3.1.1. lähtuma Töö tegemisel Tellija kirjalikult esitatud nõuetest, Raamlepingu tingimustest
ning Lepingu Lisas 1 toodud Tööde ja tegevuste loetelust;
3.1.2. esitama Tellija nõudmisel ülevaateid, aruandeid ja asjakohast teavet Töö teostamise
käigust;
3.1.3. andma Tellijale tasuta täiendavaid selgitusi Töö kohta enne Töö vastuvõtmist Tellija
poolt.
4. Tasu suurus
4.1. Lepingu kogumaksumus, arvestades Töö mahtu (530 töötundi) ja ühe töötunni hinda (50
eurot) on 26500 eurot käibemaksuta ning koos käibemaksuga 31800 eurot.
1
5. Poolte volitatud esindajad
5.1. Tellija volitatud esindaja Lepingu tingimuste täitmisel, kontrollimisel ja vastuvõtmisel on
Verner Eiber, telefon +372 6256496, e-post
[email protected].
5.2. Tellija volitatud esindajal on õigus esindada Tellijat kõikides Lepinguga seotud
küsimustes, välja arvatud Lepingu muutmine, tähtajalise Lepingu ühepoolne lõpetamine
ning leppetrahvi, viivise ja/või kahjude hüvitamise nõude esitamine.
5.3. Täitja volitatud esindaja Lepingu tingimuste täitmisel, kontrollimisel, hinnapakkumuste
esitamisel ja Tööde üleandmisel on Raul Meriloo, telefon +372 5014718, e-post
[email protected].
5.4. Juhul, kui Tellija või Täitja asendab oma esindaja teisega, teatab ta sellest teisele Poolele
koheselt kirjalikult.
6. Poolte allkirjad:
Tellija: Täitja:
/allkirjastatud digitaalselt/ /allkirjastatud digitaalselt/
Ando Leppiman Anneli Heinsoo
kantsler juhatuse liige
2
Lisa 1
E-ehituse platvormi autentimise ja autoriseerimise mikroteenuse
arendus
Lähteülesanne
Lühendid:
API – (application programming interface) rakendustarkvara liides
AT – (Access Token) Sisaldab sisse logimise seansi, tuvastab kasutaja
EHR – Ehitisregister
IP – (Internet protocol address) seadme identifikaator
jm – ja muud
Keycloak – Avatud tarkvara autentimiseks
MKM – Majandus- ja Kommunikatsiooni ministeerium
KC – (Keycloak) avatud lähtekoodiga identiteedi ja juurdepääsuhalduslahendus
ptk - peatükk
RS – Redux store
Redis – Remote Dictionary Server
SP – (Sherepoint) dokumentide hoidmise tarkvara
TARA – Riigi autentimisteenus
TEHIK – Tervise ja Heaolu Infosüsteemide Keskus
UI – (user interface) Kasutajaliides
vt – vaata
Eesmärk: arendada välja ja viia toodangu keskkonda e-ehituse mikroteenuste autoriseerimise ja
autentimise teenused ning täiendada autoriseerimise teenustega e-ehituse UI juurkomponenti.
Sissejuhatus
E-ehituse autentimise ja autoriseerimise teenuste detailanalüüs kirjeldab e-ehituse uue,
mikroteenustel baseeruva platvormi autentimise ja autoriseerimise teenused. Käesolev
lähteülesanne tuleneb detailanalüüsi dokumendist (vt Lisad Kasutajaõiguse süsteemi detailanalüüs)
ja täiendustest, mis on vajalikud, et tagada EHR olemasoleva Java rakenduse ja uue mikroteenustel
põhinevate rakenduste koostöö mikroteenustele ülemineku etapil ehk seni, kuni on kasutusel EHR
Java rakenduse autentimise ja autoriseerimise lahendus. Seega käesoleval lähteülesandel baseeruv
lahendus töötab seni, kuni kasutatakse samaaegselt EHR uut ja vanemat rakendust. Kasutajad,
kasutajate rollid võetakse lahenduse töötamise ajal vanast e olemasolevast Java rakendusest ja
Oracle andmebaasist. Uute rakenduste käivitamiseks kasutatakse uusi, detailanalüüsis kirjeldatud
rolle. Vanasse rakendusse lisatakse vanade ja uute rollide seosed.
EHR Java rakenduse arendustööde nõuded
1. Sulgeda olemas olevad Isikukoodi, mobiil ID autentimise teenused ja teenuste käivitamise
lingid.
2. Muuta olemasolev TARA autentimise teenus vastavaks ptk „Sisselogimine vana rakenduse
kaudu. Käesolevas dokumendis toodud lahendus ei erine suures osas detailanalüüsis toodud
lahendusest. Kui detailanalüüsis on kirjeldatud uue UI kaudu sisselogimist ehk browseri
rakendus saab teha otse päringu Keycloak-i siis vanas rakenduses tuleb otsepäring asendada
serveris töötava rakenduse päringuga. (vt Kasutajaõiguste süsteemi detailanaüüsi ptk 8.3,
toodud ära ptk Lisad). Detailanalüüsis kirjeldatud isikuhalduse teenust praeguses etapis
eraldi ei looda vaid see integreeritakse vanasse Java rakendusse.
3. Luua asutuse (rolli) vahetamise teenus, mis on kirjeldatud ptk „Rollivahetus vana rakenduse
kaudu“. Suures osas kattub funktsionaalsus Kasutajaõiguste süsteemi detailanalüüsis toodud
ptk. 8.4 „Asutuse vahetamine“ (toodud ära ptk Lisad).
4. Lisada vanasse rakenduse ja uue rakenduse asutuste (rollide) seosed, nii et rolli valik vanas
rakenduses oskaks määrata õiget rolli uues rakenduses vt lisatud dokument „EHRi uue ja
vana süsteemi kokkuviimine“.
5. Muuta olemasolev vana rakenduse logout teenus vastavaks ptk „Kasutaja väljumine vanast
rakendusest“
6. Lisatakse meetod, mis salvestab kasutaja browseri IP, mida kasutatakse Redise key loomisel.
Vajadus on tagada andmevahetus uue UI ja vana Java rakenduse vahel ka umbisikulistele
kasutajatele, kellel puudub Java rakenduses sessioon ja unikaalse Redis võtmena kasutatakse
kasutaja browseri IP-d.
7. Lisatakse meetod, mis uue UI väljakutsumisel salvestab vajalikud parameetrid vastava API
kaudu vt „Java rakendusest e-ehituse UI root komponendi väljakutsumine“
8. Muudetakse olemasoleva arhiveerimise komponendi väljakutsumist ja viiakse see
käivitatavaks e-ehituse UI root komponendist
Keycloak paigaldamise nõuded
Seadistada Keycloak e-ehituse toodangu ja test klastritesse ja modifitseerida TEHIK poolt pakutud
lisamooduleid TARA integratsiooniks ja rollide kasutamiseks.
1. Paigaldada Keycloak jaoks riigipilve PostgreSQL VM ja andmebaas.
2. Paigaldada Keycloak (https://koodivaramu.eesti.ee/tehik/sso/blob/master/docs/server-
setup-k8s.md) ja Realm (https://koodivaramu.eesti.ee/tehik/sso/blob/master/docs/realm-
setup.md) kasutades TEHIKu näidet lisamoodulitega paigaldamisest.
3. Lisada kasutajale atribuudid tema asutuste ja aktiivse asutuse salvestamiseks.
4. Konfigureerida kasutaja info Mapper tokenisse vajaliku info lisamiseks.
5. Seadistada TARA liidestus kasutades TEHIKu poolt pakutud lisamooduleid.
https://koodivaramu.eesti.ee/tehik/sso
E-ehituse Root komponendi1 arenduse nõuded
1
e-ehituse root komponent on komponent mille kaudu käivitatakse uus UI ja see asub:
https://git.mkm.ee/ehr/ehr-k8s-pipeline/ehr-ui
Arenduse eesmärk on täiendada UI root komponenti sisseloginud kasutaja andmed, „tokenite“ ja
käivitusparameetritega.
1. Lisada Redux (https://redux.js.org/) store (RS), milles hakatakse hoidma komponentide
parameetreid, seisundeid, tokeneid jm infot, mis on vajalikud kogu e-ehituse UI
komponentide omavaheliseks suhtluseks.
2. Lisada meetodid, mis salvestavad Access ja Refresh Tokenid RS-i.
3. Lisada meetodid, mis salvestavad kasutaja andmed ning kasutaja rolli ja asutuse andmed RS-
i, kus need on kättesaadavad kõigile ülejäänud komponentidele.
4. Lisada meetod, mis uuendab aegumisel Access Tokenit RS-is.
5. Lisada meetod, mis komponendi laadimisel pärib API teenusest käivitusparameetrid vt „Java
rakendusest e-ehituse UI root komponendi väljakutsumine“.
6. Luua API, mis vahendab parameetreid uue UI ja vana Java rakenduse vahel vt „Java
rakendusest e-ehituse UI root komponendi väljakutsumine“.
Arhiveerimise komponendi muutmine
Arenduse eesmärk on viia olemasolev arhiveerimise komponent vastavusse käesolevas arenduses
loodud teenustele.
1. Muuta arhiveerimise UI komponent2 käivitatavaks UI root komponendist
2. Muuta arhiveerimise API komponendi autoriseerimise tokeniks EHR root komponendi Redux
stores olev Access Token.
3. Lisada Keycloak-i kõik arhiveerimise rakenduse autoriseerimiseks vajaminevad rollid,
privileegid, ressursid jm objektid.
Üldised nõuded
Arendustes tuleb järgida:
1. E-ehituse platvormi mittefunktsionaalsed nõuded
2. E-ehituse platvormi tarkvaraline arhitektuur
3. Arendusprotsessi läbiviimise juhend
4. Koostada juhend arendajatele, milles on kirjeldatud EHR autoriseerimise mooduliga
integreerimist ja selle kasutamist
a. Kuidas kirjeldada Keycloakis uusi kaitsmist vajavaid ressursse;
b. Kuidas Keycloakis lisada rolle, privileege;
c. Kuidas kasutada EHR Access Tokenit ja selles olevat infot;
d. Kuidas luua ja testida kaitsmist vajavaid ressursse;
e. Kuidas kasutada EHR root komponenti ja selles olevaid parameetreid.
2
Arhiveerimise UI komponent: https://git.mkm.ee/ehr/ehr-k8s-pipeline/ehr-arhiiv-ui on kasutusel toodangus
ja käivitub EHR Java rakendusest.
sd Create_user_if_not_exists
Browser EHR Java KeyCloak TARA
Login()
Authenticate()
TARA_Login()
Ask_Credentials()
:Credentials
:User Info
Create_user_if_not_exists()
:Acess Token
Ask_user_info(Access Token)
:user_info
Create_session(user_info)
Update_user
(User_info, Role)
:Access Token
:Access_Token, User_info
Sisselogimine vana rakenduse kaudu
1. Browser login nupp algatab Login() päringu.
2. Java rakendus teeb Authenticate() päringu Keycloak-i3.
3. KeyCloak kasutab välist IDP providerit, et kasutaja sisse logida ja saada tagasi kasutaja
andmed.
4. Juhul, kui kasutaja andmeid KC-s pole siis luuakse uus kasutaja. Juhul, kui mõnest eelnevast
sisselogimisest on andmed olemas siis kasutatakse neid andmeid Access Tokeni loomiseks
5. KC tagastab Java rakendusele Access Tokeni (AT) ja Refresh Tokeni (RT), milles on kasutaja
andmed ja roll
6. Java rakendus, küsib AT-ga KC-st kasutaja andmed ja loob nende alusel sessiooni
7. Java rakendus võrdleb tokenis olevat rolli kasutaja vaikimisi rolliga Oracle andmebaasis, kui
rollid ei võrdu siis on vaja luua uus AT
8. Java rakendus uuendab vajadusel kasutaja andmed KC-s ja loob uue AT ja RT.
9. Java rakendus saadab browserile kehtiva AT ja RT ja kuvab kasutaja andmed
3
Nüüd ja edaspidi tuleb Keycloakiga suhtluseks kasutada Keycloack API-t.
Rollivahetus vana rakenduse kaudu
1. Kasutaja vahetab browseris rolli ja browser algatab rollivahetuse e “asutuse vahetuse” Java
rakenduses.
2. Java rakendus vahetab kasutaja rolli vanas rakenduses ja uuendab kasutaja andmed KC-s ning
küsib uue AT ja RT.
3. Java rakendus tagastab browserile uue AT ja RT ja kuvab uue rolli.
Kasutaja väljumine vanast rakendusest
1. Browseris Logout nupp algatab Logout() päringu.
2. Java rakendus saadab KC-le sessiooni lõpetamise teate ja lõpetab Java rakenduses sessiooni.
Java rakendusest e-ehituse UI root komponendi väljakutsumine
Uus UI kutsutakse Java rakendusest välja ja käivitatakse Iframes. Alati käivitub uue UI (React) kõige
ülemine ehk root komponent, mis omakorda käivitab teised komponendid. Root komponendi
väljakutsumisel on vaja edastada Java rakendusest komponendile parameetrid, mis tagatakse
järgmisel joonisel toodud arhitektuuriga.
Töövoog UI väljakutsumisel on järgmine:
1. Java rakendus salvestab vajaminevad parameetrid (näiteks käivitamist vajava komponendi
nime) Component Parameters API teenuse abil Redis andmebaasi KeyValue paaridena. Et
tagada unikaalne ID, millega paarid üles leida, kasutatakse peakey-ks kasutaja browseri IP
aadressi. Key-d luuakse aeguvatena, ehk kehtivad max 60 sek ja seejärel kustuvad.
2. Java rakendus kutsub välja Iframe, mis omakorda käivitab root komponendi. Iframe käivituse
URL-s peab sisalduma kasutaja Access Token.
3. Root komponent teeb päringu kasutaja andmete saamiseks Keycloak-st.
4. Root komponent teeb Get päringu Component Parameters API teenusest kasutades UserID.
Teenus kustutab peale esmast lugemist kasutajale loodud võtmed ehk iga kord kui kasutaja
avab UI siis parameetrite edastamise võtmed salvestatakse API POST päringuga ja
kustutatakse API GET päringuga. Juhul, kui parameetrite tagastamisel tekkib viga kuvatakse
kasutajale veateade ja Iframe suletakse.
5. Root komponent käivitab vastavalt parameetritele vajaliku alamkomponendi. Näiteks kui on
vaja käivitada arhiveerimise UI siis parameetrites sisaldub arhiveerimise komponendi
nimetus ning root komponent käivitab selle nimetuse alusel arhiveerimise komponendi.
soaml UI väljakutsumise arhitektuur
«agent» «participant»
React UI root call Iframe EHR Java user autent
component
«use»
GET SET
PARAMS params
HTTPS HTTPS
«participant»
Component
GET Call
parameters API POST Call
Params
Params
GET, SET Params
«flow»
«entity»
REDIS
Lisad
Failid asuvad MKMi SPs:
1. EHRi uue ja vana süsteemi kokkuviimine
2. Kasutajaõiguste süsteemi detailanalüüs
3. EHRi rollide privileegide tabel
4. E-ehituse platvormi tarkvaraline arhitektuur
5. E-ehituse platvormi mittefunktsionaalsed nõuded
6. Arendusprotsessi läbiviimise juhend