home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / epmpgp.zip / GCPPGPFE.Doc < prev    next >
Text File  |  1995-10-22  |  21KB  |  442 lines
  1.                                 GCPPGPFE
  2.                  Gibbon Computer Products PGP Front-End
  3.                                Version 1.1
  4.  
  5.                         Copyright (c) 1994, 1995
  6.                     by Gibbon Computer Products, Inc.
  7.  
  8.                       Written by John C. Frickson
  9.  
  10.  
  11.  
  12.  
  13. Sections In This User Manual:
  14.  
  15.         Installation
  16.         Configuring
  17.         Multiple Versions of EPM
  18.         Using GCPPGPFE
  19.         Security Concerns
  20.         Bug Reports and Comments
  21.         Frequently Asked Questions
  22.         Mailing Lists
  23.         Contact Information
  24.         Legal Stuff
  25.         Public Key for John C. Frickson
  26.  
  27.  
  28. Installation
  29. ------------
  30.    The distribution file (GCPPGP11.ZIP) includes an inner zip file
  31.    called GCPPGPFE.ZIP.  Unzip the GCPPGPFE.ZIP file into a temporary
  32.    directory.  The source code for the front end and several precompiled
  33.    macros will be extracted:
  34.  
  35.       GCPPGPFE.E     E Source code
  36.       GCPPGPFE.551   Macro compiled for EPM version 5.51a
  37.       GCPPGPFE.600   Macro compiled for EPM version 6.00c
  38.       GCPPGPFE.602   Macro compiled for EPM version 6.02
  39.       GCPPGPFE.603   Macro compiled for EPM version 6.03
  40.  
  41.    Rename the appropriate macro to GCPPGPFE.EX.  For example, if you are
  42.    using the version of EPM that comes with OS/2 2.11 or Warp, you would:
  43.  
  44.         REN GCPPGPFE.551 GCPPGPFE.EX
  45.  
  46.    Put the GCPPGPFE.EX file in a directory specified in either EPMPATH
  47.    or PATH.  These paths are where EPM looks for PROFILE.ERX (described
  48.    below) and *.EX files.  Most *.EX files are in the \OS2\APPS
  49.    directory.
  50.  
  51.  
  52. Configuring
  53. -----------
  54.    GCP PGP Front-End requires that the PGPPATH environment variable is
  55.    set.  This points to the directory that contain your keyrings,
  56.    RANDSEED.BIN and CONFIG.TXT.  The MYNAME, TMP, PUBRING, SECRING and
  57.    RANDSEED settings in CONFIG.TXT will be used if they are set.  Also,
  58.    the PGPPASS environment variable will be used for your passphrase if
  59.    it is set.
  60.  
  61.    Starting with the 2.6.2 version of PGP, the configuration file can be
  62.    config.txt, pgp.ini, or .pgprc so the GCP PGP Front-End will look for
  63.    each file.
  64.  
  65.    Make sure NR/2, PMMail, or any other applications are set up to use
  66.    the EPM editor.
  67.  
  68.    In NR/2, this is done by selecting then "Configure" menu on the main
  69.    menu bar, and the "Editor..." menu item, or by pressing CTRL+SHIFT+D.
  70.    A dialog box will come up where you can enter the editor name and
  71.    arguments.  Specify "x:\OS2\APPS\EPM.EXE" for the editory name where
  72.    x: is your boot drive.  In the "arguments" entry field, enter "%/M".
  73.  
  74.    Now, you need to tell EPM about GCPPGPFE.  There are three ways to do
  75.    this.  I call these three ways the "On the Fly", "Automatic", and
  76.    "Linked In" methods.
  77.  
  78.    On the Fly:  You would use this method to test GCPPGPFE, or if you
  79.       didn't want it always available.  To do this, whenever you want to
  80.       use PGP from within the EPM editor, bring up the "Command Dialog"
  81.       by pressing CTRL+I.  Then enter the command "LINK GCPPGPFE".  The
  82.       PGP menu will appear on the menu bar, and you can do whatever it
  83.       is you want.
  84.  
  85.    Automatic:  The EPM editor is highly customizable.  One of the ways
  86.       it can be customized without having to recompile the EPM.EX file,
  87.       is to use a Profile.  The profile must be named "PROFILE.ERX" and
  88.       be in a directory specified by either EPMPATH or PATH such as the
  89.       \OS2\APPS directory. This is actually a REXX script with access
  90.       to certain EPM variables and functions.  For our purposes, a
  91.       very simple file can be created that looks like this:
  92.  
  93.          /* PROFILE.ERX - REXX needs a comment on the first line */
  94.          'LINK GCPPGPFE'
  95.  
  96.       That's all there is to it -- only two lines.  But we're not quite
  97.       done yet.  EPM doesn't automatically check for a profile.  Start
  98.       EPM and bring up the "Command Dialog" (press CTRL+I) and enter
  99.       "profile on".  Then select the "Save Options" menu item on the
  100.       "Options" menu.  Exit EPM and restart it.  It should now read your
  101.       profile and link in GCPPGPFE, making the PGP menu available.
  102.  
  103.    Linked In:  GCPPGPFE can be built into the EPM.EX file, which is the
  104.       controlling file for EPM.  To do this, you need the EPM toolkit
  105.       (available from software.watson.ibm.com or ftp.cdrom.com).
  106.  
  107.       Put GCPPGPFE.E into the directory where the *.E files are.  Add a
  108.       line to MYCNF.E that reads
  109.            tryinclude 'gcppgpfe.e'
  110.       Now recreate EPM.EX by issue the command "ETPM EPM".  Copy the
  111.       resulting EPM.EX file to \OS2\APPS and you're done.
  112.  
  113.       Due to limitations in EPM versions prior to 6.x, this WILL NOT
  114.       work.  The "Linked In" approach will only work with EPM 6.x.
  115.  
  116.    NOTE: If you use the "Automatic" approach and use LaMail for email,
  117.    you will need to turn "profile on" twice.  Once for the usual EPM,
  118.    and a second time for LAMail.  LAMail has its own configuration for
  119.    EPM, so you need to turn "profile on" there, as well.  Just view or
  120.    create a note.  That will bring up the EPM editor under LAMails control.
  121.    Bring up the "Command Dialog" and enter the "profile on" command.
  122.  
  123.  
  124. Multiple Versions of EPM
  125. ------------------------
  126.    If you have more than one version of EPM, for example 5.51a that comes
  127.    with Warp, and 6.03, you need to make some special arrangements.  You
  128.    can either use the "Linked In" method described above, or you can
  129.    include multiple versions of this front end in PROFILE.ERX, and give
  130.    them unique names.  For example, my PROFILE.ERX looks like this:
  131.  
  132.       /* */
  133.       'link gcppgpf5'
  134.       'link gcppgpf6'
  135.  
  136.    This way, EPM attempts to link both macros.  You will usually get a
  137.    message about an invalid EX file when EPM tries to link the _other_
  138.    macro.  But the one that corresponds to the version of EPM being run
  139.    will link successfully.
  140.  
  141.    This is especially handy if you use EPM 6.03 for most things, but
  142.    need to use EPM 5.51a in conjunction with LaMail.
  143.  
  144.  
  145. Using GCPPGPFE
  146. --------------
  147.    Once you have THE GCP PGP Front-End installed into EPM using one of
  148.    the three methods described above, you will see a "PGP menu on the
  149.    menu bar just before the "Help" menu.  This menu is your interface to
  150.    PGP.
  151.  
  152.    Since this is a non-interactive interface, there are some things that
  153.    cannot be done.  A prime example of this is encryption and signature
  154.    checking. These functions can only operate against a public key in
  155.    PUBRING.PGP.  If you want to use a key in another keyring, it
  156.    currently cannot be done.
  157.  
  158.    The menu items and their functions are described next.
  159.  
  160.    Encrypt or Sign ->           This is a sub-menu for encryption and
  161.                                 signing functions
  162.       Encrypt                   This will encrypt the selected text and
  163.                                 REPLACE it in the document (PGP -e)
  164.       Sign Text                 This will sign the selected text, and
  165.                                 insert the signature and the "Begin" and
  166.                                 "End" delimeters into the document.  DO
  167.                                 NOT MODIFY TEXT BETWEEN THE DELIMETERS
  168.                                 OR A SIGNATURE CHECK WILL FAIL! (PGP -s)
  169.       Encrypt and Sign          This will sign the selected text,
  170.                                 encrypt it, and REPLACE it in the
  171.                                 document (PGP -se)
  172.       Conventional Encryption   This will encrypt the selected text
  173.                                 using conventional encryption and
  174.                                 REPLACE it in the document (PGP -c)
  175.    Include Key or Fingerprint-> This is a sub-menu for extracting keys
  176.                                 or fingerprints to include.
  177.       Include Public Key        This will extract a public key from the
  178.                                 currently selected public key ring, and
  179.                                 insert it into the document at the
  180.                                 current cursor position (PGP -kx)
  181.       Include key Fingerprint   This will extract a fingerprint from the
  182.                                 currently selected public key ring, and
  183.                                 insert it into the document at the
  184.                                 current cursor position (PGP -kvc)
  185.    Decrypt Message              This will decrypt an encrypted message
  186.                                 and display the plain text in a separate
  187.                                 EPM window.
  188.    Check Signature              This will check a PGP signed message for
  189.                                 a valid signature.  The signer's public
  190.                                 key MUST be in PUBRING.PGP or the check
  191.                                 will fail.
  192.    Change Defaults              This allows you to change the default
  193.                                 settings for ASCII Armor, Text mode, and
  194.                                 Clearsig.  GCP PGP Front-End sets these
  195.                                 three to "ON" by default.  If, for some
  196.                                 strange reason, you want any of these
  197.                                 switches off, this will do it.
  198.                                 NOTE: Turning these switches off only means
  199.                                 that GCP PGP Front-End will not set them
  200.                                 "ON".  Turning these off will cause PGP to
  201.                                 use the settings you have in CONFIG.TXT.
  202.    Clear Password               This will remove the passphrase used to
  203.                                 access your secret keyring from memory.
  204.                                 It is a good idea to do this if you are
  205.                                 going to be away from your computer while
  206.                                 EPM or LAMail are running.
  207.    Select Keyrings ->           This is a sub-menu for selecting
  208.                                 keyrings.  IMPORTANT NOTE: Selecting a
  209.                                 different keyring will NOT make that
  210.                                 keyring the default in all cases, such
  211.                                 as signature checking and encryption!
  212.       Secret Keyring            This will let you change which secret
  213.                                 keyring will be used for various
  214.                                 operations.  The default is SECRING.PGP.
  215.       Public Keyring            This will let you change which public
  216.                                 keyring will be used for various
  217.                                 operations.  The default is PUBRING.PGP.
  218.    View Keyring ->              This is a sub-menu for operations
  219.                                 involving the listing of information
  220.                                 from your keyrings.  NOTE: The public
  221.                                 key ring or secret key ring used by
  222.                                 these functions CAN be changed using the
  223.                                 "Select Keyrings" menu.
  224.       Pubring Normal            This will list selected keys from the
  225.                                 currently active public key ring.
  226.                                 (PGP -kv)
  227.       Pubring Verbose           This will list selected keys and
  228.                                 signatures from the currently active
  229.                                 public key ring. (PGP -kvv)
  230.       Pubring Trust/Validity    This will list selected keys from the
  231.                                 currently active public key ring, and
  232.                                 also display the trust and validity for
  233.                                 each key.  (PGP -kc)
  234.       Pubring Fingerprint       This will list selected key fingerprints
  235.                                 from the currently active public key
  236.                                 ring. (PGP -kvc)
  237.       Secring Normal            This will list selected keys from the
  238.                                 currently active secret key ring.
  239.                                 (PGP -kv)
  240.       Secring Verbose           This will list selected keys and
  241.                                 signatures from the currently active
  242.                                 secret key ring. (PGP -kvv)
  243.       Secring Fingerprint       This will list selected key fingerprints
  244.                                 from the currently active secret key
  245.                                 ring. (PGP -kvc)
  246.    Key Management ->            This is a sub-menu for key management
  247.                                 operations.  NOTE: The public key ring
  248.                                 or secret key ring used by these
  249.                                 functions CAN be changed using the
  250.                                 "Select Keyrings" menu.
  251.       Add Key to Pubring        This will add any public keys in the
  252.                                 current document to PUBRING.PGP, or the
  253.                                 currently selected public keyring.
  254.                                 (PGP -ka)
  255.                                 NOTE: If any keys on your keyring have
  256.                                 older signatures (identified as "malformed
  257.                                 or obsolete" when you do a PGP -kc),
  258.                                 these WILL BE DELETED when you add new
  259.                                 keys or signatures!!
  260.  
  261.       The rest of the menu items under Key Management all start with
  262.       (S).  This indicates that these commands are invoked using an
  263.       OS/2 Shell.  When selected, an OS/2 Window will be displayed
  264.       and you can interact with PGP.  You could just as easily run
  265.       these functions yourself from an OS/2 Window, since they have
  266.       no effect whatsoever on any document being edited or displayed
  267.       in an EPM window, but I included them here for convenience and
  268.       completeness.
  269.  
  270.    HELP ->                      This is the Help sub-menu
  271.       PGP Help                  This will invoke PGP with the -h option,
  272.                                 and display the results in an EPM
  273.                                 window
  274.       About Gibbon PGP          This will bring up an "About" dialog box
  275.  
  276.  
  277. Security Concerns
  278. -----------------
  279.    There are a few security issues here that should be addressed.
  280.  
  281.    1)  GCP PGP Front-End makes use of temporary files for processing.
  282.        These files are deleted, but can be recovered.  If you want to
  283.        make sure noone is able to read your mail, you probably want to
  284.        set up a VDISK and point the TMP variable to the VDISK.
  285.  
  286.    2)  If GCP PGP Front-End needs your pass phrase, it asks for it in a
  287.        dialog box.  The pass phrase is entered IN THE CLEAR in an entry
  288.        field.  I have been unable to find any way to make an entry field
  289.        put up by an E function in EPM to be either non-display or to
  290.        show asterisks.  Make sure NOONE is watching when you enter your
  291.        passphrase.  An alternative is to set the PGPPASS environment
  292.        variable, but that's not very secure, either.
  293.  
  294.        With release 1.1, this is only a problem in EPM 5.51a.  The
  295.        macros for EPM 6.x can set the input dialog to display asterisks
  296.        ('*') when you enter the passphrase.
  297.  
  298.  
  299. Bug Reports and Comments
  300. ------------------------
  301.    If you run across any bugs, or have comments or requests, send them
  302.    to me at support@gibbon.com.  All mail will be replied to.  Bug
  303.    reports are encouraged.  How can I fix it if I don't know it's broke?
  304.  
  305.    Any comments or requests for features or functionality are also
  306.    encouraged.  How can I make it work better if I don't know what you
  307.    want?
  308.  
  309.  
  310. Frequently Asked Questions
  311. --------------------------
  312.  
  313.    FAQs that cover questions and problems that arise can be found at
  314.    http://www.gibbon.com/faq and at ftp://ftp.gibbon.com/pub/gcp/faq.
  315.    If you have a problem or question, please check for a FAQ answer
  316.    before you contact Gibbon Computer Products, Inc. for support.
  317.  
  318.  
  319. Mailing Lists
  320. -------------
  321.  
  322.    There are two mailing lists you can subscribe to.
  323.  
  324.    The gibbon_announce mailing list is used by Gibbon Computer Products,
  325.    Inc. for official announcements.  This includes announcements of new
  326.    sofware packages, beta test programs, bugs, etc.  You can subscribe
  327.    to this list by sending email to gibbon_announce-request@gibbon.com
  328.    and put the word "subscribe" (without the quotes) in the body of the
  329.    message, or sending email to marjodomo@gibbon.com and put the words
  330.    "subscribe gibbon_announce" in the body of the message.
  331.  
  332.    The gibbon mailing list is an open, unmoderated list.  This can be
  333.    used for people to ask questions, report bugs, help each other with
  334.    problems, complain about GCP products, praise GCP products, just about
  335.    anything.  The only requirement is that the post should somehow relate
  336.    to Gibbon Computer Products, Inc., GCP software, GCP facilities, or
  337.    GCP personnel.  You can subscribe to this list by sending email to
  338.    gibbon_announce-request@gibbon.com and put the word "subscribe"
  339.    (without the quotes) in the body of the message, or sending email to
  340.    marjodomo@gibbon.com and put the words "subscribe gibbon_announce"
  341.    in the body of the message.
  342.  
  343.  
  344. Contact Information
  345. -------------------
  346.    EMail:       support@gibbon.com
  347.                 frickson@gibbon.com
  348.  
  349.    Postal Mail: Gibbon Computer Products, Inc.
  350.                 9864 Palm St. NW
  351.                 Coon Rapids, MN 55433
  352.  
  353.    Telephone:   +1 612 754 6557
  354.  
  355.    Finger:      support@gibbon.com
  356.                 info@gibbon.com
  357.                 frickson@gibbon.com
  358.                 frickson@guenon.gibbon.com
  359.  
  360.    Talk:        frickson@gibbon.com
  361.                 frickson@guenon.gibbon.com
  362.  
  363.    Information about other GCP products can be obtained as follows:
  364.  
  365.    FTP:         ftp://ftp.gibbon.com/pub/gcp/catalog
  366.    WWW:         http://www.gibbon.com/catalog/
  367.  
  368.    Two mailing lists are also available.
  369.  
  370.  
  371. Legal Stuff
  372. -----------
  373.    Copyright and License
  374.  
  375.       This document (GCPPGPFE.DOC), the program files GCPPGPFE.*
  376.       and the source file (GCPPGPFE.E) ("the software") are
  377.       copyrighted by the author.  The copyright owner hereby
  378.       licenses you to use the sofware given these restrictions:
  379.  
  380.       1)  No changes may be made to either the software or the
  381.           documentation.
  382.  
  383.       2)  The software package must be distributed in its entirety.  The
  384.           package includes: GCPPGPFE.*, GCPPGPFE.DOC and GCPPGPFE.E.
  385.  
  386.       3)  No fee or charge is to be collected for distribution in excess
  387.           of $5.00US to cover the costs of materials, handling, postage,
  388.           and general overhead without express written permission from the
  389.           author.
  390.  
  391.  
  392.  
  393.    WARRANTY DISCLAIMER
  394.  
  395.       Gibbon Computer Products makes no warranty of any kind, either
  396.       express or implied, including but not limited to implied
  397.       warranties of merchantability and fitness for a particular
  398.       purpose, with respect to this software and accompanying
  399.       documentation.
  400.  
  401.       IN NO EVENT SHALL GIBBON COMPUTER PRODUCTS BE LIABLE FOR ANY
  402.       SPECIAL, INCIDENTAL, CONSEQUENTIAL, INDIRECT OR SIMILAR DAMAGES
  403.       (INCLUDING DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
  404.       INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY
  405.       LOSS) ARISING OUT OF THE USE OF, MISUSE OF OR INABILITY TO USE
  406.       THIS PROGRAM, EVEN IF GIBBON COMPUTER PRODUCTS HAS BEEN ADVISED
  407.       OF THE POSSIBILITY OF SUCH DAMAGES.
  408.  
  409.  
  410. Public Key for John C. Frickson
  411. -------------------------------
  412.  
  413. PGP Public Key Fingerprint:
  414.  
  415. Type bits/keyID    Date       User ID
  416. pub  1024/CF1FE4E5 1994/06/10 John C. Frickson <frickson@gibbon.com>
  417. Key fingerprint =  FD 74 3D 4E 20 9D FC 26  37 19 05 C7 B5 2B 36 E9
  418.  
  419.  
  420. -----BEGIN PGP PUBLIC KEY BLOCK-----
  421. Version: 2.6.2
  422.  
  423. mQCNAi33vzEAAAEEAO3cXvFXAOuNL9gooWG9m1et+L+BfZFDGJdjcDPDzChLToum
  424. prA4ONeItXv+FKPa0hM4laOybCtgnIEKqotNwbbSzriZBs+08wJUgLVFdsaNmzJ5
  425. X5YcWErzFzfSURK1BvXgR6wq/AJnFwazIMyZj79zdOfrgFGeqJUDRRPPH+TlAAUT
  426. tCZKb2huIEMuIEZyaWNrc29uIDxmcmlja3NvbkBnaWJib24uY29tPokAlQMFEC7x
  427. t4Zqg0EULITUtQEBuHQD/RuA7BdcT8jqQH2cJi+txmC1TyrUe8MEl3/3iNfJQgWp
  428. 1g6dpP/vVrEwZ/6tpizTXCe7Q7sU97857h8iFyBr9bAAQb0DEjgKPg+drX/BrnYN
  429. BuYTZ9EMWpD6V1hSXGER5JSQv6oZ8GRyJicg1PyQR+DzMt2uguT7Qu0EaqcNUoAF
  430. iQCVAwUQLw3BRGV5hLjHqWbdAQH1nAP9FBY77RtF7D5xG/bnXvqbherBBKSJcMBs
  431. g+RTEt9shPQE1KYS3KwIXG8Jk6KuxljgAofnhxb4J4KcmOWlLoGHxhWmhXxuaE1b
  432. tKcjNjNyuV0gnlUb2ZPPXIiCy2Ln03i2vT1dZ/WMdsvdLfZU4upFzLwUjphFdrpE
  433. n9UoplmLxaiJAJUCBRAuAdFqLT/deqWC+7sBAXoKA/92qwzgiBbjjSyAvfWdS6Re
  434. eRvg4YL6nZcuDh4pD/zoXPZjoGCMjU6hr08G2Xwq6KXRXXauxFgFzwGiCBDHETx1
  435. RJoQyxWKzAK3zzPpvBfkjBhYsi0+4QhRjIixkP+1UJL65Bs7+Eeivk7Xsz7HTkL3
  436. t1cCTPb0+Cwrzshs9bdc7IkAlQIFEC33v6OVA0UTzx/k5QEBAF8D/ijmsHap6MlT
  437. V9XMO4WxGWUWt1pPucS5AV55bqx2YzCE/90F9rJFohcajfkkDyqYPMWisDlf8i5/
  438. R81bb4Fw75OCfHvobKBBfNcCuCpdISz/Dpo617wfDn725CVGXOHQWixjhv2Jp2i9
  439. 8KxrQmOmar2Tzz6XXe0YXehiHQKh4HND
  440. =pxqc
  441. -----END PGP PUBLIC KEY BLOCK-----
  442.