https://github.com/dolejska-daniel/fit_vutbr-isa2018
https://github.com/dolejska-daniel/fit_vutbr-isa2018
dns fit-vutbr-cz isa syslog
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dolejska-daniel/fit_vutbr-isa2018
- Owner: dolejska-daniel
- Created: 2018-09-27T09:20:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-18T17:33:33.000Z (almost 7 years ago)
- Last Synced: 2025-01-09T17:07:28.233Z (9 months ago)
- Topics: dns, fit-vutbr-cz, isa, syslog
- Language: C
- Size: 266 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ISA - Export DNS informací
> Cílem projektu je vytvořit aplikaci, která bude umět zpracovávat data protokolu DNS (Domain Name System) a vybrané statistiky exportovat pomocí protokolu Syslog na centrální logovací server.
## Omezení projektu
- Aplikace podporuje zpracovávání pouze následujících DNS záznamů: `A`, `AAAA`, `NS`, `PTR`, `CNAME`, `SRV`, `KX`, `MX`, `TA`, `DLV`, `DS`, `SOA`, `NSEC`, `NSEC3`, `RRSIG`, `DNSKEY`, `KEY`, `SPF` a `TXT`.
- Při zpracování `NSEC` a `NSEC3` záznamů nejsou zobrazovány seznamy typů (Type Bit Maps) a některé další položky.
- Aplikace nepodporuje překlad hostname syslog serveru na IPv6 (samotné IPv4 i IPv6 jsou podporovány)
## Rozšíření projektu
- Aplikace podporuje zpracovávání fragmentovaných DNS odpovědí přenášených protokolem `TCP`.
## Práce s programem
### Překlad programu
Pro překlad programu může použit CMake, ale je přiložen i klasický Makefile.
Překlad pomocí klasického Makefile (gcc) je proveden jednoduchým příkazem `make`.
Pro překlad pomocí CMake stačí příkaz `cmake ./ && cmake --build ./`.
### Spuštění programu
Pro správné spuštění program vyžaduje alespoň přepínač `-r` nebo `-i`,
k dispozici jsou následující přepínače:
| Přepínač | Argument | Význam
|------------------|----------------------------------|--------
| `-r ` | Cesta k `pcap` souboru. | _Nepovinný._ Specifikuje cestu k souboru, který bude aplikace zpracovávat. **Nelze použít s přepínačem `-i`.**
| `-i ` | Identifikátor síťového rozhraní. | _Nepovinný._ Specifikuje identifikátor síťového rozhraní, na kterém bude program odchytávat síťový provoz*. **Nelze použít s přepínačem `-r`.**
| `-s
` | Adresa syslog serveru. | _Nepovinný._ Specifikuje adresu (IPv4/IPv6) nebo hostname syslog serveru, na který se budou statistiky odesílat**.
| `-t ` | Časový interval v sekundách. | _Nepovinný, výchozí hodnota `60`._ Specifikuje časový interval, pro který se budou statistiky vypočítávat***.
*Použití socketů typu `SOCK_RAW` v implementaci vyžaduje při spuštění oprávnění **superusera**.
**Pokud není použit jsou statistiky vypsány na standardní výstup (forma viz kapitola [Výstup](#vystup)).
***Pokud není použit při použití přepínače `-r`, jsou statistiky vypočteny pro celý soubor.
Jinak jsou použity časové rozdíly mezi pakety.
_Další informace v MAN page `dns-export.1`._
#### Příklad
Monitorování provozu na rozhraní `wlp7s0` a výpis agregovaných statistik každé dvě minuty:
```
sudo ./dns-export -i wlp7s0 -t 120
```
Zpracování souboru `dns.pcap` a odesílání agregovaných statistik na syslog server
běžícím na 192.168.101.130 každých 5 minut (čas odesílání statistik se řídí časy
uvedenými u jednotlivých packetů):
```
./dns-export -r ./dns.pcap -s 192.168.101.130 -t 300
```
### Běh programu
Kdykoliv za běhu programu je možné procesu odeslat signál `SIGUSR1`, který
na standardní výstup vypíše statistiky provozu od spuštění programu.
```shell
sudo kill -s USR1 $(ps -aux | grep [d]ns-export | awk '{ print $2 }')
```
Tabulka statistik nebude vyprázdněna a na syslog server (v případě,
že je odpovídajícím přepínačem specifikován) nebude nic odesláno.
### Výstup
**$TITLE**:
```
=== DNS Traffic Statistics (last %ld minute(s) %ld second(s)) ===
```
**$MESSAGE**:
Pro záznamy `A`, `AAAA`, `CNAME`, `NS` a `PTR` platí následující formát:
```php
$DOMAIN_NAME $RR_TYPE $RR_RDATA $COUNT
```
Pro ostatní pak:
```php
$DOMAIN_NAME $RR_TYPE "$RR_RDATA" $COUNT
```
#### Standardní výstup
Výpis statistik na standardní výstup probíhá na základě následujícího formátu
(čísla v závorkách reprezentují počet výskytů vrámci jedoho výpisu):
```php
$TITLE\n (1)
$MESSAGE\n (0-n)
\n (1)
```
K výpisu statistik dojde buď na konci časového intervalu pro agregaci statistik,
v případě dokončení zpracování `.pcap` souboru, či při zaslání `SIGUSR1` signálu.
#### Formát syslog zprávy
Syslog zprávy se řídí následujícím formátem:
```php
<134> 1 YYYY-mm-ddTHH:ii:ss.000Z $HOSTNAME dns-export $PID - - $MESSAGE
```
Zprávy **nejsou** na syslog server odesílány jednotlivě -- jsou přidávány
do bufferu do maximální délky 1024 znaků a jsou odeslány až po jeho naplnění.
Jednotlivé zprávy jsou mezi sebou v rámci paketu odděleny pomocí CRLF (`0d 0a`).
## Seznam souborů
Součástí projektu jsou následující soubory:
**Zdrojové soubory**
| Cesta k souboru | Hlavičkový soubor
|-----------------------|----------------------------------
| `src/base64.c` | `src/base64.h`
| `src/dns.c` | `src/dns.h`
| `src/ht.c` | `src/ht.h`
| `src/main.c` | `src/main.h`
| | `src/macros.h`
| `src/network.c` | `src/network.h`
| `src/network_utils.c` | `src/network_utils.h`
| `src/pcap.c` | `src/pcap.h`
| `src/process.c` | `src/process.h`
| `src/syslog.c` | `src/syslog.h`
**Soubory dokumentace**
| Cesta k souboru
|-----------------------
| `doc/manual.pdf`
| `doc/manual.tex`
| `doc/zdroje.bib`
| `dns-export.1`
| `README.md`
**Další soubory**
| Cesta k souboru
|-----------------------
| `Makefile`