diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/README | 308 | ||||
| -rw-r--r-- | docs/fr/fr_README | 102 | ||||
| -rw-r--r-- | docs/ru/ru_README | 294 |
3 files changed, 0 insertions, 704 deletions
diff --git a/docs/en/README b/docs/en/README deleted file mode 100644 index 8901699..0000000 --- a/docs/en/README +++ /dev/null @@ -1,308 +0,0 @@ -AF - Active Port Forwarder v0.5.5 - README -Copyright (C) 2003,2004 jeremian - <jeremian [at] poczta.fm> -=================== - -================================================================================ - -GRAY-WORLD.NET / Active Port Forwarder -========================== - - The Active Port Forwarder program is part of the Gray-World.net projects. - - Our Gray-World Team presents on the http://gray-world.net website the projects - and publications we are working on which are related to the NACS (Network - Access Control System) bypassing research field and to the computer and - network security topics. - -================================================================================ - -======= -SUMMARY -======= - -INTRO - -1. INSTALLATION - 1.1 Instructions - 1.2 Required libs - 1.3 Tested platforms -2. USAGE - 2.1 afserver - 2.2 afclient -3. EXAMPLES - 3.1 tcp mode - 3.2 reverse udp mode -4. BUGS/PROBLEMS - -NOTES - -THANKS - -================================================================================ - -===== -INTRO -===== - -Active port forwarder is a software tool for secure port forwarding. -It uses ssl to increase security of communication between a server and a client. -Originally, it was developed to forward data point to point. However, the need -for bypassing firewalls in order to connect to internally located computers -influenced the further development of the project. - -AF is dedicated for people, who don't have an external ip number and want to -make some services available across the net. - -Moreover, zlib is used to compress the transferred data. - -Using one, permanent data/control channel with flow control / packet buffering -provides good performance and reasonably small latency. - -Multiple clients allow to create more sophisticated tunneling scheme. - -================================================================================ - -=============== -1. INSTALLATION -=============== - - 1.1 Instructions - ---------------- - -1. Download the compressed sources from http://www.gray-world.net/pr_af.shtml -2. Unpack them with tar zxvf -3. Type "make". -4. If something goes wrong - mail the author or post a message on - http://gray-world.net/board/ - - 1.2 Required libs - ----------------- - -1. openssl - http://www.openssl.org/ -2. zlib - http://www.gzip.org/zlib/ - - 1.3 Tested platforms - -------------------- - -1. Linux: - Gentoo, Slackware, Mandrake - built without any problems -2. Freebsd: - 4.4, 4.9 - have to use patch from project homepage -3. Windows: - win32 - cygwin version is available on the project homepage - -================================================================================ - -======== -2. USAGE -======== - - 2.1 afserver - ------------ - - Options: - -n, --hostname - it's used when creating listening sockets - (default: name returned by hostname function) - -l, --listenport - listening port number - users connect - to it (default: 50127) - -m, --manageport - manage port number - second part of the active - port forwarder connects to it (default: 50126) - -t, --timeout - the timeout value for the client's connection - (default: 5) - -u, --users - the amount of users allowed to use this server - (default: 5) - -C, --clients - the number of allowed clients to use this server - (default: 1) - -U, --usrpcli - the number of allowed users per client (default: $users) - -M, --climode - strategy used for connecting users with clients (default: 1) - Available strategies: - 1. fill first client before go to next - - -c, --cerfile - the name of the file with certificate - (default: cacert.pem) - -k, --keyfile - the name of the file with RSA key (default: server.rsa) - -f, --cfgfile - the name of the file with the configuration for the - active forwarder (server) - -p, --proto - type of server (tcp|udp) - for which protocol it will be - operating (default: tcp) - -O, --heavylog - logging everything to a logfile - -o, --lightlog - logging some data to a logfile - -v, --verbose - to be verbose - program won't enter the daemon mode - (use several times for greater effect) - - --nossl - ssl is not used for transfering data (but it's still - used to establish a connection) (default: ssl is used) - --nozlib - zlib is not used for compressing data (default: - zlib is used) - --pass - set the password used for client identification - (default: no password) - - -4, --ipv4 - use ipv4 only - -6, --ipv6 - use ipv6 only - - -h, --help - prints this help - - 2.2 afclient - ------------ - - Options: - -h, --help - prints this help - -n, --servername - where the second part of the active - port forwarder is running (required) - -m, --manageport - manage port number - server must be - listening on it (default: 50126) - -d, --hostname - the name of this host/remote host - the final - destination of the packets (default: the name - returned by hostname function) - -p, --portnum - the port we are forwarding connection to (required) - -k, --keyfile - the name of the file with RSA key (default: (none)) - -u, --udpmode - udp mode - client will use udp protocol to - communicate with the hostname - -U, --reverseudp - reverse udp forwarding. Udp packets will be forwarded - from hostname:portnum (-p) to the server name:portnum - (-m) - -O, --heavylog - logging everything to a logfile - -o, --lightlog - logging some data to a logfile - -v, --verbose - to be verbose - program won't enter the daemon mode - (use several times for greater effect) - --pass - set the password used for client identification - (default: no password) - -4, --ipv4 - use ipv4 only - -6, --ipv6 - use ipv6 only - -l, --load - load a module for user's packets filtering - -L, --Load - load a module for service's packets filtering - -================================================================================ - -=========== -3. EXAMPLES -=========== - - 3.1 tcp mode - ------------ - - local network |FireWall| Internet - || - || User 1 - || /(tcp) - AF Client <---Encrypted/Compressed channel---> AF Server - / || | \(tcp) - /(tcp) || (tcp)| User 2 - / || \ - Http server || User 3 - || - - -The use of it is extremely simple. Let's suppose we want to create a http server -on our computer and we are behind a masquerade or a firewall: - -1) We have to find some machine on the net with an external ip and a shell - account. - -2) Use "make" to compile everything on that machine. (you can freely remove the - afclient and client.rsa files) - -3) You can edit the config file or just type from the console (to use the config - type -f <cfgfile>) : - $ ./afserver - This will work, if you want to use default values: - - hostname will be taken from hostname function (it would be ideally, if - there is appropriate registration in /etc/hosts) - - server will be listening for users on port 50127 - - server will be listening for client on port 50126 - - server will be for maximum 5 users - - server will forward tcp packets - - there will be no logging and no verbose messages - - there will be no password identification - - ip protocol family will be unspecified - -4) We use "make" on our machine (we can delete everything apart from afclient - and client.rsa) - -5) We are typing from the console: - $ ./afclient -n <name of the server> -p 80 - Where <name of the server> is a string like : 'bastion.univ.gda.pl' or - '153.19.7.200' - -6) We can now enter with a web-browser to: <name of the server>:50127 and we - will enter to our computer in the fact. - - 3.2 reverse udp mode - -------------------- - - local network |FireWall| Internet - || (udp) - || User 1-------AF Client - || /(tcp) - AF Client <---Encrypted/Compressed channel---> AF Server - / || | - /(udp) || (tcp)| - / || / - Game server || AF Client-------User 2 - || (udp) - - -Let's see how to use af to forward udp packets. Suppose we want to create a game -server on our computer (udp port 27960 on our machine): - -1) - 4) is the same like in example 1. (but we add option: -p udp) - -5) We are typing from the console: - $ ./afclient -u -n <name of the server> -p 27960 - Where <name of the server> is a name (or ip) of a host where our server is - running. - -6) Connecting to our game is more complicated. The user must use afclient to do - this. He has to specify the server he is connecting to and the port, which - his program will be listening on: - $ ./afclient -U -d <hostname> -p <portnum> -n <name of the server> \ - -m <server port> - Where <hostname> is the name of the user machine (who wants to connect to our - game). <portnum> is the port he will be connecting to. <name of the server> - is the name of the host where our server is running. <server port> is the - port on which the server is listening for users. In order to connect to our - game, the user has to connect to <hostname>:<portnum>. - -================================================================================ - -================ -4. BUGS/PROBLEMS -================ - -There are no known/open bugs at the moment. - -================================================================================ - -===== -NOTES -===== - -Active port forwarder is still under development, so please sent any comments, -bugs notices and suggestions about it to <jeremian [at] poczta.fm> - -If you have some problems or want to share your opinions with others, feel free -to post a message at http://gray-world.net/board/ - -================================================================================ - -====== -THANKS -====== - - Big thanks to the GW Team: - - to Alex <alex [at] gray-world.net> - and Simon <scastro [at] entreelibre.com> for testing AF and a lot of advices. - - Thanks to Ilia Perevezentsev <iliaper [at] mail.ru> who read and corrected the -README file. - - And thanks for using this software! - -LICENSE -------- - - Active Port Forwarder is distributed under the terms of the GNU General - Public License v2.0 and is copyright (c) 2003,2004 jeremian <jeremian [at] - poczta.fm>. See the file COPYING for details. - diff --git a/docs/fr/fr_README b/docs/fr/fr_README deleted file mode 100644 index 56e87b1..0000000 --- a/docs/fr/fr_README +++ /dev/null @@ -1,102 +0,0 @@ -AF - Active Port Forwarder v0.5.2 - fr_README -Copyright (C) 2003 jeremian - jeremian@poczta.fm -================================================ - -================================================================================ - -GRAY-WORLD.NET / Active Port Forwarder -====================================== - - Le programme Active Port Forwarder est partie intйgrante des projets - Gray-World.net. - - Notre йquipe prйsente sur le site http://gray-world.net les projets et - publications sur lesquels nous travaillons. Ces projets et publications sont - relatifs au contournement des systиmes de contrфle d'accиs rйseau (NACS - bypassing) ainsi qu'а la sйcuritй des systиmes et rйseaux. - -================================================================================ - -Active port forwarder est un programme permettant de rйaliser du forwarding de -port sйcurisй. -Il utilise le protocole SSL pour augmenter le niveau de sйcuritй des -communications entre serveur et client. - -Af est destinй aux personnes sans adresse IP publique externe qui dйsirent -offrir des services accessibles depuis le net. - -EXEMPLE 1: - -L'utilisation de Af est extrиmement simple. Supposons que nous voulons mettre en -place un serveur http sur notre station et que nous sommes masqueradйs ou placй -derriиre un firewall: - -1) Nous devons tout d'abord trouver une station sur internet avec une IP -publique et un shell. - -2) Utilisez ensuite make pour compiler Af sur cette machine. (Vous pouvez par la -suite supprimer les fichiers afclient et client.rsa) - -3) Editez le fichier de configuration ou entrez sur la console: (pour utiliser -la configuration, entrez type -f <cfgfile>) - $ ./afserver - Si vous voulez utiliser les valeurs par dйfaut: - - Le nom d'hфte sera pris en compte par la fonction hostname (Il serait idйal - qu'il soit rйfйrencй dans le fichier /etc/hosts) - - Le serveur sera en йcoute pour les utilisateurs sur le port 50127 - - Le serveur sera en йcoute pour le client sur le port 50126 - - Le serveur sera limitй а 5 utilisateurs - - Le serveur retransmettra les paquets tcp - - Aucun log ou message verbeux ne sera activй - -4) Nous utilisons make sur notre propre station (Nous pouvons ensuite supprimer -tous les fichiers sauf afclient et client.rsa) - -5) Nous entrons sur la console: - $ ./afclient -n <name of the server> -p 80 - Oщ <name of the server> est une chaоne du type : 'bastion.univ.gda.pl' ou - '153.19.7.200' - -6) Nous pouvons ensuite utiliser notre navigateur web avec : - <name of the server>:50127 et nous atteindrons notre propre station. - -EXEMPLE 2: - -Regardons comment nous pouvons utiliser af pour forwarder des paquets udp. -Supposez que nous voulons mettre en place un serveur de jeu sur notre station -(port udp 27960 sur notre station): - -1) - 4) sont les mкmes que pour l'exemple 1. (mais nous utilisons l'option: --t udp) - -5) Nous entrons sur la console: - $ ./afclient -u -n <name of the server> -p 27960 - Oщ <name of the server> est un nom (ou une ip) d'un hфte sur lequel notre - serveur tourne. - -6) Nous connecter а notre jeu est un peu plus compliquй. L'utilisateur doit se - servir de afclient pour cela. - Il doit spйcifier le serveur auquel il veut se connecter et le port sur - lequel son programme sera en йcoute: - $ ./afclient -U -d <hostname> -p <portnum> -n <name of the server> -m\ - <server port> - Oщ <hostname> est le nom de la station utilisateur (qui veut se connecter а - notre jeu). <portnum> est le port auquel il se connectera. <name of the - server> est le nom de l'hфte sur lequel notre serveur tourne. <server port> - est le port sur lequel notre serveur est en йcoute pour les utilisateurs. - Pour se connecter а notre jeu, l'utilisateur doit se connecter а <hostname>: - <portnum>. - -Active port forwarder est toujours en phase en dйveloppement, alors envoyez moi -vos commentaires, les bugs que vous rencontrez et vos suggestions а -<jeremian [at] poczta.fm> - -Et merci pour votre utilisation de ce programme! - -LICENCE -------- - - Active Port Forwarder est distribuй sous les termes de la licence GNU - - General Public Licence version 2.0 et est copyright (c) 2003 jeremian - <jeremian [at] poczta.fm>. - Consultez le fichier COPYING pour plus de details. diff --git a/docs/ru/ru_README b/docs/ru/ru_README deleted file mode 100644 index 4e825f7..0000000 --- a/docs/ru/ru_README +++ /dev/null @@ -1,294 +0,0 @@ -AF - Active Port Forwarder v0.5.4 - README -Copyright (C) 2003,2004 jeremian - <jeremian [at] poczta.fm> -=================== - -================================================================================ - -GRAY-WORLD.NET / Active Port Forwarder -========================== - - Программа Active Port Forwarder является частью проекта Gray-World.net. - - Наша команда Gray-World представляет на сайте http://gray-world.net проекты и - публикации, над которыми мы работаем, относящиеся к области исследования - NACS (Систем Контроля Сетевого Доступа), а также к теме компьютерной и - сетевой безопасности. - -================================================================================ - -========== -СОДЕРЖАНИЕ -========== - -ОПИСАНИЕ - -1. УСТАНОВКА - 1.1 Инструкции - 1.2 Необходимые библиотеки - 1.3 Тестовые платформы -2. ИСПОЛЬЗОВАНИЕ - 2.1 afserver - 2.2 afclient -3. ПРИМЕРЫ - 3.1 tcp-режим - 3.2 обратный udp-режим -4. ИЗВЕСТНЫЕ ОШИБКИ/ПРОБЛЕМЫ - -ЗАМЕЧАНИЯ - -БЛАГОДАРНОСТИ - -================================================================================ - -======== -ОПИСАНИЕ -======== - -Active port forwarder это программный инструмент для безопасного тунелирования -данных. Он использует SSL для защиты соединения между клиентом и сервером. -Изначально, программа была разработана для простой пересылки данных от точки к -точке. Однако необходимость обхода брандмауэра с целью сделать компьютеры -локальной сети доступными извне, повлияла на дальнейшее развитие проекта. - -AF предназначен для людей, не имеющих внешнего IP адреса и которые хотят сделать -некоторые локальные сервисы доступными в сети. - -В программе использована библиотека zlib для сжатия передаваемых данных. - -Использование единого канала для передачи данных и команд управления в сочетании -с буферизацией пересылаемых пакетов обеспечивает хорошую производительность и -малое время отклика системы. - -Для запуска afserver не требуется привилегий root, также он не использует -thread-ы или другие процессы. - -================================================================================ - -============ -1. УСТАНОВКА -============ - - 1.1 Инструкции - -------------- - -1. Загрузите упакованный исходный код с http://www.gray-world.net/pr_af.shtml -2. Распакуйте - tar zxvf -3. Выполните команду "make". -4. Если что-то пошло не так - напишите письмо автору или оставьте сообщение на - http://gray-world.net/board/ - - 1.2 Необходимые библиотеки - -------------------------- - -1. openssl - http://www.openssl.org/ -2. zlib - http://www.gzip.org/zlib/ - - 1.3 Тестовые платформы - ---------------------- - -1. Linux: - Gentoo, Slackware, Mandrake - было собрано без каких-либо проблем -2. Freebsd: - 4.4, 4.9 - Необходим patch с домашней страницы проекта -3. Windows: - win32 - Версия с cygwin доступна на домашней странице проекта - -================================================================================ - -================ -2. ИСПОЛЬЗОВАНИЕ -================ - - 2.1 afserver - ------------ - - Параметры: - -h, --help - печатает эту справку - -n, --hostname - используется при создании "слушающих" сокетов - (по умолчанию: имя возвращаемое функцией hostname) - -l, --listenport - порт сервера - пользователи соединяются - с ним (по умолчанию: 50127) - -m, --manageport - порт для управления - другая часть active - port forwarder соединяется с ним (по умолчанию: 50126) - -u, --users - количество пользователей, использующих сервер - (по умолчанию: 5) - -c, --cerfile - имя файла с сертификатом - (по умолчанию: cacert.pem) - -k, --keyfile - имя файла с ключом RSA (по умолчанию: server.rsa) - -f, --cfgfile - имя файла с конфигурацией для active forwarder (сервер) - -p, --proto - тип сервера (tcp|udp) - с каким протоколом он будет - работать (по умолчанию: tcp) - -O, --heavylog - писать все сообщения в logfile - -o, --lightlog - писать некоторые сообщения в logfile - -v, --verbose - вывод сообщений в консоль - програма не будет работать - как daemon. - --nossl - протокол ssl не будет использован для передачи данных (но - будет использован для установки соединений) (по умолчанию: - ssl используется всегда) - --nozlib - zlib не будет использоваться для сжатия данных - (по умолчанию: zlib используется) - --pass - задать пароль для идентификации клиента - (по умолчанию: нет пароля) - -4, --ipv4 - использовать только ipv4 - -6, --ipv6 - использовать только ipv6 - - 2.2 afclient - ------------ - - Options: - -h, --help - печатает эту справку - -n, --servername - где работает вторая часть active port - forwarder (необходимо) - -m, --manageport - порт для управления - сервер соединяется с ним - (по умолчанию: 50126) - -d, --hostname - имя локального/удаленного сервера - данные будут тунелированы - на него (по умолчанию: имя возвращаемое фунцией hostname) - -p, --portnum - порт на который будут тунелированы данные (необходимо) - -k, --keyfile - имя файла с ключом RSA (по умолчанию: client.rsa) - -u, --udpmode - udp-режим - клиент будет использовать udp протокол для - коммуникации с hostname - -U, --reverseudp - обратный udp-режим. Udp пакеты будут перенаправляться - с hostname:portnum (-p) на сервер name:portnum (-m) - -O, --heavylog - писать все сообщения в logfile - -o, --lightlog - писать некоторые сообщения в logfile - -v, --verbose - вывод сообщений в консоль - програма не будет работать - как daemon. - --pass - задать пароль для идентификации клиента - (по умолчанию: нет пароля) - -4, --ipv4 - использовать только ipv4 - -6, --ipv6 - использовать только ipv6 - -l, --load - загрузить модуль для фильтрации пакетов - -================================================================================ - -========== -3. ПРИМЕРЫ -========== - - 3.1 tcp-режим - ------------- - - local network |FireWall| Internet - || - || User 1 - || /(tcp) - AF Client <---Encrypted/Compressed channel---> AF Server - / || | \(tcp) - /(tcp) || (tcp)| User 2 - / || \ - Http server || User 3 - || - - -Использование этого режима черезвычано простое. Давайте предположим, что мы -хотим создат http сервер на нашем компьютере, находящемся в локальной сети за -брандмауэром: - -1) Мы должны найти машину с внешним IP адресом и доступом к shell. - -2) Использовать "make" чтобы скомпилировать AF на ней. (вы можете спокойно - удалять файлы afclient и client.rsa) - -3) Вы можете отредактировать конфигурационный файл или передать программе все - параметры из консоли (для использования файла наберите -f <cfgfile>) : - $ ./afserver - Это будет работать, если вы хотите использовать настройки по умолчанию: - - hostname будет взят из функции hostname (это работает замечательно, если - есть соответствующая запись в /etc/hosts) - - сервер будет ждать пользователей на порту 50127 - - сервер будет ждать клиента на порту 50126 - - сервер будет обслуживать макимум 5 пользователей - - сервер будет перенаправлять tcp соединения - - отладочных сообщений не будет - - идентификаций по паролю не будет - - версия протокола ip не будет задана - -4) Мы используем "make" на нашей машине (можно удалить все кроме afclient и - client.rsa) - -5) Набираем в консоли: - $ ./afclient -n <имя сервера> -p 80 - Где <имя сервера> строка типа: 'bastion.univ.gda.pl' или '153.19.7.200' - -6) Теперь в браузере мы можем набрать: <имя сервера>:50127 и попадем на наш - компьютер. - - 3.2 обратный udp-режим - ---------------------- - - local network |FireWall| Internet - || (udp) - || User 1-------AF Client - || /(tcp) - AF Client <---Encrypted/Compressed channel---> AF Server - / || | - /(udp) || (tcp)| - / || / - Game server || AF Client-------User 2 - || (udp) - - -Давайте теперь посмотрим как мы можем использовать af для перенаправления udp -пакетов. Предположим, что мы хотим создать игровой сервер на нашем компьютере -(udp порт 27960): - -1) - 4) тоже самое, что и в первом примере. (но добавляем параметр: -p udp) - -5) Набираем в консоли: - $ ./afclient -u -n <имя сервера> -p 27960 - Где <имя сервера> это имя (или ip) компютера где работает наш сервер. - -6) Процесс соединения с игровым сервером более сложный. Пользователь должен - запустить fclient чтобы сделать это. Он должен указать сервер с которым он - будет соединяться и порт, на котором его программа будет слушать: - $ ./afclient -U -d <hostname> -p <порт> -n <имя сервера> \ - -m <порт сервера> - - Где <hostname> имя машины пользователя (который соединяется с игровым - сервером), <порт> - локальный порт, <имя сервера> - имя сервера, <порт - сервера> - порт на котором сервер ждет пользователей.Теперь, чтобы попасть на - игровой сервер, пользователь должен соединятся с <hostname>:<порт>. - -================================================================================ - -============================ -4. ИЗВЕСТНЫЕ ОШИБКИ/ПРОБЛЕМЫ -============================ - -На данный момент, нет никаких известных проблем. - -================================================================================ - -========= -ЗАМЕЧАНИЯ -========= - -Active port forwarder находится в разработке, так что пожалуйста, присылайте -свои комментарии, замечания об ошибках и предложения на jeremian [at] poczta.fm - -Если у вас есть какие-либо проблемы с использованием программы или вы хотите -поделиться своим мнением о ней, пожалйста оставляйте свои сообщения на: -http://gray-world.net/board/ - -================================================================================ - -============= -БЛАГОДАРНОСТИ -============= - - Большое спасибо команде GW: - - Alex <alex [at] gray-world.net> - и Simon <scastro [at] entreelibre.com> за тестирование AF и множество советов. - - Спасибо Ilia Perevezentsev <iliaper [at] mail.ru> за корректировку английской - версии этого файла. - - И спасибо за использование AF! - -ЛИЦЕНЗИЯ --------- - - Active Port Forwarder is distributed under the terms of the GNU General - Public License v2.0 and is copyright (c) 2003,2004 jeremian <jeremian [at] - poczta.fm>. See the file COPYING for details. |