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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Kas do
let(:jwt_secret) { SecureRandom.random_bytes(described_class::SECRET_LENGTH) }
before do
allow(described_class).to receive(:secret).and_return(jwt_secret)
end
describe '.verify_api_request' do
let(:payload) { { 'iss' => described_class::JWT_ISSUER, 'aud' => described_class::JWT_AUDIENCE } }
context 'returns nil if fails to validate the JWT' do
it 'when secret is wrong' do
encoded_token = JWT.encode(payload, 'wrong secret', 'HS256')
headers = { described_class::INTERNAL_API_REQUEST_HEADER => encoded_token }
expect(described_class.verify_api_request(headers)).to be_nil
end
it 'when issuer is wrong' do
payload['iss'] = 'wrong issuer'
encoded_token = JWT.encode(payload, described_class.secret, 'HS256')
headers = { described_class::INTERNAL_API_REQUEST_HEADER => encoded_token }
expect(described_class.verify_api_request(headers)).to be_nil
end
it 'when audience is wrong' do
payload['aud'] = 'wrong audience'
encoded_token = JWT.encode(payload, described_class.secret, 'HS256')
headers = { described_class::INTERNAL_API_REQUEST_HEADER => encoded_token }
expect(described_class.verify_api_request(headers)).to be_nil
end
end
it 'returns the decoded JWT' do
encoded_token = JWT.encode(payload, described_class.secret, 'HS256')
headers = { described_class::INTERNAL_API_REQUEST_HEADER => encoded_token }
expect(described_class.verify_api_request(headers)).to eq([
{ 'iss' => described_class::JWT_ISSUER, 'aud' => described_class::JWT_AUDIENCE },
{ 'alg' => 'HS256' }
])
end
end
describe '.secret_path' do
it 'returns default gitlab config' do
expect(described_class.secret_path).to eq(Gitlab.config.gitlab_kas.secret_file)
end
end
describe '.enabled?' do
before do
allow(Gitlab).to receive(:config).and_return(gitlab_config)
end
subject { described_class.enabled? }
context 'gitlab_config is not enabled' do
let(:gitlab_config) { { 'gitlab_kas' => { 'enabled' => false } } }
it { is_expected.to be_falsey }
end
context 'gitlab_config is enabled' do
let(:gitlab_config) { { 'gitlab_kas' => { 'enabled' => true } } }
it { is_expected.to be_truthy }
end
context 'enabled is unset' do
let(:gitlab_config) { { 'gitlab_kas' => {} } }
it { is_expected.to be_falsey }
end
end
describe '.external_url' do
it 'returns gitlab_kas external_url config' do
expect(described_class.external_url).to eq(Gitlab.config.gitlab_kas.external_url)
end
end
describe '.tunnel_url' do
before do
stub_config(gitlab_kas: { external_url: external_url })
end
let(:external_url) { 'xyz' }
subject { described_class.tunnel_url }
context 'with a gitlab_kas.external_k8s_proxy_url setting' do
let(:external_k8s_proxy_url) { 'abc' }
before do
stub_config(gitlab_kas: { external_k8s_proxy_url: external_k8s_proxy_url })
end
it { is_expected.to eq(external_k8s_proxy_url) }
end
context 'without a gitlab_kas.external_k8s_proxy_url setting' do
context 'external_url uses wss://' do
let(:external_url) { 'wss://kas.gitlab.example.com' }
it { is_expected.to eq('https://kas.gitlab.example.com/k8s-proxy') }
end
context 'external_url uses ws://' do
let(:external_url) { 'ws://kas.gitlab.example.com' }
it { is_expected.to eq('http://kas.gitlab.example.com/k8s-proxy') }
end
context 'external_url uses grpcs://' do
let(:external_url) { 'grpcs://kas.gitlab.example.com' }
it { is_expected.to eq('https://kas.gitlab.example.com/k8s-proxy') }
end
context 'external_url uses grpc://' do
let(:external_url) { 'grpc://kas.gitlab.example.com' }
it { is_expected.to eq('http://kas.gitlab.example.com/k8s-proxy') }
end
end
end
describe '.tunnel_ws_url' do
before do
stub_config(gitlab_kas: { external_url: external_url })
end
let(:external_url) { 'xyz' }
subject { described_class.tunnel_ws_url }
context 'with a gitlab_kas.external_k8s_proxy_url setting' do
let(:external_k8s_proxy_url) { 'http://abc' }
before do
stub_config(gitlab_kas: { external_k8s_proxy_url: external_k8s_proxy_url })
end
it { is_expected.to eq('ws://abc') }
end
context 'without a gitlab_kas.external_k8s_proxy_url setting' do
context 'external_url uses wss://' do
let(:external_url) { 'wss://kas.gitlab.example.com' }
it { is_expected.to eq('wss://kas.gitlab.example.com/k8s-proxy') }
end
context 'external_url uses ws://' do
let(:external_url) { 'ws://kas.gitlab.example.com' }
it { is_expected.to eq('ws://kas.gitlab.example.com/k8s-proxy') }
end
context 'external_url uses grpcs://' do
let(:external_url) { 'grpcs://kas.gitlab.example.com' }
it { is_expected.to eq('wss://kas.gitlab.example.com/k8s-proxy') }
end
context 'external_url uses grpc://' do
let(:external_url) { 'grpc://kas.gitlab.example.com' }
it { is_expected.to eq('ws://kas.gitlab.example.com/k8s-proxy') }
end
end
end
describe '.internal_url' do
it 'returns gitlab_kas internal_url config' do
expect(described_class.internal_url).to eq(Gitlab.config.gitlab_kas.internal_url)
end
end
describe '.version' do
it 'returns gitlab_kas version config' do
version_file = Rails.root.join(described_class::VERSION_FILE)
expect(described_class.version).to eq(version_file.read.chomp)
end
end
describe '.version_info' do
let(:version) { '15.6.0-rc1' }
before do
allow(described_class).to receive(:version).and_return(version)
end
it 'returns gitlab_kas version config, including suffix' do
expect(described_class.version_info.to_s).to eq(version)
end
end
describe '.ensure_secret!' do
context 'secret file exists' do
before do
allow(File).to receive(:exist?).with(Gitlab.config.gitlab_kas.secret_file).and_return(true)
end
it 'does not call write_secret' do
expect(described_class).not_to receive(:write_secret)
described_class.ensure_secret!
end
end
context 'secret file does not exist' do
before do
allow(File).to receive(:exist?).with(Gitlab.config.gitlab_kas.secret_file).and_return(false)
end
it 'calls write_secret' do
expect(described_class).to receive(:write_secret)
described_class.ensure_secret!
end
end
end
end
|