summaryrefslogtreecommitdiff
path: root/lib/api/concerns/packages/debian_endpoints.rb
blob: 6fc7c439464ea1ae1cc6ee935e94598835f28649 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# frozen_string_literal: true

module API
  module Concerns
    module Packages
      module DebianEndpoints
        extend ActiveSupport::Concern

        DISTRIBUTION_REGEX = %r{[a-zA-Z0-9][a-zA-Z0-9.-]*}.freeze
        COMPONENT_REGEX = %r{[a-z-]+}.freeze
        ARCHITECTURE_REGEX = %r{[a-z][a-z0-9]*}.freeze
        LETTER_REGEX = %r{(lib)?[a-z0-9]}.freeze
        PACKAGE_REGEX = API::NO_SLASH_URL_PART_REGEX
        DISTRIBUTION_REQUIREMENTS = {
          distribution: DISTRIBUTION_REGEX
        }.freeze
        COMPONENT_ARCHITECTURE_REQUIREMENTS = {
          component: COMPONENT_REGEX,
          architecture: ARCHITECTURE_REGEX
        }.freeze
        COMPONENT_LETTER_SOURCE_PACKAGE_REQUIREMENTS = {
          component: COMPONENT_REGEX,
          letter: LETTER_REGEX,
          source_package: PACKAGE_REGEX
        }.freeze
        FILE_NAME_REQUIREMENTS = {
          file_name: API::NO_SLASH_URL_PART_REGEX
        }.freeze

        included do
          feature_category :package_registry

          helpers ::API::Helpers::PackagesHelpers
          helpers ::API::Helpers::Packages::BasicAuthHelpers

          format :txt
          content_type :txt, 'text/plain'

          rescue_from ArgumentError do |e|
            render_api_error!(e.message, 400)
          end

          rescue_from ActiveRecord::RecordInvalid do |e|
            render_api_error!(e.message, 400)
          end

          before do
            require_packages_enabled!
          end

          namespace 'packages/debian' do
            params do
              requires :distribution, type: String, desc: 'The Debian Codename', regexp: Gitlab::Regex.debian_distribution_regex
            end

            namespace 'dists/*distribution', requirements: DISTRIBUTION_REQUIREMENTS do
              # GET {projects|groups}/:id/packages/debian/dists/*distribution/Release.gpg
              desc 'The Release file signature' do
                detail 'This feature was introduced in GitLab 13.5'
              end

              route_setting :authentication, deploy_token_allowed: true, basic_auth_personal_access_token: true, job_token_allowed: :basic_auth, authenticate_non_public: true
              get 'Release.gpg' do
                not_found!
              end

              # GET {projects|groups}/:id/packages/debian/dists/*distribution/Release
              desc 'The unsigned Release file' do
                detail 'This feature was introduced in GitLab 13.5'
              end

              route_setting :authentication, deploy_token_allowed: true, basic_auth_personal_access_token: true, job_token_allowed: :basic_auth, authenticate_non_public: true
              get 'Release' do
                # https://gitlab.com/gitlab-org/gitlab/-/issues/5835#note_414103286
                'TODO Release'
              end

              # GET {projects|groups}/:id/packages/debian/dists/*distribution/InRelease
              desc 'The signed Release file' do
                detail 'This feature was introduced in GitLab 13.5'
              end

              route_setting :authentication, deploy_token_allowed: true, basic_auth_personal_access_token: true, job_token_allowed: :basic_auth, authenticate_non_public: true
              get 'InRelease' do
                not_found!
              end

              params do
                requires :component, type: String, desc: 'The Debian Component', regexp: Gitlab::Regex.debian_component_regex
                requires :architecture, type: String, desc: 'The Debian Architecture', regexp: Gitlab::Regex.debian_architecture_regex
              end

              namespace ':component/binary-:architecture', requirements: COMPONENT_ARCHITECTURE_REQUIREMENTS do
                # GET {projects|groups}/:id/packages/debian/dists/*distribution/:component/binary-:architecture/Packages
                desc 'The binary files index' do
                  detail 'This feature was introduced in GitLab 13.5'
                end

                route_setting :authentication, deploy_token_allowed: true, basic_auth_personal_access_token: true, job_token_allowed: :basic_auth, authenticate_non_public: true
                get 'Packages' do
                  # https://gitlab.com/gitlab-org/gitlab/-/issues/5835#note_414103286
                  'TODO Packages'
                end
              end
            end

            params do
              requires :component, type: String, desc: 'The Debian Component', regexp: Gitlab::Regex.debian_component_regex
              requires :letter, type: String, desc: 'The Debian Classification (first-letter or lib-first-letter)'
              requires :source_package, type: String, desc: 'The Debian Source Package Name', regexp: Gitlab::Regex.debian_package_name_regex
            end

            namespace 'pool/:component/:letter/:source_package', requirements: COMPONENT_LETTER_SOURCE_PACKAGE_REQUIREMENTS do
              # GET {projects|groups}/:id/packages/debian/pool/:component/:letter/:source_package/:file_name
              params do
                requires :file_name, type: String, desc: 'The Debian File Name'
              end
              desc 'The package' do
                detail 'This feature was introduced in GitLab 13.5'
              end

              route_setting :authentication, deploy_token_allowed: true, basic_auth_personal_access_token: true, job_token_allowed: :basic_auth, authenticate_non_public: true
              get ':file_name', requirements: FILE_NAME_REQUIREMENTS do
                # https://gitlab.com/gitlab-org/gitlab/-/issues/5835#note_414103286
                'TODO File'
              end
            end
          end
        end
      end
    end
  end
end