X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=lib%2Fpuppet%2Fprovider%2Fapt_key%2Fapt_key.rb;h=d663ee36276303773a0e8be37acb31d0517f7f2a;hb=cd315457372a8f7d642c49c2ac5d64854da639c6;hp=49b1afdc3e0a975a7940ee269c29e506d7b75b7a;hpb=2b536b6a200e8f4f7f7ae37ec091abd06ca4cb70;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/lib/puppet/provider/apt_key/apt_key.rb b/lib/puppet/provider/apt_key/apt_key.rb index 49b1afd..d663ee3 100644 --- a/lib/puppet/provider/apt_key/apt_key.rb +++ b/lib/puppet/provider/apt_key/apt_key.rb @@ -1,59 +1,53 @@ +# frozen_string_literal: true + require 'open-uri' -require 'net/ftp' +begin + require 'net/ftp' +rescue LoadError + # Ruby 3.0 changed net-ftp to a default gem +end require 'tempfile' -if RUBY_VERSION == '1.8.7' - # Mothers cry, puppies die and Ruby 1.8.7's open-uri needs to be - # monkeypatched to support passing in :ftp_passive_mode. - require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', - 'puppet_x', 'apt_key', 'patch_openuri.rb')) - OpenURI::Options[:ftp_active_mode] = false -end +Puppet::Type.type(:apt_key).provide(:apt_key) do # rubocop:disable Metrics/BlockLength + desc 'apt-key provider for apt_key resource' -Puppet::Type.type(:apt_key).provide(:apt_key) do confine osfamily: :debian defaultfor osfamily: :debian commands apt_key: 'apt-key' commands gpg: '/usr/bin/gpg' - def self.instances - cli_args = ['adv', '--list-keys', '--with-colons', '--fingerprint', '--fixed-list-mode'] + def self.instances # rubocop:disable Metrics/AbcSize + key_array = [] - key_output = apt_key(cli_args).encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '') + cli_args = ['adv', '--no-tty', '--list-keys', '--with-colons', '--fingerprint', '--fixed-list-mode'] - pub_line, sub_line, fpr_line = nil - - key_array = key_output.split("\n").map do |line| - if line.start_with?('pub') - pub_line = line - # reset fpr_line, to skip any previous subkeys which were collected - fpr_line = nil - sub_line = nil - elsif line.start_with?('sub') - sub_line = line - elsif line.start_with?('fpr') - fpr_line = line - end + key_output = apt_key(cli_args).encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '') - if sub_line && fpr_line - sub_line, fpr_line = nil - next + pub_line = nil + fpr_lines = [] + sub_lines = [] + + lines = key_output.split("\n") + + lines.each_index do |i| + if lines[i].start_with?('pub') + pub_line = lines[i] + # starting a new public key, so reset fpr_lines and sub_lines + fpr_lines = [] + sub_lines = [] + elsif lines[i].start_with?('fpr') + fpr_lines << lines[i] + elsif lines[i].start_with?('sub') + sub_lines << lines[i] end - next unless pub_line && fpr_line - - line_hash = key_line_hash(pub_line, fpr_line) + next unless (pub_line && !fpr_lines.empty?) && (!lines[i + 1] || lines[i + 1].start_with?('pub')) - # reset everything - pub_line, fpr_line = nil + line_hash = key_line_hash(pub_line, fpr_lines) - expired = false - - if line_hash[:key_expiry] - expired = Time.now >= line_hash[:key_expiry] - end + expired = line_hash[:key_expired] || subkeys_all_expired(sub_lines) - new( + key_array << new( name: line_hash[:key_fingerprint], id: line_hash[:key_long], fingerprint: line_hash[:key_fingerprint], @@ -67,38 +61,49 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do created: line_hash[:key_created].strftime('%Y-%m-%d'), ) end - key_array.compact! + key_array end def self.prefetch(resources) apt_keys = instances - resources.keys.each do |name| - if name.length == 40 + resources.each_key do |name| + case name.length + when 40 provider = apt_keys.find { |key| key.fingerprint == name } resources[name].provider = provider if provider - elsif name.length == 16 + when 16 provider = apt_keys.find { |key| key.long == name } resources[name].provider = provider if provider - elsif name.length == 8 + when 8 provider = apt_keys.find { |key| key.short == name } resources[name].provider = provider if provider end end end - def self.key_line_hash(pub_line, fpr_line) + def self.subkeys_all_expired(sub_lines) + return false if sub_lines.empty? + + sub_lines.each do |line| + return false if line.split(':')[1] == '-' + end + true + end + + def self.key_line_hash(pub_line, fpr_lines) pub_split = pub_line.split(':') - fpr_split = fpr_line.split(':') + fpr_split = fpr_lines.first.split(':') fingerprint = fpr_split.last return_hash = { key_fingerprint: fingerprint, - key_long: fingerprint[-16..-1], # last 16 characters of fingerprint - key_short: fingerprint[-8..-1], # last 8 characters of fingerprint + key_long: fingerprint[-16..], # last 16 characters of fingerprint + key_short: fingerprint[-8..], # last 8 characters of fingerprint key_size: pub_split[2], key_type: nil, key_created: Time.at(pub_split[5].to_i), - key_expiry: pub_split[6].empty? ? nil : Time.at(pub_split[6].to_i), + key_expired: pub_split[1] == 'e', + key_expiry: pub_split[6].empty? ? nil : Time.at(pub_split[6].to_i) } # set key type based on types defined in /usr/share/doc/gnupg/DETAILS.gz @@ -119,7 +124,8 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do def source_to_file(value) parsed_value = URI.parse(value) if parsed_value.scheme.nil? - raise("The file #{value} does not exist") unless File.exist?(value) + raise(_('The file %{_value} does not exist') % { _value: value }) unless File.exist?(value) + # Because the tempfile method has to return a live object to prevent GC # of the underlying file from occuring too early, we also have to return # a file object here. The caller can still call the #path method on the @@ -128,20 +134,27 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do f.close f else + exceptions = [OpenURI::HTTPError] + exceptions << Net::FTPPermError if defined?(Net::FTPPermError) + begin # Only send basic auth if URL contains userinfo # Some webservers (e.g. Amazon S3) return code 400 if empty basic auth is sent if parsed_value.userinfo.nil? - key = parsed_value.read + key = if parsed_value.scheme == 'https' && resource[:weak_ssl] == true + URI.open(parsed_value, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE).read + else + parsed_value.read + end else user_pass = parsed_value.userinfo.split(':') parsed_value.userinfo = '' - key = open(parsed_value, http_basic_authentication: user_pass).read + key = URI.open(parsed_value, http_basic_authentication: user_pass).read end - rescue OpenURI::HTTPError, Net::FTPPermError => e - raise("#{e.message} for #{resource[:source]}") + rescue *exceptions => e + raise(_('%{_e} for %{_resource}') % { _e: e.message, _resource: resource[:source] }) rescue SocketError - raise("could not resolve #{resource[:source]}") + raise(_('could not resolve %{_resource}') % { _resource: resource[:source] }) else tempfile(key) end @@ -158,17 +171,15 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do # confirm that the fingerprint from the file, matches the long key that is in the manifest if name.size == 40 if File.executable? command(:gpg) - extracted_key = execute(["#{command(:gpg)} --with-fingerprint --with-colons #{file.path} | awk -F: '/^fpr:/ { print $10 }'"], failonfail: false) + extracted_key = execute(["#{command(:gpg)} --no-tty --with-fingerprint --with-colons #{file.path} | awk -F: '/^fpr:/ { print $10 }'"], failonfail: false) extracted_key = extracted_key.chomp found_match = false extracted_key.each_line do |line| - if line.chomp == name - found_match = true - end + found_match = true if line.chomp == name end unless found_match - raise("The id in your manifest #{resource[:name]} and the fingerprint from content/source don't match. Check for an error in the id and content/source is legitimate.") + raise(_('The id in your manifest %{_resource} and the fingerprint from content/source don\'t match. Check for an error in the id and content/source is legitimate.') % { _resource: resource[:name] }) # rubocop:disable Layout/LineLength end else warning('/usr/bin/gpg cannot be found for verification of the id.') @@ -178,7 +189,8 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do end def exists? - @property_hash[:ensure] == :present + # report expired keys as non-existing when refresh => true + @property_hash[:ensure] == :present && !(resource[:refresh] && @property_hash[:expired]) end def create @@ -186,10 +198,8 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do if resource[:source].nil? && resource[:content].nil? # Breaking up the command like this is needed because it blows up # if --recv-keys isn't the last argument. - command.push('adv', '--keyserver', resource[:server]) - unless resource[:options].nil? - command.push('--keyserver-options', resource[:options]) - end + command.push('adv', '--no-tty', '--keyserver', resource[:server]) + command.push('--keyserver-options', resource[:options]) unless resource[:options].nil? command.push('--recv-keys', resource[:id]) elsif resource[:content] key_file = tempfile(resource[:content]) @@ -199,7 +209,7 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do command.push('add', key_file.path) # In case we really screwed up, better safe than sorry. else - raise("an unexpected condition occurred while trying to add the key: #{resource[:id]}") + raise(_('an unexpected condition occurred while trying to add the key: %{_resource}') % { _resource: resource[:id] }) end apt_key(command) @property_hash[:ensure] = :present @@ -215,17 +225,11 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do end def read_only(_value) - raise('This is a read-only property.') + raise(_('This is a read-only property.')) end mk_resource_methods - # Needed until PUP-1470 is fixed and we can drop support for Puppet versions - # before that. - def expired - @property_hash[:expired] - end - # Alias the setters of read-only properties # to the read_only function. alias_method :created=, :read_only