summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/api_authentication/token_resolver_spec.rb
blob: bbc6bf0d4818bf9beed9c2605214ff91eddbc222 (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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::APIAuthentication::TokenResolver do
  let_it_be(:user) { create(:user) }
  let_it_be(:project, reload: true) { create(:project, :public) }
  let_it_be(:personal_access_token) { create(:personal_access_token, user: user) }
  let_it_be(:ci_job) { create(:ci_build, project: project, user: user, status: :running) }
  let_it_be(:ci_job_done) { create(:ci_build, project: project, user: user, status: :success) }
  let_it_be(:deploy_token) { create(:deploy_token, read_package_registry: true, write_package_registry: true) }

  shared_examples 'an authorized request' do
    it 'returns the correct token' do
      expect(subject).to eq(token)
    end
  end

  shared_examples 'an unauthorized request' do
    it 'raises an error' do
      expect { subject }.to raise_error(Gitlab::Auth::UnauthorizedError)
    end
  end

  shared_examples 'an anoymous request' do
    it 'returns nil' do
      expect(subject).to eq(nil)
    end
  end

  describe '.new' do
    context 'with a valid type' do
      it 'creates a new instance' do
        expect(described_class.new(:personal_access_token)).to be_a(described_class)
      end
    end

    context 'with an invalid type' do
      it 'raises a validation error' do
        expect { described_class.new(:not_a_real_locator) }.to raise_error(ActiveModel::ValidationError)
      end
    end
  end

  describe '#resolve' do
    let(:resolver) { described_class.new(type) }

    subject { resolver.resolve(raw) }

    context 'with :personal_access_token_with_username' do
      let(:type) { :personal_access_token_with_username }
      let(:token) { personal_access_token }

      context 'with valid credentials' do
        let(:raw) { username_and_password(user.username, token.token) }

        it_behaves_like 'an authorized request'
      end

      context 'with an invalid username' do
        let(:raw) { username_and_password("not-my-#{user.username}", token.token) }

        it_behaves_like 'an unauthorized request'
      end

      context 'with no username' do
        let(:raw) { username_and_password(nil, token.token) }

        it_behaves_like 'an unauthorized request'
      end
    end

    context 'with :job_token_with_username' do
      let(:type) { :job_token_with_username }
      let(:token) { ci_job }

      context 'with valid credentials' do
        let(:raw) { username_and_password(Gitlab::Auth::CI_JOB_USER, token.token) }

        it_behaves_like 'an authorized request'
      end

      context 'when the job is not running' do
        let(:raw) { username_and_password(Gitlab::Auth::CI_JOB_USER, ci_job_done.token) }

        it_behaves_like 'an unauthorized request'
      end

      context 'with the wrong username' do
        let(:raw) { username_and_password("not-#{Gitlab::Auth::CI_JOB_USER}", nil) }

        it_behaves_like 'an anoymous request'
      end

      context 'with an invalid job token' do
        let(:raw) { username_and_password(Gitlab::Auth::CI_JOB_USER, "not a valid CI job token") }

        it_behaves_like 'an unauthorized request'
      end
    end

    context 'with :deploy_token_with_username' do
      let(:type) { :deploy_token_with_username }
      let(:token) { deploy_token }

      context 'with a valid deploy token' do
        let(:raw) { username_and_password(token.username, token.token) }

        it_behaves_like 'an authorized request'
      end

      context 'with an invalid username' do
        let(:raw) { username_and_password("not-my-#{token.username}", token.token) }

        it_behaves_like 'an unauthorized request'
      end
    end

    context 'with :personal_access_token' do
      let(:type) { :personal_access_token }
      let(:token) { personal_access_token }

      context 'with valid credentials' do
        let(:raw) { username_and_password(nil, token.token) }

        it_behaves_like 'an authorized request'
      end
    end

    context 'with :job_token' do
      let(:type) { :job_token }
      let(:token) { ci_job }

      context 'with valid credentials' do
        let(:raw) { username_and_password(nil, token.token) }

        it_behaves_like 'an authorized request'
      end

      context 'when the job is not running' do
        let(:raw) { username_and_password(nil, ci_job_done.token) }

        it_behaves_like 'an unauthorized request'
      end

      context 'with an invalid job token' do
        let(:raw) { username_and_password(nil, "not a valid CI job token") }

        it_behaves_like 'an unauthorized request'
      end
    end

    context 'with :deploy_token' do
      let(:type) { :deploy_token }
      let(:token) { deploy_token }

      context 'with a valid deploy token' do
        let(:raw) { username_and_password(nil, token.token) }

        it_behaves_like 'an authorized request'
      end
    end

    context 'with :personal_access_token_from_jwt' do
      let(:type) { :personal_access_token_from_jwt }
      let(:token) { personal_access_token }

      context 'with valid credentials' do
        let(:raw) { username_and_password_from_jwt(token.id) }

        it_behaves_like 'an authorized request'
      end
    end

    context 'with :deploy_token_from_jwt' do
      let(:type) { :deploy_token_from_jwt }
      let(:token) { deploy_token }

      context 'with valid credentials' do
        let(:raw) { username_and_password_from_jwt(token.token) }

        it_behaves_like 'an authorized request'
      end
    end

    context 'with :job_token_from_jwt' do
      let(:type) { :job_token_from_jwt }
      let(:token) { ci_job }

      context 'with valid credentials' do
        let(:raw) { username_and_password_from_jwt(token.token) }

        it_behaves_like 'an authorized request'
      end

      context 'when the job is not running' do
        let(:raw) { username_and_password_from_jwt(ci_job_done.token) }

        it_behaves_like 'an unauthorized request'
      end

      context 'with an invalid job token' do
        let(:raw) { username_and_password_from_jwt('not a valid CI job token') }

        it_behaves_like 'an unauthorized request'
      end
    end
  end

  def username_and_password(username, password)
    ::Gitlab::APIAuthentication::TokenLocator::UsernameAndPassword.new(username, password)
  end

  def username_and_password_from_jwt(token)
    username_and_password(nil, ::Gitlab::JWTToken.new.tap { |jwt| jwt['token'] = token }.encoded)
  end
end