Changeset 699 for trunk

Timestamp:

01/01/10 11:51:27 (2 years ago)

Author:

brieb

Message:

• Added more severe checking for encrytion key file
• Added security tips on implementing payment encryption
• Added mailchimp update.php so module would display as not installed during update process

Location:

trunk/phpbms

Files:

• include/session.php (modified) (2 diffs)
• install/index.php (modified) (1 diff)
• install/update.php (modified) (2 diffs)
• modules/bms/adminsettings.php (modified) (2 diffs)
• modules/mailchimp/install/update.php (added)

trunk/phpbms/include/session.php

@@ -239 +239 @@
         var $type = "ERROR";
         var $value = "";
-        
-        /**     
+
+        /**
           *   $userid
           *   @var string user's uuid
@@ -479 +479 @@
                         if(defined("ENCRYPTION_KEY_PATH"))
                                 if(is_file(ENCRYPTION_KEY_PATH)){
-                                        $res = fopen(ENCRYPTION_KEY_PATH, "r");
+
+                                        $res = @ fopen(ENCRYPTION_KEY_PATH, "r");
+
                                         if($res !== false){
+
+                                            if(@filesize(ENCRYPTION_KEY_PATH))
                                                 define("ENCRYPTION_KEY",trim(fread($res, filesize(ENCRYPTION_KEY_PATH))));
-                                        }elseif(ENCRYPT_PAYMENT_FIELDS){
-                                                new appError(-229, "encryption key path setting is not a valid path");
+                                            else
+                                                $error = new appError(-230, "Cannot open path '".ENCRYPTION_KEY_PATH."' or file has zero length ", "Invalid Encryption Key File", true, true);
+
+                                        } elseif(ENCRYPT_PAYMENT_FIELDS){
+
+                                            $error = new appError(-229, "Invalid encryption file or cannot open '".ENCRYPTION_KEY_PATH."'", "Invalid Encryption Key File", true, true);
+
                                         }else{
-                                                define("ENCRYPTION_KEY", "");
+
+                                            define("ENCRYPTION_KEY", "");
+
                                         }//end if
-                                }elseif(ENCRYPT_PAYMENT_FIELDS){
-                                                new appError(-228, "encryption key path setting is not a valid path");
-                                }else{
-                                        define("ENCRYPTION_KEY", "");
-                                }//end if
+
+                                }elseif(ENCRYPT_PAYMENT_FIELDS)
+                                    $error = new appError(-228, ENCRYPTION_KEY_PATH." missing or invalid.", "Cannot Open Encryption Key File", true, true);
+                                else
+                                    define("ENCRYPTION_KEY", "");
 
                         // This following code is for windows boxen, because they lack some server varables as well

trunk/phpbms/install/index.php

@@ -384 +384 @@
                                 </ul>
 
-                                <h2>Suggested Security Steps</h2>
+                                <h2>Additional Security Steps</h2>
 
                                 <ul>
+                                        <li>
+                                                <h3>Payment Information Encryption</h3>
+                                                <p>
+                                                    If you plan on storing sensitive payment information such as credit card
+                                                    numbers make sure to enable the encrption option in the configuration page
+                                                    underneath the BMS module section. You will also need to create and link
+                                                    to an external file on the server that contains the encryption key. Typically,
+                                                    encyrption key files are text files containing a 64-128 character hash.
+                                                </p>
+                                        </li>
+
                                         <li>
                                                 <h3>Run phpBMS On a Secure Connection (SSL)</h3>

trunk/phpbms/install/update.php

@@ -223 +223 @@
                                 <h1>Update Modules</h1>
 
+                                <p>
+                                    To install a module that is not currently installed, wait unitl the update process
+                                    has completed successfully.  Then run the installation script and skip to the "install
+                                    modules" section.
+                                </p>
+
                                 <?php $updater->showModulesUpdate(); ?>
 
@@ -292 +298 @@
                                                 </p>
                                         </li>
+                                        <li>
+                                                <h3>Payment Information Encryption</h3>
+                                                <p>
+                                                    If you store sensitive payment information such as credit card
+                                                    numbers make sure to enable the encrption option in the configuration page
+                                                    underneath the BMS module section. You will also need to create and link
+                                                    to an external file on the server that contains the encryption key. Typically,
+                                                    encyrption key files are text files containing a 64-128 character hash.
+                                                </p>
+                                        </li>
 
                                 </ul>

trunk/phpbms/modules/bms/adminsettings.php

@@ -29 +29 @@
                         if(is_file($path))
                                 if(is_readable($path))
+                                    if(filesize($path) > 0)
                                         $theReturn = true;
 
@@ -444 +445 @@
         <p><?php echo $theform->showField("encrypt_payment_fields");?></p>
         <p class="notes">
-                Withe this option enabled, sensitive payment information in sales orders and
-                receipts with a `type` of 'Order' will be encrypted.<br/>
-
-                Also, payment fields in sales orders and receipts records of `type`
+                Enabling this option encrypts sensitive payment information in sales orders and
+                receipts with a `type` of 'Order'.<br/>
+
+                In addition, payment fields in sales orders and receipts records of `type`
                 'Invoice' will be removed or obfuscated when a sales order or receipt
-                is posted as an invoice or voided/deleted.  <strong>This type of obfuscation,
-                is not reversible</strong>
-
+                is posted as an invoice or voided/deleted.
         </p>
+
+        <p class="notes"><strong>Obfuscation is not reversible.</strong></p>
 
         <input type="hidden" name="encryptionPathChanged" id="encryptionPathChanged" value="0" />
         <p><?php echo $theform->showField("encryption_key_path");?></p>
+
+        <p class="notes">
+             Typically, encyrption key files are text containing a 64-128 character hash. Good security practices include regularly
+             rotating key files.  Do not delete the old key until the new key has been accepted and processed by phpBMS.  The system will
+             decrypt data using the old key and then re-encrypt it using the new key.
+        </p>
+
+        <p class="notes"><strong>Always keep back ups of your key file(s). Losing them may result in unencryptable data.</strong></p>
 
     </fieldset>