You are here

Home » API reference » Restrict Login or Role Access by IP Address 6.3

README.txt in Restrict Login or Role Access by IP Address 6.3

Same filename and directory in other branches
  1. 8.4 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 6.2 README.txt
  5. 7.3 README.txt
Description
===========

In general, this module provides features that allow an IP address (or range of
IP addresses) to be whitelisted which restricts the functionality of users.
Currently there are two features implemented.

IP address ranges must be entered in CIDR notation separated with semi-colons
and no trailing semi-colon (e.g., 10.20.30.0/24;192.168.199.1/32;1.0.0.0/8). For
more information on CIDR notation, see
http://www.brassy.net/2007/mar/cidr_basic_subnetting.

Restrict login by IP
--------------------
When a user is restricted, that user will not be able to log in outside the
defined IP address ranges. It is also possible to specify global IP address
ranges, which apply to ALL users, including user1. Following a denied log-in
attempt, a user is redirected to an error page as specified by the site
administrator.

Restrict role by IP
-------------------
When a role is restricted, that role will not be available to users outside the
defined IP address ranges. Role restriction does not affect users' ability to
log in, only the availability of the restricted role to users. Role restrictions
are available for all roles, except "anonymous user" and "authenticated user."

### Install

1. Follow the instructions at
   https://drupal.org/documentation/install/modules-themes/modules-5-6.

### Upgrade

#### From 6.x-2.x:
1. Follow the instructions at https://drupal.org/node/250790.
2. The session override in settings.php is no longer needed. Please remove the
   line from settings.php.

#### From 6.x-1.x or older:
* This is not supported. You must completely uninstall the current version by
  following the instructions at https://drupal.org/node/250783.

### Usage

1. All configuration can be managed from administration pages located at
   Administer > Site configuration > Restrict by IP.
2. Individual user IP restrictions may also be set in the 'Restrict by IP'
   fieldset located on the user add/edit form.
3. IP restrictions are checked on every page load. If a user restriction is
   triggered, then the user will be logged out and sent to the specified
   'error page'. If a role restriction is triggered, then a user's session will
   be unaffected; however, the restricted role will no longer be available to
   the user.
4. To remove an IP restriction, simply delete its value, and submit the
   configuration form.

### Authors

Please see project page for current list of maintainers.

* Matt Rice (mrice [at] mattrice.org)
* Bobby Kramer (panthar1 [at] gmail.com)
* James Gross (jamesrgross [at] gmail.com)

File

README.txt
View source 
  1. Description

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

  3. 

  4. In general, this module provides features that allow an IP address (or range of

  5. IP addresses) to be whitelisted which restricts the functionality of users.

  6. Currently there are two features implemented.

  7. 

  8. IP address ranges must be entered in CIDR notation separated with semi-colons

  9. and no trailing semi-colon (e.g., 10.20.30.0/24;192.168.199.1/32;1.0.0.0/8). For

  10. more information on CIDR notation, see

  11. http://www.brassy.net/2007/mar/cidr_basic_subnetting.

  12. 

  13. Restrict login by IP

  14. --------------------

  15. When a user is restricted, that user will not be able to log in outside the

  16. defined IP address ranges. It is also possible to specify global IP address

  17. ranges, which apply to ALL users, including user1. Following a denied log-in

  18. attempt, a user is redirected to an error page as specified by the site

  19. administrator.

  20. 

  21. Restrict role by IP

  22. -------------------

  23. When a role is restricted, that role will not be available to users outside the

  24. defined IP address ranges. Role restriction does not affect users' ability to

  25. log in, only the availability of the restricted role to users. Role restrictions

  26. are available for all roles, except "anonymous user" and "authenticated user."

  27. 

  28. ### Install

  29. 

  30. 1. Follow the instructions at

  31.    https://drupal.org/documentation/install/modules-themes/modules-5-6.

  32. 

  33. ### Upgrade

  34. 

  35. #### From 6.x-2.x:

  36. 1. Follow the instructions at https://drupal.org/node/250790.

  37. 2. The session override in settings.php is no longer needed. Please remove the

  38.    line from settings.php.

  39. 

  40. #### From 6.x-1.x or older:

  41. * This is not supported. You must completely uninstall the current version by

  42.   following the instructions at https://drupal.org/node/250783.

  43. 

  44. ### Usage

  45. 

  46. 1. All configuration can be managed from administration pages located at

  47.    Administer > Site configuration > Restrict by IP.

  48. 2. Individual user IP restrictions may also be set in the 'Restrict by IP'

  49.    fieldset located on the user add/edit form.

  50. 3. IP restrictions are checked on every page load. If a user restriction is

  51.    triggered, then the user will be logged out and sent to the specified

  52.    'error page'. If a role restriction is triggered, then a user's session will

  53.    be unaffected; however, the restricted role will no longer be available to

  54.    the user.

  55. 4. To remove an IP restriction, simply delete its value, and submit the

  56.    configuration form.

  57. 

  58. ### Authors

  59. 

  60. Please see project page for current list of maintainers.

  61. 

  62. * Matt Rice (mrice [at] mattrice.org)

  63. * Bobby Kramer (panthar1 [at] gmail.com)

  64. * James Gross (jamesrgross [at] gmail.com)