(CONT-773) Rubocop Unsafe Auto Fixes 1-3
[puppet-modules/puppetlabs-apt.git] / lib / puppet / provider / apt_key / apt_key.rb
index bcb0bb9730a608f95d093cb939665b64b6e80559..9ad21bcc6e6f51d5873230c867475fd122fa47cb 100644 (file)
@@ -1,23 +1,23 @@
-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[: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'
 
   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']
 
     key_output = apt_key(cli_args).encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
 
@@ -49,9 +49,7 @@ 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],
@@ -73,13 +71,14 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do
   def self.prefetch(resources)
     apt_keys = instances
     resources.each_key do |name|
-      if name.length == 40
+      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
@@ -98,7 +97,7 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do
       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_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
@@ -120,6 +119,7 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do
     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
@@ -128,17 +128,24 @@ 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
+      rescue *exceptions => e
         raise(_('%{_e} for %{_resource}') % { _e: e.message, _resource: resource[:source] })
       rescue SocketError
         raise(_('could not resolve %{_resource}') % { _resource: resource[:source] })
@@ -158,17 +165,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} and the fingerprint from content/source don\'t match. Check for an error in the id and content/source is legitimate.') % { _name: resource[:name] }) # rubocop:disable Metrics/LineLength
+          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 +183,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 +192,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])
@@ -220,12 +224,6 @@ Puppet::Type.type(:apt_key).provide(:apt_key) do
 
   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