Protokół Gadu-Gadu

0. Informacje wstępne

Opis protokołu używanego przez Gadu-Gadu bazuje na doświadczeniach przeprowadzonych przez autorów oraz informacjach nadsyłanych przez użytkowników. Żaden klient Gadu-Gadu nie został skrzywdzony podczas badań. Reverse-engineering opierał się głównie na analizie pakietów wysyłanych między klientem a serwerem.

1. Protokół Gadu-Gadu

1.1. Format pakietów

Podobnie jak coraz większa ilość komunikatorów, Gadu-Gadu korzysta z protokołu TCP/IP. Każdy pakiet zawiera na początku dwa stałe pola:

        struct gg_header {
		int type;	/* typ pakietu */
		int length;	/* długość reszty pakietu */
	};

Wszystkie zmienne liczbowe są zgodne z kolejnością bajtów maszyn Intela, czyli Little-Endian.

Przy opisie struktur, założono, że char ma rozmiar 1 bajtu, short 2 bajtów, int 4 bajtów. Używając innych architektur niż i386 należy zwrócić szczególną uwagę na rozmiar typów zmiennych i kolejność znaków.

Pola, który znaczenie jest nieznane, lub nie do końca jasne, oznaczono przedrostkiem unknown.

1.2. Zanim się połączymy

Żeby wiedzieć, z jakim serwerem mamy się połączyć, należy poudawać przez chwilę przeglądarkę WWW i połączyć się z hostem appmsg.gadu-gadu.pl.

	GET /appsvc/appmsg.asp?fmnumber=NUMER HTTP/1.0
	Host: appmsg.gadu-gadu.pl
	User-Agent: Mozilla/4.7 [en] (Win98; I)
	Pragma: no-cache

	Mozilla/4.04 [en] (Win95; I ;Nav)
	Mozilla/4.7 [en] (Win98; I)
	Mozilla/4.0 (compatible; MSIE 5.0; Windows NT; DigExt)
	Mozilla/4.0 (compatible; MSIE 5.0; Windows NT)
	Mozilla/4.0 (compatible; MSIE 5.0; Windows 98; DigExt)
	Mozilla/4.0 (compatible; MSIE 5.0; Windows 98)

	GET /appsvc/appmsg2.asp?fmnumber=NUMER&version=WERSJA&fmt=FORMAT&lastmsg=WIADOMOŚĆ
	Host: appmsg.gadu-gadu.pl
	User-Agent: ...
	Pragma: no-cache

	HTTP/1.0 200 OK
	
	0 217.17.41.84:8074 217.17.41.84

Jeśli pierwsza liczba nie jest równa zero, zaraz po nagłówku znajduje się wiadomość systemowa, lub jeśli linia zaczyna się od znaku ,,@'', adres strony, którą należy otworzyć w przeglądarce.

1.3. Logowanie się

Po połączeniu się portem 8074 lub 443 serwera Gadu-Gadu, dostajemy pakiet typu 0x0001, który na potrzeby tego dokumentu nazwiemy:

	#define GG_WELCOME 0x0001

	struct gg_welcome {
		int seed;	/* klucz szyfrowania hasła */
	};

	#define GG_LOGIN 0x000c

	struct gg_login {
		int uin;		/* numer klienta */
		int hash;		/* hash hasła */
		int status;		/* początkowy stan */
		int version;		/* wersja klienta */
		int local_ip;		/* mój adres ip */
		short local_port;	/* port, na którym słucham */
	};

	int gg_login_hash(char *password, int seed)
	{
		unsigned int x, y, z;

		y = seed;

		for (x = 0; *password; password++) {
			x = (x & 0xffffff00) | *password;
			y ^= x;
			y += x;
			x <<= 8;
			y ^= x;
			x <<= 8;
			y -= x;
			x <<= 8;
			y ^= x;

			z = y & 0x1f;
			y = (y << z) | (y >> (32 - z));
		}

		return y;
	}

Oczywiście nie są to wszystkie możliwe wersje klientów, lecz te, które udało się złapać na wolności. Najbezpieczniej będzie przedstawiać się jako ta wersja, której własności używamy. Wiadomo, że wersje 4.0 nie obsługiwały trybu ukrytego, tylko dla znajomych itd.

W najnowszej wersji protokołu jest dodatkowa maska na wersję:

	#define GG_HAS_AUDIO_MASK 0x40000000

Jeśli wszystko się powiedzie, dostaniemy w odpowiedzi pakiet typu:

      #define GG_LOGIN_OK 0x0003

      #define GG_LOGIN_FAILED 0x0009

	#define GG_LOGIN_EXT 0x0013

	struct gg_login_ext {
		int uin;		/* numer klienta */
		int hash;		/* hash hasła */
		int status;		/* początkowy stan */
		int version;		/* wersja klienta */
		int local_ip;		/* mój adres ip */
		short local_port;	/* port, na którym słucham */
		int external_ip;	/* zewnętrzny adres ip */
		short external_port;	/* zewnętrzny port */
	};

1.4. Zmiana stanu

Gadu-Gadu przewiduje kilka stanów klienta, które zmieniamy pakietem typu:

	#define GG_NEW_STATUS 0x0002

	struct gg_new_status {
		int status;		/* na jaki zmienić? */
		char description[];	/* opis, nie musi wystąpić */
		int time;		/* czas, nie musi wystąpić */
	}

Należy pamiętać, żeby przed rozłączeniem się z serwerem należy zmienić stan na GG_STATUS_NOT_AVAIL lub GG_STATUS_NOT_AVAIL_DESCR. Jeśli ma być widoczny tylko dla przyjaciół, należy dodać GG_STATUS_FRIENDS_MASK do normalnej wartości stanu.

Jeśli wybieramy stan opisowy, należy dołączyć ciąg znaków zakończony zerem oraz ewentualny czas powrotu w postaci ilości sekund od 1 stycznia 1970r (UTC). Maksymalna długość opisu wynosi 40 znaków plus zero plus 4 bajty na godzinę powrotu, co razem daje 45 bajtów.

1.5. Ludzie przychodzą, ludzie odchodzą

Zaraz po zalogowaniu możemy wysłać serwerowi naszą listę kontaktów, żeby dowiedzieć się, czy są w danej chwili dostępni. Pakiet zawiera maksymalnie 409 struktur gg_notify:

	#define GG_NOTIFY 0x0010
	
	struct gg_notify {
		int uin;	/* numerek danej osoby */
		char type;	/* rodzaj użytkownika */
	};

Jeśli nie mamy nikogo na liście wysyłamy pakiet:

	#define GG_LIST_EMPTY 0x0012

Jeśli ktoś jest, serwer odpowie pakietem zawierającym jedną lub więcej struktur gg_notify_reply:

	#define GG_NOTIFY_REPLY 0x000c	/* tak, to samo co GG_LOGIN */
	
	struct gg_notify_reply {
		int uin;		/* numerek */
		int status;		/* status danej osoby */
		int remote_ip;		/* adres ip delikwenta */
		short remote_port;	/* port, na którym słucha klient */
		int version;		/* wersja klienta */
		short unknown1;		/* znowu port? */
		char description[];	/* opis, nie musi wystąpić */
		int time;		/* czas, nie musi wystąpić */
	};

Zdarzają się też inne ,,nietypowe'' wartości, ale ich znaczenie nie jest jeszcze do końca znane.

Jeśli dany klient jest w stanie z podanym opisem, najpierw dostaniemy informację osobnym pakietem o nim, później paczkę struktur gg_notify_reply z ludźmi, którzy nie mają ustawionych opisów.

Żeby dodać kogoś do listy w trakcie pracy, trzeba wysłać niżej opisany pakiet. Jego format jest identyczny jak przy GG_NOTIFY.

	#define GG_ADD_NOTIFY 0x000d
	
	struct gg_add {
		int uin;	/* numerek */
		char type;	/* rodzaj użytkownika */
	};

	#define GG_REMOVE_NOTIFY 0x000e
	
	struct gg_add {
		int uin;	/* numerek */
		char type;	/* rodzaj użytkownika */
	};

	#define GG_STATUS 0x0002
	
	struct gg_status {
		int uin;	/* numerek */
		int status;	/* nowy stan */
	};

1.6. Wysyłanie wiadomości

Wiadomości wysyła się następującym typem pakietu:

	#define GG_SEND_MSG 0x000b

	struct gg_send_msg {
		int recipient;		/* numer odbiorcy */
		int seq;		/* numer sekwencyjny */
		int class;		/* klasa wiadomości */
		char message[];		/* treść */
	};

Długość treści wiadomości nie powinna przekraczać 2000 znaków.

Oryginalny klient wysyłając wiadomość do kilku użytkowników, wysyła po kilka takich samych pakietów z różnymi numerkami odbiorców. Nie ma osobnego pakietu do tego. Natomiast jeśli chodzi o połączenia konferencyjne do pakietu doklejana jest następująca struktura:

	struct gg_msg_recipients {
		char flag;		/* == 1 */
		int count;		/* ilość odbiorców */
		int recipients[];	/* tablica odbiorców */
	};

Od wersji 4.8.1 możliwe jest również dodawanie do wiadomości różnych atrybutów tekstu jak pogrubienie czy kolory. Niezbędne jest dołączenie następnującej struktury:

	struct gg_msg_richtext {
		char flag;	/* == 2 */
		short length;	/* długość dalszej części */
	};

	struct gg_msg_richtext_format {
		short position;	/* pozycja atrybutu w tekście */
		char font;	/* atrybuty czcionki */
		char rgb[3];	/* kolor czcionki, nie musi wystąpić */
	};

Dla przykładu, by przesłać tekst ,,ala ma kota'', należy dołączyć do wiadomości następującą sekwencję bajtów:

Serwer po otrzymaniu wiadomości odsyła potwierdzenie, które przy okazji mówi nam, czy wiadomość dotarła do odbiorcy czy została zakolejkowana z powodu nieobecności. Otrzymujemy je w postaci pakietu:

	#define GG_SEND_MSG_ACK 0x0005
	
	struct gg_send_msg_ack {
		int status;	/* stan wiadomości */
		int recipient;	/* numer odbiorcy */
		int seq;	/* numer sekwencyjny */
	};

1.7. Otrzymywanie wiadomości

Wiadomości serwer przysyła za pomocą pakietu:

	#define GG_RECV_MSG 0x000a
	
	struct gg_recv_msg {
		int sender;		/* numer nadawcy */
		int seq;		/* numer sekwencyjny */
		int time;		/* czas nadania */
		int class;		/* klasa wiadomości */
		char message[];		/* treść wiadomości */
	};

1.8. Ping, pong

Od czasu do czasu klient wysyła pakiet do serwera, by oznajmić, że połączenie jeszcze jest utrzymywane. Jeśli serwer nie dostanie takiego pakietu w przeciągu 5 minut, zrywa połączenie. To, czy klient dostaje odpowiedź zmienia się z wersji na wersję, więc najlepiej nie polegać na tym.

	#define GG_PING 0x0008
	
	#define GG_PONG 0x0007

1.9. Rozłączenie

Jeśli serwer zechce nas rozłączyć, wyśle wcześniej pusty pakiet:

	#define GG_DISCONNECTING 0x000b

2. Usługi HTTP

Opis znajduje się w pliku http.txt.

3. Bezpośrednie połączenie

Opis znajduje się w pliku dcc-protocol.txt.