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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::AuthorizedKeys do
let(:logger) { double('logger').as_null_object }
subject(:authorized_keys) { described_class.new(logger) }
describe '#accessible?' do
subject { authorized_keys.accessible? }
context 'authorized_keys file exists' do
before do
create_authorized_keys_fixture
end
after do
delete_authorized_keys_file
end
context 'can open file' do
it { is_expected.to be_truthy }
end
context 'cannot open file' do
before do
allow(File).to receive(:open).and_raise(Errno::EACCES)
end
it { is_expected.to be_falsey }
end
end
context 'authorized_keys file does not exist' do
it { is_expected.to be_falsey }
end
end
describe '#create' do
subject { authorized_keys.create }
context 'authorized_keys file exists' do
before do
create_authorized_keys_fixture
end
after do
delete_authorized_keys_file
end
it { is_expected.to be_truthy }
end
context 'authorized_keys file does not exist' do
after do
delete_authorized_keys_file
end
it 'creates authorized_keys file' do
expect(subject).to be_truthy
expect(File.exist?(tmp_authorized_keys_path)).to be_truthy
end
end
context 'cannot create file' do
before do
allow(File).to receive(:open).and_raise(Errno::EACCES)
end
it { is_expected.to be_falsey }
end
end
describe '#add_key' do
let(:id) { 'key-741' }
subject { authorized_keys.add_key(id, key) }
context 'authorized_keys file exists' do
let(:key) { 'ssh-rsa AAAAB3NzaDAxx2E trailing garbage' }
before do
create_authorized_keys_fixture
end
after do
delete_authorized_keys_file
end
it "adds a line at the end of the file and strips trailing garbage" do
auth_line = "command=\"#{Gitlab.config.gitlab_shell.path}/bin/gitlab-shell key-741\",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty ssh-rsa AAAAB3NzaDAxx2E"
expect(logger).to receive(:info).with('Adding key (key-741): ssh-rsa AAAAB3NzaDAxx2E')
expect(subject).to be_truthy
expect(File.read(tmp_authorized_keys_path)).to eq("existing content\n#{auth_line}\n")
end
end
context 'authorized_keys file does not exist' do
let(:key) { 'ssh-rsa AAAAB3NzaDAxx2E' }
before do
delete_authorized_keys_file
end
it 'creates the file' do
expect(subject).to be_truthy
expect(File.exist?(tmp_authorized_keys_path)).to be_truthy
end
end
end
describe '#batch_add_keys' do
let(:keys) do
[
double(shell_id: 'key-12', key: 'ssh-dsa ASDFASGADG trailing garbage'),
double(shell_id: 'key-123', key: 'ssh-rsa GFDGDFSGSDFG')
]
end
subject { authorized_keys.batch_add_keys(keys) }
context 'authorized_keys file exists' do
before do
create_authorized_keys_fixture
end
after do
delete_authorized_keys_file
end
it "adds lines at the end of the file" do
auth_line1 = "command=\"#{Gitlab.config.gitlab_shell.path}/bin/gitlab-shell key-12\",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty ssh-dsa ASDFASGADG"
auth_line2 = "command=\"#{Gitlab.config.gitlab_shell.path}/bin/gitlab-shell key-123\",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty ssh-rsa GFDGDFSGSDFG"
expect(logger).to receive(:info).with('Adding key (key-12): ssh-dsa ASDFASGADG')
expect(logger).to receive(:info).with('Adding key (key-123): ssh-rsa GFDGDFSGSDFG')
expect(subject).to be_truthy
expect(File.read(tmp_authorized_keys_path)).to eq("existing content\n#{auth_line1}\n#{auth_line2}\n")
end
context "invalid key" do
let(:keys) { [double(shell_id: 'key-123', key: "ssh-rsa A\tSDFA\nSGADG")] }
it "doesn't add keys" do
expect(subject).to be_falsey
expect(File.read(tmp_authorized_keys_path)).to eq("existing content\n")
end
end
end
context 'authorized_keys file does not exist' do
before do
delete_authorized_keys_file
end
it 'creates the file' do
expect(subject).to be_truthy
expect(File.exist?(tmp_authorized_keys_path)).to be_truthy
end
end
end
describe '#remove_key' do
let(:key) { 'key-741' }
subject { authorized_keys.remove_key(key) }
context 'authorized_keys file exists' do
let(:other_line) { "command=\"#{Gitlab.config.gitlab_shell.path}/bin/gitlab-shell key-742\",options ssh-rsa AAAAB3NzaDAxx2E" }
let(:delete_line) { "command=\"#{Gitlab.config.gitlab_shell.path}/bin/gitlab-shell key-741\",options ssh-rsa AAAAB3NzaDAxx2E" }
before do
create_authorized_keys_fixture
File.open(tmp_authorized_keys_path, 'a') do |auth_file|
auth_file.puts delete_line
auth_file.puts other_line
end
end
after do
delete_authorized_keys_file
end
it "removes the right line" do
erased_line = delete_line.gsub(/./, '#')
expect(logger).to receive(:info).with('Removing key (key-741)')
expect(subject).to be_truthy
expect(File.read(tmp_authorized_keys_path)).to eq("existing content\n#{erased_line}\n#{other_line}\n")
end
end
context 'authorized_keys file does not exist' do
before do
delete_authorized_keys_file
end
it { is_expected.to be_falsey }
end
end
describe '#clear' do
subject { authorized_keys.clear }
context 'authorized_keys file exists' do
before do
create_authorized_keys_fixture
end
after do
delete_authorized_keys_file
end
it { is_expected.to be_truthy }
end
context 'authorized_keys file does not exist' do
before do
delete_authorized_keys_file
end
it { is_expected.to be_truthy }
end
end
describe '#list_key_ids' do
subject { authorized_keys.list_key_ids }
context 'authorized_keys file exists' do
before do
create_authorized_keys_fixture(
existing_content:
"key-1\tssh-dsa AAA\nkey-2\tssh-rsa BBB\nkey-3\tssh-rsa CCC\nkey-9000\tssh-rsa DDD\n"
)
end
after do
delete_authorized_keys_file
end
it { is_expected.to eq([1, 2, 3, 9000]) }
end
context 'authorized_keys file does not exist' do
before do
delete_authorized_keys_file
end
it { is_expected.to be_empty }
end
end
def create_authorized_keys_fixture(existing_content: 'existing content')
FileUtils.mkdir_p(File.dirname(tmp_authorized_keys_path))
File.open(tmp_authorized_keys_path, 'w') { |file| file.puts(existing_content) }
end
def delete_authorized_keys_file
File.delete(tmp_authorized_keys_path) if File.exist?(tmp_authorized_keys_path)
end
def tmp_authorized_keys_path
Gitlab.config.gitlab_shell.authorized_keys_file
end
end
|