=head1 NAZWA stunnel - uniwersalny tunel protokołu SSL =head1 SKŁADNIA =over 4 =item B B [>] | S<-fd n> | S<-help> | S<-version> | S<-sockets> =item B B [ [S<-install> | S<-uninstall> | S<-start> | S<-stop> ] [S<-quiet>] [>] ] | S<-help> | S<-version> | S<-sockets> =back =head1 OPIS Program B został zaprojektowany do opakowywania w protokół I połączeń pomiędzy zdalnymi klientami a lokalnymi lub zdalnymi serwerami. Przez serwer lokalny rozumiana jest aplikacja przeznaczona do uruchamiania przy pomocy I. Stunnel pozwala na proste zestawienie komunikacji serwerów nie posiadających funkcjonalności I poprzez bezpieczne kanały I. B pozwala dodać funkcjonalność I do powszechnie stosowanych demonów I, np. I lub I, do samodzielnych demonów, np. I, I lub I, a nawet tunelować ppp poprzez gniazda sieciowe bez zmian w kodzie źródłowym. =head1 OPCJE =over 4 =item > użyj podanego pliku konfiguracyjnego =item B<-fd n> (tylko Unix) wczytaj konfigurację z podanego deskryptora pliku =item B<-help> drukuj listę wspieranych opcji =item B<-version> drukuj wersję programu i domyślne wartości parametrów =item B<-sockets> drukuj domyślne opcje gniazd =item B<-install> (tylko NT/2000/XP) instaluj serwis NT =item B<-uninstall> (tylko NT/2000/XP) odinstaluj serwis NT =item B<-start> (tylko NT/2000/XP) uruchom serwis NT =item B<-stop> (tylko NT/2000/XP) zatrzymaj serwis NT =item B<-quiet> (tylko NT/2000/XP) nie wyświetlaj okienka informującego o pomyślnym zainstalowaniu lub odinstalowaniu =back =head1 PLIK KONFIGURACYJNY Linia w pliku konfiguracyjnym może być: =over 4 =item * pusta (ignorowana) =item * komentarzem rozpoczynającym się znakiem ';' (ignorowana) =item * parą 'nazwa_opcji = wartość_opcji' =item * tekstem '[nazwa_usługi]' wskazującym początek definicji usługi =back =head2 OPCJE GLOBALNE =over 4 =item B = katalog (tylko Unix) katalog roboczego korzenia systemu plików Opcja określa katalog, w którym uwięziony zostanie proces programu B tuż po jego inicjalizacji, a przed rozpoczęciem odbierania połączeń. Ścieżki podane w opcjach I, I, I oraz I muszą być umieszczone wewnątrz katalogu podanego w opcji I i określone względem tego katalogu. W przypadku wykorzystania kontroli dostępu przy pomocy biblioteki libwrap (TCP wrappers) jej pliki konfiguracyjne (/etc/hosts.allow i /etc/hosts.deny) muszą zostać skopiowane do podkatalogu etc/ umieszczonego wewnątrz katalogu podanego w opcji I. =item B = zlib | rle wybór algorytmu kompresji przesyłanych danych domyślnie: bez kompresji =item B = poziom[.podsystem] szczegółowość logowania Poziom logowania można określić przy pomocy jednej z nazw lub liczb: emerg (0), alert (1), crit (2), err (3), warning (4), notice (5), info (6) lub debug (7). Zapisywane są komunikaty o poziomie niższym (numerycznie) lub równym podanemu. Do uzyskania najwyższego poziomu szczegółowości można użyć opcji B lub B. Domyślnym poziomem jest notice (5). O ile nie wyspecyfikowano podsystemu użyty będzie domyślny: daemon. Podsystemy nie są wspierane przez platformę Win32. Wielkość liter jest ignorowana zarówno dla poziomu jak podsystemu. =item B = ścieżka_do_EGD (tylko Unix) ścieżka do gniazda programu Entropy Gathering Daemon Opcja pozwala określić ścieżkę do gniazda programu Entropy Gathering Daemon używanego do zainicjalizowania generatora ciągów pseudolosowych biblioteki OpenSSL. Opcja jest dostępna z biblioteką OpenSSL 0.9.5a lub nowszą. =item B = auto | wybór sprzętowego urządzenia kryptograficznego domyślnie: bez wykorzystania urządzeń kryptograficznych Przykład wykorzystania w sekcji 'PRZYKŁADY'. =item B = [:] konfiguracja urządzenia kryptograficznego Specjalne komendy "LOAD" i "INIT" pozwalają na załadowanie i inicjalizację modułu kryptograficznego urządzenia. =item B = yes | no (tylko Unix) tryb pierwszoplanowy Użycie tej opcji powoduje, że I nie przechodzi w tło logując swoje komunikaty na konsolę zamiast przez I (o ile nie użyto opcji I). =item B = plik plik, do którego dopisane zostaną logi Użycie tej opcji zmienia domyślne zachowanie programu polegające na logowaniu swoich komunikatów poprzez syslog. Do przekierowania komunikatów na standardowe wyjście (na przykład po to, żeby zalogować je programem splogger z pakietu daemontools) można podać jako parametr urządzenie /dev/stdout. =item B = plik (tylko Unix) położenie pliku z numerem procesu Jeżeli argument jest pusty plik nie zostanie stworzony. Jeżeli zdefiniowano katalog I, to ścieżka do I jest określona względem tego katalogu. =item B = liczba_bajtów liczba bajtów do zainicjowania generatora pseudolosowego W wersjach biblioteki OpenSSL starszych niż 0.9.5a opcja ta określa również liczbę bajtów wystarczających do zainicjowania PRNG. Nowsze wersje biblioteki mają wbudowaną funkcję określającą, czy dostarczona ilość losowości jest wystarczająca do zainicjowania generatora. =item B = plik ścieżka do pliku zawierającego losowe dane Biblioteka OpenSSL użyje danych z tego pliku do zainicjowania generatora pseudolosowego. =item B = yes | no nadpisz plik nowymi wartościami pseudolosowymi domyślnie: yes (nadpisz) =item B = nazwa_serwisu użyj parametru jako nazwy serwisu B nazwa serwisu dla biblioteki TCP Wrapper w trybie I. B nazwa serwisu NT w Panelu Sterowania. domyślnie: stunnel =item B = identyfikator_grupy (tylko Unix) grupa z której prawami pracował będzie I =item B = identyfikator_użytkownika (tylko Unix) użytkownik, z którego prawami pracował będzie I =item B = a|l|r:option=value[:value] ustaw opcję na akceptującym/lokalnym/zdalnym gnieździe Dla opcji linger wartości mają postać l_onof:l_linger. Dla opcji time wartości mają postać tv_sec:tv_usec. Przykłady: socket = l:SO_LINGER=1:60 ustaw jednominutowe przeterminowanie przy zamykaniu lokalnego gniazda socket = r:TCP_NODELAY=1 wyłącz algorytm Nagle'a na zdalnych gniazdach socket = r:SO_OOBINLINE=1 umieść dane pozapasmowe (out-of-band) bezpośrednio w strumieniu danych wejściowych dla zdalnych gniazd socket = a:SO_REUSEADDR=0 zablokuj ponowne używanie portu (domyślnie włączone) socket = a:SO_BINDTODEVICE=lo przyjmuj połączenia wyłącznie na interfejsie zwrotnym (ang. loopback) =item B = yes | no (tylko WIN32) włącz ikonkę w prawym dolnym rogu ekranu domyślnie: yes (włącz) =back =head2 OPCJE USŁUG Każda sekcja konfiguracji usługi zaczyna się jej nazwą ujętą w nawias kwadratowy. Nazwa usługi używana jest do kontroli dostępu przez bibliotekę libwrap (TCP wrappers) oraz pozwala rozróżnić poszczególne usługi w logach. Jeżeli B ma zostać użyty w trybie I, gdzie za odebranie połączenia odpowiada osobny program (zwykle I, I lub I), należy przeczytać sekcję B poniżej. =over 4 =item B = [adres:]port nasłuchuje na połączenia na podanym adresie i porcie Jeżeli nie został podany adres, I domyślnie nasłuchuje na wszystkich adresach IP lokalnych interfejsów. =item B = katalog_CA katalog Centrum Certyfikacji Opcja określa katalog, w którym B będzie szukał certyfikatów, jeżeli użyta została opcja I. Pliki z certyfikatami muszą posiadać specjalne nazwy XXXXXXXX.0, gdzie XXXXXXXX jest skrótem kryptograficznym reprezentacji DER nazwy podmiotu certyfikatu (4 pierwsze bajty skrótu MD5 począwszy od najmniej znaczacego). Jeżeli zdefiniowano katalog I, to ścieżka do I jest określona względem tego katalogu. =item B = plik_CA plik Centrum Certyfikacji Opcja pozwala określić położenie pliku zawierającego certyfikaty używane przez opcję I. =item B = plik_pem plik z łańcuchem certyfikatów Opcja określa położenie pliku zawierającego certyfikaty używane przez program B do uwierzytelnienia się przed drugą stroną połączenia. Certyfikat jest konieczny, aby używać programu w trybie serwera. W trybie klienta certyfikat jest opcjonalny. =item B = lista_szyfrów lista dozwolonych szyfrów SSL Parametrem tej opcji jest lista szyfrów, które będą użyte przy otwieraniu nowych połączeń SSL, np.: DES-CBC3-SHA:IDEA-CBC-MD5 =item B = yes | no tryb kliencki (zdalna usługa używa SSL) domyślnie: no (tryb serwerowy) =item B = [adres:]port połącz się ze zdalnym serwerem na podany port Jeżeli nie został podany adres, I domyślnie łączy się z lokalnym serwerem. Komenda może byc użyta wielokrotnie w pojedynczej sekcji celem zapewnienia wysokiej niezawodności lub rozłożenia ruchu pomiędzy wiele serwerów. =item B = katalog_CRL katalog List Odwołanych Certyfikatów (CRL) Opcja określa katalog, w którym B będzie szukał list CRL, jeżeli użyta została opcja I. Pliki z listami CRL muszą posiadać specjalne nazwy XXXXXXXX.0, gdzie XXXXXXXX jest skrótem listy CRL. Jeżeli zdefiniowano katalog I, to ścieżka do I jest określona względem tego katalogu. =item B = plik_CRL plik List Odwołanych Certyfikatów (CRL) Opcja pozwala określić położenie pliku zawierającego listy CRL używane przez opcję I. =item B = yes | no opóźnij rozwinięcie adresu DNS podanego w opcji I =item B = wybierz urządzenie do odczyta klucza prywatnego Urządzenia są numerowane od 1 w górę. =item B = ścieżka_do_programu (tylko Unix) wykonaj lokalny program przystosowany do pracy z superdemonem inetd Jeżeli zdefiniowano katalog I, to ścieżka do I jest określona względem tego katalogu. =item B = $0 $1 $2 ... (tylko Unix) argumenty do opcji I włącznie z nazwą programu ($0) Cytowanie nie jest wspierane w obecnej wersji programu. Argumenty są rozdzielone dowolną liczbą białych znaków. =item B = nazwa_użytkownika weryfikuj nazwę zdalnego użytkownika korzystając z protokołu IDENT (RFC 1413) =item B = plik_klucza klucz prywatny do certyfikatu podanego w opcji I Klucz prywatny jest potrzebny do uwierzytelnienia właściciela certyfikatu. Ponieważ powinien on być zachowany w tajemnicy, prawa do jego odczytu powinien mieć wyłącznie właściciel pliku. W systemie Unix można to osiągnąć komendą: chmod 600 keyfile domyślnie: wartość opcji I =item B = serwer IP źródła do nawiązywania zdalnych połączeń Domyślnie używane jest IP najbardziej zewnętrznego interfejsu w stronę serwera, do którego nawiązywane jest połączenie. =item B = URL serwer OCSP do weryfikacji certyfikatów =item B = flaga flaga serwera OCSP aktualnie wspierane flagi: NOCERTS, NOINTERN NOSIGS, NOCHAIN, NOVERIFY, NOEXPLICIT, NOCASIGN, NODELEGATED, NOCHECKS, TRUSTOTHER, RESPID_KEY, NOTIME Aby wyspecyfikować kilka flag należy użyć I wielokrotnie. =item B = opcje_SSL opcje biblioteki OpenSSL Parametrem jest nazwa opcji zgodnie z opisem w I, ale bez przedrostka I. Aby wyspecyfikować kilka opcji należy użyć I wielokrotnie. Na przykład dla zachowania kompatybilności z błędami implementacji SSL w programie Eudora można użyć opcji: options = DONT_INSERT_EMPTY_FRAGMENTS =item B = protokół negocjuj SSL podanym protokołem aplikacyjnym aktualnie wspierane protokoły: cifs, connect, imap, nntp, pop3, smtp =item B = uwierzytelnienie rodzaj uwierzytelnienia do negocjacji protokołu aktualnie wspierane: basic, NTLM Obecnie typ uwierzytelnienia ma zastosowanie wyłącznie w protokole 'connect'. domyślnie: basic =item B = adres:port adres docelowy do negocjacji protokołu =item B = hasło hasło do negocjacji protokołu =item B = użytkownik nazwa użytkownika do negocjacji protokołu =item B = yes | no (tylko Unix) alokuj pseudoterminal dla programu uruchamianego w opcji 'exec' =item B = yes | no (tylko Unix) połącz ponownie sekcję connect+exec po rozłączeniu domyślnie: no =item B = przeterminowanie_pamięci_podręcznej_sesji czas w sekundach, po którym sesja SSL zostanie usunięta z pamięci podręcznej =item B = wersja wybierz wersję protokołu SSL Dozwolone opcje: all, SSLv2, SSLv3, TLSv1 =item B = liczba_sekund czas oczekiwania na spodziewane dane =item B = liczba_sekund czas oczekiwania na close_notify (ustaw na 0, jeżeli klientem jest MSIE) =item B = liczba_sekund czas oczekiwania na nawiązanie połączenia =item B = liczba_sekund maksymalny czas utrzymywania bezczynnego połączenia =item B = yes | no (tylko Unix) tryb przezroczystego proxy Przepisz adres, aby nawiązywane połączenie wydawało się pochodzić bezpośrednio od klienta, a nie od programu I. Opcja działa tylko w trybie lokalnym (opcja I) przez załadowanie przy pomocy LD_PRELOAD biblioteki env.so, albo w trybie zdalnym (opcja I) na systemie Linux 2.2 z włączoną opcją I. =item B = poziom weryfikuj certyfikat drugiej strony połączenia poziom 1 - weryfikuj, jeżeli został przedstawiony poziom 2 - weryfikuj z zainstalowanym certyfikatem Centrum Certyfikacji poziom 3 - weryfikuj z lokalnie zainstalowanym certyfikatem drugiej strony domyślnie - nie weryfikuj =back =head1 ZWRACANA WARTOŚĆ B zwraca zero w przypadku sukcesu, lub wartość niezerową w przypadku błędu. =head1 PRZYKŁADY Szyfrowanie połączeń do lokalnego serwera I można użyć: [imapd] accept = 993 exec = /usr/sbin/imapd execargs = imapd albo w trybie zdalnym: [imapd] accept = 993 connect = 143 W połączeniu z programem I B pozwala zestawić prosty VPN. Po stronie serwera nasłuchującego na porcie 2020 jego konfiguracja może wyglądać następująco: [vpn] accept = 2020 exec = /usr/sbin/pppd execargs = pppd local pty = yes Poniższy plik konfiguracyjny może być wykorzystany do uruchomienia programu B w trybie I. Warto zauważyć, że w pliku konfiguracyjnym nie ma sekcji I<[nazwa_usługi]>. exec = /usr/sbin/imapd execargs = imapd Przykładowa konfiguracja umożliwiająca odczytanie klucza prywatnego z urządzenia zgodnego z OpenSC engine=dynamic engineCtrl=SO_PATH:/usr/lib/opensc/engine_pkcs11.so engineCtrl=ID:pkcs11 engineCtrl=LIST_ADD:1 engineCtrl=LOAD engineCtrl=MODULE_PATH:/usr/lib/pkcs11/opensc-pkcs11.so engineCtrl=INIT [service] engineNum=1 key=id_45 =head1 PLIKI =over 4 =item F plik konfiguracyjny programu =item F certyfikat i klucz prywatny =back =head1 BŁĘDY Opcja I nie obsługuje cytowania. =head1 OGRANICZENIA I nie może być używany do szyfrowania protokołu I, ponieważ do przesyłania poszczególnych plików używa on dodatkowych połączeń otwieranych na portach o dynamicznie przydzielanych numerach. Istnieją jednak specjalne wersje klientów i serwerów FTP pozwalające na szyfrowanie przesyłanych danych przy pomocy protokołu I. =head1 NOTKI =head2 TRYB INETD (tylko Unix) W większości zastosowań B samodzielnie nasłuchuje na porcie podanym w pliku konfiguracyjnym i tworzy połączenie z innym portem podanym w opcji I lub nowym programem podanym w opcji I. Niektórzy wolą jednak wykorzystywać oddzielny program, który odbiera połączenia, po czym uruchamia program B. Przykładami takich programów są inetd, xinetd i tcpserver. Przykładowa linia pliku /etc/inetd.conf może wyglądać tak: imaps stream tcp nowait root /usr/bin/stunnel stunnel /etc/stunnel/imaps.conf Ponieważ w takich przypadkach połączenie na zdefiniowanym porcie (tutaj I) nawiązuje osobny program (tutaj I), B nie może używać opcji I. W pliku konfiguracyjnym nie może być również zdefiniowana żadna usługa (I<[nazwa_usługi]>), ponieważ konfiguracja taka pozwala na nawiązanie tylko jednego połączenia. Wszystkie I powinny być umieszczone razem z opcjami globalnymi. Przykład takiej konfiguracji znajduje się w sekcji I. =head2 CERTYFIKATY Protokół SSL wymaga, aby każdy serwer przedstawiał się nawiązującemu połączenie klientowi prawidłowym certyfikatem X.509. Potwierdzenie tożsamości serwera polega na wykazaniu, że posiada on odpowiadający certyfikatowi klucz prywatny. Najprostszą metodą uzyskania certyfikatu jest wygenerowanie go przy pomocy wolnego pakietu I. Więcej informacji na temat generowania certyfikatów można znaleźć na umieszczonych poniżej stronach. Istotną kwestią jest kolejność zawartości pliku I<.pem>. W pierwszej kolejności powinien on zawierać klucz prywatny, a dopiero za nim podpisany certyfikat (nie żądanie certyfikatu). Po certyfikacie i kluczu prywatnym powinny znajdować się puste linie. Jeżeli przed certyfikatem znajdują się dodatkowe informacje tekstowe, to powinny one zostać usunięte. Otrzymany plik powinien mieć następującą postać: -----BEGIN RSA PRIVATE KEY----- [zakodowany klucz] -----END RSA PRIVATE KEY----- [pusta linia] -----BEGIN CERTIFICATE----- [zakodowany certyfikat] -----END CERTIFICATE----- [pusta linia] =head2 LOSOWOŚĆ B potrzebuje zainicjować PRNG (generator liczb pseudolosowych), gdyż protokół SSL wymaga do bezpieczeństwa kryptograficznego źródła dobrej losowości. Następujące źródła są kolejno odczytywane aż do uzyskania wystarczającej ilości entropii: =over 4 =item * Zawartość pliku podanego w opcji I. =item * Zawartość pliku o nazwie określonej przez zmienną środowiskową RANDFILE, o ile jest ona ustawiona. =item * Plik .rnd umieszczony w katalogu domowym użytkownika, jeżeli zmienna RANDFILE nie jest ustawiona. =item * Plik podany w opcji '--with-random' w czasie konfiguracji programu. =item * Zawartość ekranu w systemie Windows. =item * Gniazdo egd, jeżeli użyta została opcja I. =item * Gniazdo egd podane w opcji '--with-egd-socket' w czasie konfiguracji programu. =item * Urządzenie /dev/urandom. =back Współczesne (>=0.9.5a) wersje biblioteki I automatycznie zaprzestają ładowania kolejnych danych w momencie uzyskania wystarczającej ilości entropii. Wcześniejsze wersje biblioteki wykorzystają wszystkie powyższe źródła, gdyż nie istnieje tam funkcja pozwalająca określić, czy uzyskano już wystarczająco dużo danych. Warto zwrócić uwagę, że na maszynach z systemem Windows, na których konsoli nie pracuje użytkownik, zawartość ekranu nie jest wystarczająco zmienna, aby zainicjować PRNG. W takim przypadku do zainicjowania generatora należy użyć opcji I. Plik I powinien zawierać dane losowe -- również w tym sensie, że powinny być one inne przy każdym uruchomieniu programu B. O ile nie użyta została opcja I jest to robione automatycznie. Do ręcznego uzyskania takiego pliku użyteczna może być komenda I dostarczana ze współczesnymi wersjami pakietu I. Jeszcze jedna istotna informacja -- jeżeli dostępne jest urządzenie I biblioteka I ma zwyczaj zasilania nim PRNG w trakcie sprawdzania stanu generatora. W systemach z I urządzenie to będzie najprawdopodobniej użyte, pomimo że znajduje się na samym końcu powyższej listy. Jest to właściwość biblioteki I, a nie programu I. =head1 ZOBACZ RÓWNIEŻ =over 4 =item L biblioteka kontroli dostępu do usług internetowych =item L 'super-serwer' internetowy =item F strona domowa programu I =item F najczęściej zadawane pytania na temat programu I =item F strona projektu I =back =head1 AUTOR =over 4 =item Michał Trojnara > =back