File: agnostic_token_revocation_service_spec.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (275 lines) | stat: -rw-r--r-- 8,681 bytes parent folder | download
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
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Groups::AgnosticTokenRevocationService, feature_category: :system_access do
  let_it_be(:group) { create(:group) }
  let_it_be(:owner) { create(:user) }
  let_it_be(:maintainer) { create(:user) }
  let_it_be(:user) { create(:user) }

  before_all do
    group.add_owner(owner)
    group.add_maintainer(maintainer)
  end

  describe '#initialize' do
    subject(:result) { described_class.new(group, owner, 'plaintext') }

    it 'accepts a group, user, and plaintext' do
      expect(result).to be_a(described_class)
    end
  end

  shared_examples_for 'a successfully revoked token' do
    it { expect(result.success?).to be(true), result.message }

    it 'revokes the token' do
      result
      expect(token.reload).to be_revoked
    end

    it 'returns the token in the payload' do
      result
      expect(result.payload[:revocable]).to eq(token)
    end

    it 'returns the token class and api_entity in the payload', :aggregate_failures do
      result
      expect(result.payload[:type]).to be(type)
      expect(result.payload[:api_entity]).to be(type)
    end
  end

  shared_examples_for 'an unsuccessfully revoked token' do
    it { expect(result.success?).to be(false) }

    it 'does not revoke the token' do
      result
      expect(token.reload.revoked?).to be(false)
    end
  end

  describe '#execute' do
    subject(:result) { service.execute }

    let_it_be(:member) { create(:user, guest_of: group) }

    let(:service) { described_class.new(group, owner, token.token) }

    context 'with a personal access token' do
      let(:type) { 'PersonalAccessToken' }

      context 'when it can access the group' do
        let_it_be(:token) { create(:personal_access_token, user: member) }

        it_behaves_like 'a successfully revoked token'
      end

      context 'when it can access a sub group' do
        let_it_be(:subgroup) { create(:group, parent: group) }
        let_it_be(:member) { create(:user, guest_of: group) }
        let_it_be(:token) { create(:personal_access_token, user: member) }

        it_behaves_like 'a successfully revoked token'
      end

      context 'when it can access a group\'s project' do
        let_it_be(:project) { create(:project, group: group) }
        let_it_be(:member) { create(:user, :project_bot, guest_of: project) }
        let_it_be(:token) { create(:personal_access_token, user: member) }

        it_behaves_like 'a successfully revoked token'
      end

      context 'when it belongs to a member with no relation to the group' do
        let_it_be(:token) { create(:personal_access_token, user: user) }

        it_behaves_like 'an unsuccessfully revoked token'
      end

      context 'when it belongs to a member of multiple groups' do
        let_it_be(:group_b) { create(:group) }
        let_it_be(:member) { create(:user, guest_of: [group, group_b]) }
        let_it_be(:token) { create(:personal_access_token, user: member) }

        it_behaves_like 'a successfully revoked token'
      end

      context 'with an already revoked personal access token that can access the group' do
        let(:token) { create(:personal_access_token, user: member, revoked: true) }

        it_behaves_like 'a successfully revoked token'
      end

      context 'with an already expired token' do
        let(:token) { create(:personal_access_token, :expired, user: member) }

        it_behaves_like 'an unsuccessfully revoked token'
      end

      context 'with an already expired and revoked token' do
        let(:token) { create(:personal_access_token, :expired, revoked: true, user: member) }

        it_behaves_like 'a successfully revoked token'
      end
    end

    context 'with a group deploy token' do
      let(:type) { 'DeployToken' }

      let_it_be(:subgroup) { create(:group, parent: group) }

      context 'when it can access the group' do
        let_it_be(:token) { create(:group_deploy_token, group: group).deploy_token }

        it_behaves_like 'a successfully revoked token'
      end

      context 'when it can access a subgroup' do
        let_it_be(:token) { create(:group_deploy_token, group: subgroup).deploy_token }

        it_behaves_like 'a successfully revoked token'
      end

      context 'when it belongs to another group' do
        let_it_be(:token) { create(:group_deploy_token).deploy_token }

        it_behaves_like 'an unsuccessfully revoked token'
      end

      context 'when it belongs to a project' do
        let_it_be(:token) { create(:project_deploy_token).deploy_token }

        it_behaves_like 'an unsuccessfully revoked token'
      end
    end

    context 'with a user feed token' do
      let(:service) { described_class.new(group, owner, user.reset.feed_token) }

      shared_examples_for 'a successfully rotated feed token' do
        it { expect(result.success?).to be(true), result.message }

        before do
          allow(Users::ResetFeedTokenService).to receive(:new).and_call_original
        end

        it 'calls ResetFeedTokenService with source' do
          result
          expect(Users::ResetFeedTokenService).to have_received(:new).with(owner, user: user,
            source: :group_token_revocation_service)
        end

        it 'rotates the token' do
          original_token = user.feed_token
          result
          expect(user.reset.feed_token).not_to eq(original_token)
        end

        it 'returns the user in the payload' do
          expect(result.payload[:revocable]).to eq(user)
        end

        it 'returns the type of token in the payload' do
          expect(result.payload[:type]).to be('FeedToken')
        end

        it 'uses the UserSafe api_entity' do
          expect(result.payload[:api_entity]).to be('UserSafe')
        end
      end

      shared_examples_for 'an unsuccessfully rotated feed token' do
        it { expect(result.success?).to be(false) }

        it 'does not revoke the token' do
          original_token = user.reset.feed_token
          result
          expect(user.reset.feed_token).to eq(original_token)
        end
      end

      context 'when the user can access the group' do
        let_it_be(:user) { create(:user, guest_of: group) }

        it_behaves_like 'a successfully rotated feed token'
      end

      context 'when the user can access a sub group' do
        let_it_be(:subgroup) { create(:group, parent: group) }
        let_it_be(:user) { create(:user, guest_of: subgroup) }

        it_behaves_like 'a successfully rotated feed token'
      end

      context 'when the user can access a group\'s project' do
        let_it_be(:project) { create(:project, group: group) }
        let_it_be(:user) { create(:user, :project_bot, guest_of: project) }

        it_behaves_like 'a successfully rotated feed token'
      end

      context 'when the user has with no relation to the group' do
        let_it_be(:user) { create(:user) }

        it_behaves_like 'an unsuccessfully rotated feed token'
      end
    end

    context 'with a token that would otherwise be revoked' do
      let_it_be(:token) { create(:personal_access_token, user: member) }

      context 'when ff disabled for group' do
        before do
          Feature.disable(:group_agnostic_token_revocation, group)
        end

        it_behaves_like 'an unsuccessfully revoked token'
      end

      context 'when group is a subgroup' do
        let_it_be(:group) { create(:group, :nested) }
        let_it_be(:member) { create(:user, guest_of: group) }

        before_all do
          group.add_owner(owner)
        end

        it_behaves_like 'an unsuccessfully revoked token'
      end

      context 'when current_user is a maintainer' do
        let(:service) { described_class.new(group, maintainer, token.token) }

        it_behaves_like 'an unsuccessfully revoked token'
      end

      context 'when current_user is not a member' do
        let(:service) { described_class.new(group, user, token.token) }

        it_behaves_like 'an unsuccessfully revoked token'
      end
    end

    context 'with an unsupported token type' do
      let(:token) { create(:oauth_access_token) }

      it_behaves_like 'an unsuccessfully revoked token'
    end

    context 'with a plaintext that does not exist' do
      let(:plaintext) { 'glpat-abc123' }
      let(:service) { described_class.new(group, owner, plaintext) }

      it { expect(result.success?).to be(false) }
    end

    context 'with a nil plaintext' do
      let(:plaintext) { nil }
      let(:service) { described_class.new(group, owner, plaintext) }

      it { expect(result.success?).to be(false) }
    end
  end
end