summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/en/README91
-rw-r--r--docs/fr/fr_README102
2 files changed, 193 insertions, 0 deletions
diff --git a/docs/en/README b/docs/en/README
new file mode 100644
index 0000000..cbae3d7
--- /dev/null
+++ b/docs/en/README
@@ -0,0 +1,91 @@
+AF - Active Port Forwarder v0.5.3 - README
+Copyright (C) 2003 jeremian - jeremian@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.
+
+================================================================================
+
+
+Active port forwarder is a software for secure port forwarding.
+It uses ssl for increasing security of communication between server and client.
+
+Af is dedicated for people, who don't have external ip number and want to
+make some services available across the net.
+
+Moreover, zlib is used to compress transfered data.
+
+EXAMPLE 1:
+
+The use of it is extremely simple. Let's suppose we want to create http server on
+our computer and we are behind masquerade or firewall:
+
+1) We have to find some machine on the net with external ip and shell account.
+
+2) Use make to compile everything on that machine. (you can freely remove afclient
+ and client.rsa files)
+
+3) You can edit config file or just type from the console: (to use 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
+
+4) We use make on our machine (we can delete everything apart 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 webbrowser to : <name of the server>:50127 and we will enter to our
+ computer in the fact.
+
+EXAMPLE 2:
+
+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: -t 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. User must use afclient to do this.
+ He has to specify server he is connecting to and 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 name of user machine (who wants to connect to our game). <portnum>
+ is a port he will be connecting to. <name of the server> is a name of a host where our server
+ is running. <server port> is a port on which server is listening for users.
+ In order to connect to our game, user have to connect to <hostname>:<portnum>.
+
+
+Active port forwarder is still under development, so please sent me any comments, bugs notices
+and suggestions about it to jeremian@poczta.fm
+
+
+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 jeremian <jeremian [at] poczta.fm>.
+ See the file COPYING for details.
+
diff --git a/docs/fr/fr_README b/docs/fr/fr_README
new file mode 100644
index 0000000..56e87b1
--- /dev/null
+++ b/docs/fr/fr_README
@@ -0,0 +1,102 @@
+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.