Itilect FTP Proxy Files

README file for Itilect FTP Proxy.



0. TERMINOLOGY

"profile" - User profile to access proxy
"account" - Stored FTP account, that is used by proxy as an actual target



1. HOW TO PREPARE

Application requires SQLite Java wrapper (http://www.ch-werner.de/javasqlite/)
to be in java.library.path.

For Windows this means, that sqlite_jni.dll must be in application folder.

For *nix, you need to download source .tar.gz either from author's site or from
this project's home, compile and install it manually and launch the application
with -Djava.library.path=/usr/local/lib added as a java argument.



2. HOW TO RUN

You'll need JRE 1.7 or later (yep, sorry about that).

Application can be run in two different modes:

1) GUI mode for administration purposes. In GUI mode, server isn't started.
2) Server mode. Currently doen't allows you to do anything.

Since application is written in pure java, you'll need "java" to run it.
GUI mode is default and requires no arguments, so the launch command will be:

	java -jar FTPProxy.jar

from the application folder.
Server mode is specified by two arguments: "server" (or "-server"), optionally
followed by internal admin password. If you don't specify it, it will be
prompted:

	java -jar FTPProxy.jar -server
	java -jar FTPProxy.jar -server mypassword

If launching is done from the external directory, you have to make sure that
Java SQLIte Wrapper is in java.library.path by any way. The easiest one is

	java -Djava.library.path=/usr/local/lib -jar FTPProxy.jar
	java -Djava.library.path=C:/Windows/system32 
	     -jar D:/my/path/to/FTPProxy.jar -server mypassword


2.1 RUN DETAILS

Application can be started twice in different modes simultaneously.
Any saved changes will be applied immediately, no server restart is needed.

WARNING: already established connection won't be interruted! Even if you've
         just disallowed those of a kind. If you worry about that, restart the
         server.


2.2 DATA STORAGE

Database is a single file stored in the application directory itself (though
probably not a best decision). All passwords are encrypted using internal
admin password.
By dafault, server shares the database to the outside using JDBC. Shared
database can also be accessed remotely using VJDBC. To disable database
sharing, set JDBC port to -1.
To establish a remote database connection, change "path" in options.ini to
<hostOrIp>:<jdbcPort> format


3. HOW TO SET UP

To fill in the actual data, the application provides a Swing GUI (no CLI,
sorry).
If you wandering about launching it, see HOW TO RUN section above.
For a detailed GUI description, see README_GUI.rtf file in the same folder.



4. HOW TO CONNECT

Connection target should be proxy-server address (default port is 31)
Auth credentials are login in form:
	profilename$hostname
or
	profilename$host_id
and a profile password.


4.1 CONENCTION PROCESS AND ERROR MESSAGES

If input was malformed:
	421 Login must be supplied in form profile$host.

If profilename wasn't found:
	530 Incorrect profile name

If profile pasword doesn't match:
	530 Incorrect profile password
(Note: any other 530 message will mean that auth was denied by remote
FTP host)

If profile don't have priveleges to access host OR if provided host
wasn't found:
	421 Your profile have no permissions to access this host

If connection to a remote host failed:
	421 Cannot conenct to host: <Error reason>

Otherwise server establishes conenction and starts to act as a proxy.



5. TROUBLESHOOTING

Q: Active Directory import fails with "PartialResultException ->
   CommunicationException : <Active Directory Domain>:389 :
   UnknownHostException : <Active Directory Domain>"
A: Such behaviour has been seen on Linux machines. The reason is
   that Windows and Linux handles LDAP redirection differently.
   As a workaround, try using port 3268 (likeldap://192.168.0.1:3268/)
   For more info, see:
   https://bugzilla.redhat.com/show_bug.cgi?id=582471
   http://www.jspwiki.org/wiki/ActiveDirectoryIntegration