=head1 NAZWA

stunnel - uniwersalny tunel protokołu SSL


=head1 SKŁADNIA

B<stunnel> S<[filename]> | S<-fd [n]> | S<-help> | S<-version> | S<-sockets>


=head1 OPIS

Program B<stunnel> został zaprojektowany do opakowywania połączeń
pomiędzy zdalnymi klientami a lokalnymi (startowalnymi przez I<inetd>)
lub zdalnymi serwerami w protokół I<SSL>.  Pozwala to proste zestawinie
komunikacji serwerów nie posiadających funkcjonalności I<SSL> poprzez
bezpieczne kanały I<SSL>.

B<stunnel> pozwala dodać funkcjonalność I<SSL> do powszechnie stosowanych
demonów I<inetd>, np. I<pop3> lub I<imap>, do samodzielnych demonów,
np. I<nntp>, I<smtp> lub I<http>, a nawet tunelować ppp poprzez gniazda sieciowe
bez zmian w kodzie źródłowym.


=head1 OPCJE

=over 4

=item B<[plik]>

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

=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<CApath> = katalog_CA

katalog Centrum Certyfikacji

Opcja określa katalog, w którym B<stunnel> będzie szukał certyfikatów,
jeżeli użyta została opcja I<verify>.  Pliki z certyfikatami muszą
posiadać specjalne nazwy XXXXXXXX.0, gdzie XXXXXXXX jest skrótem
certyfikatu.

=item B<CAfile> = plik_CA

plik Centrum Certyfikacji

Opcja pozwala określić położenie pliku zawierającego certyfikaty używane
przez opcję I<verify>.

=item B<cert> = plik_pem

plik z łańcuchem certyfikatów

Opcja określa położenie pliku zawierającego certyfikaty używane przez
program B<stunnel> 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<chroot> = katalog (tylko Unix)

katalog roboczego korzenia systemu plików

Opcja określa katalog, w którym uwięziony zostanie proces programu
B<stunnel> tuż po jego inicjalizacji, a przed rozpoczęciem odbierania
połączeń.  Ścieżki podane w opcjach I<CApath>, I<pid> oraz I<exec>
muszą być umieszczone wewnątrz katalogu podanego w opcji I<chroot>
i określone wzlę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<chroot>.

=item B<ciphers> = 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<client> = yes | no

tryb kliencki (dalna usługa używa SSL)

domyślnie: no (tryb serwerowy)

=item B<CRLpath> = katalog_CRL

katalog List Odwołanych Certyfikatów (CRL)

Opcja określa katalog, w którym B<stunnel> będzie szukał list CRL,
jeżeli użyta została opcja I<verify>.  Pliki z listami CRL muszą
posiadać specjalne nazwy XXXXXXXX.0, gdzie XXXXXXXX jest skrótem
listy CRL.

=item B<CRLfile> = 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<verify>.

=item B<debug> = 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<debug = debug> lub B<debug = 7>.  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<EGD> = ś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<foreground> = yes | no (tylko Unix)

tryb pierwszoplanowy

Użycie tej opcji powoduje, że I<stunnel> nie przechodzi w tło logująć
swoje komunikaty na konsolę zamiast przez I<syslog> (o ile nie użyto
opcji I<output>).

=item B<key> = plik_klucza

klucz prywatny do certyfikatu podanego w opcji I<cert>

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<cert>

=item B<options> = opcje_SSL

opcje biblioteki OpenSSL

Paremetrem jest nazwa opcji zgodnie z opisem w I<SSL_CTX_set_options(3ssl)>,
ale bez przedrostka I<SSL_OP_>.
Aby wyspecyfikować kilka opcji należy użyć I<options> 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<output> = 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<pid> = plik (tylko Unix)

położenie pliku z numerem procesu

Jeżeli argument jest pusty plik nie zostanie stworzony.

=item B<RNDbytes> = 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<RNDfile> = plik

ścieżka do pliku zawierającego losowe dane

Biblioteka OpenSSL użyje danych z tego pliku do zainicjowania
generatora pseudolosowego.

=item B<RNDoverwrite> = yes | no

nadpisz plik nowymi wartościami pseudolosowymi

domyślnie: yes (nadpisz)

=item B<service> = nazwa_serwisu (tylko NT/2000/XP)

użyj parametru jako nazwy serwisu

Unix: nazwa serwisu dla biblioteki TCP Wrapper w trybie I<inetd>.

NT/2000/XP: nazwa serwisu NT w Panelu Sterowania.

domyślnie: stunnel

=item B<session> = przeterminowanie_pamięci_podręcznej_sesji

czas w sekundach, po którym sesja SSL zostanie usunięta z pamięci podręcznej

=item B<setgid> = identyfikator_grupy (tylko Unix)

grupa z której prawami pracował będzie I<stunnel>

=item B<setuid> = identyfikator_użytkownika (tylko Unix)

użytkownik, z którego prawami pracował będzie I<stunnel>

=item B<socket> = 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 algortym 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<taskbar> = yes | no (tylko WIN32)

włącz ikonkę w prawym dolnym rogu ekranu

domyślnie: yes (włącz)

=item B<verify> = 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


=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<stunnel> ma zostać użyty w trybie I<inetd>, gdzie za odebranie
połączenia odpowiada osobny program (zwykle I<inetd>, I<xinetd>
lub I<tcpserver>), należy przeczytać sekcję B<TRYB INETD> poniżej.

=over 4

=item B<accept> = [adres:]port

nasłuchuje na połączenia na podanym adresie i porcie

Jeżeli nie został podany adres, I<stunnel> domyślnie nasłuchuje
na wszystkich adresach IP lokalnych interfejsów.

=item B<connect> = [adres:]port

połącz się ze zdalnym serwerem na podany port

Jeżeli nie został podany adres, I<stunnel> domyślnie łączy się
z lokalnym serwerem.

=item B<delay> = yes | no

opóźnij rozwinięcie adresu DNS podanego w opcji I<connect>

=item B<exec> = ścieżka_do_programu (tylko Unix)

wykonaj lokalny program przystosowany do pracy z superdemonem inetd

=item B<execargs> = $0 $1 $2 ... (tylko Unix)

argumenty do opcji I<exec> 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<ident> = nazwa_użytkownika

weryfikuj nazwę zdalnego użytkownika korzystając z protołu IDENT (RFC 1413)

=item B<local> = 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<protocol> = protokół

negocjuj SSL podanym protokołem aplikacyjnym

aktualnie wspierane protokoły: cifs, nntp, pop3, smtp

=item B<pty> = yes | no (tylko Unix)

alokuj pseudoterminal dla programu uruchamianego w opcji 'exec'

=item B<TIMEOUTbusy> = liczba_sekund

czas oczekiwania na spodziewane dane

=item B<TIMEOUTclose> = liczba_sekund

czas oczekiwania na close_notify (ustaw na 0, jeżeli klientem jest MSIE)

=item B<TIMEOUTidle> = liczba_sekund

maksymalny czas utrzymywania bezczynnego połączenia

=item B<transparent> = yes | no (tylko Unix)

tryb przezroczystego proxy

Przepisz adres, aby nawiązywane połączenie wydawało się pochodzić
z bezpośrednio od klienta, a nie od programu I<stunnel>.
Opcja działa tylko w trybie lokalnym (opcja I<exec>) przez załadowanie
przy pomocy LD_PRELOAD biblioteki env.so, albo w trybie zdalnym (opcja
I<connect>) na systemie Linux 2.2 z włączoną opcją I<transparent proxy>.

=back


=head1 ZWRACANA WARTOŚĆ

B<stunnel> zwraca zero w przypadku sukcesu, lub wartość niezerową
w przypadku błędu.


=head1 PRZYKŁADY

Szyfrowanie połączeń do lokalnego serwera I<imapd> 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<pppd> B<stunnel> pozwala zestawić prosty VPN.
Po stronie sewera 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żeby być wykorzystany do uruchomienia
programu B<stunnel> w trybie I<inetd>.  Warto zauważyć, że w pliku
konfiguracyjnym nie ma sekcji I<[nazwa_usługi]>.

    exec = /usr/sbin/imapd
    execargs = imapd


=head1 PLIKI

=over 4

=item F<stunnel.conf>

plik konfiguracyjny programu

=item F<stunnel.pem>

certyfikat i klucz prywatny

=back


=head1 BŁĘDY

Opcja I<execargs> nie obsługuje cytowania.


=head1 OGRANICZENIA

I<stunnel> nie może być używany do szyfrowania protokołu I<FTP>,
ponieważ do przesyłania poszczególnych plików używa on dodatkowych
połączeń na otwieranych na dynamicznie przydzielanych portach.
Istnieją jednak specjalne wersje klientów i serwerów FTP pozwalające
na szyfrowanie przesyłanych danych przy pomocy protokołu I<SSL>.


=head1 NOTKI

=head2 TRYB INETD (tylko Unix)

W większości zastosowań B<stunnel> samodzielnie nasłuchuje na porcie
podanym w pliku konfiguracyjnym i tworzy połączenie z innym portem
podanym w opcji I<connect> lub nowym programem podanym w opcji I<exec>.
Niektórzy wolą jednak wykorzystywać oddzielny program, który odbiera
połączenia, po czym uruchamia program B<stunnel>.  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/sbin/stunnel
        stunnel /etc/stunnel/imaps.conf

Ponieważ w takich przypadkach połączenie na zdefiniowanym porcie
(tutaj I<imaps>) nawiązuje osobny program (tutaj I<inetd>), B<stunnel>
nie może mieć używać opcji I<accept>.  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<OPCJE USŁUG> powinny być umieszczone razem z opcjami
globalnymi.  Przykład takiej konfiguracji znajduje się w sekcji
I<PRZYKŁADY>.


=head2 CERTYFIKATY

Protokół SSL wymaga, aby każdy serwer przedstawiał się nawiązującemu
połączenie klientowi prawidłowym certyfikatem X.509.  Do potwierdzenia
tożsamości właściciela certyfikatu serwer musi mieć odpowiadający mu
klucz prywatny.  Najprostszą metodą uzyskania certyfikatu jest wygenerowanie
go przy pomocy wolnego pakietu I<OpenSSL>.  Więcej informacji na temat
generowania certyfikatów można znaleźć na umieszczonych poniżej stronach.

Przy generowaniu par certyfikat-klucz dla programu B<stunnel> istotne
są dwie kwestie.  Po pierwsze klucz prywatny nie może być zaszyfrowany,
ponieważ startujący serwer nie ma w ogólnym przypadku możliwości
uzyskania hasła od użytkownika.  Do wytworzenia niezaszyfrowanego
klucza należy przy uruchamianiu komendy I<openssl req>
podać jej parametr I<-nodes>.

Drugą 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<stunnel> 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<RNDfile>.

=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<EGD>.

=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<OpenSSL> 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<RNDfile>.

Plik I<RNDfile> powinien zawierać dane losowe -- również w tym sensie,
że powinny być one inne przy każdym uruchomieniu programu B<stunnel>.
O ile nie użyta została opcja I<RNDoverwrite> jest to robione
automatycznie.  Do ręcznego uzyskania takiego pliku użyteczna
może być komenda I<openssl rand> dostarczana ze współczesnymi
wersjami pakietu I<OpenSSL>.

Jeszcze jedna istotna informacja -- jeżeli dostępne jest urządzenie
I</dev/urandom> biblioteka I<OpenSSL> ma zwyczaj zasilania nim PRNG w trakcie
sprawdzania stanu generatora.  W systemach z I</dev/urandom> 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<OpenSSL>, a nie programu
I<stunnel>.


=head1 ZOBACZ RÓWNIEŻ

=over 4

=item L<tcpd(8)>

biblioteka kontroli dostępu do usług internetowych

=item L<inetd(8)>

super-serwer internetowy

=item F<http://stunnel.mirt.net/>

strona domowa programu I<stunnel>

=item F<http://www.stunnel.org/>

najczęściej zadawane pytania na temat programu I<stunnel>

=item F<http://www.openssl.org/>

strona projektu I<OpenSSL>

=back


=head1 AUTOR

=over 4

=item Michał Trojnara

<F<Michal.Trojnara@mirt.net>>

=back

