home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / dnetc.zip / dnetc.txt < prev    next >
Text File  |  2002-06-08  |  16KB  |  306 lines
  1.   distributed.net client documentation
  2.   document revision $Id: dnetc.txt,v 1.1.2.4 2000/04/21 13:26:33 cyp Exp $
  3.  
  4.   Copyright distributed.net 1997-2000 - All Rights Reserved
  5.   For use in distributed.net projects only.
  6.   Any other distribution violates copyright.
  7.  
  8.   Use of the distributed.net client implies agreement with
  9.   the prize terms listed on http://www.distributed.net/
  10.  
  11.  Index ---------------------------------------------------------------
  12.  
  13.     1.0  Introduction
  14.     2.0  General system requirements
  15.          refer to platform specific readme.s for details
  16.     3.0  Getting and starting the client
  17.          refer to platform specific readme.s for details
  18.     4.0  Upgrading from a client older than the 2.7xxx
  19.     5.0  Fetching and flushing work
  20.          5.1 over a TCP/IP network connection (and/or through a firewall)
  21.          5.2 via e-mail
  22.          5.3 to/from "remote" buffers that are serviced by another client
  23.     6.0  Help!
  24.  
  25.  1.0  Introduction ---------------------------------------------------
  26.  
  27.     Congratulations! This distributed.net client will make your computer
  28.     a part of the world's largest computer, distributed.net. The client
  29.     you have downloaded is capable of working on two of distributed.net's
  30.     ongoing projects: The brute-force decryption of a RC5-64 message, and
  31.     the brute force decryption of a DES message. The RC5-64 contest is a
  32.     long-term contest, which may take a couple of years to solve. The DES
  33.     contests, run twice a year, are short (refer to the DES contest
  34.     documentation for details). As a result, this client will work on DES
  35.     during DES contests, and switch back to RC5-64 when no DES contest is
  36.     running. No user intervention is required for this switchover.
  37.  
  38.  2.0  General system requirements ------------------------------------
  39.  
  40.     The system requirements for the client vary from platform to platform
  41.     and are detailed in the readme.* you should have received when you
  42.     downloaded the client.
  43.  
  44.     In general, all that is required is:
  45.     - a 32-bit processor
  46.     - one megabyte of free memory
  47.     - a method to update local buffers (fetch/flush work). See section 5.
  48.     - less than a megabyte of disk space (optional)
  49.  
  50.     The most important requirement for running the distributed.net client,
  51.     of course, is authorization to run the client on the computer that it
  52.     is installed on. This is not an issue with your home computer, but
  53.     many companies and schools have policies against running outside
  54.     programs on their computers. In cases where such a policy exists, ask
  55.     your system administrator BEFORE attempting to install the client.
  56.     It is very possible that he/she will like the idea, and choose to
  57.     install the client on all computers at that site. However, if the
  58.     answer is a 'no', do not push the issue. RSA's contest rules stipulate
  59.     that all clients must be run on authorized systems. The only support
  60.     we will give to unauthorized installations is help in uninstalling
  61.     them.
  62.  
  63.     Although there are a number of platforms that meet these requirements,
  64.     distributed.net cannot create or maintain clients for them all. The
  65.     prerequisites for creating a client for a platform are:
  66.     - a C++ compiler is available for that platform
  67.     - the compiler 'understands' 64bit quanta ('long long', 'wide' etc)
  68.     - distributed.net must have access to such a machine
  69.  
  70.     If you know of a platform that fulfills these requirements, and would
  71.     like to have a client for the platform, you can request it at
  72.     http://www.distributed.net/porting/
  73.  
  74.                                                                      
  75.  3.0  Getting and starting the client --------------------------------
  76.  
  77.     Clients are (barring a few exceptions) *only* available from
  78.     http://www.distributed.net/download/ or from ftp servers linked from
  79.     that page. They are occasionally available directly from distributed.net
  80.     coders in the #distributed channel on EFNet IRC. FreeBSD clients are
  81.     also available on FreeBSD distribution CDs.
  82.  
  83.     Once you have downloaded the client, it is a simple matter of getting
  84.     going. Simply unpack/unzip/unarc the archive you downloaded and fire
  85.     it up.
  86.  
  87.     If you have never run the client before, it will initiate the
  88.     menu-driven configuration. Save and quit when done, the
  89.     configuration file will be saved in the same directory as the
  90.     client. Then, simply restart the client. From that point on it will
  91.     use the saved configuration.
  92.  
  93.     Each configuration option is accompanied by a description that will
  94.     assist you in making the right decisions. Most default values can be
  95.     accepted as-is. Refer to the Help! section at the end of this document
  96.     for sources of assistance.
  97.  
  98.     A "Complete Step-by-Step Guide to Running Your First Client" is
  99.     available from http://distributed.net/faq/
  100.  
  101.     The client's configuration may be adjusted at any time by starting
  102.     the client with the -config switch. A list of other command line
  103.     options can be obtained by starting the client with -help.
  104.  
  105.  
  106.  4.0  Upgrading from a client older than the 2.7xxx ------------------
  107.  
  108.      If you are upgrading from a version of the client older than the
  109.      2.7xxx series, please stop the existing client, flush its buffers,
  110.      delete all of its files before installing the new client. Buffer
  111.      files formats have changed, and this will help prevent compatibility
  112.      problems. If you are sharing buffer files between multiple clients,
  113.      please make sure that the clients have compatible buffer formats.
  114.  
  115.                                                                           
  116.  5.0  Fetching and flushing work -------------------------------------
  117.  
  118.      The distributed.net client can fetch/flush work using 3 methods:
  119.      1) over a TCP/IP network connection
  120.      2) via e-mail
  121.      3) to/from "remote" buffers that are serviced by another client
  122.      In addition, it can share buffers with another client.
  123.  
  124.   5.1  Fetching and flushing work over a TCP/IP connection ---
  125.  
  126.      The client uses normal TCP/IP to communicate with keyservers.
  127.      It connects to port TCP port 2064 by default.
  128.  
  129.      distributed.net keyserver hostnames follow the following naming
  130.      convention: <us|euro|asia|aussie|jp>[port].v27.distributed.net .
  131.      The "port" is an optional field and may be either "80" or "23".
  132.      All other numbers cause the client to ignore it and automatically
  133.      select a hostname (see next para).
  134.  
  135.      It is generally not necessary to set a specific distributed.net
  136.      keyserver hostname. The client can automatically pick one in your
  137.      approximate vicinity if you leave it blank.
  138.  
  139.      If you do not connect through a firewall, or access to port 2064 is
  140.      permitted, you can leave all network-related options at their
  141.      default values.
  142.  
  143.      If you are connected through a strict firewall, port 2064 may
  144.      be blocked by default. There are a number of methods to allow your
  145.      client to fetch/flush...
  146.  
  147.      Configuring for firewall support is easy.
  148.      a) Enter the configuration
  149.      b) Select "Buffer and Buffer Update Options" menu
  150.         If "Disable buffer updates to/from a keyserver" is "on",
  151.         turn it off.
  152.      c) Select in the "Keyserver<->client connectivity" submenu.
  153.      Read on...
  154.  
  155.      If you have administrative access to the firewall machine, it is
  156.      probably easiest to use a "data pipe" or if you are using WinGate
  157.      or Internet Gate, using "direct port mapping". Both describe
  158.      essentially the same thing: A piece of software, either internal
  159.      to or separate from the firewall software itself, map ports on one
  160.      side of the firewall to ports on the other side. That is, the "data
  161.      pipe" listens for connections on a particular port on the inside of
  162.      the firewall, and forwards these to a predefined host/port on the
  163.      other side. Set the client's "keyserver host" and "keyserver port"
  164.      to point to the datapipe, and configure the datapipe to connect
  165.      to a distributed.net host (refer to the beginning of this section
  166.      for information on distributed.net host names).
  167.  
  168.      Another method requiring administrative access, but with great
  169.      advantages if you have a number of clients running inside the
  170.      firewall, is to use a distributed.net personal proxy on the
  171.      firewall machine. Personal proxies may be downloaded from
  172.      http://www.distributed.net/download/. Configuration guides for setting
  173.      up a personal proxy are beyond the scope of this document, but for
  174.      the client, configuration is the same as that for a "datapipe" (in
  175.      the section above).
  176.  
  177.      If your firewall permits access to telnet ports (port 23), or
  178.      to HTTP ports (port 80), simply set the "Keyserver port" to that
  179.      port. If it doesn't work, and you are sure that access to telnet
  180.      ports is permitted, it is possible that your firewall does not
  181.      cleanly handle 8bit data. Try again after enabling "Always use
  182.      UUEncoding". UUE converts the 8bit data that that the client tries
  183.      to send into 7bit data, permitting buffer updates to work even when
  184.      8bit data is not handled cleanly. This situation does not happen
  185.      very often, but it does occur now and then.
  186.  
  187.      In addition to these "native" connectivity methods, the client
  188.      also has HTTP and SOCKS proxy support:
  189.  
  190.      Select the "Firewall/proxy protocol" option from the menu and...
  191.  
  192.      For SOCKS support:
  193.  
  194.         Both SOCKS[4] and SOCKSv5 are supported. If you are unsure about
  195.         which to use, try SOCKS4 first. Now, edit the "HTTP/SOCKS host" and
  196.         "HTTP/SOCKS proxy port" and ensure that they point to the SOCKS
  197.         proxy you will be communicating through. If you must use a SOCKS
  198.         userid/password, enter it in the appropriate field as well. (Note:
  199.         only SOCKS5 uses passwords, so that field is invisible if you
  200.         select SOCKS4).
  201.  
  202.      For HTTP proxy support:
  203.  
  204.         The most compatible firewall communications method is to select
  205.         "HTTP proxy" support. Next, enter the name/address of the HTTP
  206.         proxy in the "HTTP/SOCKS proxy host" field and the port number
  207.         of the HTTP proxy in the "HTTP/SOCKS proxy port" field. If you
  208.         cannot connect to a host without explicitely specifying one,
  209.         select one based on the naming conventions described in the
  210.         beginning of this section.
  211.  
  212.      Firewall software Known to work with the distributed.net client.
  213.  
  214.      Software              Platform    Method       Download from
  215.      --------------------- ----------- ------------ -------------------
  216.      Squid                 Unix        HTTP Proxy   http://squid.nlanr.net
  217.      Internet Gate         OS/2        Port Mapping
  218.      MS Proxy Server       WinNT       HTTP Proxy
  219.      Novell BorderManager  NetWare     HTTP Proxy
  220.      Purveyor HTTP Proxy   VMS/NetWare HTTP Proxy
  221.      Wingate 2.x           Win32       HTTP Proxy   http://www.wingate.com
  222.                                        Port Mapping
  223.      AltaVista 97 proxy    Unix/Win32  HTTP
  224.  
  225.   5.2  Flushing and fetching via e-mail ----
  226.  
  227.      If you can not get your client to flush/fetch directly (due to a
  228.      very stringent firewall), or are running a networkless client,
  229.      such as the MS-DOS client, there is one last way for your client
  230.      to fetch and flush: e-mail.
  231.  
  232.      1. Send a message to fetch@distributed.net; an auto-responder
  233.         will reply with information on the proper options to use.
  234.      2. Once you know the correct format, send a correctly formatted
  235.         message in. You should quickly receive a message back with
  236.         the specified amount of work attached as "buff-in.rc5".
  237.      3. Stop the client.
  238.      4. Save the file to the directory from which you are running the
  239.         client.
  240.      5. Restart the client.
  241.  
  242.      Once your client has completed the work provided to it, you may
  243.      send in back via e-mail as follows:
  244.  
  245.      1. Create a message to flush@distributed.net with the file
  246.         "buff-out.rc5" attached as a MIME/base64 or UUencoded (UUE) file.
  247.         You will be send a "receipt" of the proper flushing within a few
  248.         minutes.
  249.      2. Delete the buff-out.rc5 file so that you do not accidently
  250.         send part of its contents twice.
  251.  
  252.   5.3  Flushing and fetching using remote buffers ----
  253.  
  254.      "Remote buffers" are simply buffers that are serviced by another
  255.      client. When fetching/flushing from/to remote buffers, the client
  256.      opens the remote files and moves what it needs from/to its "local"
  257.      buffer files. The difference betwees "remote buffers" and "shared
  258.      buffers" is of course the fact that with "remote buffers" each
  259.      client has its own files. Lock contention is thus minimized and
  260.      they can work without the user having to worry about the network
  261.      (if one exists) between them failing.
  262.                                                                      
  263.  6.0  Help! ----------------------------------------------------------
  264.  
  265.      If you've having a problem with the client, the first place you
  266.      should visit is http://www.distributed.net/download/ to
  267.      see if a newer version is available. It is likely that a given
  268.      bug you have been experiencing will be fixed by the new version.
  269.  
  270.      If you are still having problems, here are a few places you can
  271.      find help (in order of responsiveness).
  272.  
  273.      - The quickest way to get question(s) answered about the operation
  274.        and setup of the client is to connect to an EFNet IRC server and
  275.        join the channel #distributed. Although there are dozens of EFNet
  276.        servers world-wide, the following should give you a starting point:
  277.        In the U.S: irc.cs.cmu.edu:6667, ingenue.eecs.berkeley.edu:6667,
  278.        piglet.cc.utexas.edu:6667. In Europe: irc.homelien.no:6667,
  279.        irc.df.lth.se:6667, or efnet.demon.co.uk:6667
  280.  
  281.      - If you need further assistance with client use or operation, refer
  282.        to the the list of "Frequently asked Questions" (FAQs) available
  283.        online at http://www.distributed.net/faq/  Documents cover every
  284.        aspect of running a client including "The Complete Step by Step
  285.        Guide to Running Your First Client", "How To Join A Team", and
  286.        the popular "Statistics Server FAQ".
  287.  
  288.      - If you don't mind your mailbox receiving a few messages a day,
  289.        you may consider subscribing to the general client mailing list
  290.        at <rc5@lists.distributed.net> (To subscribe to the mailing list,
  291.        send a message to <majordomo@lists.distributed.net> with
  292.        "subscribe rc5" as the message text).
  293.  
  294.      - More user support is available from <help@distributed.net>
  295.        as well as from our regional support representatives listed at
  296.        http://www.distributed.net/regional/index.html
  297.  
  298.      - If you believe you have found a bug in the client or would like
  299.        to make a suggestion, please use the bug tracking pages at
  300.        http://www.distributed.net/bugs/
  301.        DO NOT FORGET TO PROVIDE THE **FULL** VERSION NUMBER OF YOUR CLIENT
  302.        Don't fret if you don't get a response right away - porters are
  303.        usually very busy and it may take weeks before they get around to
  304.        answering your message.
  305.  
  306.