debian-mirror-gitlab/lib/gitlab/middleware/read_only/controller.rb

147 lines
4.9 KiB
Ruby
Raw Normal View History

2019-02-15 15:39:39 +05:30
# frozen_string_literal: true
2018-03-27 19:54:05 +05:30
module Gitlab
module Middleware
class ReadOnly
class Controller
DISALLOWED_METHODS = %w(POST PATCH PUT DELETE).freeze
2019-12-04 20:38:33 +05:30
APPLICATION_JSON = 'application/json'
2018-11-08 19:23:39 +05:30
APPLICATION_JSON_TYPES = %W{#{APPLICATION_JSON} application/vnd.git-lfs+json}.freeze
2019-12-04 20:38:33 +05:30
ERROR_MESSAGE = 'You cannot perform write operations on a read-only instance'
2018-03-27 19:54:05 +05:30
2018-11-08 19:23:39 +05:30
WHITELISTED_GIT_ROUTES = {
2020-03-13 15:44:24 +05:30
'repositories/git_http' => %w{git_upload_pack git_receive_pack}
2018-11-08 19:23:39 +05:30
}.freeze
WHITELISTED_GIT_LFS_ROUTES = {
2020-03-13 15:44:24 +05:30
'repositories/lfs_api' => %w{batch},
'repositories/lfs_locks_api' => %w{verify create unlock}
2018-11-08 19:23:39 +05:30
}.freeze
2019-12-21 20:55:43 +05:30
WHITELISTED_GIT_REVISION_ROUTES = {
'projects/compare' => %w{create}
}.freeze
2020-03-13 15:44:24 +05:30
WHITELISTED_SESSION_ROUTES = {
'sessions' => %w{destroy},
'admin/sessions' => %w{create destroy}
}.freeze
2019-12-21 20:55:43 +05:30
GRAPHQL_URL = '/api/graphql'
2018-03-27 19:54:05 +05:30
def initialize(app, env)
@app = app
@env = env
end
def call
if disallowed_request? && Gitlab::Database.read_only?
2020-11-24 15:15:51 +05:30
Gitlab::AppLogger.debug('GitLab ReadOnly: preventing possible non read-only operation')
2018-03-27 19:54:05 +05:30
if json_request?
return [403, { 'Content-Type' => APPLICATION_JSON }, [{ 'message' => ERROR_MESSAGE }.to_json]]
else
rack_flash.alert = ERROR_MESSAGE
rack_session['flash'] = rack_flash.to_session_value
return [301, { 'Location' => last_visited_url }, []]
end
end
@app.call(@env)
end
private
def disallowed_request?
DISALLOWED_METHODS.include?(@env['REQUEST_METHOD']) &&
!whitelisted_routes
end
def json_request?
2018-11-08 19:23:39 +05:30
APPLICATION_JSON_TYPES.include?(request.media_type)
2018-03-27 19:54:05 +05:30
end
def rack_flash
@rack_flash ||= ActionDispatch::Flash::FlashHash.from_session_value(rack_session)
end
def rack_session
@env['rack.session']
end
def request
2019-03-02 22:35:43 +05:30
@env['actionpack.request'] ||= ActionDispatch::Request.new(@env)
2018-03-27 19:54:05 +05:30
end
def last_visited_url
@env['HTTP_REFERER'] || rack_session['user_return_to'] || Gitlab::Routing.url_helpers.root_url
end
def route_hash
@route_hash ||= Rails.application.routes.recognize_path(request.url, { method: request.request_method }) rescue {}
end
2019-03-02 22:35:43 +05:30
def relative_url
File.join('', Gitlab.config.gitlab.relative_url_root).chomp('/')
end
2018-11-08 19:23:39 +05:30
# Overridden in EE module
2018-03-27 19:54:05 +05:30
def whitelisted_routes
2020-04-08 14:13:33 +05:30
workhorse_passthrough_route? || internal_route? || lfs_route? || compare_git_revisions_route? || sidekiq_route? || session_route? || graphql_query?
2018-03-27 19:54:05 +05:30
end
2020-04-08 14:13:33 +05:30
# URL for requests passed through gitlab-workhorse to rails-web
# https://gitlab.com/gitlab-org/gitlab-workhorse/-/merge_requests/12
def workhorse_passthrough_route?
2018-03-27 19:54:05 +05:30
# Calling route_hash may be expensive. Only do it if we think there's a possible match
2020-04-08 14:13:33 +05:30
return false unless request.post? &&
2018-11-08 19:23:39 +05:30
request.path.end_with?('.git/git-upload-pack', '.git/git-receive-pack')
2018-03-27 19:54:05 +05:30
2018-11-08 19:23:39 +05:30
WHITELISTED_GIT_ROUTES[route_hash[:controller]]&.include?(route_hash[:action])
2018-03-27 19:54:05 +05:30
end
2019-03-02 22:35:43 +05:30
def internal_route?
ReadOnly.internal_routes.any? { |path| request.path.include?(path) }
end
2019-12-21 20:55:43 +05:30
def compare_git_revisions_route?
# Calling route_hash may be expensive. Only do it if we think there's a possible match
return false unless request.post? && request.path.end_with?('compare')
WHITELISTED_GIT_REVISION_ROUTES[route_hash[:controller]]&.include?(route_hash[:action])
end
2019-03-02 22:35:43 +05:30
def lfs_route?
2018-03-27 19:54:05 +05:30
# Calling route_hash may be expensive. Only do it if we think there's a possible match
2018-11-08 19:23:39 +05:30
unless request.path.end_with?('/info/lfs/objects/batch',
'/info/lfs/locks', '/info/lfs/locks/verify') ||
%r{/info/lfs/locks/\d+/unlock\z}.match?(request.path)
return false
end
WHITELISTED_GIT_LFS_ROUTES[route_hash[:controller]]&.include?(route_hash[:action])
end
2018-03-27 19:54:05 +05:30
2020-03-13 15:44:24 +05:30
def session_route?
# Calling route_hash may be expensive. Only do it if we think there's a possible match
return false unless request.post? && request.path.end_with?('/users/sign_out',
'/admin/session', '/admin/session/destroy')
WHITELISTED_SESSION_ROUTES[route_hash[:controller]]&.include?(route_hash[:action])
end
2019-03-02 22:35:43 +05:30
def sidekiq_route?
request.path.start_with?("#{relative_url}/admin/sidekiq")
2018-03-27 19:54:05 +05:30
end
2019-12-21 20:55:43 +05:30
def graphql_query?
2020-10-24 23:57:45 +05:30
request.post? && request.path.start_with?(File.join(relative_url, GRAPHQL_URL))
2019-12-21 20:55:43 +05:30
end
2018-03-27 19:54:05 +05:30
end
end
end
end
2020-05-24 23:13:21 +05:30
Gitlab::Middleware::ReadOnly::Controller.prepend_if_ee('EE::Gitlab::Middleware::ReadOnly::Controller')