Virtual Server Documentation

Home | Getting Started | FreeBSD | Solaris | Handbook

Click Here for Web Hosting Information & Pricing

PGP FormMail CGI
FormMail is a generic WWW form to e-mail gateway, which will parse the results of any form and send them to the specified user. This CGI has many formatting and operational options, most of which can be specified through the form, meaning you don't need any programming knowledge or multiple CGIs for multiple forms. This also makes FormMail the perfect system-wide solution for allowing users form-based user feedback capabilities without the risks of allowing freedom of CGI access.

PGP (Pretty Good Privacy), originally developed by Phil Zimmerman, is a high security cryptographic software application for MSDOS, UNIX, VAX/VMS, and other computers. PGP allows people to exchange files or messages with privacy, authentication, and convenience.

Installation
Connect to your Virtual Server via Telnet or SSH and do the following.

1. Install PGP 5.0.

2. Install the PGP FormMail software. Issue the commands that match your Virtual Server O/S.

   • FreeBSD & Solaris
     % vinstall pgp5formmail

   • BSD/OS Upgrade! PGP FormMail 1.6
     % cd
% tar -xvf /usr/local/contrib/pgp5formmail.tar

   • Huh?
     If you don't know the Virtual Server O/S, try the following:

     • Which O/S Is Your Virtual Server Running?

   These commands install two files, pgp5formmail.pl and pgp5formmail.README.txt, into your ~/www/cgi-bin directory.

Configuration
Set the referer information such that only your server will have privileges to use the PGP FormMail CGI. Near the top of the pgp5formmail.pl file you will find the following line:

 
@referers = ('YOUR-DOMAIN.NAME','YOUR.IP.ADD.RESS'); 

Substitute your domain name and Virtual Server IP address for the values YOUR-DOMAIN.NAME and YOUR.IP.ADD.RESS respectively.

In addition, you must also add the list of domains that will receive e-mail as recipients to the @ok_recipients array (just below the @referers array). This will prevent PGP FormMail from sending unauthorized messages to a recipient other than the intended recipient.

 
@ok_recipients = ('@YOUR-DOMAIN.NAME$', '@SUBHOST-DOMAIN.NAME$'); 

Substitute your domain name and all subhosted domains on your server if you wish them to be able to use PGP FormMail also.

Usage
Create a form that you would like the contents mailed to some address. The form should include the following fields (at the very least):

• recipient = specifies who mail is sent to
• pgpuserid = specifies your PGP user ID

Other optional fields can also be used to enhance the operation of PGP FormMail for you site, for example:

• subject = specify the subject included in e-mail sent back to you
• email = allow the user to specify a return e-mail address
• realname = allow the user to input their real name
• redirect = URL of page to redirect to instead of echoing form input
• required = list of field names that are required input (comma delimited)

Several other fields are supported, please see the pgp5formmail.README document for a complete presentation of the supported fields.

For example, the HTML source for your form may look like this:

 
<form method="POST" action="/cgi-bin/pgp5formmail.pl"> 
<input type="hidden" name="recipient"  
       value="order@yourdomain.com"> 
<input type="hidden" name="pgpuserid"  
       value="YOUR-USER-ID"> 
<input type="hidden" name="subject"  
       value="Order Request"> 
<input type="hidden" name="required"  
       value="realname,username,phone"> 
Please Enter Your Name:<br> 
<input name="realname" size="40"> 
<p> 
Please Enter Your Email Address:<br> 
<input name="username" size="40"> 
<p> 
Please Enter Your Phone Number:<br> 
<input name="phone" size="40"> 
<p> 
. 
. 
. 
<input type="submit" value="Submit"> 
<input type="reset" value="Reset"> 
</form> 

YOUR-USER-ID is the user ID for your public key. If your user ID contains characters that could be misinterpreted by a web browser, such as '<' and '>', you will want to replace these characters with the proper escape sequences. For example if your user ID is:

John Q. Smith <12345.6789@compuserve.com>

Represent the user ID with the following string (note the &lt; and &gt; escape sequences):

John Q. Smith &lt;12345.6789@compuserve.com&gt;

Tip
One way to modify the PGP FormMail CGI is have it "autorespond" to the client filling out the form. You can do this by simply uncommenting out the call to "autorespond" located near the top of the CGI. The autorespond function is placed at the end of the file and can be modified to suit your needs.