BigW Consortium Gitlab

helpers_spec.rb 13.9 KB
Newer Older
1 2
require 'spec_helper'

3
describe API::Helpers do
4
  include API::APIGuard::HelperMethods
5
  include described_class
6
  include SentryHelper
7

8 9 10 11 12
  let(:user) { create(:user) }
  let(:admin) { create(:admin) }
  let(:key) { create(:key, user: user) }

  let(:params) { {} }
13 14
  let(:env) { { 'REQUEST_METHOD' => 'GET' } }
  let(:request) { Rack::Request.new(env) }
Kamil Trzcinski committed
15
  let(:header) { }
16

17
  def set_env(user_or_token, identifier)
18 19
    clear_env
    clear_param
20
    env[API::APIGuard::PRIVATE_TOKEN_HEADER] = user_or_token.respond_to?(:private_token) ? user_or_token.private_token : user_or_token
21
    env[API::Helpers::SUDO_HEADER] = identifier.to_s
22 23
  end

24
  def set_param(user_or_token, identifier)
25 26
    clear_env
    clear_param
27
    params[API::APIGuard::PRIVATE_TOKEN_PARAM] = user_or_token.respond_to?(:private_token) ? user_or_token.private_token : user_or_token
28
    params[API::Helpers::SUDO_PARAM] = identifier.to_s
29 30 31
  end

  def clear_env
32
    env.delete(API::APIGuard::PRIVATE_TOKEN_HEADER)
33
    env.delete(API::Helpers::SUDO_HEADER)
34 35 36
  end

  def clear_param
37
    params.delete(API::APIGuard::PRIVATE_TOKEN_PARAM)
38
    params.delete(API::Helpers::SUDO_PARAM)
39 40
  end

41 42 43 44 45 46 47 48 49
  def warden_authenticate_returns(value)
    warden = double("warden", authenticate: value)
    env['warden'] = warden
  end

  def doorkeeper_guard_returns(value)
    allow_any_instance_of(self.class).to receive(:doorkeeper_guard){ value }
  end

Kamil Trzcinski committed
50
  def error!(message, status, header)
51
    raise Exception.new("#{status} - #{message}")
52 53 54
  end

  describe ".current_user" do
55 56
    subject { current_user }

57
    describe "Warden authentication" do
58 59
      before { doorkeeper_guard_returns false }

60 61 62 63 64
      context "with invalid credentials" do
        context "GET request" do
          before { env['REQUEST_METHOD'] = 'GET' }
          it { is_expected.to be_nil }
        end
65 66
      end

67
      context "with valid credentials" do
68 69
        before { warden_authenticate_returns user }

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
        context "GET request" do
          before { env['REQUEST_METHOD'] = 'GET' }
          it { is_expected.to eq(user) }
        end

        context "HEAD request" do
          before { env['REQUEST_METHOD'] = 'HEAD' }
          it { is_expected.to eq(user) }
        end

        context "PUT request" do
          before { env['REQUEST_METHOD'] = 'PUT' }
          it { is_expected.to be_nil }
        end

        context "POST request" do
          before { env['REQUEST_METHOD'] = 'POST' }
          it { is_expected.to be_nil }
        end

        context "DELETE request" do
          before { env['REQUEST_METHOD'] = 'DELETE' }
          it { is_expected.to be_nil }
        end
94 95 96
      end
    end

97
    describe "when authenticating using a user's private token" do
98
      it "returns nil for an invalid token" do
99
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = 'invalid token'
100
        allow_any_instance_of(self.class).to receive(:doorkeeper_guard){ false }
101

102 103 104
        expect(current_user).to be_nil
      end

105
      it "returns nil for a user without access" do
106
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = user.private_token
107
        allow_any_instance_of(Gitlab::UserAccess).to receive(:allowed?).and_return(false)
108

109 110
        expect(current_user).to be_nil
      end
111

112
      it "leaves user as is when sudo not specified" do
113
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = user.private_token
114

115
        expect(current_user).to eq(user)
116

117
        clear_env
118

119
        params[API::APIGuard::PRIVATE_TOKEN_PARAM] = user.private_token
120

121 122
        expect(current_user).to eq(user)
      end
123 124
    end

125 126 127
    describe "when authenticating using a user's personal access tokens" do
      let(:personal_access_token) { create(:personal_access_token, user: user) }

128 129 130 131
      before do
        allow_any_instance_of(self.class).to receive(:doorkeeper_guard) { false }
      end

132
      it "returns nil for an invalid token" do
133
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = 'invalid token'
134

135 136 137
        expect(current_user).to be_nil
      end

138
      it "returns nil for a user without access" do
139
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
140
        allow_any_instance_of(Gitlab::UserAccess).to receive(:allowed?).and_return(false)
141

142 143 144
        expect(current_user).to be_nil
      end

145 146 147 148
      it "returns nil for a token without the appropriate scope" do
        personal_access_token = create(:personal_access_token, user: user, scopes: ['read_user'])
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
        allow_access_with_scope('write_user')
149

150 151 152
        expect(current_user).to be_nil
      end

153
      it "leaves user as is when sudo not specified" do
154
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
155 156
        expect(current_user).to eq(user)
        clear_env
157
        params[API::APIGuard::PRIVATE_TOKEN_PARAM] = personal_access_token.token
158

159 160 161 162 163
        expect(current_user).to eq(user)
      end

      it 'does not allow revoked tokens' do
        personal_access_token.revoke!
164
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
165

166 167 168 169 170
        expect(current_user).to be_nil
      end

      it 'does not allow expired tokens' do
        personal_access_token.update_attributes!(expires_at: 1.day.ago)
171
        env[API::APIGuard::PRIVATE_TOKEN_HEADER] = personal_access_token.token
172

173 174
        expect(current_user).to be_nil
      end
175 176
    end

177 178 179 180 181 182
    context 'sudo usage' do
      context 'with admin' do
        context 'with header' do
          context 'with id' do
            it 'changes current_user to sudo' do
              set_env(admin, user.id)
183

184 185
              expect(current_user).to eq(user)
            end
186

187 188 189 190 191 192 193
            it 'memoize the current_user: sudo permissions are not run against the sudoed user' do
              set_env(admin, user.id)

              expect(current_user).to eq(user)
              expect(current_user).to eq(user)
            end

194 195
            it 'handles sudo to oneself' do
              set_env(admin, admin.id)
196

197 198
              expect(current_user).to eq(admin)
            end
199

200 201 202 203
            it 'throws an error when user cannot be found' do
              id = user.id + admin.id
              expect(user.id).not_to eq(id)
              expect(admin.id).not_to eq(id)
204

205
              set_env(admin, id)
206

207 208 209
              expect { current_user }.to raise_error(Exception)
            end
          end
210

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
          context 'with username' do
            it 'changes current_user to sudo' do
              set_env(admin, user.username)

              expect(current_user).to eq(user)
            end

            it 'handles sudo to oneself' do
              set_env(admin, admin.username)

              expect(current_user).to eq(admin)
            end

            it "throws an error when the user cannot be found for a given username" do
              username = "#{user.username}#{admin.username}"
              expect(user.username).not_to eq(username)
              expect(admin.username).not_to eq(username)

              set_env(admin, username)

              expect { current_user }.to raise_error(Exception)
            end
          end
        end

        context 'with param' do
          context 'with id' do
            it 'changes current_user to sudo' do
              set_param(admin, user.id)

              expect(current_user).to eq(user)
            end

            it 'handles sudo to oneself' do
              set_param(admin, admin.id)

              expect(current_user).to eq(admin)
            end

            it 'handles sudo to oneself using string' do
              set_env(admin, user.id.to_s)

              expect(current_user).to eq(user)
            end

            it 'throws an error when user cannot be found' do
              id = user.id + admin.id
              expect(user.id).not_to eq(id)
              expect(admin.id).not_to eq(id)
260

261
              set_param(admin, id)
262

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
              expect { current_user }.to raise_error(Exception)
            end
          end

          context 'with username' do
            it 'changes current_user to sudo' do
              set_param(admin, user.username)

              expect(current_user).to eq(user)
            end

            it 'handles sudo to oneself' do
              set_param(admin, admin.username)

              expect(current_user).to eq(admin)
            end

            it "throws an error when the user cannot be found for a given username" do
              username = "#{user.username}#{admin.username}"
              expect(user.username).not_to eq(username)
              expect(admin.username).not_to eq(username)

              set_param(admin, username)

              expect { current_user }.to raise_error(Exception)
            end
          end
        end
      end

      context 'with regular user' do
        context 'with env' do
          it 'changes current_user to sudo when admin and user id' do
            set_env(user, admin.id)

            expect { current_user }.to raise_error(Exception)
          end

          it 'changes current_user to sudo when admin and user username' do
            set_env(user, admin.username)

            expect { current_user }.to raise_error(Exception)
          end
        end

        context 'with params' do
          it 'changes current_user to sudo when admin and user id' do
            set_param(user, admin.id)

            expect { current_user }.to raise_error(Exception)
          end

          it 'changes current_user to sudo when admin and user username' do
            set_param(user, admin.username)

            expect { current_user }.to raise_error(Exception)
          end
        end
      end
322 323 324
    end
  end

325 326 327 328 329 330 331 332 333
  describe '.sudo?' do
    context 'when no sudo env or param is passed' do
      before do
        doorkeeper_guard_returns(nil)
      end

      it 'returns false' do
        expect(sudo?).to be_falsy
      end
334 335
    end

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    context 'when sudo env or param is passed', 'user is not an admin' do
      before do
        set_env(user, '123')
      end

      it 'returns an 403 Forbidden' do
        expect { sudo? }.to raise_error '403 - {"message"=>"403 Forbidden  - Must be admin to use sudo"}'
      end
    end

    context 'when sudo env or param is passed', 'user is admin' do
      context 'personal access token is used' do
        before do
          personal_access_token = create(:personal_access_token, user: admin)
          set_env(personal_access_token.token, user.id)
        end

        it 'returns an 403 Forbidden' do
          expect { sudo? }.to raise_error '403 - {"message"=>"403 Forbidden  - Private token must be specified in order to use sudo"}'
        end
      end

      context 'private access token is used' do
        before do
          set_env(admin.private_token, user.id)
        end

        it 'returns true' do
          expect(sudo?).to be_truthy
        end
      end
367 368
    end
  end
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
  describe '.handle_api_exception' do
    before do
      allow_any_instance_of(self.class).to receive(:sentry_enabled?).and_return(true)
      allow_any_instance_of(self.class).to receive(:rack_response)
    end

    it 'does not report a MethodNotAllowed exception to Sentry' do
      exception = Grape::Exceptions::MethodNotAllowed.new({ 'X-GitLab-Test' => '1' })
      allow(exception).to receive(:backtrace).and_return(caller)

      expect(Raven).not_to receive(:capture_exception).with(exception)

      handle_api_exception(exception)
    end

    it 'does report RuntimeError to Sentry' do
      exception = RuntimeError.new('test error')
      allow(exception).to receive(:backtrace).and_return(caller)

      expect_any_instance_of(self.class).to receive(:sentry_context)
      expect(Raven).to receive(:capture_exception).with(exception)

      handle_api_exception(exception)
    end
  end
395 396 397 398 399

  describe '.authenticate_non_get!' do
    %w[HEAD GET].each do |method_name|
      context "method is #{method_name}" do
        before do
400
          expect_any_instance_of(self.class).to receive(:route).and_return(double(request_method: method_name))
401 402 403 404 405 406 407 408 409 410 411 412 413
        end

        it 'does not raise an error' do
          expect_any_instance_of(self.class).not_to receive(:authenticate!)

          expect { authenticate_non_get! }.not_to raise_error
        end
      end
    end

    %w[POST PUT PATCH DELETE].each do |method_name|
      context "method is #{method_name}" do
        before do
414
          expect_any_instance_of(self.class).to receive(:route).and_return(double(request_method: method_name))
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
        end

        it 'calls authenticate!' do
          expect_any_instance_of(self.class).to receive(:authenticate!)

          authenticate_non_get!
        end
      end
    end
  end

  describe '.authenticate!' do
    context 'current_user is nil' do
      before do
        expect_any_instance_of(self.class).to receive(:current_user).and_return(nil)
430
        allow_any_instance_of(self.class).to receive(:initial_current_user).and_return(nil)
431 432 433 434 435 436 437 438
      end

      it 'returns a 401 response' do
        expect { authenticate! }.to raise_error '401 - {"message"=>"401 Unauthorized"}'
      end
    end

    context 'current_user is present' do
439 440
      let(:user) { build(:user) }

441
      before do
442 443
        expect_any_instance_of(self.class).to receive(:current_user).at_least(:once).and_return(user)
        expect_any_instance_of(self.class).to receive(:initial_current_user).and_return(user)
444 445 446 447 448 449
      end

      it 'does not raise an error' do
        expect { authenticate! }.not_to raise_error
      end
    end
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471

    context 'current_user is blocked' do
      let(:user) { build(:user, :blocked) }

      before do
        expect_any_instance_of(self.class).to receive(:current_user).at_least(:once).and_return(user)
      end

      it 'raises an error' do
        expect_any_instance_of(self.class).to receive(:initial_current_user).and_return(user)

        expect { authenticate! }.to raise_error '401 - {"message"=>"401 Unauthorized"}'
      end

      it "doesn't raise an error if an admin user is impersonating a blocked user (via sudo)" do
        admin_user = build(:user, :admin)

        expect_any_instance_of(self.class).to receive(:initial_current_user).and_return(admin_user)

        expect { authenticate! }.not_to raise_error
      end
    end
472
  end
473
end