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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
|
#
# Author:: Thom May (<thom@chef.io>)
# Copyright:: 2016-2020, Chef Software 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_relative "../resource"
require_relative "../http/simple"
require "tmpdir" unless defined?(Dir.mktmpdir)
require "addressable" unless defined?(Addressable)
class Chef
class Resource
class AptRepository < Chef::Resource
unified_mode true
provides(:apt_repository) { true }
description "Use the apt_repository resource to specify additional APT repositories. Adding a new repository will update the APT package cache immediately."
introduced "12.9"
examples <<~DOC
Add repository with basic settings
```ruby
apt_repository 'nginx' do
uri 'http://nginx.org/packages/ubuntu/'
components ['nginx']
end
```
Enable Ubuntu multiverse repositories
```ruby
apt_repository 'security-ubuntu-multiverse' do
uri 'http://security.ubuntu.com/ubuntu'
distribution 'trusty-security'
components ['multiverse']
deb_src true
end
```
Add the Nginx PPA, autodetect the key and repository url
```ruby
apt_repository 'nginx-php' do
uri 'ppa:nginx/stable'
end
```
Add the JuJu PPA, grab the key from the keyserver, and add source repo
```ruby
apt_repository 'juju' do
uri 'http://ppa.launchpad.net/juju/stable/ubuntu'
components ['main']
distribution 'trusty'
key 'C8068B11'
keyserver 'keyserver.ubuntu.com'
action :add
deb_src true
end
```
Add repository that requires multiple keys to authenticate packages
```ruby
apt_repository 'rundeck' do
uri 'https://dl.bintray.com/rundeck/rundeck-deb'
distribution '/'
key ['379CE192D401AB61', 'http://rundeck.org/keys/BUILD-GPG-KEY-Rundeck.org.key']
keyserver 'keyserver.ubuntu.com'
action :add
end
```
Add the Cloudera Repo of CDH4 packages for Ubuntu 12.04 on AMD64
```ruby
apt_repository 'cloudera' do
uri 'http://archive.cloudera.com/cdh4/ubuntu/precise/amd64/cdh'
arch 'amd64'
distribution 'precise-cdh4'
components ['contrib']
key 'http://archive.cloudera.com/debian/archive.key'
end
```
Remove a repository from the list
```ruby
apt_repository 'zenoss' do
action :remove
end
```
DOC
# There's a pile of [ String, nil, FalseClass ] types in these properties.
# This goes back to Chef 12 where String didn't default to nil and we had to do
# it ourself, which required allowing that type as well. We've cleaned up the
# defaults, but since we allowed users to pass nil here we need to continue
# to allow that so don't refactor this however tempting it is
property :repo_name, String,
regex: [%r{^[^/]+$}],
description: "An optional property to set the repository name if it differs from the resource block's name. The value of this setting must not contain spaces.",
validation_message: "repo_name property cannot contain a forward slash '/'",
introduced: "14.1", name_property: true
property :uri, String,
description: "The base of the Debian distribution."
property :distribution, [ String, nil, FalseClass ],
description: "Usually a distribution's codename, such as trusty, xenial or bionic. Default value: the codename of the node's distro.",
default: lazy { node["lsb"]["codename"] }, default_description: "The LSB codename of the host such as 'bionic'."
property :components, Array,
description: "Package groupings, such as 'main' and 'stable'.",
default: lazy { [] }, default_description: "'main' if using a PPA repository."
property :arch, [String, nil, FalseClass],
description: "Constrain packages to a particular CPU architecture such as 'i386' or 'amd64'."
property :trusted, [TrueClass, FalseClass],
description: "Determines whether you should treat all packages from this repository as authenticated regardless of signature.",
default: false
property :deb_src, [TrueClass, FalseClass],
description: "Determines whether or not to add the repository as a source repo as well.",
default: false
property :keyserver, [String, nil, FalseClass],
description: "The GPG keyserver where the key for the repo should be retrieved.",
default: "keyserver.ubuntu.com"
property :key, [String, Array, nil, FalseClass],
description: "If a keyserver is provided, this is assumed to be the fingerprint; otherwise it can be either the URI of GPG key for the repo, or a cookbook_file.",
default: lazy { [] }, coerce: proc { |x| x ? Array(x) : x }
property :key_proxy, [String, nil, FalseClass],
description: "If set, a specified proxy is passed to GPG via http-proxy=."
property :cookbook, [String, nil, FalseClass],
description: "If key should be a cookbook_file, specify a cookbook where the key is located for files/default. Default value is nil, so it will use the cookbook where the resource is used.",
desired_state: false
property :cache_rebuild, [TrueClass, FalseClass],
description: "Determines whether to rebuild the APT package cache.",
default: true, desired_state: false
default_action :add
allowed_actions :add, :remove
action_class do
LIST_APT_KEY_FINGERPRINTS = %w{apt-key adv --list-public-keys --with-fingerprint --with-colons}.freeze
# is the provided ID a key ID from a keyserver. Looks at length and HEX only values
# @param [String] id the key value passed by the user that *may* be an ID
def is_key_id?(id)
id = id[2..-1] if id.start_with?("0x")
id =~ /^\h+$/ && [8, 16, 40].include?(id.length)
end
# run the specified command and extract the fingerprints from the output
# accepts a command so it can be used to extract both the current key's fingerprints
# and the fingerprint of the new key
# @param [Array<String>] cmd the command to run
#
# @return [Array] an array of fingerprints
def extract_fingerprints_from_cmd(*cmd)
so = shell_out(*cmd)
so.stdout.split(/\n/).map do |t|
if z = t.match(/^fpr:+([0-9A-F]+):/)
z[1].split.join
end
end.compact
end
# validate the key against the apt keystore to see if that version is expired
# @param [String] key
#
# @return [Boolean] is the key valid or not
def key_is_valid?(key)
valid = true
so = shell_out("apt-key", "list")
so.stdout.split(/\n/).map do |t|
if t =~ %r{^\/#{key}.*\[expired: .*\]$}
logger.debug "Found expired key: #{t}"
valid = false
break
end
end
logger.debug "key #{key} #{valid ? "is valid" : "is not valid"}"
valid
end
# return the specified cookbook name or the cookbook containing the
# resource.
#
# @return [String] name of the cookbook
def cookbook_name
new_resource.cookbook || new_resource.cookbook_name
end
# determine if a cookbook file is available in the run
# @param [String] fn the path to the cookbook file
#
# @return [Boolean] cookbook file exists or doesn't
def has_cookbook_file?(fn)
run_context.has_cookbook_file_in_cookbook?(cookbook_name, fn)
end
# determine if there are any new keys by comparing the fingerprints of installed
# keys to those of the passed file
# @param [String] file the keyfile of the new repository
#
# @return [Boolean] true: no new keys in the file. false: there are new keys
def no_new_keys?(file)
# Now we are using the option --with-colons that works across old os versions
# as well as the latest (16.10). This for both `apt-key` and `gpg` commands
installed_keys = extract_fingerprints_from_cmd(*LIST_APT_KEY_FINGERPRINTS)
proposed_keys = extract_fingerprints_from_cmd("gpg", "--with-fingerprint", "--with-colons", file)
(installed_keys & proposed_keys).sort == proposed_keys.sort
end
# Given the provided key URI determine what kind of chef resource we need
# to fetch the key
# @param [String] uri the uri of the gpg key (local path or http URL)
#
# @raise [Chef::Exceptions::FileNotFound] Key isn't remote or found in the current run
#
# @return [Symbol] :remote_file or :cookbook_file
def key_type(uri)
if uri.start_with?("http")
:remote_file
elsif has_cookbook_file?(uri)
:cookbook_file
else
raise Chef::Exceptions::FileNotFound, "Cannot locate key file: #{uri}"
end
end
# Fetch the key using either cookbook_file or remote_file, validate it,
# and install it with apt-key add
# @param [String] key the key to install
#
# @raise [RuntimeError] Invalid key which can't verify the apt repository
#
# @return [void]
def install_key_from_uri(key)
key_name = key.gsub(/[^0-9A-Za-z\-]/, "_")
cached_keyfile = ::File.join(Chef::Config[:file_cache_path], key_name)
tmp_dir = Dir.mktmpdir(".gpg")
at_exit { FileUtils.remove_entry(tmp_dir) }
declare_resource(key_type(key), cached_keyfile) do
source key
mode "0644"
sensitive new_resource.sensitive
action :create
verify "gpg --homedir #{tmp_dir} %{path}"
end
execute "apt-key add #{cached_keyfile}" do
command [ "apt-key", "add", cached_keyfile ]
default_env true
sensitive new_resource.sensitive
action :run
not_if { no_new_keys?(cached_keyfile) }
notifies :run, "execute[apt-cache gencaches]", :immediately
end
end
# build the apt-key command to install the keyserver
# @param [String] key the key to install
# @param [String] keyserver the key server to use
#
# @return [String] the full apt-key command to run
def keyserver_install_cmd(key, keyserver)
cmd = "apt-key adv --no-tty --recv"
cmd << " --keyserver-options http-proxy=#{new_resource.key_proxy}" if new_resource.key_proxy
cmd << " --keyserver "
cmd << if keyserver.start_with?("hkp://")
keyserver
else
"hkp://#{keyserver}:80"
end
cmd << " #{key}"
cmd
end
# @param [String] key
# @param [String] keyserver
#
# @raise [RuntimeError] Invalid key which can't verify the apt repository
#
# @return [void]
def install_key_from_keyserver(key, keyserver = new_resource.keyserver)
execute "install-key #{key}" do
command keyserver_install_cmd(key, keyserver)
default_env true
sensitive new_resource.sensitive
not_if do
present = extract_fingerprints_from_cmd(*LIST_APT_KEY_FINGERPRINTS).any? do |fp|
fp.end_with? key.upcase
end
present && key_is_valid?(key.upcase)
end
notifies :run, "execute[apt-cache gencaches]", :immediately
end
raise "The key #{key} is invalid and cannot be used to verify an apt repository." unless key_is_valid?(key.upcase)
end
# @param [String] owner
# @param [String] repo
#
# @raise [RuntimeError] Could not access the Launchpad PPA API
#
# @return [void]
def install_ppa_key(owner, repo)
url = "https://launchpad.net/api/1.0/~#{owner}/+archive/#{repo}"
key_id = Chef::HTTP::Simple.new(url).get("signing_key_fingerprint").delete('"')
install_key_from_keyserver(key_id, "keyserver.ubuntu.com")
rescue Net::HTTPClientException => e
raise "Could not access Launchpad ppa API: #{e.message}"
end
# determine if the repository URL is a PPA
# @param [String] url the url of the repository
#
# @return [Boolean] is the repo URL a PPA
def is_ppa_url?(url)
url.start_with?("ppa:")
end
# determine the repository's components:
# - "components" property if defined
# - "main" if "components" not defined and the repo is a PPA URL
# - otherwise nothing
#
# @return [String] the repository component
def repo_components
if is_ppa_url?(new_resource.uri) && new_resource.components.empty?
"main"
else
new_resource.components
end
end
# given a PPA return a PPA URL in http://ppa.launchpad.net format
# @param [String] ppa the ppa URL
#
# @return [String] full PPA URL
def make_ppa_url(ppa)
owner, repo = ppa[4..-1].split("/")
repo ||= "ppa"
install_ppa_key(owner, repo)
"http://ppa.launchpad.net/#{owner}/#{repo}/ubuntu"
end
# build complete repo text that will be written to the config
# @param [String] uri
# @param [Array] components
# @param [Boolean] trusted
# @param [String] arch
# @param [Boolean] add_src
#
# @return [String] complete repo config text
def build_repo(uri, distribution, components, trusted, arch, add_src = false)
uri = make_ppa_url(uri) if is_ppa_url?(uri)
uri = Addressable::URI.parse(uri)
components = Array(components).join(" ")
options = []
options << "arch=#{arch}" if arch
options << "trusted=yes" if trusted
optstr = unless options.empty?
"[" + options.join(" ") + "]"
end
info = [ optstr, uri.normalize.to_s, distribution, components ].compact.join(" ")
repo = "deb #{info}\n"
repo << "deb-src #{info}\n" if add_src
repo
end
# clean up a potentially legacy file from before we fixed the usage of
# new_resource.name vs. new_resource.repo_name. We might have the
# name.list file hanging around and need to clean it up.
#
# @return [void]
def cleanup_legacy_file!
legacy_path = "/etc/apt/sources.list.d/#{new_resource.name}.list"
if new_resource.name != new_resource.repo_name && ::File.exist?(legacy_path)
converge_by "Cleaning up legacy #{legacy_path} repo file" do
file legacy_path do
action :delete
# Not triggering an update since it isn't super likely to be needed.
end
end
end
end
end
action :add do
return unless debian?
execute "apt-cache gencaches" do
command %w{apt-cache gencaches}
default_env true
ignore_failure true
action :nothing
end
apt_update new_resource.name do
ignore_failure true
action :nothing
end
if new_resource.key.nil?
logger.debug "No 'key' property specified skipping key import"
else
new_resource.key.each do |k|
if is_key_id?(k) && !has_cookbook_file?(k)
install_key_from_keyserver(k)
else
install_key_from_uri(k)
end
end
end
cleanup_legacy_file!
repo = build_repo(
new_resource.uri,
new_resource.distribution,
repo_components,
new_resource.trusted,
new_resource.arch,
new_resource.deb_src
)
file "/etc/apt/sources.list.d/#{new_resource.repo_name}.list" do
owner "root"
group "root"
mode "0644"
content repo
sensitive new_resource.sensitive
action :create
notifies :run, "execute[apt-cache gencaches]", :immediately
notifies :update, "apt_update[#{new_resource.name}]", :immediately if new_resource.cache_rebuild
end
end
action :remove do
return unless debian?
cleanup_legacy_file!
if ::File.exist?("/etc/apt/sources.list.d/#{new_resource.repo_name}.list")
converge_by "Removing #{new_resource.repo_name} repository from /etc/apt/sources.list.d/" do
apt_update new_resource.name do
ignore_failure true
action :nothing
end
file "/etc/apt/sources.list.d/#{new_resource.repo_name}.list" do
sensitive new_resource.sensitive
action :delete
notifies :update, "apt_update[#{new_resource.name}]", :immediately if new_resource.cache_rebuild
end
end
else
logger.trace("/etc/apt/sources.list.d/#{new_resource.repo_name}.list does not exist. Nothing to do")
end
end
end
end
end
|