You are here

Home » API reference » Encrypt 6

README.txt in Encrypt 6

Same filename and directory in other branches
  1. 7 README.txt
 Encrypt Description
====================================
(Two-way) Encryption Drupal module.  Please see
the following page for more current information:

http://drupal.org/project/encrypt

Encrypt is an API module to provide (two-way)
encryption.  It also provides a system for
other modules to provide encryption methods.


 Installation
====================================
Regular Drupal module installation.  You
can then choose a different default
encryption method here:

admin/settings/encrypt

It is not required, but will actually MAKE
YOU ENCRYPTION SECURE by putting your encryption
key outside of the webroot.  You can choose the 
the directory in the administrative interface.


 API
====================================
encrypt($text, $options, $method, $key)

This encrypts text.  Only the text is needed.
The default method will be used unless specified.
The default key will be used unless specified.

decrypt($text, $options, $method, $key)

This decrypts text.  Only the text is needed.
The default method will be used unless specified.
The default key will be used unless specified.
Since the key and method names are stored with
the encrypted data, it is suggested to not
use any options, so that the correct
method and key can be used.

Please see the following file on how to implement
your own encryption methods:

encrypt.api.php


 Credits
====================================
zzolo (Alan Palazzolo): http://drupal.org/user/147331

File

README.txt
View source 
  1.  Encrypt Description

  2. ====================================

  3. (Two-way) Encryption Drupal module.  Please see

  4. the following page for more current information:

  5. 

  6. http://drupal.org/project/encrypt

  7. 

  8. Encrypt is an API module to provide (two-way)

  9. encryption.  It also provides a system for

  10. other modules to provide encryption methods.

  11. 

  12. 

  13.  Installation

  14. ====================================

  15. Regular Drupal module installation.  You

  16. can then choose a different default

  17. encryption method here:

  18. 

  19. admin/settings/encrypt

  20. 

  21. It is not required, but will actually MAKE

  22. YOU ENCRYPTION SECURE by putting your encryption

  23. key outside of the webroot.  You can choose the 

  24. the directory in the administrative interface.

  25. 

  26. 

  27.  API

  28. ====================================

  29. encrypt($text, $options, $method, $key)

  30. 

  31. This encrypts text.  Only the text is needed.

  32. The default method will be used unless specified.

  33. The default key will be used unless specified.

  34. 

  35. decrypt($text, $options, $method, $key)

  36. 

  37. This decrypts text.  Only the text is needed.

  38. The default method will be used unless specified.

  39. The default key will be used unless specified.

  40. Since the key and method names are stored with

  41. the encrypted data, it is suggested to not

  42. use any options, so that the correct

  43. method and key can be used.

  44. 

  45. Please see the following file on how to implement

  46. your own encryption methods:

  47. 

  48. encrypt.api.php

  49. 

  50. 

  51.  Credits

  52. ====================================

  53. zzolo (Alan Palazzolo): http://drupal.org/user/147331