You are here

README.txt in Encrypt Submissions 6

Same filename in this branch
  1. 6 README.txt
  2. 6 jcryption/README.txt
Same filename and directory in other branches
  1. 7 README.txt
; $Id$
=======================
Encrypt Submissions
(For Drupal 6)
=======================
Richard Peacock (richard@richardpeacock.com)

NOTE:  Initial backport to D6 (from D7) was done by user k8n (http://drupal.org/user/243127)


This module uses the jCryption plugin (http://www.jcryption.org) to encrypt any form
submission in Drupal using 265-bit public/private key encryption.
For example, you can use it to encrypt the login and registration
form, so a user's passwords are never transmitted in clear text.
This is similar to how SSL works to encrypt traffic.

It should be noted that this module is not a replacement for SSL, which
can protect against other types of attacks.  This module is intended
for those who desire some minimal security from hackers,
but either cannot afford an SSL certificate, or only need basic
protection of form data.  For full protection, you should purchase
an SSL certificate.


======================
Important Limitations
======================
Unlike the D7 version, this D6 version of encrypt_submissions requires jQuery 1.4.4, which
does not come packaged with Drupal 6.  So, a copy of jQuery 1.4.4 is included in this project.
As a result, some existing javascript may have trouble running on the same page
as a form which has encryption turned on.

If you plan on using this module in a production environment, please test
and re-test all of your pages which might have extra or unusual javascript requirements, to
make sure nothing breaks!


======================
Features
======================
 - Works on any Drupal forms-- login, search, content types, settings, and
   forms from other contributed modules.
 - 256-bit public/private key encryption.
 - The keys are generated freshly per-submission, reducing the chances of cycling attacks.
 - Administrators may specify that the module only encrypt certain form submissions,
   leaving other form submissions in the clear.
 - Can be used to encrypt passwords during login, similar to
   the Safer Login module for Drupal 6 (http://drupal.org/project/safer_login)
 - If the user has JavaScript disabled, then all form submissions still work
   using standard, unencrypted submissions.
 - Works with Libraries API


======================
Requirements
======================
 - This module requires you to download the jCryption libraries, located here:
   http://www.jcryption.org (version 1.2 or later)
   The "Production" download is all you need, though the "Package" download works
   as well.
 - These libraries were NOT programmed by this module's maintainer.  It was mostly
   programmed by Daniel Griesser, and comprises several other libraries by different
   authors.  Please visit http://www.jcryption.org/about for a full list of credits.

=======================
Restrictions
=======================
 - This module only works on forms which use POST as their method type.  This is most
   of the forms in Drupal, but possibly there are some contributed modules out there
   which use GET.
    
======================
Directions
======================

- Unpack the module files into /sites/all/modules/encrypted_submissions.

- Download the jCryption libraries (1.2 or later) and unpack them into:
  /sites/all/modules/encrypted_submissions/jcryption
  so that the jcryption.php file is located at:
  sites/all/modules/encrypt_submissions/jcryption/jcryption.php
  
- ** Important! ** Make sure the jcryption files are named the following:
  jcryption.php and jquery.jcryption.js
  Even if you choose to minify the js file, please make sure it is named
  simply jquery.jcryption.js.  

- If using Libraries API module, place files at:
    /sites/all/libraries/jcryption/*.*  (note jcryption is all lowercase)
  
- Enable the module, and be sure to enable the "access" permission for your users,
  or else no one will be able to use it.  If you are protecting the login and registration
  forms, be sure to give the "access" permission to anonymous users!

- Visit the configuration page to specify which forms you want it to work on.

File

README.txt
View source
  1. ; $Id$
  2. =======================
  3. Encrypt Submissions
  4. (For Drupal 6)
  5. =======================
  6. Richard Peacock (richard@richardpeacock.com)
  7. NOTE: Initial backport to D6 (from D7) was done by user k8n (http://drupal.org/user/243127)
  8. This module uses the jCryption plugin (http://www.jcryption.org) to encrypt any form
  9. submission in Drupal using 265-bit public/private key encryption.
  10. For example, you can use it to encrypt the login and registration
  11. form, so a user's passwords are never transmitted in clear text.
  12. This is similar to how SSL works to encrypt traffic.
  13. It should be noted that this module is not a replacement for SSL, which
  14. can protect against other types of attacks. This module is intended
  15. for those who desire some minimal security from hackers,
  16. but either cannot afford an SSL certificate, or only need basic
  17. protection of form data. For full protection, you should purchase
  18. an SSL certificate.
  19. ======================
  20. Important Limitations
  21. ======================
  22. Unlike the D7 version, this D6 version of encrypt_submissions requires jQuery 1.4.4, which
  23. does not come packaged with Drupal 6. So, a copy of jQuery 1.4.4 is included in this project.
  24. As a result, some existing javascript may have trouble running on the same page
  25. as a form which has encryption turned on.
  26. If you plan on using this module in a production environment, please test
  27. and re-test all of your pages which might have extra or unusual javascript requirements, to
  28. make sure nothing breaks!
  29. ======================
  30. Features
  31. ======================
  32. - Works on any Drupal forms-- login, search, content types, settings, and
  33. forms from other contributed modules.
  34. - 256-bit public/private key encryption.
  35. - The keys are generated freshly per-submission, reducing the chances of cycling attacks.
  36. - Administrators may specify that the module only encrypt certain form submissions,
  37. leaving other form submissions in the clear.
  38. - Can be used to encrypt passwords during login, similar to
  39. the Safer Login module for Drupal 6 (http://drupal.org/project/safer_login)
  40. - If the user has JavaScript disabled, then all form submissions still work
  41. using standard, unencrypted submissions.
  42. - Works with Libraries API
  43. ======================
  44. Requirements
  45. ======================
  46. - This module requires you to download the jCryption libraries, located here:
  47. http://www.jcryption.org (version 1.2 or later)
  48. The "Production" download is all you need, though the "Package" download works
  49. as well.
  50. - These libraries were NOT programmed by this module's maintainer. It was mostly
  51. programmed by Daniel Griesser, and comprises several other libraries by different
  52. authors. Please visit http://www.jcryption.org/about for a full list of credits.
  53. =======================
  54. Restrictions
  55. =======================
  56. - This module only works on forms which use POST as their method type. This is most
  57. of the forms in Drupal, but possibly there are some contributed modules out there
  58. which use GET.
  59. ======================
  60. Directions
  61. ======================
  62. - Unpack the module files into /sites/all/modules/encrypted_submissions.
  63. - Download the jCryption libraries (1.2 or later) and unpack them into:
  64. /sites/all/modules/encrypted_submissions/jcryption
  65. so that the jcryption.php file is located at:
  66. sites/all/modules/encrypt_submissions/jcryption/jcryption.php
  67. - ** Important! ** Make sure the jcryption files are named the following:
  68. jcryption.php and jquery.jcryption.js
  69. Even if you choose to minify the js file, please make sure it is named
  70. simply jquery.jcryption.js.
  71. - If using Libraries API module, place files at:
  72. /sites/all/libraries/jcryption/*.* (note jcryption is all lowercase)
  73. - Enable the module, and be sure to enable the "access" permission for your users,
  74. or else no one will be able to use it. If you are protecting the login and registration
  75. forms, be sure to give the "access" permission to anonymous users!
  76. - Visit the configuration page to specify which forms you want it to work on.