Installer requirements for Plop

"Do no harm to the user's machine."

Overview of package: (What software does it install? What does the software do? In very general terms)

Plop is a limited functionality FTP client that implements the GSSAPI extensions. It's primarily intended to provide a secure means for MIT users to transfer files from a PC to AFS for the purpose of web publishing.

 

  1. Hardware and Operating System requirements
    1. Which operating systems are supported

      2. Windows 2000

      NT 4.0

      Windows 98

      Windows 95

    2. What are the relevant hardware requirements
      1. Disk space required by application = ~136Kb
      2. Disk space required for installation = ~170Kb
      3. The size of the installer image = ~31Kb
      4. Typical RAM requirements for running the application = ~5MB

     

  2. Does this software obsolete any existing software?

    3. No.

  3. What are the known backwards compatibility issues?

    4. The user must install Mink-09-20-99 or later because the application is dependant on the GSS and Kerberos DLLs contained in that installer.

  4. The user visible components during install time are:

    5. The Plop application.

  5. The files to be installed are:

    6. Plop.exe

    GFTPDLL.DLL

    Plop.html

    PSAPI.DLL, if necessary.

    1. The default location of each file to be installed is:

      2. %Program Files%\Kerberos

    2. Restrictions on file locations are as follows:

      3. GFTPDLL.DLL should either be on the path or in the same directory as plop.exe.

      Plop.html must be in the same directory as Plop.exe

      Psapi.dll must reside in the system32 directory on NT 4.0 and W2k.

    3. The following files have been changed, added, or removed since version XXXX

    This is the first version. It does not supplant any pre-existing product. However, some early beta testers had access to the product under its earlier name of SoFTP.

  6. The following files will have an associated menu entry and the text of the menu entry will be:

    7. Plop.exe - Plop, under the "Kerberos utilities" menu.

    1. The following files will have a Desktop shortcut and the label for the shortcut will be:

    Plop.exe - Plop

  7. The following registry values will be set:
    1. The follow registry values are configuration options which affect the system as follows:

      2. HKEY_CURRENT_USER\Software\MIT\Plop\Plop-Bar0\BarID

      HKEY_CURRENT_USER\Software\MIT\Plop\Plop-summary\

      Bars

      ScreenCX

      ScreenCy

      HKEY_CURRENT_USER\Software\MIT\Plop\Settings\

      [hostname REG_SZ: ftp.dialup.mit.edu] Server to connect to if no command line option is given

      [directory REG_SZ:] Destination directory if there is no command line option, or if user does not want to use Hesiod to determine default location.

      HKEY_CURRENT_USER\Software\MIT\Plop\Window size\

      Icon reg_DWORD: 0 Should the application be iconified?

      Max reg_DWORD: 0 Should the application be maximized?

      Rect reg_sz: 0249 0171 0882 0559 Screen coordinates for initial display of application

    2. These are set by the installer

      3. None.

    3. These are unset but may be modified via the application UI

      4. The regsitry values listed above will self-populate during use of the application. The installer is not required to initialize anyof the regsitry settings.

      The hostname and directory registry settings may be modified by the option menu in the application.

    4. These have no UI but may be set by advanced users via the registry editor

     

  8. The following command line options affect the application:

    9.  

    All of these are optional command line arguments, none are required.

    -s servername The name of the ftp server to connect to when transferring a file.

    -d directoryname The name of the destination directory. This is the location into which all files will be transferred.

    -t [A\I] Use "A" if you want to transfer the files as ASCII files. This will cause CRLFs in the file on the PC to be converted to CRs during the transfer. Use "I" if you want the files to transferred without any changes being made. The default mode will always be "I" if this command line option is not specified.

    -u username Kerberos authentication will still take place using the Kerberos principal name. However, a command line username can be used to populate the additional, possible, username/password dialog boxes. The Hesiod queries to find the default home directory will also use this username.

    Additional command line parameters without the "-" will be treated as filenames. Additional "-" options will be treated as errors and a usage message will be displayed to the user.

  9. The following environment variables will affect the system:

    10. %USERNAME% - if the user does not have Kerberos version 5 tickets during execution, and a username is not specified in the command line parameters, and the environment variable exists.

    1. The installer will modify or set the following environment variables:

    None.

  10. What are the license restrictions or export restrictions
    1. What text regarding the license will be displayed to the user during installation?

      2. --------------------

      Copyright (C) 1999 by the Massachusetts Institute of Technology.

      All rights reserved.

      Export of this software from the United States of America may require a

      specific license from the United States Government. It is the

      responsibility of any person or organization contemplating export to

      obtain such a license before exporting.

      WITHIN THAT CONSTRAINT, permission to use, copy, modify, and distribute

      this software and its documentation for any purpose and without fee is

      hereby granted, provided that the above copyright notice appear in all

      copies and that both that copyright notice and this permission notice

      appear in supporting documentation, and that the name of M.I.T. not be

      used in advertising or publicity pertaining to distribution of the

      software without specific, written prior permission. Furthermore if you

      modify this software you must label your software as modified software

      and not distribute it in such a fashion that it might be confused with

      the original MIT software. M.I.T. makes no representations about the

      suitability of this software for any purpose. It is provided "as is"

      without express or implied warranty.

      THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED

      WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF

      MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

      Individual source code files are copyright MIT, and others.

      Project Athena, Athena, Athena MUSE, Discuss, Hesiod, Kerberos, Moira,

      and Zephyr are trademarks of the Massachusetts Institute of Technology

      (MIT). No commercial use of these trademarks may be made without prior

      written permission of MIT.

      "Commercial use" means use of a name in a product or other for-profit

      manner. It does NOT prevent a commercial firm from referring to the MIT

      trademarks in order to convey information (although in doing so,

      recognition of their trademark status should be given).

       

      ---------------------------------------

      1. Who provided or reviewed this text?

      No one yet. Modified from the current Kerberos copyright.

    2. What text regarding export restrictions will be presented to the user?

      3. Same as Kerberos libraries. Notice included in text above.

      1. Who provided or reviewed this text?

    To be determined.

  11. The following applications may be affected by installing this application or the libraries that it uses:
    1. Known compatibility issues

      2. This application relies on the GSSAPI and Kerberos DLLs that are installed by Mink-09-20-99.exe or later.

    2. This application is dependant on the following libraries or applications:

    Plop.exe

    Gftpdll.dll

    Gssapi32.dll

    Krb5_32.dll

    Krbcc32.dll

    Comerr32.dll

    Wshelp32.dll

  12. The following web pages or documents are expected to reference this installer or the binaries that it installs
    1. The contacts for these documents are:

     

  13. Can we desupport prior software versions?

    14. Not applicable.

  14. What is the planned software distribution method?

    15.  

    1. net-dist - NO
    2. CD (schedule for production and distribution) - NO
    3. nic-dist - YES
    4. AFS locker - not at this time.

     

  15. Other issues that should be highlighted

    16.  

  16. Web pages that may be affected by the distribution of this software

    17. < http://web.mit.edu/acs/faq/remote_access/filetransfer.html> Academic Computing

    <http://web.mit.edu/acs/webguide/file_transfer.html >

    < http://web.mit.edu/acs/www/whererunsa.html>

    < http://web.mit.edu/cwis/secure-xfer/> CWIS

    < http://web.mit.edu/afs/athena.mit.edu/org/c/cwis/www/faq/wsftp.html>

    < http://web.mit.edu/dialup/www/> jweiss

    < http://web.mit.edu/dialup/www/ftp.html>

    < http://web.mit.edu/net-security/www/resources.html> netsec

    < http://web.mit.edu/net-security/www/faq.html>

     

     

  17. Mailing lists, individuals or teams that may be interested in early testing of this software:

    18. sw-release-team

    Fl

    netsec

    Sbjones

    Bobmah

    Ray Faith

    David Hogarth

    Bill Huxley

    Chris Murphy

  18. Test plan / cases

    19. - What if you don't have the GSS or v5 DLLs?

    - What if you don't have wshelp32.dll?

    - What if your principal name is not your username?

    You can manually set the name of the target directory.

    - What if you don't have tickets?

    - What if you don't have forwardable tickets?

    - What if the server doesn't support GSS/v5?

    - What if you drag multiple files?

    - What if you drag a folder?

    - Look at case sensitivity?

    - What if the network drops during a transfer?

    - What if the server exits during a transfer?

    - What if you don't have permissions on the remote server?

    - What if a file already exists on the remote server?

    - AFS cache issues?

    - What if you share this machine with several other users?

    - Command line -s host name

    - Command line -d directory name

    - "-d ." should just put user into the default directory

    - Command line -u user name

    - Command line file[s]

    - Command line invalid options

  19. Check list

Post testing, pre official release:

Change embedded URL to http://web.mit.edu/is/help/plop

Change the name of the list for problem or bug reporting.