You are here

README.txt in Security Review 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
Security Review module for Drupal

-- ABOUT --

Security Review automates checking many of the configuration errors that lead
to an insecure Drupal site and looks for existing vulnerabilities and attack
attempts.

The primary goal of the module is to elevate your awareness of the importance of
securing your Drupal site. The results of some checks may be incorrect depending
on unique factors, this module does not make your site more secure. You should
use the results of the checklist and its resources to manually secure your site.

Refer to the support section below if you are interested in securing your Drupal
site. 

-- INSTALLATION --

Place the security_review directory and its contents under sites/all/modules or
under an appropriate sites/ directory if you are using Drupal's multisite
capabilities.

Enable the module at Administer >> Site building >> Modules and refer to the
following sections for configuration and usage.

-- CONFIGURATION --

Two permissions are provided and required to use the module. Navigate to
Administer >> User management >> Permissions to enable
'access security review list' and 'run security checks' for trusted roles.

NOTICE:
This module provides information on the state of your site's security so
it is imperative you grant Security Review permissions to trusted roles and
users only. For instance, if you have an admin role that you intend to grant
these permissions to, be sure that all the users who have been granted this role
are indeed users you trust.

After you have granted permissions to the module you should inform the system
what roles are not trusted. Navigate to
Administer >> Reports >> Security review >> Settings to mark which roles are
untrusted. Most checks only care if the resource is usable by
untrusted roles.

On this page you can also define the level of logging. The result
of the last checklist is always stored but you can enable watchdog logging of
each check if you like.

-- USAGE --

Navigate to Administer >> Reports >> Security review to run the checklist.

If a check is enabled it will be run. You can enable or skip a check on this
page only after it has been run. Clicking on the 'Details' link beside each
check will provide details on why the check exists and what was found on the 
last run.

-- FAQ --

Q: What does the watchdog message "____ is no longer applicable for checking"
mean?
A: Some checks purposefully return neither Pass or Fail when it is no longer
relevant (such as when a module is disabled) so a previously failing or passing
check that is now not applicable is recorded.

-- KNOWN ISSUES --

If you have several hundred thousand pieces of content or comments you are
likely to experience a fault in the review process. If you are experiencing time
outs and batch halts you should consider running the checklist by its drush
command or skipping the Content and Comments checks on via the skip form at
admin/reports/security-review/settings.

-- SUPPORT --

Please use the issue queue at http://drupal.org/project/security_review for all
module support. You can read more about securely configuring your site at
http://drupal.org/security/secure-configuration and http://drupalscout.com

Acquia, the provider of this module, offers detailed,
targetted security review and support for Drupal websites and can be contacted
at http://wwww.acquia.com or via email at sales@acquia.com.

You can read more about our Drupal security review service at 
http://www.acquia.com/products-services/acquia-professional-services/service-offerings

-- CREDIT --

Security Review module written by Benjamin Jeavons, drupal.org user coltrane,
with thanks to Greg Knaddison, drupal.org user greggles, for the idea and
mentorship.

File

README.txt
View source
  1. Security Review module for Drupal
  2. -- ABOUT --
  3. Security Review automates checking many of the configuration errors that lead
  4. to an insecure Drupal site and looks for existing vulnerabilities and attack
  5. attempts.
  6. The primary goal of the module is to elevate your awareness of the importance of
  7. securing your Drupal site. The results of some checks may be incorrect depending
  8. on unique factors, this module does not make your site more secure. You should
  9. use the results of the checklist and its resources to manually secure your site.
  10. Refer to the support section below if you are interested in securing your Drupal
  11. site.
  12. -- INSTALLATION --
  13. Place the security_review directory and its contents under sites/all/modules or
  14. under an appropriate sites/ directory if you are using Drupal's multisite
  15. capabilities.
  16. Enable the module at Administer >> Site building >> Modules and refer to the
  17. following sections for configuration and usage.
  18. -- CONFIGURATION --
  19. Two permissions are provided and required to use the module. Navigate to
  20. Administer >> User management >> Permissions to enable
  21. 'access security review list' and 'run security checks' for trusted roles.
  22. NOTICE:
  23. This module provides information on the state of your site's security so
  24. it is imperative you grant Security Review permissions to trusted roles and
  25. users only. For instance, if you have an admin role that you intend to grant
  26. these permissions to, be sure that all the users who have been granted this role
  27. are indeed users you trust.
  28. After you have granted permissions to the module you should inform the system
  29. what roles are not trusted. Navigate to
  30. Administer >> Reports >> Security review >> Settings to mark which roles are
  31. untrusted. Most checks only care if the resource is usable by
  32. untrusted roles.
  33. On this page you can also define the level of logging. The result
  34. of the last checklist is always stored but you can enable watchdog logging of
  35. each check if you like.
  36. -- USAGE --
  37. Navigate to Administer >> Reports >> Security review to run the checklist.
  38. If a check is enabled it will be run. You can enable or skip a check on this
  39. page only after it has been run. Clicking on the 'Details' link beside each
  40. check will provide details on why the check exists and what was found on the
  41. last run.
  42. -- FAQ --
  43. Q: What does the watchdog message "____ is no longer applicable for checking"
  44. mean?
  45. A: Some checks purposefully return neither Pass or Fail when it is no longer
  46. relevant (such as when a module is disabled) so a previously failing or passing
  47. check that is now not applicable is recorded.
  48. -- KNOWN ISSUES --
  49. If you have several hundred thousand pieces of content or comments you are
  50. likely to experience a fault in the review process. If you are experiencing time
  51. outs and batch halts you should consider running the checklist by its drush
  52. command or skipping the Content and Comments checks on via the skip form at
  53. admin/reports/security-review/settings.
  54. -- SUPPORT --
  55. Please use the issue queue at http://drupal.org/project/security_review for all
  56. module support. You can read more about securely configuring your site at
  57. http://drupal.org/security/secure-configuration and http://drupalscout.com
  58. Acquia, the provider of this module, offers detailed,
  59. targetted security review and support for Drupal websites and can be contacted
  60. at http://wwww.acquia.com or via email at sales@acquia.com.
  61. You can read more about our Drupal security review service at
  62. http://www.acquia.com/products-services/acquia-professional-services/service-offerings
  63. -- CREDIT --
  64. Security Review module written by Benjamin Jeavons, drupal.org user coltrane,
  65. with thanks to Greg Knaddison, drupal.org user greggles, for the idea and
  66. mentorship.