lib/puppet/provider/apt_key/apt_key.rb

   1 # frozen_string_literal: true
   2
   3 require 'open-uri'
   4 begin
   5   require 'net/ftp'
   6 rescue LoadError
   7   # Ruby 3.0 changed net-ftp to a default gem
   8 end
   9 require 'tempfile'
  10
  11 Puppet::Type.type(:apt_key).provide(:apt_key) do
  12   desc 'apt-key provider for apt_key resource'
  13
  14   confine    osfamily: :debian
  15   defaultfor osfamily: :debian
  16   commands   apt_key: 'apt-key'
  17   commands   gpg: '/usr/bin/gpg'
  18
  19   def self.instances
  20     cli_args = ['adv', '--no-tty', '--list-keys', '--with-colons', '--fingerprint', '--fixed-list-mode']
  21
  22     key_output = apt_key(cli_args).encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
  23
  24     pub_line, sub_line, fpr_line = nil
  25
  26     key_array = key_output.split("\n").map do |line|
  27       if line.start_with?('pub')
  28         pub_line = line
  29         # reset fpr_line, to skip any previous subkeys which were collected
  30         fpr_line = nil
  31         sub_line = nil
  32       elsif line.start_with?('sub')
  33         sub_line = line
  34       elsif line.start_with?('fpr')
  35         fpr_line = line
  36       end
  37
  38       if sub_line && fpr_line
  39         sub_line, fpr_line = nil
  40         next
  41       end
  42
  43       next unless pub_line && fpr_line
  44
  45       line_hash = key_line_hash(pub_line, fpr_line)
  46
  47       # reset everything
  48       pub_line, fpr_line = nil
  49
  50       expired = false
  51
  52       expired = Time.now >= line_hash[:key_expiry] if line_hash[:key_expiry]
  53
  54       new(
  55         name: line_hash[:key_fingerprint],
  56         id: line_hash[:key_long],
  57         fingerprint: line_hash[:key_fingerprint],
  58         short: line_hash[:key_short],
  59         long: line_hash[:key_long],
  60         ensure: :present,
  61         expired: expired,
  62         expiry: line_hash[:key_expiry].nil? ? nil : line_hash[:key_expiry].strftime('%Y-%m-%d'),
  63         size: line_hash[:key_size],
  64         type: line_hash[:key_type],
  65         created: line_hash[:key_created].strftime('%Y-%m-%d'),
  66       )
  67     end
  68     key_array.compact!
  69   end
  70
  71   def self.prefetch(resources)
  72     apt_keys = instances
  73     resources.each_key do |name|
  74       case name.length
  75       when 40
  76         provider = apt_keys.find { |key| key.fingerprint == name }
  77         resources[name].provider = provider if provider
  78       when 16
  79         provider = apt_keys.find { |key| key.long == name }
  80         resources[name].provider = provider if provider
  81       when 8
  82         provider = apt_keys.find { |key| key.short == name }
  83         resources[name].provider = provider if provider
  84       end
  85     end
  86   end
  87
  88   def self.key_line_hash(pub_line, fpr_line)
  89     pub_split = pub_line.split(':')
  90     fpr_split = fpr_line.split(':')
  91
  92     fingerprint = fpr_split.last
  93     return_hash = {
  94       key_fingerprint: fingerprint,
  95       key_long: fingerprint[-16..], # last 16 characters of fingerprint
  96       key_short: fingerprint[-8..], # last 8 characters of fingerprint
  97       key_size: pub_split[2],
  98       key_type: nil,
  99       key_created: Time.at(pub_split[5].to_i),
 100       key_expiry: pub_split[6].empty? ? nil : Time.at(pub_split[6].to_i)
 101     }
 102
 103     # set key type based on types defined in /usr/share/doc/gnupg/DETAILS.gz
 104     case pub_split[3]
 105     when '1'
 106       return_hash[:key_type] = :rsa
 107     when '17'
 108       return_hash[:key_type] = :dsa
 109     when '18'
 110       return_hash[:key_type] = :ecc
 111     when '19'
 112       return_hash[:key_type] = :ecdsa
 113     end
 114
 115     return_hash
 116   end
 117
 118   def source_to_file(value)
 119     parsed_value = URI.parse(value)
 120     if parsed_value.scheme.nil?
 121       raise(_('The file %{_value} does not exist') % { _value: value }) unless File.exist?(value)
 122
 123       # Because the tempfile method has to return a live object to prevent GC
 124       # of the underlying file from occuring too early, we also have to return
 125       # a file object here.  The caller can still call the #path method on the
 126       # closed file handle to get the path.
 127       f = File.open(value, 'r')
 128       f.close
 129       f
 130     else
 131       exceptions = [OpenURI::HTTPError]
 132       exceptions << Net::FTPPermError if defined?(Net::FTPPermError)
 133
 134       begin
 135         # Only send basic auth if URL contains userinfo
 136         # Some webservers (e.g. Amazon S3) return code 400 if empty basic auth is sent
 137         if parsed_value.userinfo.nil?
 138           key = if parsed_value.scheme == 'https' && resource[:weak_ssl] == true
 139                   URI.open(parsed_value, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE).read
 140                 else
 141                   parsed_value.read
 142                 end
 143         else
 144           user_pass = parsed_value.userinfo.split(':')
 145           parsed_value.userinfo = ''
 146           key = URI.open(parsed_value, http_basic_authentication: user_pass).read
 147         end
 148       rescue *exceptions => e
 149         raise(_('%{_e} for %{_resource}') % { _e: e.message, _resource: resource[:source] })
 150       rescue SocketError
 151         raise(_('could not resolve %{_resource}') % { _resource: resource[:source] })
 152       else
 153         tempfile(key)
 154       end
 155     end
 156   end
 157
 158   # The tempfile method needs to return the tempfile object to the caller, so
 159   # that it doesn't get deleted by the GC immediately after it returns.  We
 160   # want the caller to control when it goes out of scope.
 161   def tempfile(content)
 162     file = Tempfile.new('apt_key')
 163     file.write content
 164     file.close
 165     # confirm that the fingerprint from the file, matches the long key that is in the manifest
 166     if name.size == 40
 167       if File.executable? command(:gpg)
 168         extracted_key = execute(["#{command(:gpg)} --no-tty --with-fingerprint --with-colons #{file.path} | awk -F: '/^fpr:/ { print $10 }'"], failonfail: false)
 169         extracted_key = extracted_key.chomp
 170
 171         found_match = false
 172         extracted_key.each_line do |line|
 173           found_match = true if line.chomp == name
 174         end
 175         unless found_match
 176           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
 177         end
 178       else
 179         warning('/usr/bin/gpg cannot be found for verification of the id.')
 180       end
 181     end
 182     file
 183   end
 184
 185   def exists?
 186     # report expired keys as non-existing when refresh => true
 187     @property_hash[:ensure] == :present && !(resource[:refresh] && @property_hash[:expired])
 188   end
 189
 190   def create
 191     command = []
 192     if resource[:source].nil? && resource[:content].nil?
 193       # Breaking up the command like this is needed because it blows up
 194       # if --recv-keys isn't the last argument.
 195       command.push('adv', '--no-tty', '--keyserver', resource[:server])
 196       command.push('--keyserver-options', resource[:options]) unless resource[:options].nil?
 197       command.push('--recv-keys', resource[:id])
 198     elsif resource[:content]
 199       key_file = tempfile(resource[:content])
 200       command.push('add', key_file.path)
 201     elsif resource[:source]
 202       key_file = source_to_file(resource[:source])
 203       command.push('add', key_file.path)
 204     # In case we really screwed up, better safe than sorry.
 205     else
 206       raise(_('an unexpected condition occurred while trying to add the key: %{_resource}') % { _resource: resource[:id] })
 207     end
 208     apt_key(command)
 209     @property_hash[:ensure] = :present
 210   end
 211
 212   def destroy
 213     loop do
 214       apt_key('del', resource.provider.short)
 215       r = execute(["#{command(:apt_key)} list | grep '/#{resource.provider.short}\s'"], failonfail: false)
 216       break unless r.exitstatus.zero?
 217     end
 218     @property_hash.clear
 219   end
 220
 221   def read_only(_value)
 222     raise(_('This is a read-only property.'))
 223   end
 224
 225   mk_resource_methods
 226
 227   # Alias the setters of read-only properties
 228   # to the read_only function.
 229   alias_method :created=, :read_only
 230   alias_method :expired=, :read_only
 231   alias_method :expiry=, :read_only
 232   alias_method :size=, :read_only
 233   alias_method :type=, :read_only
 234 end