Team A eftp User Guide 1/30 eftp Application User Guide Table of Contents Page 1. Acknowledgement 2 2. Introduction a. Welcome eftp Audience 3 b. What s in this manual 3 c. Manual Conventions 3 d. Getting Help 3 3. Part I a. Systems Requirements 4 b. Installing eftp Application 5 c. Uninstalling 6 4. Part II a. Getting Started Logon Details 7 b. User Class (Skip to Part III, if you are not administrator of eftp) 8 c. Administrator Options 9 i. How to use Access Control List (ACL) Maintenance 9 ii. How to use IP Table Maintenance 12 5. Part III a. Rights with FTP Client 16 b. How to use FTP Client Application 17 6. Part IV - Troubleshooting a. General 20 b. FTP Client Troubleshooting 21 c. ACL Troubleshooting 21 d. IP Table Maintenance Troubleshooting 22 e. Administrator Support 22 f. Where to go from here 22 7. Acronyms 23 8. Glossary 23 9. References 24 10. Index 25
Team A eftp User Guide 2/30 Acknowledgements First of all, we would like to thank Dr. Jonathan Hodgson for accepting our e-ftp (Enterprise File Transfer Protocol) project and he has been a source of inspiration as our project guide. He has always been prompt in giving us suggestions whenever needed. His regular interaction during our project is worth applause. In a team, the desire to improve and meet the next challenge is an integral part of its attitude. It is impossible to put into words the contributions of all the team members across the development of the Project. We would like to thank one and all who are helping us in developing our software. Authors: Apurva Rajkotia Pravinkumar Govindaradjou Mehul Mehta Xianglin Wang Zhiyun Wen.
Team A eftp User Guide 3/30 Introducing eftp Application: Thank you for choosing eftp (Enterprise File Transfer Protocol) Application for your enterprise. eftp lets you easily transfer and receive files from your vendors, clients, and other departments within your organization e.t.c. With just click of few buttons on the screen you can easily transfer or receive files. The strongest point from enterprise perspective is that you can now configure your security regarding sites visit from within the application an application software firewall. Also eftp application is written 100% in Java, as a result you can install eftp Application in any Personal Computer that runs Macintosh, Windows, Linux or any operating system that supports Java Runtime Environment. What s in this manual? This manual is designed for users and administrators of eftp application. Basic computer skills are expected before you this application. This manual starts of with Systems requirements for installing the application, how to use and maintain eftp application at various user levels (Normal Users, Super Users and Administrator), followed by Troubleshooting guide followed by appendix for acronyms, references, glossary and Index for the document. Manual Conventions Bold text is used for keys, buttons, check boxes, radio buttons, menus or menu items, and text that you are directed to type. Italicized text refers to names for folders, files, disks or discs,windows, and dialog boxes. It s also used for new terms, chapter or section references, and important ideas. Ctrl, Shift or Alt followed by a letter means hold down that key while pressing the letter. For example, Ctrl-S means hold down the Ctrl key while pressing the S key. Click means click the left mouse button. Double-click means click the left mouse button twice in quick succession. Right-Click means to click the right mouse button. Shift-Click means hold down the Shift key while clicking the left mouse button. This applies if your mouse is configured on your PC as Right-handed, otherwise reverse the instruction for left-handed mouse. Getting Help: eftp Application is written 100% in Java. So in case you have the source code for this application you can debug and get additional information at java.sun.com.
Team A eftp User Guide 4/30 Part I : eftp Systems Requirements Hardware Requirements: 64 MB RAM 25 MB Hard disk space (Approximately), if you are installing bundled JRE (Java Runtime Environment) 5 MB Hard disk space (Approximately), if you are installing with out JRE (Java Runtime Environment) Supported Platforms Windows 95 Windows 98 (1st or 2nd edition) Windows NT 4.0 with Service Pack 5 Windows ME Windows 2000 Windows XP Linux Solaris Unix Any other platform with a compatible Java TM Virtual Machine. Software requirements JRE 1.2 or later (JRE 1.2.2 is strongly recommended). Note JRE 1.2.2 is bundled with the Windows Installer. If you are downloading a copy of eftp for a platform other than Windows, you must first install JRE 1.2.2 on to your system. You can download JRE from http://java.sun.com/products
Team A eftp User Guide 5/30 Installing eftp Application: Note - Installation instructions were written prior to actual development of software as a result the steps might be altered at installation time by supplying release note along with software, which will specify the any modifications to installation step. Windows - Run the downloaded file and follow the instructions that will be displayed. The installer will create shortcuts to launch eftp on your desktop and Start Programs menu. MacOS - MacOS requires installation of Apple's MRJ 2.1 for proper operation of eftp. Un Stuff the downloaded bin file, and it will unpack to the eftp installer. Run the installer and follow the instructions to install the software. Important MacOS Note: After installing on the Mac, you will find a file named jconfig.sit in your <eftp root>/bin folder. eftp determines which application to use for specific file types from the Mac's Internet Configuration. If the Internet Configuration is disabled, eftp uses some typical defaults. UNIX / Linux- Make sure that your java executable (1.1.7 or later) is in the current PATH. You will have to change the permission of the download to executable in order to run it. Open a console window on your graphical desktop and run the downloaded bin file to launch the installer. The installer will run at first within the console and then launch an installation wizard. Follow the instructions that appear Important UNIX Note: In order to view files on UNIX systems, be sure to provide the name of your editor application in eftp's Preferences dialog. The link to KC Multimedia will only launch a program "netscape" that must be in the default PATH. We suggest installing eftp to /usr/local/eftp. Following installation, create a link in /usr/local/bin to the eftp executable: cd /usr/local/bin ln -s /usr/local/eftp/bin/eftp You will find an icon image, eftp, in your eftp installation directory. Place this in your desktop's icon folder and use it with an eftp desktop shortcut if desired. Generic - for OS/2 and UNIX-like platforms, The generic installer should not be used with Windows or MacOS. We strongly recommend that Unix/Linux users use the UNIX/Linux installer. eftp has not been tested on other platforms, and we can only provide some general guidance on installation. Important Generic Note: In order to view files on generic systems, be sure to provide the name of your editor application in eftp's Preferences dialog. Since the generic installer does not create a script or shortcut, you will have to create your own to run eftp. To do this, place eftp.jar and swingall.jar (located in <eftp>/lib) in your Java CLASSPATH. Then run eftp's main class with your Java executable. Create a script to perform this and save it in <eftp>/bin Create a symbolic link or shortcut to this script in a folder that is in the PATH.
Team A eftp User Guide 6/30 Uninstalling eftp Application: Note - Uninstallation instructions were written prior to actual development of software as a result the steps might be altered at installation time by supplying release note along with software, which will specify the any modifications to uninstallation step. Windows If you choose to uninstall eftp, go to ControlPanel Add/Remove Programs and select eftp from the list of installed software to remove it. MacOS To remove eftp simply delete the installation folder. UNIX / Linux- To remove eftp, simply delete the installation folder.
Team A eftp User Guide 7/30 Part II : Getting Started Logon Details After your administrator has setup appropriate ways of executing / running the eftp Application, the first thing you will see is the log on screen. You cannot use any functions until you have logged on (identified yourself to eftp). Login is a process where you identify yourself to the system by providing proper authentication - The Username and Password provided by your administrator. Note to Administrator Default Username and Password will be provided to you with Installation Disc. To login: Type in your username and password Password - you cannot view what you typed in for security purpose. Select LogOn to complete logging in. Logging on: You cannot use any functions until you have logged on. You will be asked for User name and your Password. When your username and password has been verified, e-ftp Application will automatically let you in. If you make a mistake by typing wrong username or password it will not let you in and you have to start all over again. After successful login process you will see FTP Client screen, if you are not the Administrator of the application. If you forget your password, you have to ask your Administrator of the application to create a new password for you.
Team A eftp User Guide 8/30 User Class (Skip to Part III, if you are not the administrator of application): There are three-user classes for eftp Application viz. Normal User, Super User and Administrator. Administrator the person who has full control over the application including managing application firewall, creating / deleting / updating user names and passwords and performing actual FTP operations. Super user(s) the person(s) who has unrestricted access to FTP operations. Normal user(s) the person(s) who has restricted access to FTP operations meaning restricted sites. The administrator should make the decision of creating user type after consulting the manager(s) of the business unit requesting the installation of eftp Application.
Team A eftp User Guide 9/30 Administrator Options After successfully logging the eftp application, the administrator will see the following: Note: Administrator can select one of the above options I. ACL Maintenance (Access Control List - ACL) This module can only be accessed by Administrator to do changes in Access Control List, which maintains list of User ID, User Password, User Type and User Description. Administrator will use this function of the application to add / modify / view / and delete users information. At setup time administrator will know the actual path of the file, which maintains ACL List. The ACL Maintenance also known as User maintenance screen is shown below:
Team A eftp User Guide 10/30 User ID: This field contains user ID User Password: This field contains user password User Type: This field contains user type (A-Administrator, S-Super user, N- User) User Description: This field contains users description Functionality: To add a user Click on File Menu and then click on Add User i. Type in User ID (Ranging from 1 to 100 digits) ii. Type in Password can be seen on the screen (Ranging from 3 to 10 characters) iii. Type in User Type (A Administrator, S Super user, N Normal User) iv. Type in User Description (Ranging form 7 to 30 characters) v. Then click on Save Changes vi. Press Cancel to exit from the screen without adding record. Note: If user name already exist, it will show you an error message and allow you to reenter a new user name.
Team A eftp User Guide 11/30 To modify (Update) user s record including password Click on File Menu and then click on Modify User. i. Type in User ID (Ranging from 1 to 100 Digits) ii. Press Enter If record is found it will fill in the remaining fields, else it will show an error message and it will prompt for another User ID iii. After record is found, you can change any field(s) and then Click on Save Changes iv. Press Cancel to exit out of the screen.
Team A eftp User Guide 12/30 To View user s record Click on File Menu and then click on View User i. Type in User ID (Ranging from 1 to 100 digits). ii. Press Enter or Click on GetRecord, if record is found it will fill in the remaining fields, else it will show an error message and allow you to reenter a new user name. iii. Press Cancel to exit out of the screen.
Team A eftp User Guide 13/30 To Delete a record Click on File Menu and then click on Delete User i. Type in User ID (Ranging from 1 to 100 digits) ii. If User ID exists, then application will display all User s information and then application will prompt with new screen which will ask Administrator to type in yes if they surely want to delete the record or they can press cancel if Administrator do not delete the record
Team A eftp User Guide 14/30 II IP (Site) Maintenance: An IP (Site) maintenance right is given only to administrator, they can add new record, can view records, can update records and can delete records. This application only applies to normal user class, any time a normal user class wishes to connect to an FTP site by specifying an URL (Uniform Resource Locator e.g.: polaris.sju.edu), it is converted by the eftp application to its IP (Internet Protocol) address and verified against this IP Table. If a match is found then user is allowed to connect else user will get error message specifying not authorized FTP address. The first screen that pops up is the 'Site Processor for eftp' screen when the Administrator wants to do IP (Site) maintenance. If the Administrator clicks on ok button then it will go to the 'Site Processor for eftp' screen. There is the 'file' menu item in the menu bar from where administrator can select a particular task.
Team A eftp User Guide 15/30 First time access to IP (Site) Processor, Administrator needs to decide here where to store IP Table Maintenance file. Please select the location where every user has read access but no update access. Subsequent access to IP (Site) Processor, Administrator should know the file where he has stored IP Table Maintenance File. Click on File Open and select the file
Team A eftp User Guide 16/30 Note: If the file exists, it will open it with read and write access, else if the file does not exist it will create new IP table maintenance file. Once the file is successfully opened all the remaining options in File Menu will be enabled. The screen should look like below:
Team A eftp User Guide 17/30 Site ID: This field contains Site ID (Ranging from 1 to 100 digits) Site Address: This field contains user password (Ranging from 7 to 30 Characters) Description: This field contains users description (Ranging from 7 to 30 Characters) Functionality: Following are the steps for the Administrator to perform a certain tasks 1. Adding a new IP address to the IP maintenance table Click File->New Record (from the menu bar). Type in Site ID (must be from 1 to 100 digits) Type in a valid IP (Site) Address and any description. Then click on Save Changes button to save his information in the file.
Team A eftp User Guide 18/30 If Item number already exists, it will show an error message telling item number exist. 2. View Record: Click on File List Records Type in the Item number (must be a digit). Then click on Get Record button or press enter. After this action it will display information of that particular IP.
Team A eftp User Guide 19/30 Note: If the record is found, it will show the information of the record else it will show appropriate error message. 3. Update Record: Click on File Update Record Type in Site ID and then press enter. After typing in updates to the record click on Save Changes button and then proceed to update the user record. If you do not want to update record then just click on cancel button to come out of the screen.
Team A eftp User Guide 20/30 Note: If the record is found, it will show the information of the record else it will show appropriate error message. 4. Delete Record Click File->Delete Record Now type in the Site ID (Ranging from 1 to 100 digits) If Site ID exists, then application will display all User s information and then application will prompt with new screen which will ask Administrator to type in yes if they surely want to delete the record or they can press cancel if Administrator do not delete the record
Team A eftp User Guide 21/30 Note: If the record is found, it will show the information of the record else it will show appropriate error message. Part III: Review of Rights with FTP Client: There are three-user classes for eftp Application viz. Normal User, Super User and Administrator. Administrator the person who has full control over the application including managing application firewall, creating / deleting / updating user names and passwords and performing actual FTP operations. Super user(s) the person(s) who has unrestricted access to FTP operations. Normal user(s) the person(s) who has restricted access to FTP operations meaning restricted sites.
Team A eftp User Guide 22/30 How to use FTP Client Application: After successful log in process you should see the following screen: This is the FTP Client to transfer and receive files from remote FTP Site. Note that, basic FTP knowledge is required to understand and operate this application.
Team A eftp User Guide 23/30 To perform a FTP Operation: Type in User name: Remote site user name, user name for URL or IP you want to connect. Type in Password: Remote site password, password for URL or IP you want to connect. Type in URL or IP: Site you wish to connect Type in Remote Directory: Site directory, if not known leave it blank. Host Filename: The file you wish to download or upload at remote site. If not sure Click on List Remote Directory Button or press Alt L. List Remote Directory Button: This will list remote site directory contents after connecting to remote site. User name, Password, URL or IP address will be validated at connection step. Local Filename: The file you wish to download or upload at your PC. If not sure click on Browse Local Files button or press Alt B. Browse Local Files button: This will allow you to browse your PC and help you select the file. Disconnect Button: If there is some problem with the file transfer and you want to try again then you have to first disconnect the and then connect again for file transferring. Put Transfer Files Button (Alt P): Transfers file from your PC to remote site. Get Receive Files Button (Alt G): Receives file from remote site to your PC. Close Button (Alt C): To close and exit from FTP Client Application Help Me Button: If User encounters problem understanding FTPClient then they can click on Help Me button to know how this FTPClient Application works. Connection Monitor Area: Connection Monitor Area acts like a message area showing appropriate messages to client at various milestone activities achieved by application. Any run time error messages, which are not caught by application, will be show here. User should take a note of these run-time errors while troubleshooting or contacting administrator. Note for administrator All the messages shown in Connection Monitor area is logged into FTPApp.log file. The location of this file should be noted at install time. Progress Bar: This shows the completion percentage of an upload or download of a file. It will start at 0% and ideally will end at 100%.
Team A eftp User Guide 24/30 Here is an Example of FTP Operation:
Team A eftp User Guide 25/30 Part IV Troubleshooting a. General 1. Why Do I Keep Getting "Invalid Logon" or "Password Verification Failure" Messages? The most likely cause is that either you have forgotten to put the capital "P" in front of your username, or the "p" is lowercase, or your username is in caps. The other area to check is your password itself, making sure all letters are lowercase as assigned, or that it matches exactly whatever new password you have changed to. User name and password are case sensitive. Initial Troubleshooting: The following pages provide initial troubleshooting procedures and tables listing specific problems, probable causes and recommended actions to take if the software fails after you configure it. Invalid Password Error Problem Solution Some passwords might have been created with Upper Cases or they may also include Numerical characters in them. This can be rectified by typing the correct password again or by checking for the cases/numbers. Note: Password Fields are case-sensitive. User Not Found Timed Out Connection Lost When the user-name that was typed cannot be found in the user database file, this message is displayed. When we try to access a remote server, sometimes it may take a long time to get connected to them or there might be a firewall or the server may be down. IT is self-explanatory, we get this when a connection that had with a server is lost. This may happen when the server is down or Type the correct User Name or verify with administrator Try to ping to that server or try connecting after sometime. We have to try reconnecting or waiting till the problem is rectified.
Team A eftp User Guide 26/30 File Not Found power-failure etc. This happens when the file you are searching for is not available in that location Try giving the right path, correct file-name and extensions. b. FTP Client Troubleshooting: This section will help you to troubleshoot any problems that you face with FTP. Error Problem Solution FTP port already in use Could not determine Site address of server Another FTP session running on the same machine The DNS server is not responding properly: it may be down or otherwise inaccessible Bad Folder entry that the folder has a slash (/) somewhere in the path Write Stream Error Server does not respond to requests outside company means that the client has closed the connection your FTP server might be behind a firewall Restart your machine and try again. First, try using a web browser or FTP client to check another server. If your DNS server is down, you will get an error Check your hard drive and enclosing folders for this character, and remove it. does not indicate a problem with the server or the client, and does not require any action by an administrator the network administrator will need to ensure that ports are available for access c. Access Control List (ACL) Troubleshooting: Error Problem Solution The Access control subsystem cannot be started at this time. Your Access Control account information cannot be retrieved at this time ACL file is either deleted, or has become corrupted or directory / file authorization permission, remote session not active A possible reason that this message was issued is that the PASSWD data set in the ACL Root Path is not readable Please contact your system administrator Please try again or contact your system administrator
Team A eftp User Guide 27/30 Your Access Control account information is incomplete This message was issued is that the group information for the user is missing. Make sure that the user is assigned to at least one group Please contact your system administrator d. IP Table Maintenance Troubleshooting: Error opening the file Error File not found Error Problem Solution If another System is running at the same time or when the server is down, then it gives problem accessing the file Cannot open IP (Site) maintenance file for updating. Restart the application all over again Make sure file exist and no one is reading the file while you are trying to update the record. *Contact your server administrator *Server administrator is different then eftp administrator. Server administrator could be Unix administrator, Linux administrator, Windows NT administrator, etc. e. Administrator Support (Log File): Every FTP transactions in an Enterprise are logged in a log file (for security and Audit purpose). The program writes a log file, which records every activity of the user. The file is written as each transaction is completed. The data is first copied to a file, which uniquely identifies the information of the user. File should no longer be required by the system, but in case of processing errors or physical loss, it is saved for further modification. The program then copies this file to the system as the permanent audit log. The log file can be viewed by opening the file in any editor. Sample content of the FTP log file is as follows: #Connecting to host polaris.sju.edu User ar115333 login OK ***************************** Connecting to host polaris.sju.edu User ar115333 login OK Directory: EMAA ***************************** Connecting to host polaris.sju.edu User ar115333 login OK
Team A eftp User Guide 28/30 Directory: EMAA File link.txt: 27 bytes ***************************** f. Where to go from here (For Additional Tech Support) If all the troubleshooting techniques failed and you are not able to resolve the issue, please visit the following sites: http://www.apple.com/developer/ http://msdn.microsoft.com http://www.linux.org http://java.sun.com http://sun.com Acronyms: FTP : File Transfer Protocol eftp: Enterprise File Transfer Protocol ACL : Access Control List RAF: Random Access File IEEE: Institute of Electrical and Electronics Engineers Glossary: FTP File Transfer Protocol, FTP is a protocol designed for the sole purpose of transferring (e.g., upload/download) files between two computers. Upload - Copy files from your computer (client) to a remote computer (server). Download - Copy files from a remote computer (server) to your computer (client). eftp Enterprise File Transfer Protocol Application is our Graphical User Interface Client that can be implemented in an Enterprise. Log file - Every FTP transactions in an Enterprise is logged in a log file (for security and audit purpose.
Team A eftp User Guide 29/30 Firewall - A firewall is a set of related programs, located at a network gateway server, that protects the resources of a private network from users from other networks. (The term also implies the security policy that is used with the programs.) References Software Engineering An Object Oriented Perspective from Eric J Braude. User Manual - Greeting Card Factory from Art Explosion. User Guide Borland C++ Builder 3 User Guide Linksys Router http://java.sun.com http://msdn.microsoft.com http://www.linux.org http://www.apple.com/developer/ http://www.sju.edu/~jhodgson
Team A eftp User Guide 30/30 Index Acknowledgements... 1, 22 ACL... 2, 9, 21, 23 Acronyms... 2, 3, 23 Administrator...3, 4, 7, 8, 9, 12, 14, 16, 22 Application... 3, 4, 5, 6, 7, 15, 16, 17, 22,23 Browse... 18 Conventions... 2,3 Download... 23 eftp... 3, 4, 5, 6, 7, 8,9,10, 11, 15, 22 firewall... 3, 7, 15, 19, 22 FTP Client... 1, 7, 16, 17, 18, 21 Get... 14, 18 glossary... 1 Glossary... 1, 22 Help... 1, 2 Host... 17 IEEE... 22 Installing... 1, 5 Invalid... 20 IP... 1, 11, 12, 13, 17, 21, 22 Java... 2, 3, 4 JRE... 3 Linux... 2, 3, 4, 5 Local... 17 log... 6, 17, 21, 22 Logon... 1, 6, 19 Macintosh... 2 MacOS... 4, 5 manual... 1, 2 Password... 6, 8, 9, 17, 19 Put... 17 RAF... 22 References... 1, 2, 22 Remote... 17 Requirements... 1, 3 Rights... 1, 15 Super Users... 2 Support... 1, 21 Troubleshooting... 1, 2, 19, 20, 21 Uninstalling... 1, 5 Unix... 3, 4, 5 Upload... 22 URL... 11, 17 User Class... 1, 7, 8 User Name... 8, 9, 10, 19 Welcome... 1 Windows... 3, 4, 5, 6