diff --git a/README.markdown b/README.markdown index 61bc96f2..e368c272 100644 --- a/README.markdown +++ b/README.markdown @@ -59,11 +59,11 @@ have multiple ones, `WebConsole::DoubleRenderError` will be raised. _Web Console_ allows you to execute arbitrary code on the server. Therefore, be very careful who you give access to. -### config.web_console.whitelisted_ips +### config.web_console.permissions By default, only requests coming from IPv4 and IPv6 localhosts are allowed. -`config.web_console.whitelisted_ips` lets you control which IP's have access to +`config.web_console.permissions` lets you control which IP's have access to the console. You can whitelist single IP's or whole networks. Say you want to share your @@ -71,7 +71,7 @@ console with `192.168.0.100`: ```ruby class Application < Rails::Application - config.web_console.whitelisted_ips = '192.168.0.100' + config.web_console.permissions = '192.168.0.100' end ``` @@ -79,7 +79,7 @@ If you want to whitelist the whole private network: ```ruby Rails.application.configure do - config.web_console.whitelisted_ips = '192.168.0.0/16' + config.web_console.permissions = '192.168.0.0/16' end ``` diff --git a/lib/web_console/railtie.rb b/lib/web_console/railtie.rb index f567533c..a9aff2dd 100644 --- a/lib/web_console/railtie.rb +++ b/lib/web_console/railtie.rb @@ -5,7 +5,7 @@ module WebConsole class Railtie < ::Rails::Railtie config.web_console = ActiveSupport::OrderedOptions.new - config.web_console.whitelisted_ips = %w( 127.0.0.1 ::1 ) + config.web_console.permissions = %w( 127.0.0.1 ::1 ) initializer "web_console.initialize" do require "bindex" @@ -53,8 +53,8 @@ class Railtie < ::Rails::Railtie end initializer "web_console.permissions" do - if whitelisted_ips = config.web_console.whitelisted_ips - Request.permissions = Permissions.new(whitelisted_ips) + if permissions = config.web_console.permissions || config.web_console.whitelisted_ips + Request.permissions = Permissions.new(permissions) end end diff --git a/test/web_console/railtie_test.rb b/test/web_console/railtie_test.rb index 515e587e..a0536d13 100644 --- a/test/web_console/railtie_test.rb +++ b/test/web_console/railtie_test.rb @@ -9,9 +9,9 @@ class RailtieTest < ActiveSupport::TestCase Middleware.mount_point = "/__web_console" end - test "config.whitelisted_ips sets whitelisted networks" do + test "config.permissions sets whitelisted networks" do new_uninitialized_app do |app| - app.config.web_console.whitelisted_ips = %w( 172.16.0.0/12 192.168.0.0/16 ) + app.config.web_console.permissions = %w( 172.16.0.0/12 192.168.0.0/16 ) app.initialize! 1.upto(255).each do |n| @@ -21,9 +21,9 @@ class RailtieTest < ActiveSupport::TestCase end end - test "config.whitelisted_ips always includes localhost" do + test "config.permissions always includes localhost" do new_uninitialized_app do |app| - app.config.web_console.whitelisted_ips = "8.8.8.8" + app.config.web_console.permissions = "8.8.8.8" app.initialize! assert_includes Request.permissions, "127.0.0.1"