Skip to content

Commit 61ce65b

Browse files
committedApr 29, 2019
Move to config.web_console.permissions
Moving away from the white listing term. We'll still support `config.web_console.whitelisted_ips` for backwards compatibility, though. Without it, we'll break a lot of installs.
1 parent 7d26040 commit 61ce65b

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed
 

‎README.markdown

+4-4
Original file line numberDiff line numberDiff line change
@@ -59,27 +59,27 @@ have multiple ones, `WebConsole::DoubleRenderError` will be raised.
5959
_Web Console_ allows you to execute arbitrary code on the server. Therefore, be
6060
very careful who you give access to.
6161

62-
### config.web_console.whitelisted_ips
62+
### config.web_console.permissions
6363

6464
By default, only requests coming from IPv4 and IPv6 localhosts are allowed.
6565

66-
`config.web_console.whitelisted_ips` lets you control which IP's have access to
66+
`config.web_console.permissions` lets you control which IP's have access to
6767
the console.
6868

6969
You can whitelist single IP's or whole networks. Say you want to share your
7070
console with `192.168.0.100`:
7171

7272
```ruby
7373
class Application < Rails::Application
74-
config.web_console.whitelisted_ips = '192.168.0.100'
74+
config.web_console.permissions = '192.168.0.100'
7575
end
7676
```
7777

7878
If you want to whitelist the whole private network:
7979

8080
```ruby
8181
Rails.application.configure do
82-
config.web_console.whitelisted_ips = '192.168.0.0/16'
82+
config.web_console.permissions = '192.168.0.0/16'
8383
end
8484
```
8585

‎lib/web_console/railtie.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
module WebConsole
66
class Railtie < ::Rails::Railtie
77
config.web_console = ActiveSupport::OrderedOptions.new
8-
config.web_console.whitelisted_ips = %w( 127.0.0.1 ::1 )
8+
config.web_console.permissions = %w( 127.0.0.1 ::1 )
99

1010
initializer "web_console.initialize" do
1111
require "bindex"
@@ -53,8 +53,8 @@ class Railtie < ::Rails::Railtie
5353
end
5454

5555
initializer "web_console.permissions" do
56-
if whitelisted_ips = config.web_console.whitelisted_ips
57-
Request.permissions = Permissions.new(whitelisted_ips)
56+
if permissions = config.web_console.permissions || config.web_console.whitelisted_ips
57+
Request.permissions = Permissions.new(permissions)
5858
end
5959
end
6060

‎test/web_console/railtie_test.rb

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ class RailtieTest < ActiveSupport::TestCase
99
Middleware.mount_point = "/__web_console"
1010
end
1111

12-
test "config.whitelisted_ips sets whitelisted networks" do
12+
test "config.permissions sets whitelisted networks" do
1313
new_uninitialized_app do |app|
14-
app.config.web_console.whitelisted_ips = %w( 172.16.0.0/12 192.168.0.0/16 )
14+
app.config.web_console.permissions = %w( 172.16.0.0/12 192.168.0.0/16 )
1515
app.initialize!
1616

1717
1.upto(255).each do |n|
@@ -21,9 +21,9 @@ class RailtieTest < ActiveSupport::TestCase
2121
end
2222
end
2323

24-
test "config.whitelisted_ips always includes localhost" do
24+
test "config.permissions always includes localhost" do
2525
new_uninitialized_app do |app|
26-
app.config.web_console.whitelisted_ips = "8.8.8.8"
26+
app.config.web_console.permissions = "8.8.8.8"
2727
app.initialize!
2828

2929
assert_includes Request.permissions, "127.0.0.1"

0 commit comments

Comments
 (0)
Please sign in to comment.