3rdparty/modules/stdlib/lib/puppet/parser/functions/pw_hash.rb

   1 #  Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
   2 Puppet::Parser::Functions.newfunction(
   3   :pw_hash,
   4   :type => :rvalue,
   5   :arity => 3,
   6   :doc => "Hashes a password using the crypt function. Provides a hash
   7   usable on most POSIX systems.
   8
   9   The first argument to this function is the password to hash. If it is
  10   undef or an empty string, this function returns undef.
  11
  12   The second argument to this function is which type of hash to use. It
  13   will be converted into the appropriate crypt(3) hash specifier. Valid
  14   hash types are:
  15
  16   |Hash type            |Specifier|
  17   |---------------------|---------|
  18   |MD5                  |1        |
  19   |SHA-256              |5        |
  20   |SHA-512 (recommended)|6        |
  21
  22   The third argument to this function is the salt to use.
  23
  24   Note: this uses the Puppet Master's implementation of crypt(3). If your
  25   environment contains several different operating systems, ensure that they
  26   are compatible before using this function.",
  27 ) do |args|
  28   raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3
  29   args.map! do |arg|
  30     if (defined? Puppet::Pops::Types::PSensitiveType::Sensitive) && (arg.is_a? Puppet::Pops::Types::PSensitiveType::Sensitive)
  31       arg.unwrap
  32     else
  33       arg
  34     end
  35   end
  36   raise ArgumentError, 'pw_hash(): first argument must be a string' unless args[0].is_a?(String) || args[0].nil?
  37   raise ArgumentError, 'pw_hash(): second argument must be a string' unless args[1].is_a? String
  38   hashes = { 'md5'     => '1',
  39              'sha-256' => '5',
  40              'sha-512' => '6' }
  41   hash_type = hashes[args[1].downcase]
  42   raise ArgumentError, "pw_hash(): #{args[1]} is not a valid hash type" if hash_type.nil?
  43   raise ArgumentError, 'pw_hash(): third argument must be a string' unless args[2].is_a? String
  44   raise ArgumentError, 'pw_hash(): third argument must not be empty' if args[2].empty?
  45   raise ArgumentError, 'pw_hash(): characters in salt must be in the set [a-zA-Z0-9./]' unless args[2] =~ %r{\A[a-zA-Z0-9./]+\z}
  46
  47   password = args[0]
  48   return nil if password.nil? || password.empty?
  49
  50   salt = "$#{hash_type}$#{args[2]}"
  51
  52   # handle weak implementations of String#crypt
  53   if 'test'.crypt('$1$1') != '$1$1$Bp8CU9Oujr9SSEw53WV6G.'
  54     # JRuby < 1.7.17
  55     # MS Windows and other systems that don't support enhanced salts
  56     raise Puppet::ParseError, 'system does not support enhanced salts' unless RUBY_PLATFORM == 'java'
  57     # puppetserver bundles Apache Commons Codec
  58     org.apache.commons.codec.digest.Crypt.crypt(password.to_java_bytes, salt)
  59   else
  60     password.crypt(salt)
  61   end
  62 end