www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/security_review/README.txt

   1
   2 -- ABOUT --
   3
   4 Security Review automates checking many of the configuration errors that lead
   5 to an insecure Drupal site and looks for existing vulnerabilities and attack
   6 attempts.
   7
   8 The primary goal of the module is to elevate your awareness of the importance of
   9 securing your Drupal site. The results of some checks may be incorrect depending
  10 on unique factors, this module does not make your site more secure. You should
  11 use the results of the checklist and its resources to manually secure your site.
  12
  13 Refer to the support section below if you are interested in securing your Drupal
  14 site.
  15
  16 -- INSTALLATION --
  17
  18 Place the security_review directory and its contents under /modules or a
  19 subdirectory of /modules in the Drupal root directory.
  20
  21 Enable the module at Administer >> Modules and refer to the
  22 following sections for configuration and usage.
  23
  24 -- CONFIGURATION --
  25
  26 Two permissions are provided and required to use the module. Navigate to
  27 Administer >> People >> Permissions to enable
  28 'access security review list' and 'run security checks' for trusted roles.
  29
  30 NOTICE: This module provides information on the state of your site's security so
  31 it is imperative you grant these permissions to trusted roles and users only.
  32 For instance, if you have an admin role, be sure that all the users who have
  33 been granted this role are indeed users you trust if you grant them these
  34 permissions.
  35
  36 After you have granted permissions to the module you should inform the system
  37 what roles are not trusted. Navigate to
  38 Administer >> Reports >> Security Review >> Settings to mark which roles are
  39 untrusted. Most checks only care if the resource is usable by
  40 untrusted roles.
  41
  42 On this page you can also define the level of logging. The result
  43 of the last checklist is always stored but you can enable watchdog logging of
  44 each check if you like.
  45
  46 -- USAGE --
  47
  48 Navigate to Administer >> Reports >> Security Review to run the checklist.
  49
  50 If a check is enabled it will be run. You can enable or skip a check on this
  51 page only after it has been run. Clicking on the 'Help' link beside each check
  52 will provide details on why the check exists and what was found on the last run.
  53
  54 -- DRUSH USAGE --
  55
  56 Running the Security Review checklist using Drush is a great way to build
  57 automated security audits of your site into your site development lifecycle and
  58 as part of continuous integration.
  59
  60 With the module installed invoke 'drush secrev' from within your Drupal root.
  61
  62 Call 'drush help secrev' to see available options.
  63
  64 For running specific checks pass the '--check' option. Be sure to remove any
  65 whitespace characters separating check names.
  66
  67 Consult implementations of hook_security_checks() for exact list of available
  68 check options. Standard Security Review checks are:
  69
  70 file_perms, input_formats, field, error_reporting, private_files, query_errors,
  71 failed_logins, upload_extensions, admin_permissions, executable_php,
  72 trusted_hosts, temporary_files
  73
  74 For custom checks you may prefix the check name with the module name and
  75 colon (:) character. For example:
  76
  77 'drush secrev --check=my_module:my_check'
  78
  79 Note, custom checks require that its module be enabled. Also, should you be
  80 skipping any check the 'store' option will not allow that check to be run.
  81
  82 -- SUPPORT --
  83
  84 Please use the issue queue at http://drupal.org/project/security_review for all
  85 module support. You can read more about securely configuring your site at
  86 http://drupal.org/security/secure-configuration and http://drupalscout.com
  87
  88 -- CREDIT --
  89
  90 Security Review module originally written by Benjamin Jeavons, drupal.org user
  91 coltrane. Ported to Drupal 8 by Viktor Bán.