2018-10-22 07:00:50 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-02-01 10:33:22 +00:00
|
|
|
require 'base64'
|
|
|
|
require 'json'
|
2016-08-19 17:10:41 +00:00
|
|
|
require 'securerandom'
|
2017-03-24 17:22:42 +00:00
|
|
|
require 'uri'
|
2016-02-01 10:33:22 +00:00
|
|
|
|
|
|
|
module Gitlab
|
|
|
|
class Workhorse
|
2019-08-31 19:25:25 +00:00
|
|
|
SEND_DATA_HEADER = 'Gitlab-Workhorse-Send-Data'
|
|
|
|
VERSION_FILE = 'GITLAB_WORKHORSE_VERSION'
|
|
|
|
INTERNAL_API_CONTENT_TYPE = 'application/vnd.gitlab-workhorse+json'
|
|
|
|
INTERNAL_API_REQUEST_HEADER = 'Gitlab-Workhorse-Api-Request'
|
|
|
|
NOTIFICATION_CHANNEL = 'workhorse:notifications'
|
2018-03-07 15:22:37 +00:00
|
|
|
ALLOWED_GIT_HTTP_ACTIONS = %w[git_receive_pack git_upload_pack info_refs].freeze
|
2019-08-31 19:25:25 +00:00
|
|
|
DETECT_HEADER = 'Gitlab-Workhorse-Detect-Content-Type'
|
2019-10-31 15:06:41 +00:00
|
|
|
ARCHIVE_FORMATS = %w(zip tar.gz tar.bz2 tar).freeze
|
2016-08-19 17:10:41 +00:00
|
|
|
|
2019-09-03 23:03:20 +00:00
|
|
|
include JwtAuthenticatable
|
2016-02-02 13:09:55 +00:00
|
|
|
|
2016-02-11 17:10:14 +00:00
|
|
|
class << self
|
2019-03-18 16:51:11 +00:00
|
|
|
def git_http_ok(repository, repo_type, user, action, show_all_refs: false)
|
2018-03-07 15:22:37 +00:00
|
|
|
raise "Unsupported action: #{action}" unless ALLOWED_GIT_HTTP_ACTIONS.include?(action.to_s)
|
2018-03-06 14:17:00 +00:00
|
|
|
|
2018-08-01 14:47:14 +00:00
|
|
|
attrs = {
|
2016-08-19 17:10:41 +00:00
|
|
|
GL_ID: Gitlab::GlId.gl_id(user),
|
2020-03-05 00:07:49 +00:00
|
|
|
GL_REPOSITORY: repo_type.identifier_for_container(repository.container),
|
2017-08-03 18:38:33 +00:00
|
|
|
GL_USERNAME: user&.username,
|
2018-03-29 08:35:33 +00:00
|
|
|
ShowAllRefs: show_all_refs,
|
|
|
|
Repository: repository.gitaly_repository.to_h,
|
2018-08-01 14:47:14 +00:00
|
|
|
GitConfigOptions: [],
|
2018-03-29 08:35:33 +00:00
|
|
|
GitalyServer: {
|
2019-12-27 15:08:16 +00:00
|
|
|
address: Gitlab::GitalyClient.address(repository.storage),
|
|
|
|
token: Gitlab::GitalyClient.token(repository.storage),
|
2019-08-28 16:51:17 +00:00
|
|
|
features: Feature::Gitaly.server_feature_flags
|
2018-03-29 08:35:33 +00:00
|
|
|
}
|
2017-07-06 12:45:29 +00:00
|
|
|
}
|
2018-08-01 14:47:14 +00:00
|
|
|
|
|
|
|
# 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
|
|
|
|
attrs[:GitConfigOptions] << "receive.maxInputSize=#{receive_max_input_size.megabytes}"
|
|
|
|
end
|
|
|
|
|
|
|
|
attrs
|
2016-04-06 15:52:12 +00:00
|
|
|
end
|
|
|
|
|
2016-02-01 10:33:22 +00:00
|
|
|
def send_git_blob(repository, blob)
|
2018-07-09 10:02:02 +00:00
|
|
|
params = {
|
|
|
|
'GitalyServer' => gitaly_server_hash(repository),
|
|
|
|
'GetBlobRequest' => {
|
|
|
|
repository: repository.gitaly_repository.to_h,
|
|
|
|
oid: blob.id,
|
|
|
|
limit: -1
|
|
|
|
}
|
|
|
|
}
|
2016-02-01 10:33:22 +00:00
|
|
|
|
|
|
|
[
|
2016-02-02 13:09:55 +00:00
|
|
|
SEND_DATA_HEADER,
|
2016-06-08 12:30:15 +00:00
|
|
|
"git-blob:#{encode(params)}"
|
2016-02-01 10:33:22 +00:00
|
|
|
]
|
|
|
|
end
|
2016-02-02 13:09:55 +00:00
|
|
|
|
2019-04-11 14:03:02 +00:00
|
|
|
def send_git_archive(repository, ref:, format:, append_sha:, path: nil)
|
2019-04-11 14:33:27 +00:00
|
|
|
path_enabled = Feature.enabled?(:git_archive_path, default_enabled: true)
|
|
|
|
path = nil unless path_enabled
|
|
|
|
|
2016-02-02 13:09:55 +00:00
|
|
|
format ||= 'tar.gz'
|
2018-10-22 07:00:50 +00:00
|
|
|
format = format.downcase
|
2019-04-11 14:33:27 +00:00
|
|
|
|
|
|
|
metadata = repository.archive_metadata(
|
|
|
|
ref,
|
|
|
|
Gitlab.config.gitlab.repository_downloads_path,
|
|
|
|
format,
|
|
|
|
append_sha: append_sha,
|
|
|
|
path: path
|
|
|
|
)
|
2016-02-02 13:09:55 +00:00
|
|
|
|
2019-04-11 14:03:02 +00:00
|
|
|
raise "Repository or ref not found" if metadata.empty?
|
|
|
|
|
2019-04-11 14:33:27 +00:00
|
|
|
params =
|
|
|
|
if path_enabled
|
|
|
|
send_git_archive_params(repository, metadata, path, archive_format(format))
|
|
|
|
else
|
|
|
|
metadata
|
|
|
|
end
|
2017-10-01 00:13:23 +00:00
|
|
|
|
2019-04-11 14:33:27 +00:00
|
|
|
# If present, DisableCache must be a Boolean. Otherwise
|
|
|
|
# workhorse ignores it.
|
2018-01-09 15:59:46 +00:00
|
|
|
params['DisableCache'] = true if git_archive_cache_disabled?
|
2019-04-11 14:33:27 +00:00
|
|
|
params['GitalyServer'] = gitaly_server_hash(repository)
|
2018-01-09 15:59:46 +00:00
|
|
|
|
2016-02-02 13:09:55 +00:00
|
|
|
[
|
|
|
|
SEND_DATA_HEADER,
|
2016-06-08 12:30:15 +00:00
|
|
|
"git-archive:#{encode(params)}"
|
2016-02-02 13:09:55 +00:00
|
|
|
]
|
|
|
|
end
|
2016-05-12 18:50:49 +00:00
|
|
|
|
2018-04-03 17:57:55 +00:00
|
|
|
def send_git_snapshot(repository)
|
|
|
|
params = {
|
|
|
|
'GitalyServer' => gitaly_server_hash(repository),
|
|
|
|
'GetSnapshotRequest' => Gitaly::GetSnapshotRequest.new(
|
|
|
|
repository: repository.gitaly_repository
|
|
|
|
).to_json
|
|
|
|
}
|
|
|
|
|
|
|
|
[
|
|
|
|
SEND_DATA_HEADER,
|
|
|
|
"git-snapshot:#{encode(params)}"
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2016-06-08 12:30:15 +00:00
|
|
|
def send_git_diff(repository, diff_refs)
|
2018-07-06 10:01:15 +00:00
|
|
|
params = {
|
|
|
|
'GitalyServer' => gitaly_server_hash(repository),
|
|
|
|
'RawDiffRequest' => Gitaly::RawDiffRequest.new(
|
|
|
|
gitaly_diff_or_patch_hash(repository, diff_refs)
|
|
|
|
).to_json
|
|
|
|
}
|
2016-05-12 18:50:49 +00:00
|
|
|
|
|
|
|
[
|
|
|
|
SEND_DATA_HEADER,
|
|
|
|
"git-diff:#{encode(params)}"
|
2016-02-02 13:09:55 +00:00
|
|
|
]
|
|
|
|
end
|
2016-06-06 11:16:30 +00:00
|
|
|
|
2016-07-03 21:01:13 +00:00
|
|
|
def send_git_patch(repository, diff_refs)
|
2018-07-11 10:59:15 +00:00
|
|
|
params = {
|
|
|
|
'GitalyServer' => gitaly_server_hash(repository),
|
|
|
|
'RawPatchRequest' => Gitaly::RawPatchRequest.new(
|
|
|
|
gitaly_diff_or_patch_hash(repository, diff_refs)
|
|
|
|
).to_json
|
|
|
|
}
|
2016-06-10 12:57:50 +00:00
|
|
|
|
|
|
|
[
|
2016-06-28 12:59:25 +00:00
|
|
|
SEND_DATA_HEADER,
|
2016-06-10 12:57:50 +00:00
|
|
|
"git-format-patch:#{encode(params)}"
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2017-09-08 12:04:44 +00:00
|
|
|
def send_artifacts_entry(build, entry)
|
2018-01-29 17:57:34 +00:00
|
|
|
file = build.artifacts_file
|
|
|
|
archive = file.file_storage? ? file.path : file.url
|
|
|
|
|
2016-07-05 14:58:38 +00:00
|
|
|
params = {
|
2018-01-29 17:57:34 +00:00
|
|
|
'Archive' => archive,
|
2017-09-08 12:04:44 +00:00
|
|
|
'Entry' => Base64.encode64(entry.to_s)
|
2016-07-05 14:58:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
[
|
|
|
|
SEND_DATA_HEADER,
|
|
|
|
"artifacts-entry:#{encode(params)}"
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2018-02-06 14:31:39 +00:00
|
|
|
def send_url(url, allow_redirects: false)
|
|
|
|
params = {
|
|
|
|
'URL' => url,
|
|
|
|
'AllowRedirects' => allow_redirects
|
|
|
|
}
|
|
|
|
|
|
|
|
[
|
|
|
|
SEND_DATA_HEADER,
|
|
|
|
"send-url:#{encode(params)}"
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2019-04-04 18:32:02 +00:00
|
|
|
def channel_websocket(channel)
|
2016-11-22 19:55:56 +00:00
|
|
|
details = {
|
2019-04-04 18:32:02 +00:00
|
|
|
'Channel' => {
|
|
|
|
'Subprotocols' => channel[:subprotocols],
|
|
|
|
'Url' => channel[:url],
|
|
|
|
'Header' => channel[:headers],
|
|
|
|
'MaxSessionTime' => channel[:max_session_time]
|
2016-11-22 19:55:56 +00:00
|
|
|
}
|
|
|
|
}
|
2019-04-04 18:32:02 +00:00
|
|
|
details['Channel']['CAPem'] = channel[:ca_pem] if channel.key?(:ca_pem)
|
2016-11-22 19:55:56 +00:00
|
|
|
|
|
|
|
details
|
|
|
|
end
|
|
|
|
|
2016-07-18 11:58:08 +00:00
|
|
|
def version
|
2016-07-21 20:04:28 +00:00
|
|
|
path = Rails.root.join(VERSION_FILE)
|
|
|
|
path.readable? ? path.read.chomp : 'unknown'
|
2016-07-18 11:58:08 +00:00
|
|
|
end
|
|
|
|
|
2016-08-19 17:10:41 +00:00
|
|
|
def verify_api_request!(request_headers)
|
2016-08-18 14:31:44 +00:00
|
|
|
decode_jwt(request_headers[INTERNAL_API_REQUEST_HEADER])
|
|
|
|
end
|
|
|
|
|
|
|
|
def decode_jwt(encoded_message)
|
2019-09-03 23:03:20 +00:00
|
|
|
decode_jwt_for_issuer('gitlab-workhorse', encoded_message)
|
2016-08-19 17:10:41 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def secret_path
|
2017-03-31 00:37:45 +00:00
|
|
|
Gitlab.config.workhorse.secret_file
|
2016-08-19 17:10:41 +00:00
|
|
|
end
|
2016-09-20 16:21:52 +00:00
|
|
|
|
2017-03-06 10:44:45 +00:00
|
|
|
def set_key_and_notify(key, value, expire: nil, overwrite: true)
|
2019-07-22 06:00:37 +00:00
|
|
|
Gitlab::Redis::SharedState.with do |redis|
|
2017-02-28 11:07:04 +00:00
|
|
|
result = redis.set(key, value, ex: expire, nx: !overwrite)
|
|
|
|
if result
|
2017-03-06 10:44:45 +00:00
|
|
|
redis.publish(NOTIFICATION_CHANNEL, "#{key}=#{value}")
|
2017-02-28 11:07:04 +00:00
|
|
|
value
|
|
|
|
else
|
|
|
|
redis.get(key)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-02-02 13:09:55 +00:00
|
|
|
protected
|
2016-06-06 11:16:30 +00:00
|
|
|
|
2019-04-11 14:29:08 +00:00
|
|
|
# This is the outermost encoding of a senddata: header. It is safe for
|
|
|
|
# inclusion in HTTP response headers
|
2016-02-02 13:09:55 +00:00
|
|
|
def encode(hash)
|
|
|
|
Base64.urlsafe_encode64(JSON.dump(hash))
|
|
|
|
end
|
2017-07-10 03:43:20 +00:00
|
|
|
|
2019-04-11 14:29:08 +00:00
|
|
|
# This is for encoding individual fields inside the senddata JSON that
|
|
|
|
# contain binary data. In workhorse, the corresponding struct field should
|
|
|
|
# be type []byte
|
2019-04-11 14:03:02 +00:00
|
|
|
def encode_binary(binary)
|
2019-04-11 14:29:08 +00:00
|
|
|
Base64.encode64(binary)
|
2019-04-11 14:03:02 +00:00
|
|
|
end
|
|
|
|
|
2017-07-10 03:43:20 +00:00
|
|
|
def gitaly_server_hash(repository)
|
|
|
|
{
|
2020-03-30 18:08:07 +00:00
|
|
|
address: Gitlab::GitalyClient.address(repository.container.repository_storage),
|
|
|
|
token: Gitlab::GitalyClient.token(repository.container.repository_storage),
|
2019-08-28 16:51:17 +00:00
|
|
|
features: Feature::Gitaly.server_feature_flags
|
2017-07-10 03:43:20 +00:00
|
|
|
}
|
|
|
|
end
|
2017-10-02 18:51:20 +00:00
|
|
|
|
|
|
|
def gitaly_diff_or_patch_hash(repository, diff_refs)
|
|
|
|
{
|
|
|
|
repository: repository.gitaly_repository,
|
|
|
|
left_commit_id: diff_refs.base_sha,
|
|
|
|
right_commit_id: diff_refs.head_sha
|
|
|
|
}
|
|
|
|
end
|
2018-01-09 15:59:46 +00:00
|
|
|
|
|
|
|
def git_archive_cache_disabled?
|
|
|
|
ENV['WORKHORSE_ARCHIVE_CACHE_DISABLED'].present? || Feature.enabled?(:workhorse_archive_cache_disabled)
|
|
|
|
end
|
2019-04-11 14:03:02 +00:00
|
|
|
|
|
|
|
def archive_format(format)
|
|
|
|
case format
|
|
|
|
when "tar.bz2", "tbz", "tbz2", "tb2", "bz2"
|
|
|
|
Gitaly::GetArchiveRequest::Format::TAR_BZ2
|
|
|
|
when "tar"
|
|
|
|
Gitaly::GetArchiveRequest::Format::TAR
|
|
|
|
when "zip"
|
|
|
|
Gitaly::GetArchiveRequest::Format::ZIP
|
|
|
|
else
|
|
|
|
Gitaly::GetArchiveRequest::Format::TAR_GZ
|
|
|
|
end
|
|
|
|
end
|
2019-04-11 14:33:27 +00:00
|
|
|
|
|
|
|
def send_git_archive_params(repository, metadata, path, format)
|
|
|
|
{
|
|
|
|
'ArchivePath' => metadata['ArchivePath'],
|
|
|
|
'GetArchiveRequest' => encode_binary(
|
|
|
|
Gitaly::GetArchiveRequest.new(
|
|
|
|
repository: repository.gitaly_repository,
|
|
|
|
commit_id: metadata['CommitId'],
|
|
|
|
prefix: metadata['ArchivePrefix'],
|
|
|
|
format: format,
|
|
|
|
path: path.presence || ""
|
|
|
|
).to_proto
|
|
|
|
)
|
|
|
|
}
|
|
|
|
end
|
2016-02-01 10:33:22 +00:00
|
|
|
end
|
|
|
|
end
|
2016-02-01 11:27:35 +00:00
|
|
|
end
|