git_access.rb 6.4 KB
Newer Older
1 2 3 4 5
module Gitlab
  class GitAccess
    DOWNLOAD_COMMANDS = %w{ git-upload-pack git-upload-archive }
    PUSH_COMMANDS = %w{ git-receive-pack }

6
    attr_reader :actor, :project, :protocol
7

8
    def initialize(actor, project, protocol = nil)
9 10
      @actor    = actor
      @project  = project
11
      @protocol = protocol
12 13 14 15 16
    end

    def user
      return @user if defined?(@user)

M
Marin Jankovski 已提交
17
      @user =
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
        case actor
        when User
          actor
        when DeployKey
          nil
        when Key
          actor.user
        end
    end

    def deploy_key
      actor if actor.is_a?(DeployKey)
    end

    def can_push_to_branch?(ref)
33
      return false unless user
34

D
Douwe Maan 已提交
35
      if project.protected_branch?(ref) && !project.developers_can_push_to_protected_branch?(ref)
36 37 38 39 40 41
        user.can?(:push_code_to_protected_branches, project)
      else
        user.can?(:push_code, project)
      end
    end

42 43 44 45 46 47 48 49 50 51 52
    def can_read_project?
      if user
        user.can?(:read_project, project)
      elsif deploy_key
        deploy_key.projects.include?(project)
      else
        false
      end
    end

    def check(cmd, changes = nil)
53 54
      return build_status_object(false, "Git access over #{protocol.upcase} is not allowed") unless protocol_allowed?

D
Douwe Maan 已提交
55 56 57 58 59 60 61 62 63 64 65 66
      unless actor
        return build_status_object(false, "No user or key was provided.")
      end

      if user && !user_allowed?
        return build_status_object(false, "Your account has been blocked.")
      end

      unless project && can_read_project?
        return build_status_object(false, 'The project you were looking for could not be found.')
      end

67 68
      case cmd
      when *DOWNLOAD_COMMANDS
69
        download_access_check
70
      when *PUSH_COMMANDS
71
        push_access_check(changes)
72
      else
D
Douwe Maan 已提交
73
        build_status_object(false, "The command you're trying to execute is not allowed.")
74 75 76
      end
    end

77
    def download_access_check
78 79
      return build_status_object(false, "Git access over #{protocol.upcase} is not allowed") unless protocol_allowed?

80 81 82
      if user
        user_download_access_check
      elsif deploy_key
D
Douwe Maan 已提交
83
        build_status_object(true)
84 85 86 87 88
      else
        raise 'Wrong actor'
      end
    end

89
    def push_access_check(changes)
90 91
      return build_status_object(false, "Git access over #{protocol.upcase} is not allowed") unless protocol_allowed?

92 93 94
      if user
        user_push_access_check(changes)
      elsif deploy_key
D
Douwe Maan 已提交
95
        build_status_object(false, "Deploy keys are not allowed to push code.")
96 97 98 99 100 101
      else
        raise 'Wrong actor'
      end
    end

    def user_download_access_check
102 103
      return build_status_object(false, "Git access over #{protocol.upcase} is not allowed") unless protocol_allowed?

D
Douwe Maan 已提交
104 105
      unless user.can?(:download_code, project)
        return build_status_object(false, "You are not allowed to download code from this project.")
106 107
      end

D
Douwe Maan 已提交
108
      build_status_object(true)
109 110 111
    end

    def user_push_access_check(changes)
112 113
      return build_status_object(false, "Git access over #{protocol.upcase} is not allowed") unless protocol_allowed?

114 115 116 117 118
      if changes.blank?
        return build_status_object(true)
      end

      unless project.repository.exists?
D
Douwe Maan 已提交
119
        return build_status_object(false, "A repository for this project does not exist yet.")
120
      end
121 122 123 124

      changes = changes.lines if changes.kind_of?(String)

      # Iterate over all changes to find if user allowed all of them to be applied
125
      changes.map(&:strip).reject(&:blank?).each do |change|
126
        status = change_access_check(change)
127
        unless status.allowed?
128
          # If user does not have access to make at least one change - cancel all push
129
          return status
130 131 132
        end
      end

133
      build_status_object(true)
134 135
    end

136 137 138 139 140
    def can_user_do_action?(action)
      @permission_cache ||= {}
      @permission_cache[action] ||= user.can?(action, project)
    end

141
    def change_access_check(change)
142 143
      oldrev, newrev, ref = change.split(' ')

M
Marin Jankovski 已提交
144
      action =
145 146
        if project.protected_branch?(branch_name(ref))
          protected_branch_action(oldrev, newrev, branch_name(ref))
147
        elsif (tag_ref = tag_name(ref)) && protected_tag?(tag_ref)
148 149 150 151 152
          # Prevent any changes to existing git tag unless user has permissions
          :admin_project
        else
          :push_code
        end
153

154
      unless can_user_do_action?(action)
D
Douwe Maan 已提交
155
        status =
D
Douwe Maan 已提交
156 157 158 159 160 161 162 163 164 165 166
          case action
          when :force_push_code_to_protected_branches
            build_status_object(false, "You are not allowed to force push code to a protected branch on this project.")
          when :remove_protected_branches
            build_status_object(false, "You are not allowed to deleted protected branches from this project.")
          when :push_code_to_protected_branches
            build_status_object(false, "You are not allowed to push code to protected branches on this project.")
          when :admin_project
            build_status_object(false, "You are not allowed to change existing tags on this project.")
          else # :push_code
            build_status_object(false, "You are not allowed to push code to this project.")
M
Marin Jankovski 已提交
167
          end
D
Douwe Maan 已提交
168
        return status
169
      end
D
Douwe Maan 已提交
170 171

      build_status_object(true)
172 173
    end

174
    def forced_push?(oldrev, newrev)
175
      Gitlab::ForcePushCheck.force_push?(project, oldrev, newrev)
176 177 178 179
    end

    private

180
    def protected_branch_action(oldrev, newrev, branch_name)
181
      # we dont allow force push to protected branch
182
      if forced_push?(oldrev, newrev)
183
        :force_push_code_to_protected_branches
184
      elsif Gitlab::Git.blank_ref?(newrev)
185 186
        # and we dont allow remove of protected branch
        :remove_protected_branches
187
      elsif project.developers_can_push_to_protected_branch?(branch_name)
188
        :push_code
189
      else
190
        :push_code_to_protected_branches
191 192 193
      end
    end

194
    def protected_tag?(tag_name)
195
      project.repository.tag_exists?(tag_name)
196 197
    end

198
    def user_allowed?
199
      Gitlab::UserAccess.allowed?(user)
200
    end
201

202 203 204 205
    def protocol_allowed?
      protocol ? Gitlab::ProtocolAccess.allowed?(protocol) : true
    end

206 207
    def branch_name(ref)
      ref = ref.to_s
208 209
      if Gitlab::Git.branch_ref?(ref)
        Gitlab::Git.ref_name(ref)
210 211 212 213 214 215 216
      else
        nil
      end
    end

    def tag_name(ref)
      ref = ref.to_s
217 218
      if Gitlab::Git.tag_ref?(ref)
        Gitlab::Git.ref_name(ref)
219 220 221 222
      else
        nil
      end
    end
223 224 225 226 227 228

    protected

    def build_status_object(status, message = '')
      GitAccessStatus.new(status, message)
    end
229 230
  end
end