debian-mirror-gitlab/lib/api/internal.rb

298 lines
10 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module API
# Internal access API
class Internal < Grape::API
2015-04-26 12:48:37 +05:30
before { authenticate_by_gitlab_shell_token! }
2017-08-17 22:00:37 +05:30
helpers ::API::Helpers::InternalHelpers
2018-03-17 18:26:18 +05:30
helpers ::Gitlab::Identifier
2017-08-17 22:00:37 +05:30
2018-11-20 20:47:30 +05:30
UNKNOWN_CHECK_RESULT_ERROR = 'Unknown check result'.freeze
helpers do
def response_with_status(code: 200, success: true, message: nil, **extra_options)
status code
{ status: success, message: message }.merge(extra_options).compact
end
2019-07-07 11:18:12 +05:30
def lfs_authentication_url(project)
# This is a separate method so that EE can alter its behaviour more
# easily.
project.http_url_to_repo
end
2018-11-20 20:47:30 +05:30
end
2014-09-02 18:07:02 +05:30
namespace 'internal' do
2018-11-20 20:47:30 +05:30
# Check if git command is allowed for project
2014-09-02 18:07:02 +05:30
#
# Params:
# key_id - ssh key id for Git over SSH
2018-11-18 11:00:15 +05:30
# user_id - user id for Git over HTTP or over SSH in keyless SSH CERT mode
# username - user name for Git over SSH in keyless SSH cert mode
2017-08-17 22:00:37 +05:30
# protocol - Git access protocol being used, e.g. HTTP or SSH
2018-03-27 19:54:05 +05:30
# project - project full_path (not path on disk)
2014-09-02 18:07:02 +05:30
# action - git action (git-upload-pack or git-receive-pack)
2017-08-17 22:00:37 +05:30
# changes - changes as "oldrev newrev ref", see Gitlab::ChangesList
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2015-04-26 12:48:37 +05:30
post "/allowed" do
2017-08-17 22:00:37 +05:30
# Stores some Git-specific env thread-safely
2018-03-17 18:26:18 +05:30
env = parse_env
2018-05-09 12:01:36 +05:30
Gitlab::Git::HookEnv.set(gl_repository, env) if project
2017-08-17 22:00:37 +05:30
2016-06-02 11:05:42 +05:30
actor =
2015-04-26 12:48:37 +05:30
if params[:key_id]
Key.find_by(id: params[:key_id])
elsif params[:user_id]
User.find_by(id: params[:user_id])
2018-11-18 11:00:15 +05:30
elsif params[:username]
2018-12-13 13:39:08 +05:30
UserFinder.new(params[:username]).find_by_username
2015-04-26 12:48:37 +05:30
end
2016-08-24 12:49:21 +05:30
protocol = params[:protocol]
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
actor.update_last_used_at if actor.is_a?(Key)
2018-03-17 18:26:18 +05:30
user =
if actor.is_a?(Key)
actor.user
else
actor
end
2015-04-26 12:48:37 +05:30
2019-07-07 11:18:12 +05:30
access_checker_klass = repo_type.access_checker_class
2018-03-17 18:26:18 +05:30
access_checker = access_checker_klass.new(actor, project,
protocol, authentication_abilities: ssh_authentication_abilities,
namespace_path: namespace_path, project_path: project_path,
redirected_path: redirected_path)
2017-09-10 17:25:29 +05:30
2018-11-20 20:47:30 +05:30
check_result = begin
result = access_checker.check(params[:action], params[:changes])
@project ||= access_checker.project
result
rescue Gitlab::GitAccess::UnauthorizedError => e
break response_with_status(code: 401, success: false, message: e.message)
2018-12-13 13:39:08 +05:30
rescue Gitlab::GitAccess::TimeoutError => e
break response_with_status(code: 503, success: false, message: e.message)
2018-11-20 20:47:30 +05:30
rescue Gitlab::GitAccess::NotFoundError => e
break response_with_status(code: 404, success: false, message: e.message)
end
2016-08-24 12:49:21 +05:30
2017-09-10 17:25:29 +05:30
log_user_activity(actor)
2018-11-20 20:47:30 +05:30
case check_result
when ::Gitlab::GitAccessResult::Success
payload = {
gl_repository: gl_repository,
2019-07-07 11:18:12 +05:30
gl_project_path: gl_project_path,
2018-11-20 20:47:30 +05:30
gl_id: Gitlab::GlId.gl_id(user),
gl_username: user&.username,
git_config_options: [],
2019-07-07 11:18:12 +05:30
gitaly: gitaly_payload(params[:action]),
gl_console_messages: check_result.console_messages
2018-11-20 20:47:30 +05:30
}
2018-11-08 19:23:39 +05:30
2018-11-20 20:47:30 +05:30
# Custom option for git-receive-pack command
receive_max_input_size = Gitlab::CurrentSettings.receive_max_input_size.to_i
if receive_max_input_size > 0
payload[:git_config_options] << "receive.maxInputSize=#{receive_max_input_size.megabytes}"
end
response_with_status(**payload)
when ::Gitlab::GitAccessResult::CustomAction
response_with_status(code: 300, message: check_result.message, payload: check_result.payload)
else
response_with_status(code: 500, success: false, message: UNKNOWN_CHECK_RESULT_ERROR)
end
2014-09-02 18:07:02 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2014-09-02 18:07:02 +05:30
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2016-09-29 09:46:39 +05:30
post "/lfs_authenticate" do
status 200
2018-11-18 11:00:15 +05:30
if params[:key_id]
actor = Key.find(params[:key_id])
actor.update_last_used_at
elsif params[:user_id]
actor = User.find_by(id: params[:user_id])
raise ActiveRecord::RecordNotFound.new("No such user id!") unless actor
else
raise ActiveRecord::RecordNotFound.new("No key_id or user_id passed!")
end
2017-08-17 22:00:37 +05:30
2019-07-07 11:18:12 +05:30
Gitlab::LfsToken
.new(actor)
.authentication_payload(lfs_authentication_url(project))
2016-09-29 09:46:39 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-09-29 09:46:39 +05:30
2016-09-13 17:45:13 +05:30
get "/merge_request_urls" do
2018-03-17 18:26:18 +05:30
merge_request_urls
end
#
# Get a ssh key using the fingerprint
#
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2018-03-17 18:26:18 +05:30
get "/authorized_keys" do
fingerprint = params.fetch(:fingerprint) do
Gitlab::InsecureKeyFingerprint.new(params.fetch(:key)).fingerprint
end
key = Key.find_by(fingerprint: fingerprint)
not_found!("Key") if key.nil?
present key, with: Entities::SSHKey
2016-09-13 17:45:13 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2016-09-13 17:45:13 +05:30
2014-09-02 18:07:02 +05:30
#
2018-11-18 11:00:15 +05:30
# Discover user by ssh key, user id or username
2014-09-02 18:07:02 +05:30
#
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2014-09-02 18:07:02 +05:30
get "/discover" do
2017-09-10 17:25:29 +05:30
if params[:key_id]
key = Key.find(params[:key_id])
user = key.user
elsif params[:user_id]
user = User.find_by(id: params[:user_id])
2018-11-18 11:00:15 +05:30
elsif params[:username]
2018-12-13 13:39:08 +05:30
user = UserFinder.new(params[:username]).find_by_username
2017-09-10 17:25:29 +05:30
end
2018-03-17 18:26:18 +05:30
2017-09-10 17:25:29 +05:30
present user, with: Entities::UserSafe
2014-09-02 18:07:02 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2014-09-02 18:07:02 +05:30
get "/check" do
{
api_version: API.version,
gitlab_version: Gitlab::VERSION,
2018-10-15 14:42:47 +05:30
gitlab_rev: Gitlab.revision,
2018-03-17 18:26:18 +05:30
redis: redis_ping
2014-09-02 18:07:02 +05:30
}
end
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
get "/broadcast_messages" do
if messages = BroadcastMessage.current
present messages, with: Entities::BroadcastMessage
else
[]
end
end
2015-04-26 12:48:37 +05:30
get "/broadcast_message" do
2017-09-10 17:25:29 +05:30
if message = BroadcastMessage.current&.last
2015-04-26 12:48:37 +05:30
present message, with: Entities::BroadcastMessage
else
{}
end
end
2016-09-29 09:46:39 +05:30
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2016-09-29 09:46:39 +05:30
post '/two_factor_recovery_codes' do
status 200
2018-11-18 11:00:15 +05:30
if params[:key_id]
key = Key.find_by(id: params[:key_id])
2016-09-29 09:46:39 +05:30
2018-11-18 11:00:15 +05:30
if key
key.update_last_used_at
else
break { 'success' => false, 'message' => 'Could not find the given key' }
end
2016-09-29 09:46:39 +05:30
2018-11-18 11:00:15 +05:30
if key.is_a?(DeployKey)
break { success: false, message: 'Deploy keys cannot be used to retrieve recovery codes' }
end
user = key.user
2016-09-29 09:46:39 +05:30
2018-11-18 11:00:15 +05:30
unless user
break { success: false, message: 'Could not find a user for the given key' }
end
elsif params[:user_id]
user = User.find_by(id: params[:user_id])
2016-09-29 09:46:39 +05:30
2018-11-18 11:00:15 +05:30
unless user
break { success: false, message: 'Could not find the given user' }
end
2016-09-29 09:46:39 +05:30
end
unless user.two_factor_enabled?
2018-10-15 14:42:47 +05:30
break { success: false, message: 'Two-factor authentication is not enabled for this user' }
2016-09-29 09:46:39 +05:30
end
2017-09-10 17:25:29 +05:30
codes = nil
2018-03-17 18:26:18 +05:30
::Users::UpdateService.new(current_user, user: user).execute! do |user|
2017-09-10 17:25:29 +05:30
codes = user.generate_otp_backup_codes!
end
2016-09-29 09:46:39 +05:30
{ success: true, recovery_codes: codes }
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
post '/pre_receive' do
status 200
reference_counter_increased = Gitlab::ReferenceCounter.new(params[:gl_repository]).increase
{ reference_counter_increased: reference_counter_increased }
end
2017-08-17 22:00:37 +05:30
post "/notify_post_receive" do
status 200
# TODO: Re-enable when Gitaly is processing the post-receive notification
# return unless Gitlab::GitalyClient.enabled?
#
# begin
# repository = wiki? ? project.wiki.repository : project.repository
2017-09-10 17:25:29 +05:30
# Gitlab::GitalyClient::NotificationService.new(repository.raw_repository).post_receive
2017-08-17 22:00:37 +05:30
# rescue GRPC::Unavailable => e
# render_api_error!(e, 500)
# end
end
2018-03-17 18:26:18 +05:30
post '/post_receive' do
status 200
2019-02-15 15:39:39 +05:30
2019-07-07 11:18:12 +05:30
output = {} # Messages to gitlab-shell
user = identify(params[:identifier])
project = Gitlab::GlRepository.parse(params[:gl_repository]).first
push_options = Gitlab::PushOptions.new(params[:push_options])
2018-03-17 18:26:18 +05:30
PostReceive.perform_async(params[:gl_repository], params[:identifier],
2019-07-07 11:18:12 +05:30
params[:changes], push_options.as_json)
if Feature.enabled?(:mr_push_options, default_enabled: true)
2019-07-31 22:56:46 +05:30
Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/61359')
2019-07-07 11:18:12 +05:30
mr_options = push_options.get(:merge_request)
output.merge!(process_mr_push_options(mr_options, project, user, params[:changes])) if mr_options.present?
end
2018-03-17 18:26:18 +05:30
broadcast_message = BroadcastMessage.current&.last&.message
reference_counter_decreased = Gitlab::ReferenceCounter.new(params[:gl_repository]).decrease
2019-07-07 11:18:12 +05:30
output.merge!(
2018-03-17 18:26:18 +05:30
broadcast_message: broadcast_message,
2019-07-07 11:18:12 +05:30
reference_counter_decreased: reference_counter_decreased,
merge_request_urls: merge_request_urls
)
2018-03-17 18:26:18 +05:30
# A user is not guaranteed to be returned; an orphaned write deploy
# key could be used
if user
redirect_message = Gitlab::Checks::ProjectMoved.fetch_message(user.id, project.id)
project_created_message = Gitlab::Checks::ProjectCreated.fetch_message(user.id, project.id)
output[:redirected_message] = redirect_message if redirect_message
output[:project_created_message] = project_created_message if project_created_message
end
output
end
2014-09-02 18:07:02 +05:30
end
end
end