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
276
277
278
279
|
#
# Author:: Daniel DeLeo (<dan@opscode.com>)
# Copyright:: Copyright 2012-2016, Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require "spec_helper"
require "tempfile"
require "chef/api_client/registration"
describe Chef::ApiClient::Registration do
let(:key_location) do
make_tmpname("client-registration-key")
end
let(:client_name) { "silent-bob" }
subject(:registration) { Chef::ApiClient::Registration.new(client_name, key_location) }
let(:private_key_data) do
File.open(Chef::Config[:validation_key], "r") {|f| f.read.chomp }
end
let(:http_mock) { double("Chef::ServerAPI mock") }
let(:expected_post_data) do
{ :name => client_name, :admin => false, :public_key => generated_public_key.to_pem }
end
let(:expected_put_data) do
{ :name => client_name, :admin => false, :public_key => generated_public_key.to_pem }
end
let(:server_v10_response) do
{
"uri" => "https://chef.local/clients/#{client_name}",
"private_key" => "--begin rsa key etc--",
}
end
# Server v11 includes `json_class` on all replies
let(:server_v11_response) do
response = Chef::ApiClient.new
response.name(client_name)
response.private_key("--begin rsa key etc--")
response
end
let(:response_409) { Net::HTTPConflict.new("1.1", "409", "Conflict") }
let(:exception_409) { Net::HTTPServerException.new("409 conflict", response_409) }
let(:generated_private_key_pem) { IO.read(File.expand_path("ssl/private_key.pem", CHEF_SPEC_DATA)) }
let(:generated_private_key) { OpenSSL::PKey::RSA.new(generated_private_key_pem) }
let(:generated_public_key) { generated_private_key.public_key }
let(:create_with_pkey_response) do
{
"uri" => "",
"chef_key" => {
"public_key" => generated_public_key.to_pem
},
}
end
let(:update_with_pkey_response) do
{"name"=>client_name,
"admin"=>false,
"public_key"=> generated_public_key,
"validator"=>false,
"private_key"=>false,
"clientname"=>client_name}
end
before do
Chef::Config[:validation_client_name] = "test-validator"
Chef::Config[:validation_key] = File.expand_path("ssl/private_key.pem", CHEF_SPEC_DATA)
allow(OpenSSL::PKey::RSA).to receive(:generate).with(2048).and_return(generated_private_key)
end
after do
File.unlink(key_location) if File.exist?(key_location)
end
it "has an HTTP client configured with validator credentials" do
expect(registration.http_api).to be_a_kind_of(Chef::ServerAPI)
expect(registration.http_api.options[:client_name]).to eq("test-validator")
auth = registration.http_api.middlewares.select { |klass| klass.kind_of? Chef::HTTP::Authenticator }.first
expect(auth.client_name).to eq("test-validator")
end
describe "when creating/updating the client on the server" do
before do
allow(registration).to receive(:http_api).and_return(http_mock)
end
it "posts a locally generated public key to the server to create a client" do
expect(http_mock).to receive(:post).
with("clients", expected_post_data).
and_return(create_with_pkey_response)
expect(registration.run.public_key).to eq(create_with_pkey_response["chef_key"]["public_key"])
expect(OpenSSL::PKey::RSA.new(registration.private_key).to_s).to eq(OpenSSL::PKey::RSA.new(generated_private_key_pem).to_s)
end
it "puts a locally generated public key to the server to update a client" do
expect(http_mock).to receive(:post).
with("clients", expected_post_data).
and_raise(exception_409)
expect(http_mock).to receive(:put).
with("clients/#{client_name}", expected_put_data).
and_return(update_with_pkey_response)
expect(registration.run.public_key).to eq(update_with_pkey_response["public_key"].to_pem)
expect(OpenSSL::PKey::RSA.new(registration.private_key).to_s).to eq(OpenSSL::PKey::RSA.new(generated_private_key_pem).to_s)
end
it "writes the generated private key to disk" do
expect(http_mock).to receive(:post).
with("clients", expected_post_data).
and_return(create_with_pkey_response)
registration.run
expect(OpenSSL::PKey::RSA.new(IO.read(key_location)).to_s).to eq(OpenSSL::PKey::RSA.new(generated_private_key_pem).to_s)
end
context "and the client already exists on a Chef 11 server" do
it "requests a new key from the server and saves it" do
expect(http_mock).to receive(:post).and_raise(exception_409)
expect(http_mock).to receive(:put).
with("clients/#{client_name}", expected_put_data).
and_return(update_with_pkey_response)
expect(registration.run.public_key).to eq(update_with_pkey_response["public_key"].to_pem)
expect(OpenSSL::PKey::RSA.new(registration.private_key).to_s).to eq(OpenSSL::PKey::RSA.new(generated_private_key_pem).to_s)
end
end
context "when local key generation is disabled" do
let(:expected_post_data) do
{ :name => client_name, :admin => false }
end
let(:expected_put_data) do
{ :name => client_name, :admin => false, :private_key => true }
end
before do
Chef::Config[:local_key_generation] = false
expect(OpenSSL::PKey::RSA).not_to receive(:generate)
end
it "creates a new ApiClient on the server using the validator identity" do
expect(http_mock).to receive(:post).
with("clients", expected_post_data).
and_return(server_v10_response)
expect(registration.run.private_key).to eq(server_v10_response["private_key"])
expect(registration.private_key).to eq("--begin rsa key etc--")
end
context "and the client already exists on a Chef 11 server" do
it "requests a new key from the server and saves it" do
expect(http_mock).to receive(:post).and_raise(exception_409)
expect(http_mock).to receive(:put).
with("clients/#{client_name}", expected_put_data).
and_return(server_v11_response)
expect(registration.run).to eq(server_v11_response)
expect(registration.private_key).to eq("--begin rsa key etc--")
end
end
context "and the client already exists on a Chef 10 server" do
it "requests a new key from the server and saves it" do
expect(http_mock).to receive(:post).with("clients", expected_post_data).
and_raise(exception_409)
expect(http_mock).to receive(:put).
with("clients/#{client_name}", expected_put_data).
and_return(server_v10_response)
expect(registration.run.private_key).to eq(server_v10_response["private_key"])
expect(registration.private_key).to eq("--begin rsa key etc--")
end
end
end
end
describe "when writing the private key to disk" do
before do
allow(registration).to receive(:private_key).and_return("--begin rsa key etc--")
end
# Permission read via File.stat is busted on windows, though creating the
# file with 0600 has the desired effect of giving access rights to the
# owner only. A platform-specific functional test would be helpful.
it "creates the file with 0600 permissions", :unix_only do
expect(File).not_to exist(key_location)
registration.write_key
expect(File).to exist(key_location)
stat = File.stat(key_location)
expect(stat.mode & 07777).to eq(0600)
end
it "writes the private key content to the file" do
registration.write_key
expect(IO.read(key_location)).to eq("--begin rsa key etc--")
end
context "when the client key location is a symlink" do
it "does not follow the symlink", :unix_only do
expected_flags = (File::CREAT|File::TRUNC|File::RDWR)
if defined?(File::NOFOLLOW)
expected_flags |= File::NOFOLLOW
end
expect(registration.file_flags).to eq(expected_flags)
end
context "with follow_client_key_symlink set to true" do
before do
Chef::Config[:follow_client_key_symlink] = true
end
it "follows the symlink", :unix_only do
expect(registration.file_flags).to eq(File::CREAT|File::TRUNC|File::RDWR)
end
end
end
end
describe "when registering a client" do
before do
allow(registration).to receive(:http_api).and_return(http_mock)
end
it "creates the client on the server and writes the key" do
expect(http_mock).to receive(:post).ordered.and_return(server_v10_response)
registration.run
expect(OpenSSL::PKey::RSA.new(IO.read(key_location)).to_s).to eq(OpenSSL::PKey::RSA.new(generated_private_key_pem).to_s)
end
it "retries up to 5 times" do
response_500 = Net::HTTPInternalServerError.new("1.1", "500", "Internal Server Error")
exception_500 = Net::HTTPFatalError.new("500 Internal Server Error", response_500)
expect(http_mock).to receive(:post).ordered.and_raise(exception_500) # 1
expect(http_mock).to receive(:post).ordered.and_raise(exception_500) # 2
expect(http_mock).to receive(:post).ordered.and_raise(exception_500) # 3
expect(http_mock).to receive(:post).ordered.and_raise(exception_500) # 4
expect(http_mock).to receive(:post).ordered.and_raise(exception_500) # 5
expect(http_mock).to receive(:post).ordered.and_return(server_v10_response)
registration.run
expect(OpenSSL::PKey::RSA.new(IO.read(key_location)).to_s).to eq(OpenSSL::PKey::RSA.new(generated_private_key_pem).to_s)
end
it "gives up retrying after the max attempts" do
response_500 = Net::HTTPInternalServerError.new("1.1", "500", "Internal Server Error")
exception_500 = Net::HTTPFatalError.new("500 Internal Server Error", response_500)
expect(http_mock).to receive(:post).exactly(6).times.and_raise(exception_500)
expect {registration.run}.to raise_error(Net::HTTPFatalError)
end
end
end
|