Annotation of pgp/doc/setup.doc, revision 1.1.1.2

1.1.1.2 ! root        1:                   Pretty Good Privacy version 2.3
1.1       root        2:                 Installation Guide by Perry Metzger
1.1.1.2 ! root        3:                    Edited for 2.3 by Colin Plumb
1.1       root        4: 
                      5: 
                      6: How to Install PGP
                      7: ==================
                      8: 
                      9: The first question is, what platform are you on?
                     10: 
1.1.1.2 ! root       11: The base PGP 2.3 distribution runs on several varieties of Unix, MS-DOS
        !            12: and VAX VMS.  Ports can be expected shortly to the Atari, Amiga, Macintosh,
        !            13: and possibly other systems.  Naturally, installation instructions differ
        !            14: depending on your hardware.  Separate instructions are provided here for
        !            15: MSDOS and Unix.
1.1       root       16: 
                     17: No matter what the machine you are on, though, do this...
                     18: 
                     19: STEP 1:
                     20: READ THE DOCUMENTATION.  At least read Volume I of the PGP User's
                     21: Guide.  Cryptography software is easy to misuse, and if you don't use
                     22: it properly much of the security you could gain by using it will be
                     23: lost!  You might also be unfamiliar with the concepts behind public
                     24: key cryptography; the manual explains these ideas.  Even if you are
                     25: already familiar with Public Key Cryptography, it is important that
                     26: you understand the various security issues associated with using
                     27: PGP.  It may not be important to read the fine print on a box of
                     28: breakfast cereal, but it may be crucial to read the label of a
                     29: prescription drug.  Cryptography software is like pharmaceuticals-- 
                     30: so read the manual!
                     31: 
                     32: See the section below for your system's particular installation
                     33: instructions.
                     34: 
                     35: If you do not have any of these systems, you will either have to port
                     36: the sources to your machine or find someone who has already done so.
                     37: 
                     38: ######################################################################
                     39: For MSDOS:
                     40: 
                     41: PGP is distributed in a compressed archive format, which keeps all
                     42: the relevant files grouped together, and also saves disk space and 
                     43: transmission time.
                     44: 
1.1.1.2 ! root       45: The current version, 2.3, is archived with the ZIP utility, and the
        !            46: PGP executable binary release system is in a file named PGP23.ZIP.
1.1       root       47: This contains the executable program, the user documentation, and a
                     48: few keys and signatures.  There is also a second file available
1.1.1.2 ! root       49: containing the C and assembly source code, called PGP23SRC.ZIP; unless
1.1       root       50: you are a programmer interested in cryptography, it is probably of
                     51: little interest to you.  It may or may not be available from the
1.1.1.2 ! root       52: source from which you get PGP23.ZIP; if not, and you want it, see the
1.1       root       53: Licensing and Distribution section of the PGP User's Guide.
                     54: 
                     55: You will need PKUNZIP version 1.1 or later to uncompress and split
1.1.1.2 ! root       56: the PGP23.ZIP archive file into individual files.  PKUNZIP is
1.1       root       57: shareware and is widely available on MSDOS machines.
                     58: 
                     59: Create a directory for the PGP files.  For this description, let's
                     60: use the directory C:\PGP as an example, but you should substitute
                     61: your own disk and directory name if you use something different. 
                     62: Type these commands to make the new directory:
                     63: 
                     64:    c:
                     65:    md \pgp
                     66:    cd \pgp
                     67: 
1.1.1.2 ! root       68: Uncompress the distribution file PGP23.ZIP to the directory.  For
1.1       root       69: this example, we will assume the file is on floppy drive A - if not,
                     70: substitute your own file location.
                     71: 
1.1.1.2 ! root       72:    pkunzip -d a:pgp23
        !            73: 
        !            74: If you omit the -d flag, all the files in the doc subdirectory will
        !            75: be deposited in the pgp directory.  This merely causes clutter.
1.1       root       76: 
                     77: 
                     78: Setting the Environment
                     79: -----------------------
                     80: 
                     81: Next, you can set an MSDOS "environment variable" to let PGP know
                     82: where to find its special files, in case you use it from other than
                     83: the default PGP directory.  Use your favorite text editor to add the
                     84: following lines to your AUTOEXEC.BAT file (usually on your C: drive):
                     85: 
                     86:    SET PGPPATH=C:\PGP
                     87:    SET PATH=C:\PGP;%PATH%
                     88: 
                     89: Substitute your own directory name if different from "C:\PGP".
                     90: 
1.1.1.2 ! root       91: The CONFIG.TXT file contains various preferences.  You can change
        !            92: the language PGP operates in, and the character set it uses.  The
        !            93: IBM PC's default character set, "Code Page 850" will be used if the
        !            94: line "charset = cp850" appears in the config.txt file.  You probably
        !            95: want to add that line.
        !            96: 
1.1       root       97: Another environmental variable you should set in MSDOS is "TZ", which
                     98: tells MSDOS what time zone you are in, which helps PGP create GMT
                     99: timestamps for its keys and signatures.  If you properly define TZ in
                    100: AUTOEXEC.BAT, then MSDOS gives you good GMT timestamps, and will
                    101: handle daylight savings time adjustments for you.  Here are some
                    102: sample lines to insert into AUTOEXEC.BAT, depending on your time
                    103: zone:
                    104: 
                    105: For Los Angeles:  SET TZ=PST8PDT
                    106: For Denver:       SET TZ=MST7MDT
                    107: For Arizona:      SET TZ=MST7
                    108:    (Arizona never uses daylight savings time)
                    109: For Chicago:      SET TZ=CST6CDT
                    110: For New York:     SET TZ=EST5EDT
                    111: For London:       SET TZ=GMT0BST
                    112: For Amsterdam:    SET TZ=MET-1DST
                    113: For Moscow:       SET TZ=MSK-3MSD
                    114: For Aukland:      SET TZ=NZT-13
                    115: 
                    116: Now reboot your system to run AUTOEXEC.BAT, which will set up 
                    117: PGPPATH and TZ for you.
                    118: 
                    119: 
                    120: 
                    121: Generating Your First Key
                    122: -------------------------
                    123: 
                    124: One of the first things you will want to do to really use PGP (other
                    125: than to test itself) is to generate your own key.  This is described
                    126: in more detail in the "RSA Key Generation" section of PGP User's
                    127: Guide.  Remember that your key becomes something like your written
                    128: signature or your bank card code number or even a house key - keep it
                    129: secret and keep it secure!  Use a long, unguessable pass phrase and
                    130: remember it.  Right after you generate a key, put it on your key
                    131: rings and copy your secret keyring (SECRING.PGP) to a blank floppy
1.1.1.2 ! root      132: and write protect the floppy.
        !           133: 
        !           134: You might wish to generate a short test key to play around with PGP
        !           135: for a little bit and see how it works, or even more than one so
        !           136: you can pretend to be sending messages between two different people.
        !           137: Since you won't be guarding any secrets, this can be short and have
        !           138: a simple pass phrase.  But when you generate your permanent key,
        !           139: that you intend to give to others so they can send secure messages
        !           140: to you, be much more careful.
1.1       root      141: 
                    142: After you generate your own key pair, you can add a few more public
                    143: keys to your key ring.  A collection of sample public keys is
                    144: provided with the release in the file KEYS.ASC.  To add them to your
                    145: public key ring, see the PGP User's Guide, in the section on adding
                    146: keys to your key ring.
                    147: 
                    148: 
                    149: ######################################################################
                    150: For UNIX:
                    151: 
                    152: You likely will have to compile PGP for your system; to do this, first
                    153: make sure the unpacked files are in the correct unix textfile format
1.1.1.2 ! root      154: (the files in pgp23src.zip are in MSDOS CRLF format, so for unix you
        !           155: must unpack with "unzip -a"; the tar file pgp23.tar.Z uses normal Unix
        !           156: line feed conventions).  Then copy the file "makefile.unx" in the
1.1       root      157: distribution to "Makefile".
                    158: 
                    159: If you don't have an ANSI C compiler you will need the unproto package
                    160: written by Wietse Venema.  unproto was posted on comp.sources.misc and
                    161: can be obtained from the various sites that archive this newsgroup
                    162: (volume 23: v23i012 and v23i013) or ftp.win.tue.nl file:
                    163: /pub/programming/unproto4.shar.Z  Read the file README in the unproto
                    164: distribution for instructions on how to use unproto.  The unix makefile
                    165: for pgp (makefile.unx) contains a few targets for compliling with
                    166: unproto, these assume you have unpacked unproto in a subdirectory
                    167: "unproto" in the pgp "src" directory.
                    168: 
                    169: 
                    170: Then...
                    171: 
                    172: type:
                    173:   "make sungcc"   for Sun with GNU gcc
                    174:   "make suncc"    for Sun with cc and unproto
                    175:   "make sysv_386" for SVR4 386 with asm primitives
                    176:   "make x286"     for XENIX/286 with asm primitives and unproto
                    177:   "make ultrix"   for DEC 4.2BSD Ultrix with gcc
                    178:   "make rs6000"   for RS6000 AIX
                    179: 
                    180: There are more targets in makefile.unx.  If your system doesn't have
                    181: a target in makefile.unx you will have to edit the makefile, make
                    182: sure you compile for the correct byte order for your system: define
                    183: HIGHFIRST if your system is big-endian (eg. Motorola 68030).
                    184: There are also some platform-specific parameters in the include file
                    185: "platform.h".  Some platforms may have to modify this file.
                    186: 
                    187: If all goes well, you will end up with an executable file called "pgp".
                    188: 
                    189: Before you install pgp, run these tests:
                    190: (do not create your real public key yet, this is just for testing pgp)
                    191: 
                    192: - create a public/secret key pair (enter "test" as userid/password):
                    193:        pgp -kg
                    194: 
                    195: - add the sample keys from the file "keys.asc" to the public keyring:
                    196:        pgp -ka keys.asc
                    197:   pgp will ask if you want to sign the keys you are adding, answer yes
                    198:   for at least one key.
                    199: 
                    200: - do a keyring check:
                    201:        pgp -kc
                    202: 
                    203: - encrypt pgpdoc1.txt:
                    204:        pgp -e pgpdoc1.txt test -o testfile.pgp
                    205: 
                    206: - decrypt this file:
                    207:        pgp testfile.pgp
                    208: 
                    209: this should produce the file "testfile" compare this file with pgpdoc1.txt
                    210: 
                    211: If everything went well, install pgp in a bin directory.
                    212: 
                    213: Place the documentation, pgpdoc1.txt and pgpdoc2.txt somewhere where
                    214: you can reasonably read it; since it's for you, not the software, the
                    215: location doesn't really matter.
                    216: 
                    217: Place the man page (pgp.1) in an appropriate spot.  If you don't know
                    218: anything about how man pages work, you can make the man page look
                    219: human readable yourself by typing "nroff -man pgp.1 >pgp.man" and
                    220: reading "pgp.man".
                    221: 
                    222: Create a subdirectory somewhere in your home directory hierarchy to
                    223: hold your public and private key rings and anything else pgp might
                    224: need (like the language.txt file).  You must set the environment
                    225: variable "PGPPATH" to point to this place before you use the system.
                    226: Copy the files "language.txt", "config.txt", and the ".hlp" files from
                    227: the distribution into this subdirectory.
                    228: 
1.1.1.2 ! root      229: Tell PGP the character set and language you wish to use in the config.txt
        !           230: file.  If you have a terminal that only displays 7-bit ASCII, use
        !           231: "charset=ascii" to display an approximation (accents are omitted) of
        !           232: extended characters.
        !           233: 
1.1       root      234: > IMPORTANT: This directory cannot be shared!  It will contain your <
                    235: > personal private keys!                                            <
                    236: 
                    237: >> IMPORTANT: Please read the sections in the man page and manual  <<
                    238: >> about vulnerabilities before even THINKING about using this     <<
                    239: >> software on a multi-user machine!!!!                            <<
                    240: 
                    241: Now, if you haven't done so yet, GO READ THE MANUAL.
                    242: 
                    243: 
                    244: ######################################################################
                    245: For VMS:
                    246: 
1.1.1.2 ! root      247: Read the file readme.vms in the doc subdirectory
1.1       root      248: 
                    249: ######################################################################
                    250: For Amiga:
                    251: 
1.1.1.2 ! root      252: The standard distribution does not yet compile directly on an Amiga.
        !           253: If you have SAS C, you might try the makefile.amy as a starting place.
1.1       root      254: 
                    255: ######################################################################
                    256: For Atari:
                    257: 
1.1.1.2 ! root      258: The standard distribution does not yet compile directly on an Atari ST.
1.1       root      259: 
                    260: ######################################################################

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.