Terminology related corrections.

2 files changed, 20 insertions, 17 deletions

diff --git a/GibberishAES.php b/GibberishAES.php
index fbbf46a..4c5a704 100644
--- a/GibberishAES.php
+++ b/GibberishAES.php
@@ -19,18 +19,18 @@
  *
  * Usage:
  *
- * // This is a secret key, keep it in a safe place and don't loose it.
- * $key = 'my secret key';
+ * // This is a secret pass-phrase, keep it in a safe place and don't loose it.
+ * $pass = 'my secret pass-phrase, it should be long';
  *
  * // The string to be encrypted.
  * $string = 'my secret message';
  *
  * // This is the result after encryption of the given string.
- * $encrypted_string = GibberishAES::enc($string, $key);
+ * $encrypted_string = GibberishAES::enc($string, $pass);
  *
  * // This is the result after decryption of the previously encrypted string.
  * // $decrypted_string == $string (should be).
- * $decrypted_string = GibberishAES::dec($encrypted_string, $key);
+ * $decrypted_string = GibberishAES::dec($encrypted_string, $pass);
  * echo $decrypted_string;
  *
  * // The default key-size is 256 bits. 128 and 192 bits are also allowed.
@@ -38,8 +38,8 @@
  * $old_key_size = GibberishAES::size();
  * GibberishAES::size(192);
  * // The short way: $old_key_size = GibberishAES::size(192);
- * $encrypted_string = GibberishAES::enc($string, $key);
- * $decrypted_string = GibberishAES::dec($encrypted_string, $key);
+ * $encrypted_string = GibberishAES::enc($string, $pass);
+ * $decrypted_string = GibberishAES::dec($encrypted_string, $pass);
  * GibberishAES::size($old_key_size);
  * echo $decrypted_string;
  *
@@ -77,7 +77,10 @@ class GibberishAES {
      * Crypt AES (256, 192, 128)
      *
      * @param   string  $string     The input message to be encrypted.
-     * @param   string  $pass       The key (string representation).
+     * @param   string  $pass       The secret pass-phrase, choose a long string
+     *                              (64 characters for example) for keeping high entropy.
+     *                              The pass-phrase is converted internaly into
+     *                              a binary key that is to be used for encryption.
      * @return  mixed               base64 encrypted string, FALSE on failure.
      */
     public static function enc($string, $pass) {
@@ -114,7 +117,7 @@ class GibberishAES {
      * Decrypt AES (256, 192, 128)
      *
      * @param   string  $string     The input message to be decrypted.
-     * @param   string  $pass       The key (string representation).
+     * @param   string  $pass       The secret pass-phrase that has been used for encryption.
      * @return  mixed               base64 decrypted string, FALSE on failure.
      */
     public static function dec($string, $pass) {
diff --git a/README.markdown b/README.markdown
index 66d50b9..dd5549f 100644
--- a/README.markdown
+++ b/README.markdown
@@ -29,9 +29,9 @@ Usage Example:
 ```php
 echo '<br />';
 
-// This is a secret key, keep it in a safe place and don't loose it.
-$key = 'my secret key';
-echo '$key = '.$key;
+// This is a secret pass-phrase, keep it in a safe place and don't loose it.
+$pass = 'my secret pass-phrase, it should be long';
+echo '$pass = '.$pass;
 echo '<br />';
 // The string to be encrypted.
 $string = 'my secret message';
@@ -46,10 +46,10 @@ echo 'Encryption and decryption using a 256-bit key:';
 echo '<br />';
 GibberishAES::size(256);
 // This is the result after encryption of the given string.
-$encrypted_string = GibberishAES::enc($string, $key);
+$encrypted_string = GibberishAES::enc($string, $pass);
 // This is the result after decryption of the previously encrypted string.
 // $decrypted_string == $string (should be).
-$decrypted_string = GibberishAES::dec($encrypted_string, $key);
+$decrypted_string = GibberishAES::dec($encrypted_string, $pass);
 echo '$encrypted_string = '.$encrypted_string;
 echo '<br />';
 echo '$decrypted_string = '.$decrypted_string;
@@ -59,8 +59,8 @@ echo '<br />';
 echo 'Encryption and decryption using a 192-bit key:';
 echo '<br />';
 GibberishAES::size(192);
-$encrypted_string = GibberishAES::enc($string, $key);
-$decrypted_string = GibberishAES::dec($encrypted_string, $key);
+$encrypted_string = GibberishAES::enc($string, $pass);
+$decrypted_string = GibberishAES::dec($encrypted_string, $pass);
 echo '$encrypted_string = '.$encrypted_string;
 echo '<br />';
 echo '$decrypted_string = '.$decrypted_string;
@@ -70,8 +70,8 @@ echo '<br />';
 echo 'Encryption and decryption using a 128-bit key:';
 echo '<br />';
 GibberishAES::size(128);
-$encrypted_string = GibberishAES::enc($string, $key);
-$decrypted_string = GibberishAES::dec($encrypted_string, $key);
+$encrypted_string = GibberishAES::enc($string, $pass);
+$decrypted_string = GibberishAES::dec($encrypted_string, $pass);
 echo '$encrypted_string = '.$encrypted_string;
 echo '<br />';
 echo '$decrypted_string = '.$decrypted_string;