Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use safe redirect paths in admin redirects #3129

Merged
merged 2 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions app/controllers/alchemy/admin/base_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,27 @@ def leave

private

def safe_redirect_path(path = params[:redirect_to], fallback: admin_path)
if is_safe_redirect_path?(path)
path
elsif is_safe_redirect_path?(fallback)
fallback
else
admin_path
end
end

def is_safe_redirect_path?(path)
mount_path = alchemy.root_path
path.to_s.match? %r{^#{mount_path}admin/}
end

def relative_referer_path(referer = request.referer)
return unless referer

URI(referer).path
end

# Disable layout rendering for xhr requests.
def set_layout
(request.xhr? || turbo_frame_request?) ? false : "alchemy/admin"
Expand Down Expand Up @@ -105,16 +126,23 @@ def render_errors_or_redirect(object, redirect_url, flash_notice)
end
end

# Does redirects for html and js requests
# Does redirects for html, turbo_stream and js requests
#
# Makes sure that the redirect path is safe.
#
def do_redirect_to(url_or_path)
redirect_path = safe_redirect_path(url_or_path)
respond_to do |format|
format.js do
@redirect_url = url_or_path
@redirect_url = redirect_path
render :redirect
end
format.turbo_stream { redirect_to(url_or_path) }
format.html { redirect_to(url_or_path) }
format.turbo_stream do
redirect_to(redirect_path, allow_other_host: false)
end
format.html do
redirect_to(redirect_path, allow_other_host: false)
end
end
end

Expand Down
2 changes: 1 addition & 1 deletion app/controllers/alchemy/admin/languages_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def destroy
def switch
@language = set_alchemy_language(params[:language_id])
session[:alchemy_language_id] = @language.id
do_redirect_to request.referer || alchemy.admin_dashboard_path
do_redirect_to relative_referer_path || alchemy.admin_dashboard_path
end

private
Expand Down
6 changes: 1 addition & 5 deletions app/controllers/alchemy/admin/pages_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -187,17 +187,13 @@
respond_to do |format|
format.js
format.html do
redirect_to(unlock_redirect_path, allow_other_host: true)

Check warning

Code scanning / CodeQL

URL redirection from remote source Medium

Untrusted URL redirection depends on a
user-provided value
.
end
end
end

def unlock_redirect_path
if params[:redirect_to].to_s.match?(/\A\/admin\/(layout_)?pages/)
params[:redirect_to]
else
admin_pages_path
end
safe_redirect_path(fallback: admin_pages_path)
end

# Sets the page public and updates the published_at attribute that is used as cache_key
Expand Down
2 changes: 1 addition & 1 deletion app/controllers/alchemy/admin/resources_controller.rb
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def destroy
flash[:error] = resource_instance_variable.errors.full_messages.join(", ")
end
flash_notice_for_resource_action
do_redirect_to resource_url_proxy.url_for(search_filter_params.merge(action: "index"))
do_redirect_to resource_url_proxy.url_for(search_filter_params.merge(action: "index", only_path: true))
end

def resource_handler
Expand Down
128 changes: 128 additions & 0 deletions spec/controllers/alchemy/admin/base_controller_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -211,4 +211,132 @@ def index
end
end
end

describe "#safe_redirect_path" do
subject { controller.send(:safe_redirect_path) }

context "when params[:redirect_to] is present" do
before do
allow(controller).to receive(:params) { {redirect_to: redirect_url} }
end

context "and it is not an external URL" do
let(:redirect_url) { "/admin/pages" }

it "redirects to given path" do
is_expected.to eq("/admin/pages")
end
end

context "and it is an external URL" do
let(:redirect_url) { "https://evil.com" }

context "and no fallback is given" do
it "redirects to default fallback path" do
is_expected.to eq("/admin")
end
end

context "and a fallback is given" do
subject { controller.send(:safe_redirect_path, fallback: "/admin/pages") }

context "which is a safe path" do
it "redirects to given fallback path" do
is_expected.to eq("/admin/pages")
end
end

context "which is not a safe path" do
subject { controller.send(:safe_redirect_path, fallback: "evil.com") }

it "redirects to default fallback path" do
is_expected.to eq("/admin")
end
end
end
end
end

context "when params[:redirect_to] is not present" do
context "and another path is given" do
subject { controller.send(:safe_redirect_path, redirect_path) }

context "which is a safe path" do
let(:redirect_path) { "/admin/pages" }

it "redirects to given path" do
is_expected.to eq("/admin/pages")
end
end

context "which is not a safe path" do
let(:redirect_path) { "evil.com" }

it "redirects to default fallback path" do
is_expected.to eq("/admin")
end
end
end

context "and no fallback is given" do
it "redirects to default fallback path" do
is_expected.to eq("/admin")
end
end

context "and a fallback is given" do
subject { controller.send(:safe_redirect_path, fallback: "/admin/pages") }

context "which is a safe path" do
it "redirects to given fallback path" do
is_expected.to eq("/admin/pages")
end
end

context "which is not a safe path" do
subject { controller.send(:safe_redirect_path, fallback: "evil.com") }

it "redirects to default fallback path" do
is_expected.to eq("/admin")
end
end
end
end
end

describe "#is_safe_redirect_path?" do
subject { controller.send(:is_safe_redirect_path?, path) }

context "path is not an external URL" do
let(:path) { "/admin/pages" }

it { is_expected.to be(true) }
end

context "path is an external URL" do
let(:path) { "https://evil.com" }

it { is_expected.to be(false) }
end

context "alchemy is mounted under a path" do
before do
allow(controller).to receive(:alchemy) do
double(root_path: "/cms/")
end
end

context "path is not an external URL" do
let(:path) { "/cms/admin/pages" }

it { is_expected.to be(true) }
end

context "path is an external URL" do
let(:path) { "https://evil.com" }

it { is_expected.to be(false) }
end
end
end
end
Loading