debian-mirror-gitlab/lib/gitlab/workhorse.rb

299 lines
8.7 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
2016-04-02 18:10:28 +05:30
require 'base64'
require 'json'
2016-09-29 09:46:39 +05:30
require 'securerandom'
2017-08-17 22:00:37 +05:30
require 'uri'
2016-04-02 18:10:28 +05:30
module Gitlab
class Workhorse
2017-08-17 22:00:37 +05:30
SEND_DATA_HEADER = 'Gitlab-Workhorse-Send-Data'.freeze
VERSION_FILE = 'GITLAB_WORKHORSE_VERSION'.freeze
INTERNAL_API_CONTENT_TYPE = 'application/vnd.gitlab-workhorse+json'.freeze
INTERNAL_API_REQUEST_HEADER = 'Gitlab-Workhorse-Api-Request'.freeze
NOTIFICATION_CHANNEL = 'workhorse:notifications'.freeze
2018-03-27 19:54:05 +05:30
ALLOWED_GIT_HTTP_ACTIONS = %w[git_receive_pack git_upload_pack info_refs].freeze
2019-02-15 15:39:39 +05:30
DETECT_HEADER = 'Gitlab-Workhorse-Detect-Content-Type'.freeze
2016-09-29 09:46:39 +05:30
# Supposedly the effective key size for HMAC-SHA256 is 256 bits, i.e. 32
# bytes https://tools.ietf.org/html/rfc4868#section-2.6
SECRET_LENGTH = 32
2016-06-02 11:05:42 +05:30
2016-04-02 18:10:28 +05:30
class << self
2019-07-07 11:18:12 +05:30
def git_http_ok(repository, repo_type, user, action, show_all_refs: false)
2018-03-27 19:54:05 +05:30
raise "Unsupported action: #{action}" unless ALLOWED_GIT_HTTP_ACTIONS.include?(action.to_s)
2017-08-17 22:00:37 +05:30
project = repository.project
2018-05-09 12:01:36 +05:30
2018-11-20 20:47:30 +05:30
attrs = {
2016-09-29 09:46:39 +05:30
GL_ID: Gitlab::GlId.gl_id(user),
2019-07-07 11:18:12 +05:30
GL_REPOSITORY: repo_type.identifier_for_subject(project),
2018-03-17 18:26:18 +05:30
GL_USERNAME: user&.username,
2018-05-09 12:01:36 +05:30
ShowAllRefs: show_all_refs,
Repository: repository.gitaly_repository.to_h,
2018-11-20 20:47:30 +05:30
GitConfigOptions: [],
2018-05-09 12:01:36 +05:30
GitalyServer: {
address: Gitlab::GitalyClient.address(project.repository_storage),
token: Gitlab::GitalyClient.token(project.repository_storage)
}
2016-09-29 09:46: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
attrs[:GitConfigOptions] << "receive.maxInputSize=#{receive_max_input_size.megabytes}"
end
attrs
2016-09-29 09:46:39 +05:30
end
2016-04-02 18:10:28 +05:30
def send_git_blob(repository, blob)
2018-11-18 11:00:15 +05:30
params = {
'GitalyServer' => gitaly_server_hash(repository),
'GetBlobRequest' => {
repository: repository.gitaly_repository.to_h,
oid: blob.id,
limit: -1
}
}
2016-04-02 18:10:28 +05:30
[
2016-06-02 11:05:42 +05:30
SEND_DATA_HEADER,
"git-blob:#{encode(params)}"
2016-04-02 18:10:28 +05:30
]
end
2016-06-02 11:05:42 +05:30
2019-07-31 22:56:46 +05:30
def send_git_archive(repository, ref:, format:, append_sha:, path: nil)
path_enabled = Feature.enabled?(:git_archive_path, default_enabled: true)
path = nil unless path_enabled
2016-06-02 11:05:42 +05:30
format ||= 'tar.gz'
2018-12-13 13:39:08 +05:30
format = format.downcase
2016-06-02 11:05:42 +05:30
2019-07-31 22:56:46 +05:30
metadata = repository.archive_metadata(
ref,
Gitlab.config.gitlab.repository_downloads_path,
format,
append_sha: append_sha,
path: path
)
2018-03-17 18:26:18 +05:30
2019-07-31 22:56:46 +05:30
raise "Repository or ref not found" if metadata.empty?
params =
if path_enabled
send_git_archive_params(repository, metadata, path, archive_format(format))
else
metadata
end
# If present, DisableCache must be a Boolean. Otherwise
# workhorse ignores it.
2018-03-17 18:26:18 +05:30
params['DisableCache'] = true if git_archive_cache_disabled?
2019-07-31 22:56:46 +05:30
params['GitalyServer'] = gitaly_server_hash(repository)
2018-03-17 18:26:18 +05:30
2016-06-02 11:05:42 +05:30
[
SEND_DATA_HEADER,
"git-archive:#{encode(params)}"
2016-06-02 11:05:42 +05:30
]
end
2018-05-09 12:01:36 +05:30
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
def send_git_diff(repository, diff_refs)
2018-11-18 11:00:15 +05:30
params = {
'GitalyServer' => gitaly_server_hash(repository),
'RawDiffRequest' => Gitaly::RawDiffRequest.new(
gitaly_diff_or_patch_hash(repository, diff_refs)
).to_json
}
[
SEND_DATA_HEADER,
"git-diff:#{encode(params)}"
]
end
2016-08-24 12:49:21 +05:30
def send_git_patch(repository, diff_refs)
2018-11-18 11:00:15 +05:30
params = {
'GitalyServer' => gitaly_server_hash(repository),
'RawPatchRequest' => Gitaly::RawPatchRequest.new(
gitaly_diff_or_patch_hash(repository, diff_refs)
).to_json
}
2016-08-24 12:49:21 +05:30
[
SEND_DATA_HEADER,
"git-format-patch:#{encode(params)}"
]
end
def send_artifacts_entry(build, entry)
2018-03-17 18:26:18 +05:30
file = build.artifacts_file
archive = file.file_storage? ? file.path : file.url
2016-08-24 12:49:21 +05:30
params = {
2018-03-17 18:26:18 +05:30
'Archive' => archive,
'Entry' => Base64.encode64(entry.to_s)
2016-08-24 12:49:21 +05:30
}
[
SEND_DATA_HEADER,
"artifacts-entry:#{encode(params)}"
]
end
2018-03-17 18:26:18 +05:30
def send_url(url, allow_redirects: false)
params = {
'URL' => url,
'AllowRedirects' => allow_redirects
}
[
SEND_DATA_HEADER,
"send-url:#{encode(params)}"
]
end
2019-07-07 11:18:12 +05:30
def channel_websocket(channel)
2017-08-17 22:00:37 +05:30
details = {
2019-07-07 11:18:12 +05:30
'Channel' => {
'Subprotocols' => channel[:subprotocols],
'Url' => channel[:url],
'Header' => channel[:headers],
'MaxSessionTime' => channel[:max_session_time]
2017-08-17 22:00:37 +05:30
}
}
2019-07-07 11:18:12 +05:30
details['Channel']['CAPem'] = channel[:ca_pem] if channel.key?(:ca_pem)
2017-08-17 22:00:37 +05:30
details
end
2016-09-13 17:45:13 +05:30
def version
path = Rails.root.join(VERSION_FILE)
path.readable? ? path.read.chomp : 'unknown'
end
2016-09-29 09:46:39 +05:30
def secret
@secret ||= begin
bytes = Base64.strict_decode64(File.read(secret_path).chomp)
raise "#{secret_path} does not contain #{SECRET_LENGTH} bytes" if bytes.length != SECRET_LENGTH
2018-03-17 18:26:18 +05:30
2016-09-29 09:46:39 +05:30
bytes
end
end
2016-11-03 12:29:30 +05:30
2016-09-29 09:46:39 +05:30
def write_secret
bytes = SecureRandom.random_bytes(SECRET_LENGTH)
2016-11-03 12:29:30 +05:30
File.open(secret_path, 'w:BINARY', 0600) do |f|
f.chmod(0600) # If the file already existed, the '0600' passed to 'open' above was a no-op.
2016-09-29 09:46:39 +05:30
f.write(Base64.strict_encode64(bytes))
end
end
2016-11-03 12:29:30 +05:30
2016-09-29 09:46:39 +05:30
def verify_api_request!(request_headers)
2017-08-17 22:00:37 +05:30
decode_jwt(request_headers[INTERNAL_API_REQUEST_HEADER])
end
def decode_jwt(encoded_message)
2016-09-29 09:46:39 +05:30
JWT.decode(
2017-08-17 22:00:37 +05:30
encoded_message,
2016-09-29 09:46:39 +05:30
secret,
true,
2017-09-10 17:25:29 +05:30
{ iss: 'gitlab-workhorse', verify_iss: true, algorithm: 'HS256' }
2016-09-29 09:46:39 +05:30
)
end
def secret_path
2017-08-17 22:00:37 +05:30
Gitlab.config.workhorse.secret_file
end
def set_key_and_notify(key, value, expire: nil, overwrite: true)
2019-10-12 21:52:04 +05:30
Gitlab::Redis::SharedState.with do |redis|
2017-08-17 22:00:37 +05:30
result = redis.set(key, value, ex: expire, nx: !overwrite)
if result
redis.publish(NOTIFICATION_CHANNEL, "#{key}=#{value}")
value
else
redis.get(key)
end
end
2016-09-29 09:46:39 +05:30
end
2016-11-03 12:29:30 +05:30
2016-06-02 11:05:42 +05:30
protected
2019-07-31 22:56:46 +05:30
# This is the outermost encoding of a senddata: header. It is safe for
# inclusion in HTTP response headers
2016-06-02 11:05:42 +05:30
def encode(hash)
Base64.urlsafe_encode64(JSON.dump(hash))
end
2017-09-10 17:25:29 +05:30
2019-07-31 22:56:46 +05:30
# This is for encoding individual fields inside the senddata JSON that
# contain binary data. In workhorse, the corresponding struct field should
# be type []byte
def encode_binary(binary)
Base64.encode64(binary)
end
2017-09-10 17:25:29 +05:30
def gitaly_server_hash(repository)
{
address: Gitlab::GitalyClient.address(repository.project.repository_storage),
token: Gitlab::GitalyClient.token(repository.project.repository_storage)
}
end
2018-03-17 18:26:18 +05:30
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
def git_archive_cache_disabled?
ENV['WORKHORSE_ARCHIVE_CACHE_DISABLED'].present? || Feature.enabled?(:workhorse_archive_cache_disabled)
end
2019-07-31 22:56:46 +05:30
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
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-04-02 18:10:28 +05:30
end
end
end