RBLDNS DNS-based blocklists management felhasználói kézikönyv (INTEGRITY Kft. 2013. 06. 27.)
RBLDNS Webes kezelőfelülete Az INTEGRITY által működtetett RBLDNS rendszer webes felületét a spamdns.eu/rbl/ címen keresztül lehet elérni. Itt a bejelentkezést követően egy zónát (hosztnév) tud karbantartani a felhasználó. Az oldal fejlécében jól látható, hogy melyik zónát tudja karbantartani a felhasználó. Ez a zóna a felhasználó létrehozásakor meghatározásra kerül és a későbbiek folyamán nincs mód ennek a megváltoztatására. A program utolsó frissítésének dátumáról a fejlécben található információ.
Alzóna A zóna alatt találhatóak az alzónák (aldomain), ebből több is tartozhat egy zónához. Minden alzóna egy vagy több adathalmazhoz (dataset) van hozzárendelve, így az ezekből álló DNS rekordok összességét jelenti. A zónában minimum egy alzónának szerepelnie kell. Az alzónákat az Alzóna menüpont alatt lehet felügyelni. Itt egy összefoglaló táblázatban lehet áttekinteni a létrehozott alzónákat, azok fontosabb adataival együtt mint: Id (egyedi azonosító) Név (egyedi azonosító) Dataset (datasetek száma amelyekhez az alzóna hozzá van rendelve) Létrehozás ideje (az alzóna létrehozásának ideje).
Alzóna műveletek: Létrehozás: Alzónát az Alzóna menü alatt megjelenő oldalon az + Új alzóna hozzáadása gomb megnyomásával lehet létrehozni. Kötelező megadni egy nevet ami egy érvényes hostnév, ez lesz az alzóna neve ami egyben egyedi azonosításra is szolgál. Ezt a Név mezőbe kell beírni. Üres alzónát aminek az adatai közvetlenül a zóna alá tartoznak a @ névvel létrehozott alzóna valósítja meg. A név az angol ABC betűit, számjegyeket és kötőjelet tartalmazhat, teljes hossza maximálisan 63 karakter lehet. Az alzónát a név megadása után a Mentés gomb segítségével lehet létrehozni, a Mégse gomb segítségével pedig a létrehozó folyamatot lehet megszakítani. Szerkesztés: Már létező alzóna szerkesztésére is van mód. Az Alzóna menüpontban az alzónákat tartalmazó táblázat első oszlopában található ceruza ikonra kattintva, az adott oszlopban található alzóna szerkeszthetővé válik. Szerkesztésnél a név módosítható csak (a létrehozásnál leírt feltételeknek kell megfelelnie az új névnek is), az Id és a Létrehozás dátuma mezők értéke nem módosítható. A módosítást a Mentés gomb segítségével lehet érvényre juttatni a Mégse gombbal pedig elvetni.
Dataset: Az alzónákat tartalmazó táblázat első oszlopában található három ikon közül a középső mappa ikon segítségével van lehetőség arra, hogy megnézzük, hogy az adott alzóna melyik datasetekhez van hozzárendelve. A megjelenő táblázat mutatja a datasetek főbb jellemzői, mint Id, Név, Típus, Lejárat ideje. A datasetek listáját tartalmazó ablakot az Ok gomb lenyomásával lehet bezárni. Törlés: A felvett alzónákat törölni is lehet, ezt az alzónákat tartalmazó táblázat első oszlopában található szemetes ikon segítségével lehet. Ekkor a rendszer rákérdez a műveletre a véletlen törlés elkerülése végett. A törlést véglegesíteni a felugró ablakban a Törlés gomb megnyomásával lehetséges, a műveletet a Mégse gomb megnyomásával lehet megszakítani.
Dataset A dataset (adathalmaz) a DNS rekordok gyűjteménye amelyek IP címet (tartományt) vagy hosztneve(ke)t tartalmaz. Egy adathalmazon belül csak hosztnév vagy csak IP típus lehetséges, egyszerre a kettő nem. Egy adathalmaz több alzónához is tartozhat. Az adathalmazokat a Dataset menüpont alatt lehet kezelni. Itt egy összefoglaló táblázatban lehet áttekinteni a létrehozott adathalmazokat, azok fontosabb adataival együtt mint: Id (egyedi azonosító) Név (egyedi azonosító) Típus (az adathalmaz típusa) Lejárat ideje (az adathalmaz lejáratának számított ideje) Alzóna (az adott adathalmazhoz tartozó alzónák száma) Rekord (az adott adathalmazhoz tartozó rekordok száma) Létrehozás ideje (az adathalmaz létrehozásának ideje).
Dataset műveletek: Létrehozás: Adathalmazt a Dataset menü alatt megjelenő oldalon az + Új dataset hozzáadása gomb megnyomásával lehet létrehozni. Kötelező megadni egy nevet a Név mezőben, ez lesz a dataset neve ami egyben egyedi azonosításra is szolgál egy zónán belül. A név az angol ABC betűit, számjegyeket és kötőjelet tartalmazhat, teljes hossza maximálisan 63 karakter lehet. Kötelező kiválasztani a dataset típusát. A Típus mezőben ezt egy lenyíló lista segítségével tehetjük meg. A típus lehet ip4set ha IP címe(ke)t vagy tartomány(oka)t fog tartalmazni a hozzárendelt rekord(ok) vagy dnset ha hosztneve(ke)t. Kötelező megadni a dataset lejárati idejét. A Lejárat(sec) mezőben másodpercben kell megadni azt, hogy mennyi idő múlva kerüljenek törlésre az adathalmazhoz hozzárendelt rekordok. Nulla esetén nem lesz lejárati idő definiálva, a maximálisan megadható értéke 2 147 483 647 (előjeles 32 bites integer). Ez a dataseteket tartalmazó táblázatban már dátumként fog megjelenni a könnyebb emberi értelmezhetőség érdekében. Kötelező megadni az adathalmaz válasz üzenetét a Válaszkód mezőbe. Ennek értéke IP cím és egy nem kötelező szöveg. Ezek együttes hossza nem haladhatja meg a 255 karaktert. Támogatott formátumok a következőek:
:127.0.0.2: :127.0.0.2:Blacklisted: http://example.com/bl?$ A $ jel használható a DNS lekérdezésben megadott érték helyettesítésére. Kötelező megadni az adathalmazhoz hozzárendelt alzónákat. Ezt az Alzónák kiválasztó mező segítségével lehet megadni. A bal oldali dobozban találhatóak a rendelkezésre álló alzónák a nyilak segítségével könnyen át lehet helyezni a kívánt alzónákat a jobb oldali dobozban (az ellentétes nyilakkal könnyen elvégezhető a művelet visszafele is). A jobb oldali doboz tartalma fog hozzárendelődni az adathalmazhoz. Egy alzóna kiválasztása kötelező. Az adathalmazt a kötelező mezők kitöltése után a Mentés gomb segítségével lehet létrehozni, a Mégse gomb segítségével pedig a létrehozó folyamatot lehet megszakítani. Szerkesztés: Már létező adathalmaz szerkesztésére is van mód. Az Dataset menüpontban az adathalmazokat tartalmazó táblázat első oszlopában található ceruza ikonra kattintva, az adott oszlopban található adathalmaz szerkeszthetővé válik. Szerkesztésnél a Név, Lejárat(sec), Válaszkód és az Alzónák mezők szerkeszthetőek csak utólag. Ezeket a mezőket a létrehozásnál leírt szabályokat betartva lehet módosítani. Látható még a következő mezők is a szerkesztés alatt Id, Típus, Lejárat ideje és a Létrehozás ideje, ezek csak informatív jellegűek segítve a szerkeszthető mezők helyes módosítását. A módosítást a Mentés gomb segítségével lehet érvényre juttatni a Mégse gombbal pedig elvetni.
Rekordok: Az adathalmazokat tartalmazó táblázat első oszlopában található három ikon közül a középső mappa ikon segítségével van lehetőség arra, hogy megnézzük, hogy az adott datasethez melyik rekordok vannak hozzárendelve. A megjelenő táblázat mutatja a rekordok főbb jellemzői, mint Id, Érték, Lejárat(sec), Lejárat ideje, Létrehozás ideje, Megjegyzés. Létrehozás: Itt van lehetőség új rekordot létrehozni a + Új rekord hozzáadása gomb megnyomásával. Kötelező megadni a rekord értékét, ezt az Érték mezőben lehet megtenni. Az érték csak ASCII 32-126 közötti karaktereket tartalmazhat. Az érték mező tartalmának összhangban kell lennie az adathalmaz típusával a következő módon: ip4set esetén: IP cím pl.: 127.0.0.1
IP tartomány pl.: 127.16.0.0-127.31.255.255 IP tartomány CIDR formátumban pl.: 127.0.0.0/24 dnset esetén: example.com (csak az example.com) *.example.com (az example.com összes aldomainje).examle.com (az example.com összes aldomainje és az examle.com együttesen) Nem kötelező megadni a rekord lejárati idejét. Csak akkor kell kitölteni ha Lejárat(sec) mezőt ha eltár a dataset lejárati idejétől. Megadásakor ugyan azok a szabályok vonatkoznak rá, mint az adathalmaznál való megadásra. Amennyiben meg lett adva érték, akkor a megadott időben a rekord törlődni fog az adott adathalmazból. Nem kötelező a Megjegyzés mező kitöltése sem, ez a könnyebb azonosítást teszi lehetővé. Csak ASCII 32-127 karaktereket tartalmazhat. A rekordot a kötelező mezők kitöltése után a Mentés gomb segítségével lehet létrehozni, a Mégse gomb segítségével pedig a létrehozó folyamatot lehet megszakítani. Batch hozzáadása: A Batch hozzáadása gombra való kattintással tömegesen lehet rekordokat felvenni. Kötelező megadni a Rekordok mező tartalmát. Itt a megfelelő értékeket lehet megadni, soronként egyet. Az értékekre vonatkozó szabályok megegyeznek az egyenként való rekordmegadáséval.
Törlés: A Törlés gomb segítségével van mód a rekordok törlésére. Ez a gomb szürke addig, amíg nem kerül kijelölésre egy rekord sem. Kijelölni a rekordokat a táblázat első oszlopában található négyzetre kattintva lehet. Az összes rekord kijelöléséhez az oszlop fejlécében kell az első oszlopban szereplő négyzetre kattintani, ezt követően az összes rekord ki lesz jelölve. Ezt követően a Törlés gombra kell kattintani, ami a kijelölésnek köszönhetően már aktív lesz. Ekkor a rendszer rákérdez a műveletre a véletlen törlés elkerülése végett. A törlést véglegesíteni a felugró ablakban a Törlés gomb megnyomásával lehetséges, a műveletet a Mégse gomb megnyomásával lehet megszakítani. A rekordok listáját tartalmazó ablakot az Ok gomb lenyomásával lehet bezárni.
Törlés: A felvett adathalmazokat törölni is lehet, ezt a dataseteket tartalmazó táblázat első oszlopában található szemetes ikon segítségével lehet. Ekkor a rendszer rákérdez a műveletre a véletlen törlés elkerülése végett. A törlést véglegesíteni a felugró ablakban a Törlés gomb megnyomásával lehetséges, a műveletet a Mégse gomb megnyomásával lehet megszakítani.
Rekordok Az adathalmazokhoz tartozó rekordokat a Rekord menüpontban lehet megtekinteni. Itt egy összefoglaló táblázatban lehet áttekinteni a létrehozott rekordokat, azok fontosabb adataival együtt mint: Id (egyedi azonosító) Érték (a rekord értéke) Lejárat(sec) (lejárati idő másodpercben kifejezve) Lejárat ideje (a lejárat ideje emberi szem számára könnyen értelmezhető formában) Dataset (annak az adathalmaznak a neve amelyhez a rekord tartozik) Létrehozás ideje (az a dátum, amikor a rekord készítve lett) Megjegyzés (amennyiben a rekord létrehozásakor lett megadva megjegyzés az itt megjelenik). Törlés: A felvett adathalmazokat törölni is lehet, ezt a dataseteket tartalmazó táblázat első oszlopában található szemetes ikon segítségével lehet. Ekkor a rendszer rákérdez a műveletre a véletlen törlés elkerülése végett. A törlést véglegesíteni a felugró ablakban a Törlés gomb megnyomásával lehetséges, a műveletet a Mégse gomb megnyomásával lehet megszakítani.
Nyelvválasztás A kezelőfelület nyelvét a fejlécben található zászlók segítségével lehet megváltoztatni. A magyar nyelv az alapértelmezett (magyar zászló), az oldal elérhető angol verzióban (angol zászló) és orosz verzióban is (orosz zászló). Kijelentkezés Az oldalt elhagyni a fejlécben található KILÉPÉS gomb megnyomásával lehetséges.
RBLDNS REST API-n keresztüli kezelése A REST API segítségével a webes felület kiiktatásával lehet adatokat felvenni, törölni és módosítani az RBLDNS rendszerben. A REST API a http://spamdns.eu/rbl/rs/root útvonalon érhető el. Autentikáció Az API csak autentikált felhasználó számára érhető el, ugyan úgy mint a webes felület. Az alap autentikációs paramétereket a HTTP header-ben kell Base64 enkódolva elküldeni minden API hívás során. Műveletek A REST API-n keresztül az alábbi műveletek hajthatók végre: Alzóna Dataset adott zónához tartozó alzónák listázása (GET): /subzones/{zone} adott alzóna részletező (GET): /subzones/{zone}/{id} alzóna létrehozása (POST): /subzones/{zone} alzóna módosítása (PUT): /subzones/{zone} alzóna törlése (DELETE): /subzones/{zone} adott alzónához tartozó dataset-ek listája (GET): /datasets/{zone} adott dataset részletező (GET): /datasets/{zone}/{id} adott dataset-hez tartozó rekordok listázója (GET): /datasets/record/{zone}/{id} dataset létrehozása (POST): /datasets/{zone} dataset módosítása (PUT): /datasets/{zone} dataset törlése (DELETE): /datasets/{zone} rekord létrehozása (POST): /datasets/record/{zone} több rekord egyidejű felvétele (POST): /datasets/records/{zone} Rekord adott zóna rekordjainak listázója (GET): /records/{zone} adott rekord részletező (GET): /records/{zone}/{id} rekordok törlése (DELETE): /records/{zone}
Adatstruktúra A kért adatokat JSON formátumban kell beküldeni és ugyanilyen formátumban kapja vissza a kliens is. Pl. alzóna listázó esetén a kliens csak az url paramétereket állítja be, válaszként meg az alábbi struktúrát kapja: [ ] { }, { } "id": 2, "name": "mysubzone-1", "datasets": 1, "creationtime": "2013-06-17T15:04:19.107" "id": 3, "name": "mysubzone-2", "datasets": 2, "creationtime": "2013-06-17T15:04:19.107" A timestamp értékeket (dátumok) a kliens nem küldhet be, ezek szerver oldalon keletkeznek. Új alzóna esetén a request paraméter a következő: {"name":"subzonename-a"} Több rekord egyidejű létrehozásához az alábbi struktúrát kell beküldeni: [ ] { }, { } "value": "128.0.0.35", "expiration": 1000, "remark": "test remark", "datasetid": 4 "value": "128.0.0.36", "expiration": 1000, "remark": "test remark", "datasetid": 4