Sissejuhatus

Järgnev dokument kirjeldab, kuidas seadistada ja paigaldada CYBSIS (Cybersecurity Standard Implementation Software) tarkvara.

Paigaldusfailide laadimine

Lae paigaldusfail alla ning paki lahti seadmes soovitud asukohta. Paigaldus pakk sisaldab järgmisi faile ja katalooge:

/static teenuse skriptid
/views kasutajaliidese failid
/translations lokaliseerimise failid
/keys self-generated võti ja sertifikaat
/data sisaldab EITS andmefaili
.env näidis konfiguratsioonifail
cybsis.exe (win) või cybsis (unix) rakendusfail

Konfiguratsioon

Cybsis konfiguratsioon on ära kirjeldatud .env (dotenv) failis, mis asub käivitusprogrammiga samas kataloogis.

Konfiguratsiooni fail peab sisaldama järgmisi muutujaid:

TLS_KEY TLS/SSL võtmefaili asukoht
* jäta kirjeldamata pordi suunamise korral
TLS_CERT TLS/SSL sertifikaadi asukoht
* jäta kirjeldamata pordi suunamise korral
SESSION_KEY sessiooni tunnus
EITS_DATA_FILE Eesti Infoturbe Standardi andmete faili asukoht
/data sisaldab EITS andmefaili
.env näidis konfiguratsioonifail
cybsis.exe (win) või cybsis (unix) rakendusfail

Näidis konfiguratsioon (Unix):

TLS_KEY=/opt/eits/key.pem
TLS_CERT=/opt/eits/cert.pem
SESSION_KEY=application-session
EITS_DATA_FILE=/opt/eits/eits2020.json
LOGS_LOCATION=/opt/eits/logs/
DATABASE_LOCATION=/opt/eits/

Näidis konfiguratsioon (Windows):

TLS_KEY=C:\eits\key.pem
TLS_CERT=C:\eits\cert.pem
SESSION_KEY=application-session
EITS_DATA_FILE=C:\eits\eits2020.json
LOGS_LOCATION=C:\eits\logs\
DATABASE_LOCATION=C:\eits\

Oluline on tähele panna, et andmebaasi asukoha kirjeldus (DATABASE_LOCATION) ja logi failide asukoht (LOGS_LOCATION) peab lõppema kaldkriipsuga, et andmebaas loodaks kirjeldatud kausta.

Punktiga (.) algavad failid on enamikes süsteemides peidetud failid, seega faili avamiseks kasuta käsurida või seadista süsteem kuvama ka peidetud faile.

Juhul, kui planeerite kasutada veebiserveri tarkvara (nt. Apache) teenuse ees, jätke TLS_KEY ja TLS_CERT konfiguratsiooni parameetrid kirjeldamata.

Cybsis käivitamine

Enne käivitamist veendu, et rakendusfailil oleks antud käivitusõigus. Windows platvormil kasuta selleks "File Properties", Mac ja Linux operatsioonisüsteemis käivita käsurealt käsk:

chmod +x cybsis

Teenuse käivitamiseks mine käsureal Cybsis rakendusfaili asukohta ning käivita rakendusfail.

Windows:

cybsis.exe

Mac/Linux:

./cybsis

Vaikimisi töötab teenus pordis 9090. Juhul, kui vaikimisi kasutatud port ei ole sinu süsteemis lubatud kasutada või on see kasutusel mõne teise teenuse poolt, saad seda muuta rakendusfailile käivitamisel võtme port väärtuse lisamisega.

Windows:

cybsis.exe -port=8888

Mac/Linux:

./cybsis -port=8888

Operatsioonisüsteemiti on mõningased erinevused edasises toimimises. Linux seadmetes käivitub server automaatselt, Windows ja Mac masinal käib serveri töö juhtimine süsteemiikoonist antavate korraldustega.

Linux arvutil ava brauseris veebiaadress http(s)://localhost:9090

Windows ja Mac arvutis on süsteemiikoonide hulgas Cybsis ikoon kolme korraldusega:

  1. Start server - serveri käivitamine
    (ava brauseris aadress https://localhost:9090)
  2. Stop server - serveri töö peatamine
  3. Quit - programmi töö lõpetamine

Tarkvara litsentsi paigaldamine

Tarkvara litsents paigaldatakse seadmesse automaatselt. Esmasel käivitusel kuvatakse vorm litsentsi koodi aktiveerimiseks. Sisesta vormi välja oma litsentsi kood ning kinnita vorm.

Valiidse koodi korral paigaldab tarkvara litsentsi faili konfiguratsiooni parameetriga DATABASE_LOCATION kirjeldatud kataloogi.

Litsentsi koodi väljastab RaulWalter OÜ.

NB! Litsentsi fail on seotud kasutatava seadmega ehk tarkvara ringi tõstmisel uuele seadmele tuleb teavitada kliendituge

Litsentsi paigaldamine ühenduseta seadmetes

Juhul, kui tarkvara kasutatakse seadmes, millel puudub internetiühendus, tuleb litsents paigaldada seadmesse käsitsi.

Selleks toimi järgnevalt:

  1. käivita teenus
  2. kopeeri litsentsi aktiveerimise aknas kuvatav kood (fingerprint)
  3. edasta see kood RaulWalter OÜ’le
  4. Sulle tagastatakse litsentsifail (Account.pem)
  5. kopeeri see konfiguratsioonis kirjeldatud DATABASE_LOCATION kataloogi
  6. käivita teenus uuesi

Root kasutaja

Esimesel sisse logimisel luuakse süsteemi esmane administraatori õigustega kasutaja.

Veebiserveri kasutamine

Juhul, kui kasutate mõnda veebiserveri tarkvara (Apache, Nginx, vms) Cybsis teenuse ees, konfigureerige pordi suunamine veebiserveris.

Näide (Apache):

<VirtualHost *:443>
  ServerName cybsis.minudomeen.ee
  ProxyPreserveHost On

  # setup the proxy
  <Proxy *>
    Order allow,deny
    Allow from all
  </Proxy>
 ProxyPass / http://localhost:9090/
 ProxyPassReverse / http://localhost:9090/
</VirtualHost>  

Samuti tuleks võimalusel Cybsis konfiguratsioonist eemalda SSL võtme ja sertifikaadi kirjed ning kasutada veebiserveri konfiguratsiooni nende paigaldamiseks.

Andmete varundamine

Varundamist (tagavarakoopia) tuleb vajadusel luua konfiguratsiooni parameetriga DATABASE_LOCATION ära kirjeldatud kataloogist.

Tarkvara uuendamine

Tarkvara versiooni uuendamiseks peata teenuse töö ning kopeeri paigaldusfailide pakis olevate failidega eksisteerivad failid üle (v.a. konfiguratsiooni fail) ning käivita teenus uuesti.