X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=lib%2Fpuppet%2Fprovider%2Fapt_key%2Fapt_key.rb;h=9ad21bcc6e6f51d5873230c867475fd122fa47cb;hb=3d5e23644f0fc557464409d98415872b2e7ba81d;hp=3f95c3cc96af9c68f40234d6f07a9a3072be5173;hpb=5c209ee1a0f16b0ef59f665f5bfa9df451c82b9d;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 3f95c3c..9ad21bc 100644 --- a/lib/puppet/provider/apt_key/apt_key.rb +++ b/lib/puppet/provider/apt_key/apt_key.rb @@ -1,51 +1,46 @@ -require 'open-uri' -require 'net/ftp' -require 'tempfile' +# frozen_string_literal: true -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.merge!({:ftp_active_mode => false,}) +require 'open-uri' +begin + require 'net/ftp' +rescue LoadError + # Ruby 3.0 changed net-ftp to a default gem end +require 'tempfile' Puppet::Type.type(:apt_key).provide(:apt_key) do + desc 'apt-key provider for apt_key resource' - confine :osfamily => :debian - defaultfor :osfamily => :debian - commands :apt_key => 'apt-key' - commands :gpg => '/usr/bin/gpg' + 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'] + cli_args = ['adv', '--no-tty', '--list-keys', '--with-colons', '--fingerprint', '--fixed-list-mode'] - if RUBY_VERSION > '1.8.7' - key_output = apt_key(cli_args).encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '') - else - key_output = apt_key(cli_args) - end + key_output = apt_key(cli_args).encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '') pub_line, sub_line, fpr_line = nil - key_array = key_output.split("\n").collect do |line| + 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 + 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 + sub_line = line elsif line.start_with?('fpr') - fpr_line = line + fpr_line = line end - if (sub_line and fpr_line) + if sub_line && fpr_line sub_line, fpr_line = nil next end - next unless (pub_line and fpr_line) + next unless pub_line && fpr_line line_hash = key_line_hash(pub_line, fpr_line) @@ -54,22 +49,20 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do expired = false - if line_hash[:key_expiry] - expired = Time.now >= line_hash[:key_expiry] - end + expired = Time.now >= line_hash[:key_expiry] if line_hash[:key_expiry] new( - :name => line_hash[:key_fingerprint], - :id => line_hash[:key_long], - :fingerprint => line_hash[:key_fingerprint], - :short => line_hash[:key_short], - :long => line_hash[:key_long], - :ensure => :present, - :expired => expired, - :expiry => line_hash[:key_expiry].nil? ? nil : line_hash[:key_expiry].strftime("%Y-%m-%d"), - :size => line_hash[:key_size], - :type => line_hash[:key_type], - :created => line_hash[:key_created].strftime("%Y-%m-%d") + name: line_hash[:key_fingerprint], + id: line_hash[:key_long], + fingerprint: line_hash[:key_fingerprint], + short: line_hash[:key_short], + long: line_hash[:key_long], + ensure: :present, + expired: expired, + expiry: line_hash[:key_expiry].nil? ? nil : line_hash[:key_expiry].strftime('%Y-%m-%d'), + size: line_hash[:key_size], + type: line_hash[:key_type], + created: line_hash[:key_created].strftime('%Y-%m-%d'), ) end key_array.compact! @@ -77,19 +70,17 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do def self.prefetch(resources) apt_keys = instances - resources.keys.each do |name| - if name.length == 40 - if provider = apt_keys.find{ |key| key.fingerprint == name } - resources[name].provider = provider - end - elsif name.length == 16 - if provider = apt_keys.find{ |key| key.long == name } - resources[name].provider = provider - end - elsif name.length == 8 - if provider = apt_keys.find{ |key| key.short == name } - resources[name].provider = provider - end + resources.each_key do |name| + case name.length + when 40 + provider = apt_keys.find { |key| key.fingerprint == name } + resources[name].provider = provider if provider + when 16 + provider = apt_keys.find { |key| key.long == name } + resources[name].provider = provider if provider + when 8 + provider = apt_keys.find { |key| key.short == name } + resources[name].provider = provider if provider end end end @@ -100,34 +91,35 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do 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_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_fingerprint: fingerprint, + key_long: fingerprint[-16..-1], # last 16 characters of fingerprint + key_short: fingerprint[-8..-1], # 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) } # set key type based on types defined in /usr/share/doc/gnupg/DETAILS.gz case pub_split[3] - when "1" + when '1' return_hash[:key_type] = :rsa - when "17" + when '17' return_hash[:key_type] = :dsa - when "18" + when '18' return_hash[:key_type] = :ecc - when "19" + when '19' return_hash[:key_type] = :ecdsa end - return return_hash + return_hash end def source_to_file(value) - parsedValue = URI::parse(value) - if parsedValue.scheme.nil? - fail("The file #{value} does not exist") unless File.exists?(value) + parsed_value = URI.parse(value) + if parsed_value.scheme.nil? + 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 @@ -136,20 +128,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 parsedValue.userinfo.nil? - key = parsedValue.read + if parsed_value.userinfo.nil? + 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 = parsedValue.userinfo.split(':') - parsedValue.userinfo = '' - key = open(parsedValue, :http_basic_authentication => user_pass).read + user_pass = parsed_value.userinfo.split(':') + parsed_value.userinfo = '' + key = URI.open(parsed_value, http_basic_authentication: user_pass).read end - rescue OpenURI::HTTPError, Net::FTPPermError => e - fail("#{e.message} for #{resource[:source]}") + rescue *exceptions => e + raise(_('%{_e} for %{_resource}') % { _e: e.message, _resource: resource[:source] }) rescue SocketError - fail("could not resolve #{resource[:source]}") + raise(_('could not resolve %{_resource}') % { _resource: resource[:source] }) else tempfile(key) end @@ -163,20 +162,18 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do file = Tempfile.new('apt_key') file.write content file.close - #confirm that the fingerprint from the file, matches the long key that is in the manifest + # 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 - if not found_match - fail("The id in your manifest #{resource[:name]} and the fingerprint from content/source do not match. Please check there is not an error in the id or check the content/source is legitimate.") + unless found_match + 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.') @@ -186,18 +183,17 @@ 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 command = [] - if resource[:source].nil? and resource[:content].nil? + 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]) @@ -207,37 +203,32 @@ 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 - fail("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 end def destroy - begin + loop do apt_key('del', resource.provider.short) - r = execute(["#{command(:apt_key)} list | grep '/#{resource.provider.short}\s'"], :failonfail => false) - end while r.exitstatus == 0 + r = execute(["#{command(:apt_key)} list | grep '/#{resource.provider.short}\s'"], failonfail: false) + break unless r.exitstatus.zero? + end @property_hash.clear end - def read_only(value) - fail('This is a read-only property.') + def read_only(_value) + 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 :created= :read_only - alias :expired= :read_only - alias :expiry= :read_only - alias :size= :read_only - alias :type= :read_only + alias_method :created=, :read_only + alias_method :expired=, :read_only + alias_method :expiry=, :read_only + alias_method :size=, :read_only + alias_method :type=, :read_only end