==========================================================================
GG Spy - sniffer Gadu-Gadu
Program slużący do podsłuchiwania Gadu-Gadu
(C) Copyright 2002 GaduPO Team
==========================================================================

   Niniejszy program jest wolnym oprogramowaniem; możesz go
   rozprowadzać dalej i/lub modyfikować na warunkach GNU General
   Public License wydanej przez Free Software Foundation - według
   wersji 2-giej tej Licencji lub którejś z późniejszych wersji.

   Niniejszy program rozpowszechniany jest z nadzieją, iż będzie on
   użyteczny - jednak BEZ JAKIEJKOLWIEK GWARANCJI, nawet domyślnej
   gwarancji PRZYDATNOŚCI HANDLOWEJ albo PRZYDATNOŚCI DO OKREŚLONYCH
   ZASTOSOWAŃ. 

   Treść GNU General Public License znajdziesz w pliku COPYING.

   Do stworzenia tego programu użyłem opisu protokołu Gadu-Gadu
   stworzonego przez twórców Eksperymentalnego Klienta Gadu-Gadu,
   który można znaleźć na <http://dev.null.pl/ekg/>, oraz informacji
   uzyskanych przez badanie pakietów wysyłanych między klientem a
   serwerem.

   This product includes software developed by the University of
   California, Berkeley and its contributors.

   This product includes software developed by the Politecnico
   di Torino, and its contributors.

   This product includes software developed by the Computer Systems
   Engineering Group at Lawrence Berkeley Laboratory.

   Gadu-gadu jest zastrzeżonym znakiem towarowym sms-express sp. z o.o.

   Podsłuchiwanie cudzych rozmów jest prawnie karalne (patrz np.:
   art. 267 Kodeksu Karnego).

===========================================================================

1. INSTALACJA
   
   a. użyj skryptu 'configure' do określenia interfejsu

   b. skompiluj (odpalając 'make')

   Program wymaga biblioteki libpcap (chyba, że kiedyś powstanie
   moduł umożliwiający chwytanie pakietów za pomocą innej
   biblioteki), ma ona odpowiednik Windows'owy, który nazywa się
   WinPcap, i jest dostępny z <http://winpcap.polito.it>.

   Co do Windows'ów to proponuję kompilować pod środowiskiem Cygwin
   (kompilator GNU C + bash, etc.), bodajże <http://www.cygnus.com>
   
2. BUDOWA

   ui-*.c            moduły interfejsu użytkownika

   cap-*.c           moduły przechwytywania pakietów (obecnie tylko
                     cap-pcap.c)

   analyse.c         "spinacz" pomiędzy parserem a
                     modułem przechwytywania

   parse-handlers.c  zawiera funkcje obsługiwania poszczególnych
                     typów pakietów GG

   parse.c           przetwarza pakiety GG

   utils.c           różne funkcje pomocnicze

   genver.c          programik modyfikujący numer wersji

   Działa to mniej więcej w ten sposób (na przykładzie cap-pcap i
   ui-wingui):

   [WinPcap] -> [cap-pcap] -> [analyse] -> [parse] -> [ui-wingui]

3. INTERFEJSY UŻYTKÓWNIKA      

   Wszystkie interfejsy użytkownika pozwalają na odczyt bezpośrednio
   z urządzenia lub z pliku zrzutu (dump file). (BTW: jak na razie
   pliki zrzutu są tworzone zawsze).

   Za wzór tworzenia nowego UI powinien służyć ui-console.c.

   a. ui-console.c

   UI czysto tekstowy, wszystkie informacje drukuje bezpośrednio na
   standardowe wyjście. Właściwie nie ma co w nim zrobić więcej.

   b. ui-wingui.c

   UI okienkowy, działa tylko w Windowsach.
   
   Z racji tego, że GG używam wyłącznie w Windowsach, to tylko ten
   interfejs będzie jakoś rozwijany.

   Przeczytaj README-WinGUI.

4. MODUŁY PRZECHWYTYWANIA PAKIETÓW

   a. cap-pcap.c

   Moduł przechwytywania opakowywujący bibliotekę libpcap.
   Robiąc jakiś inny wypadałoby, żeby zachować format plików zrzutu
   z libpcap'a, żeby była zgodność formatu między wszystkimi
   wersjami.

   FYI: Informacje dostarczane przez libpcap różnią się nieco
   między systemami...

5. AUTORZY

   ok0n <ok0n@poczta.fm>

   i inni pozostający w ukryciu...

6. PODZIĘKOWANIA

   EKG Team <http://dev.null.pl/ekg/>