debian-mirror-gitlab/lib/container_registry/client.rb

168 lines
5.2 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
2016-06-02 11:05:42 +05:30
module ContainerRegistry
2022-04-04 11:22:00 +05:30
class Client < BaseClient
2020-03-13 15:44:24 +05:30
include Gitlab::Utils::StrongMemoize
2016-06-02 11:05:42 +05:30
attr_accessor :uri
2023-03-17 16:20:25 +05:30
attr_reader :options, :base_uri
2016-06-02 11:05:42 +05:30
2020-05-24 23:13:21 +05:30
REGISTRY_VERSION_HEADER = 'gitlab-container-registry-version'
REGISTRY_FEATURES_HEADER = 'gitlab-container-registry-features'
2021-01-29 00:20:46 +05:30
REGISTRY_TAG_DELETE_FEATURE = 'tag_delete'
2019-12-21 20:55:43 +05:30
2022-11-25 23:54:43 +05:30
DEFAULT_TAGS_PAGE_SIZE = 10000
2022-05-07 20:08:51 +05:30
ALLOWED_REDIRECT_SCHEMES = %w[http https].freeze
REDIRECT_OPTIONS = {
clear_authorization_header: true,
limit: 3,
cookies: [],
callback: -> (response_env, request_env) do
request_env.request_headers.delete(::FaradayMiddleware::FollowRedirects::AUTH_HEADER)
redirect_to = request_env.url
unless redirect_to.scheme.in?(ALLOWED_REDIRECT_SCHEMES)
raise ArgumentError, "Invalid scheme for #{redirect_to}"
end
end
}.freeze
2020-11-24 15:15:51 +05:30
def self.supports_tag_delete?
2022-04-04 11:22:00 +05:30
with_dummy_client(return_value_if_disabled: false) do |client|
client.supports_tag_delete?
end
2020-11-24 15:15:51 +05:30
end
2021-11-18 22:05:49 +05:30
def self.registry_info
2022-04-04 11:22:00 +05:30
with_dummy_client do |client|
client.registry_info
end
2016-06-02 11:05:42 +05:30
end
2020-05-24 23:13:21 +05:30
def registry_info
response = faraday.get("/v2/")
return {} unless response&.success?
version = response.headers[REGISTRY_VERSION_HEADER]
features = response.headers.fetch(REGISTRY_FEATURES_HEADER, '')
{
version: version,
features: features.split(',').map(&:strip),
vendor: version ? 'gitlab' : 'other'
}
end
2022-11-25 23:54:43 +05:30
def repository_tags(name, page_size: DEFAULT_TAGS_PAGE_SIZE)
response = faraday.get("/v2/#{name}/tags/list") do |req|
req.params['n'] = page_size
end
response_body(response)
2016-06-02 11:05:42 +05:30
end
def repository_manifest(name, reference)
2016-08-24 12:49:21 +05:30
response_body faraday.get("/v2/#{name}/manifests/#{reference}")
2016-06-02 11:05:42 +05:30
end
def repository_tag_digest(name, reference)
2016-08-24 12:49:21 +05:30
response = faraday.head("/v2/#{name}/manifests/#{reference}")
2021-12-11 22:18:48 +05:30
response.headers[DependencyProxy::Manifest::DIGEST_HEADER] if response.success?
2016-06-02 11:05:42 +05:30
end
2020-03-13 15:44:24 +05:30
def delete_repository_tag_by_digest(name, reference)
delete_if_exists("/v2/#{name}/manifests/#{reference}")
end
2019-12-21 20:55:43 +05:30
2020-03-13 15:44:24 +05:30
def delete_repository_tag_by_name(name, reference)
delete_if_exists("/v2/#{name}/tags/reference/#{reference}")
end
# Check if the registry supports tag deletion. This is only supported by the
# GitLab registry fork. The fastest and safest way to check this is to send
# an OPTIONS request to /v2/<name>/tags/reference/<tag>, using a random
# repository name and tag (the registry won't check if they exist).
# Registries that support tag deletion will reply with a 200 OK and include
# the DELETE method in the Allow header. Others reply with an 404 Not Found.
def supports_tag_delete?
strong_memoize(:supports_tag_delete) do
2021-01-29 00:20:46 +05:30
registry_features = Gitlab::CurrentSettings.container_registry_features || []
next true if ::Gitlab.com? && registry_features.include?(REGISTRY_TAG_DELETE_FEATURE)
2020-03-13 15:44:24 +05:30
response = faraday.run_request(:options, '/v2/name/tags/reference/tag', '', {})
response.success? && response.headers['allow']&.include?('DELETE')
end
2019-12-21 20:55:43 +05:30
end
def upload_raw_blob(path, blob)
digest = "sha256:#{Digest::SHA256.hexdigest(blob)}"
if upload_blob(path, blob, digest).success?
[blob, digest]
end
end
def upload_blob(name, content, digest)
2021-03-08 18:12:59 +05:30
upload = faraday(timeout_enabled: false).post("/v2/#{name}/blobs/uploads/")
2019-12-26 22:10:19 +05:30
return upload unless upload.success?
2019-12-21 20:55:43 +05:30
location = URI(upload.headers['location'])
2021-03-08 18:12:59 +05:30
faraday(timeout_enabled: false).put("#{location.path}?#{location.query}") do |req|
2019-12-21 20:55:43 +05:30
req.params['digest'] = digest
req.headers['Content-Type'] = 'application/octet-stream'
req.body = content
end
end
def generate_empty_manifest(path)
image = {
config: {}
}
2020-05-24 23:13:21 +05:30
image, image_digest = upload_raw_blob(path, Gitlab::Json.pretty_generate(image))
2019-12-21 20:55:43 +05:30
return unless image
{
schemaVersion: 2,
mediaType: DOCKER_DISTRIBUTION_MANIFEST_V2_TYPE,
config: {
mediaType: CONTAINER_IMAGE_V1_TYPE,
size: image.size,
digest: image_digest
}
}
2016-06-02 11:05:42 +05:30
end
def blob(name, digest, type = nil)
2016-08-24 12:49:21 +05:30
type ||= 'application/octet-stream'
2022-07-16 23:28:13 +05:30
response_body faraday_blob.get("/v2/#{name}/blobs/#{digest}", nil, 'Accept' => type)
2016-06-02 11:05:42 +05:30
end
def delete_blob(name, digest)
2020-03-13 15:44:24 +05:30
delete_if_exists("/v2/#{name}/blobs/#{digest}")
2019-12-21 20:55:43 +05:30
end
def put_tag(name, reference, manifest)
2021-03-08 18:12:59 +05:30
response = faraday(timeout_enabled: false).put("/v2/#{name}/manifests/#{reference}") do |req|
2019-12-21 20:55:43 +05:30
req.headers['Content-Type'] = DOCKER_DISTRIBUTION_MANIFEST_V2_TYPE
2020-05-24 23:13:21 +05:30
req.body = Gitlab::Json.pretty_generate(manifest)
2019-12-21 20:55:43 +05:30
end
2021-12-11 22:18:48 +05:30
response.headers[DependencyProxy::Manifest::DIGEST_HEADER] if response.success?
2016-06-02 11:05:42 +05:30
end
2016-08-24 12:49:21 +05:30
2016-06-02 11:05:42 +05:30
private
2016-08-24 12:49:21 +05:30
def faraday_blob
2020-04-22 19:07:51 +05:30
@faraday_blob ||= faraday_base do |conn|
2016-08-24 12:49:21 +05:30
initialize_connection(conn, @options)
2022-05-07 20:08:51 +05:30
2022-07-16 23:28:13 +05:30
conn.use ::FaradayMiddleware::FollowRedirects, REDIRECT_OPTIONS
2016-08-24 12:49:21 +05:30
end
2016-06-22 15:30:34 +05:30
end
2016-06-02 11:05:42 +05:30
end
end
2019-12-04 20:38:33 +05:30
2021-06-08 01:23:25 +05:30
ContainerRegistry::Client.prepend_mod_with('ContainerRegistry::Client')