TARA statistika

TARA statistikalogi. Spetsifikatsioon

Algselt koostatud: 20.11.2017.

1. Statistikalogi eesmärk on koguda andmeid RIHA kasutusstatistika koostamiseks.
2. Statistikalogi salvestatakse eraldi logifailide kogumina.
3. Statistikalogi hõlmab nii siseriiklikku kui ka piiriülest autentimist.
4. Logisse ei salvestata isikuandmeid.
5. Logi ei toimetata RIA taristust välja.
6. Statistika tootmise kõrval võib logi kasutada ka teenuse tõrgete põhjuste otsimisel ja turvajuhtumite uurimisel.
7. Logi säilitatakse 1 aasta.
8. Logifaili näide:

2017-12-08 12:03:42;openIdDemo;MobileID;START_AUTH;
2017-12-08 12:03:42;openIdDemo;MobileID;ERROR;NOT_ACTIVATED
2017-12-08 12:05:19;openIdDemo;IDCard;START_AUTH;
2017-12-08 12:05:19;openIdDemo;IDCard;SUCCESSFUL_AUTH;;http://aia.demo.sk.ee/esteid2018
2017-12-15 11:37:15;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:15;openIdDemo;MobileID;ERROR;USER_CANCEL
2017-12-15 11:37:16;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:16;openIdDemo;MobileID;ERROR;SENDING_ERROR
2017-12-15 11:37:17;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:17;openIdDemo;MobileID;ERROR;MID_NOT_READY
2017-12-15 11:37:17;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:18;openIdDemo;MobileID;ERROR;PHONE_ABSENT
2017-12-15 11:37:18;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:19;openIdDemo;MobileID;ERROR;SIM_ERROR
2017-12-15 11:37:19;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:20;openIdDemo;MobileID;ERROR;INTERNAL_ERROR
2017-12-15 11:37:20;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:37:20;openIdDemo;MobileID;ERROR;CERTIFICATE_REVOKED: Certificate is revoked
2017-12-15 11:46:12;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:46:28;openIdDemo;MobileID;SUCCESSFUL_AUTH;
2017-12-15 11:48:22;openIdDemo;MobileID;START_AUTH;
2017-12-15 11:48:38;openIdDemo;MobileID;SUCCESSFUL_AUTH;
2017-12-15 11:59:10;openIdDemo;MobileID;START_AUTH;
2018.06.28 08:05:52;openIdDemo;eIDAS/FI;START_AUTH;
2018.06.28 08:06:21;openIdDemo;eIDAS/FI;SUCCESSFUL_AUTH;
2018.06.27 11:23:14;openIdDemo;BankLink/SEB;START_AUTH;
2018.06.27 11:23:15;openIdDemo;BankLink/SEB;SUCCESSFUL_AUTH;
2018.06.27 11:23:14;openIdDemo;BankLink/LUMINOR;START_AUTH;
2018.06.27 11:23:15;openIdDemo;BankLink/LUMINOR;SUCCESSFUL_AUTH;
2018.06.27 11:23:14;openIdDemo;BankLink/SWEDBANK;START_AUTH;
2018.06.27 11:23:15;openIdDemo;BankLink/SWEDBANK;SUCCESSFUL_AUTH;
2018.06.27 11:23:14;openIdDemo;BankLink/COOP;START_AUTH;
2018.06.27 11:23:15;openIdDemo;BankLink/COOP;SUCCESSFUL_AUTH;
2018.06.27 11:23:14;openIdDemo;BankLink/LHV;START_AUTH;
2018.06.27 11:23:15;openIdDemo;BankLink/LHV;SUCCESSFUL_AUTH;
2018.06.27 10:38:27;openIdDemo;SmartID;START_AUTH;
2018.06.27 10:38:28;openIdDemo;SmartID;SUCCESSFUL_AUTH;

9. Logikirje formaat. Logikirjeid on kahte tüüpi:

autentimistoimingu alustamise kirje

nr	väli	selgitus	formaat
1.	toimingu aeg	autentimistoimingu alustamise aeg.	ISO 8601, `YYYY-MM-DD hh:mm:ssTZD`
2.	klientrakendus	klientrakenduse nimi, `client id` OpenID Connecti mõistes.	sõne
4.	autentimismeetod	`MobileID`, `IDCard` jne	sõne
5.	toimingu alustamise kood		`START_AUTH`

autentimistoimingu õnnestumise või ebaõnnestumise kirje;

nr	väli	selgitus	formaat
1.	toimingu aeg	autentimistoimingu alustamise aeg.	ISO 8601, `YYYY-MM-DD hh:mm:ss`
2.	klientrakendus	klientrakenduse nimi, `client id` OpenID Connecti mõistes.	sõne
4.	autentimismeetod	`IDCard`, `MobileID`, `eIDAS/{riigi kood}`, `BankLink/{panga kood}`, `SmartID`	sõne
5.	toimingu tulemus	õnnestumise puhul `SUCCESSFUL_AUTH`, ebaedu puhul `ERROR`	üks järgnevatest konstantidest: `SUCCESSFUL_AUTH`, `ERROR`
6.	veateade	selgitav veateade. Täidetud ainlt juhul kui tomingu tulemus on `ERROR`	sõne
7.	ocsp url	kliendi sertifikaadi staatuse kontrollil kasutatud OCSP url. Täidetud ainult juhul kui autentimismeetod on `IDCard`	URL

Logikirjed on ajalises järgnevuses, kuid mitte paariti - s.t autentimistoimingu tulemuse kirje ei tarvitse vahetult järgneda autentimistoimingu alustamise kirjele.

10. Autentimistoiming
10.1. Autentimistoimingu alguseks loeme hetke, kus TARA teenusesse saabunud kasutaja valib autentimismeetodi - s.t avab meetodi kastikese ja vajutab nupule Sisenen (nupu nimi võib vastavalt autentimismeetodile erineda).
10.2. Autentimistoiming lõpeb kas edukalt või ebaedukalt.
10.3. Autentimistoimingu loeme lõppenuks edukalt siis, kui klientrakendusele väljastatakse volituskood (authorization code).
10.4. Kõigil muudel juhtudel loetakse autentimistoiming lõppenuks ebaedukalt.

11.Kasutusstatistika logifailid asuvad kaustas /etc/cas/logs/statistics.

Kasutusstatistika aruande moodustamisel tuleb arvestada, et teenuse paigaldamisel mitmes instantsis (koormusjaoturi taga), moodustab kumbki oma logifailid.

12.Kasutatakse log4j appenderit. Reeglid ja konfiguratsioon:

<RollingFile name="statisticsAppender"
  fileName="${sys:cas.log.dir}/statistics/stats.log" append="true"
  filePattern="${sys:cas.log.dir}/statistics/stats-%d{yyyy-MM-dd-HH}-%i.log">
<PatternLayout pattern="%m%n"/>
<Policies>
<OnStartupTriggeringPolicy/>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<SizeBasedTriggeringPolicy size="10 MB"/>
</Policies>
</RollingFile>

TARA teenuse statistiline aruanne. Spetsifikatsioon

1. TARA teenuse statistiline aruanne esitab teenuse kaudu teostatud autentimistoimingute arvu ajaperioodil:
1.1. klientrakenduste lõikes
1.2. piiriülene/siseriiklik lõikes
1.3. välisriikide lõikes
1.4. autentimismeetodite lõikes
1.5. autentimistoimingu õnnestumise/ebaõnnestumise lõikes
1.6. ajalises lõikes.
2. Statistikaperioodiks on 1 kuu või 1 nädal, aga võib olla ka muu.
3. Statistiline aruanne koostatakse perioodi statistikalogi faili(de) põhjal, spetsiaalse skriptiga.
4. Statistiline aruanne vormistatakse inimloetava, UTF-8 vormingus tekstifailina. Eriline kujundus ei ole vajalik.

Riigi Infosüsteemi Amet · 2017-2024 · https://github.com/e-gov/TARA-Doku