chef 18.9.4 → 18.11.11

data/lib/chef/resource/ohai.rb

@@ -31,46 +31,46 @@ class Chef
       description "Use the **ohai** resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{ChefUtils::Dist::Infra::PRODUCT} run."
 
       examples <<~DOC
-      Reload All Ohai Plugins
+        Reload All Ohai Plugins
 
-      ```ruby
-      ohai 'reload' do
-        action :reload
-      end
-      ```
+        ```ruby
+        ohai 'reload' do
+          action :reload
+        end
+        ```
 
-      Reload A Single Ohai Plugin
+        Reload A Single Ohai Plugin
 
-      ```ruby
-      ohai 'reload' do
-        plugin 'ipaddress'
-        action :reload
-      end
-      ```
+        ```ruby
+        ohai 'reload' do
+          plugin 'ipaddress'
+          action :reload
+        end
+        ```
 
-      Reload Ohai after a new user is created
+        Reload Ohai after a new user is created
 
-      ```ruby
-      ohai 'reload_passwd' do
-        action :nothing
-        plugin 'etc'
-      end
+        ```ruby
+        ohai 'reload_passwd' do
+          action :nothing
+          plugin 'etc'
+        end
 
-      user 'daemon_user' do
-        home '/dev/null'
-        shell '/sbin/nologin'
-        system true
-        notifies :reload, 'ohai[reload_passwd]', :immediately
-      end
+        user 'daemon_user' do
+          home '/dev/null'
+          shell '/sbin/nologin'
+          system true
+          notifies :reload, 'ohai[reload_passwd]', :immediately
+        end
 
-      ruby_block 'just an example' do
-        block do
-          # These variables will now have the new values
-          puts node['etc']['passwd']['daemon_user']['uid']
-          puts node['etc']['passwd']['daemon_user']['gid']
+        ruby_block 'just an example' do
+          block do
+            # These variables will now have the new values
+            puts node['etc']['passwd']['daemon_user']['uid']
+            puts node['etc']['passwd']['daemon_user']['gid']
+          end
         end
-      end
-      ```
+        ```
       DOC
 
       property :plugin, String,

data/lib/chef/resource/ohai_hint.rb

@@ -26,37 +26,37 @@ class Chef
       description "Use the **ohai_hint** resource to aid in configuration detection by passing hint data to Ohai."
       introduced "14.0"
       examples <<~DOC
-      **Create a hint file**
+        **Create a hint file**
 
-      ```ruby
-      ohai_hint 'example' do
-        content a: 'test_content'
-      end
-      ```
+        ```ruby
+        ohai_hint 'example' do
+          content a: 'test_content'
+        end
+        ```
 
-      **Create a hint file with a name that does not match the resource name**
+        **Create a hint file with a name that does not match the resource name**
 
-      ```ruby
-      ohai_hint 'example' do
-        hint_name 'custom'
-      end
-      ```
+        ```ruby
+        ohai_hint 'example' do
+          hint_name 'custom'
+        end
+        ```
 
-      **Create a hint file that is not loaded at compile time**
+        **Create a hint file that is not loaded at compile time**
 
-      ```ruby
-      ohai_hint 'example' do
-        compile_time false
-      end
-      ```
+        ```ruby
+        ohai_hint 'example' do
+          compile_time false
+        end
+        ```
 
-      **Delete a hint file**
+        **Delete a hint file**
 
-      ```ruby
-      ohai_hint 'example' do
-        action :delete
-      end
-      ```
+        ```ruby
+        ohai_hint 'example' do
+          action :delete
+        end
+        ```
       DOC
 
       property :hint_name, String,

data/lib/chef/resource/openssl_ec_private_key.rb

@@ -60,7 +60,7 @@ class Chef
         description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options.",
         default: "prime256v1"
 
-      property :key_pass, String,
+      property :key_pass, String, sensitive: true,
         description: "The desired passphrase for the key."
 
       property :key_cipher, String,
@@ -89,7 +89,7 @@ class Chef
       action :create, description: "Generate the EC private key file." do
         unless new_resource.force || priv_key_file_valid?(new_resource.path, new_resource.key_pass)
           converge_by("Create an EC private key #{new_resource.path}") do
-            log "Generating an #{new_resource.key_curve} "\
+            log "Generating an #{new_resource.key_curve} " \
                 "EC key file at #{new_resource.path}, this may take some time"
 
             if new_resource.key_pass

data/lib/chef/resource/openssl_ec_public_key.rb

@@ -56,10 +56,10 @@ class Chef
       property :private_key_path, String,
         description: "The path to the private key file."
 
-      property :private_key_content, String,
+      property :private_key_content, String, sensitive: true,
         description: "The content of the private key including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk"
 
-      property :private_key_pass, String,
+      property :private_key_pass, String, sensitive: true,
         description: "The passphrase of the provided private key."
 
       property :owner, [String, Integer],

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -59,7 +59,7 @@ class Chef
         description: "The desired bit length of the generated key.",
         default: 2048
 
-      property :key_pass, String,
+      property :key_pass, String, sensitive: true,
         description: "The desired passphrase for the key."
 
       property :key_cipher, String,

data/lib/chef/resource/openssl_rsa_public_key.rb

@@ -57,10 +57,10 @@ class Chef
       property :private_key_path, String,
         description: "The path to the private key file."
 
-      property :private_key_content, String,
+      property :private_key_content, String, sensitive: true,
         description: "The content of the private key, including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk."
 
-      property :private_key_pass, String,
+      property :private_key_pass, String, sensitive: true,
         description: "The passphrase of the provided private key."
 
       property :owner, [String, Integer],

data/lib/chef/resource/openssl_x509_certificate.rb

@@ -115,7 +115,7 @@ class Chef
       property :key_file, String,
         description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
 
-      property :key_pass, String,
+      property :key_pass, String, sensitive: true,
         description: "The passphrase for an existing key's passphrase."
 
       property :key_type, String,

data/lib/chef/resource/openssl_x509_crl.rb

@@ -29,24 +29,24 @@ class Chef
       description "Use the **openssl_x509_crl** resource to generate PEM-formatted x509 certificate revocation list (CRL) files."
       introduced "14.4"
       examples <<~DOC
-      **Create a certificate revocation file**
+        **Create a certificate revocation file**
 
-      ```ruby
-      openssl_x509_crl '/etc/ssl_test/my_ca.crl' do
-        ca_cert_file '/etc/ssl_test/my_ca.crt'
-        ca_key_file '/etc/ssl_test/my_ca.key'
-      end
-      ```
+        ```ruby
+        openssl_x509_crl '/etc/ssl_test/my_ca.crl' do
+          ca_cert_file '/etc/ssl_test/my_ca.crt'
+          ca_key_file '/etc/ssl_test/my_ca.key'
+        end
+        ```
 
-      **Create a certificate revocation file for a particular serial**
+        **Create a certificate revocation file for a particular serial**
 
-      ```ruby
-      openssl_x509_crl '/etc/ssl_test/my_ca.crl' do
-        ca_cert_file '/etc/ssl_test/my_ca.crt'
-        ca_key_file '/etc/ssl_test/my_ca.key'
-        serial_to_revoke C7BCB6602A2E4251EF4E2827A228CB52BC0CEA2F
-      end
-      ```
+        ```ruby
+        openssl_x509_crl '/etc/ssl_test/my_ca.crl' do
+          ca_cert_file '/etc/ssl_test/my_ca.crt'
+          ca_key_file '/etc/ssl_test/my_ca.key'
+          serial_to_revoke C7BCB6602A2E4251EF4E2827A228CB52BC0CEA2F
+        end
+        ```
       DOC
 
       property :path, String,

data/lib/chef/resource/openssl_x509_request.rb

@@ -66,7 +66,7 @@ class Chef
       DOC
 
       property :path, String, name_property: true,
-               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name."
+        description: "An optional property for specifying the path to write the file to if it differs from the resource block's name."
 
       property :owner, [String, Integer],
         description: "The owner applied to all files created by the resource."
@@ -102,7 +102,7 @@ class Chef
       property :key_file, String,
         description: "The path to a certificate key file on the filesystem. If the `key_file` property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the `key_file` property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."
 
-      property :key_pass, String,
+      property :key_pass, String, sensitive: true,
         description: "The passphrase for an existing key's passphrase."
 
       property :key_type, String,

data/lib/chef/resource/osx_profile.rb

@@ -32,68 +32,68 @@ class Chef
       description "Use the **osx_profile** resource to manage configuration profiles (`.mobileconfig` files) on the macOS platform. The **osx_profile** resource installs profiles by using the uuidgen library to generate a unique `ProfileUUID`, and then using the `profiles` command to install the profile on the system."
       introduced "12.7"
       examples <<~DOC
-      **Install a profile from a cookbook file**
-
-      ```ruby
-      osx_profile 'com.company.screensaver.mobileconfig'
-      ```
-
-      **Install profile from a hash**
-
-      ```ruby
-      profile_hash = {
-        'PayloadIdentifier' => 'com.company.screensaver',
-        'PayloadRemovalDisallowed' => false,
-        'PayloadScope' => 'System',
-        'PayloadType' => 'Configuration',
-        'PayloadUUID' => '1781fbec-3325-565f-9022-8aa28135c3cc',
-        'PayloadOrganization' => 'Chef',
-        'PayloadVersion' => 1,
-        'PayloadDisplayName' => 'Screensaver Settings',
-        'PayloadContent' => [
-          {
-            'PayloadType' => 'com.apple.ManagedClient.preferences',
-            'PayloadVersion' => 1,
-            'PayloadIdentifier' => 'com.company.screensaver',
-            'PayloadUUID' => '73fc30e0-1e57-0131-c32d-000c2944c108',
-            'PayloadEnabled' => true,
-            'PayloadDisplayName' => 'com.apple.screensaver',
-            'PayloadContent' => {
-              'com.apple.screensaver' => {
-                'Forced' => [
-                  {
-                    'mcx_preference_settings' => {
-                      'idleTime' => 0,
+        **Install a profile from a cookbook file**
+
+        ```ruby
+        osx_profile 'com.company.screensaver.mobileconfig'
+        ```
+
+        **Install profile from a hash**
+
+        ```ruby
+        profile_hash = {
+          'PayloadIdentifier' => 'com.company.screensaver',
+          'PayloadRemovalDisallowed' => false,
+          'PayloadScope' => 'System',
+          'PayloadType' => 'Configuration',
+          'PayloadUUID' => '1781fbec-3325-565f-9022-8aa28135c3cc',
+          'PayloadOrganization' => 'Chef',
+          'PayloadVersion' => 1,
+          'PayloadDisplayName' => 'Screensaver Settings',
+          'PayloadContent' => [
+            {
+              'PayloadType' => 'com.apple.ManagedClient.preferences',
+              'PayloadVersion' => 1,
+              'PayloadIdentifier' => 'com.company.screensaver',
+              'PayloadUUID' => '73fc30e0-1e57-0131-c32d-000c2944c108',
+              'PayloadEnabled' => true,
+              'PayloadDisplayName' => 'com.apple.screensaver',
+              'PayloadContent' => {
+                'com.apple.screensaver' => {
+                  'Forced' => [
+                    {
+                      'mcx_preference_settings' => {
+                        'idleTime' => 0,
+                      },
                     },
-                  },
-                ],
+                  ],
+                },
               },
             },
-          },
-        ],
-      }
+          ],
+        }
 
-      osx_profile 'Install screensaver profile' do
-        profile profile_hash
-      end
-      ```
+        osx_profile 'Install screensaver profile' do
+          profile profile_hash
+        end
+        ```
 
-      **Remove profile using identifier in resource name**
+        **Remove profile using identifier in resource name**
 
-      ```ruby
-      osx_profile 'com.company.screensaver' do
-        action :remove
-      end
-      ```
+        ```ruby
+        osx_profile 'com.company.screensaver' do
+          action :remove
+        end
+        ```
 
-      **Remove profile by identifier and user friendly resource name**
+        **Remove profile by identifier and user friendly resource name**
 
-      ```ruby
-      osx_profile 'Remove screensaver profile' do
-        identifier 'com.company.screensaver'
-        action :remove
-      end
-      ```
+        ```ruby
+        osx_profile 'Remove screensaver profile' do
+          identifier 'com.company.screensaver'
+          action :remove
+        end
+        ```
       DOC
 
       property :profile_name, String,

data/lib/chef/resource/package.rb

@@ -24,12 +24,12 @@ class Chef
     class Package < Chef::Resource
       provides :package
 
-      description "Use the **package** resource to manage packages. When the package is"\
-                  " installed from a local file (such as with RubyGems, dpkg, or RPM"\
-                  " Package Manager), the file must be added to the node using the remote_file"\
-                  " or cookbook_file resources.\n\nThis resource is the base resource for"\
-                  " several other resources used for package management on specific platforms."\
-                  " While it is possible to use each of these specific resources, it is"\
+      description "Use the **package** resource to manage packages. When the package is" \
+                  " installed from a local file (such as with RubyGems, dpkg, or RPM" \
+                  " Package Manager), the file must be added to the node using the remote_file" \
+                  " or cookbook_file resources.\n\nThis resource is the base resource for" \
+                  " several other resources used for package management on specific platforms." \
+                  " While it is possible to use each of these specific resources, it is" \
                   " recommended to use the package resource as often as possible."
 
       default_action :install

data/lib/chef/resource/perl.rb

@@ -29,11 +29,11 @@ class Chef
         @interpreter = "perl"
       end
 
-      description "Use the **perl** resource to execute scripts using the Perl interpreter."\
-                  " This resource may also use any of the actions and properties that are"\
-                  " available to the **execute** resource. Commands that are executed with this"\
-                  " resource are (by their nature) not idempotent, as they are typically"\
-                  " unique to the environment in which they are run. Use `not_if` and `only_if`"\
+      description "Use the **perl** resource to execute scripts using the Perl interpreter." \
+                  " This resource may also use any of the actions and properties that are" \
+                  " available to the **execute** resource. Commands that are executed with this" \
+                  " resource are (by their nature) not idempotent, as they are typically" \
+                  " unique to the environment in which they are run. Use `not_if` and `only_if`" \
                   " to guard this resource for idempotence."
     end
   end

data/lib/chef/resource/plist.rb

@@ -59,9 +59,9 @@ class Chef
       DEFAULTS_EXECUTABLE = "/usr/bin/defaults".freeze
       PLUTIL_EXECUTABLE = "/usr/bin/plutil".freeze
       PLUTIL_FORMAT_MAP = { "us-ascii" => "xml1",
-                             "text/xml" => "xml1",
-                             "utf-8" => "xml1",
-                             "binary" => "binary1" }.freeze
+                            "text/xml" => "xml1",
+                            "utf-8" => "xml1",
+                            "binary" => "binary1" }.freeze
 
       load_current_value do |new_resource|
         current_value_does_not_exist! unless ::File.exist? new_resource.path
@@ -206,7 +206,7 @@ class Chef
               end
         entry_with_arg = ["\"#{entry}\"", arg].join(sep).strip
         subcommand = "#{subcommand.capitalize} :#{entry_with_arg}"
-        [PLISTBUDDY_EXECUTABLE, "-c", "\'#{subcommand}\'", "\"#{path}\""].join(" ")
+        [PLISTBUDDY_EXECUTABLE, "-c", "'#{subcommand}'", "\"#{path}\""].join(" ")
       end
 
       def setting_from_plist(entry, path)

data/lib/chef/resource/powershell_package_source.rb

@@ -143,7 +143,7 @@ class Chef
         introduced: "17.6",
         description: "A username that, as part of a credential object, is used to register a repository or other package source with."
 
-      property :password, String,
+      property :password, String, sensitive: true,
         introduced: "17.6",
         description: "A password that, as part of a credential object, is used to register a repository or other package source with."
 
@@ -239,17 +239,17 @@ class Chef
 
         def get_package_source_details
           powershell_exec! <<~EOH
-              $package_details = Get-PackageSource -Name '#{new_resource.source_name}' -ErrorAction SilentlyContinue
-              if ($package_details.ProviderName -match "PowerShellGet"){
-                return "PSRepository"
-              }
-              elseif ($package_details.ProviderName ) {
-                return "PackageSource"
-              }
-              elseif ($null -eq $package_details)
-              {
-                return "Unregistered"
-              }
+            $package_details = Get-PackageSource -Name '#{new_resource.source_name}' -ErrorAction SilentlyContinue
+            if ($package_details.ProviderName -match "PowerShellGet"){
+              return "PSRepository"
+            }
+            elseif ($package_details.ProviderName ) {
+              return "PackageSource"
+            }
+            elseif ($null -eq $package_details)
+            {
+              return "Unregistered"
+            }
           EOH
         end
 

data/lib/chef/resource/python.rb

@@ -28,10 +28,10 @@ class Chef
         @interpreter = "python"
       end
 
-      description "Use the **python** resource to execute scripts using the Python interpreter."\
-                  " This resource may also use any of the actions and properties that are available"\
-                  " to the **execute** resource. Commands that are executed with this resource are (by"\
-                  " their nature) not idempotent, as they are typically unique to the environment in"\
+      description "Use the **python** resource to execute scripts using the Python interpreter." \
+                  " This resource may also use any of the actions and properties that are available" \
+                  " to the **execute** resource. Commands that are executed with this resource are (by" \
+                  " their nature) not idempotent, as they are typically unique to the environment in" \
                   " which they are run. Use `not_if` and `only_if` to guard this resource for idempotence."
     end
   end

data/lib/chef/resource/reboot.rb

@@ -25,11 +25,11 @@ class Chef
 
       provides :reboot
 
-      description "Use the **reboot** resource to reboot a node, a necessary step with some"\
-                  " installations on certain platforms. This resource is supported for use on"\
-                  " the Microsoft Windows, macOS, and Linux platforms.\n"\
-                  "In using this resource via notifications, it's important to *only* use"\
-                  " immediate notifications. Delayed notifications produce unintuitive and"\
+      description "Use the **reboot** resource to reboot a node, a necessary step with some" \
+                  " installations on certain platforms. This resource is supported for use on" \
+                  " the Microsoft Windows, macOS, and Linux platforms.\n" \
+                  "In using this resource via notifications, it's important to *only* use" \
+                  " immediate notifications. Delayed notifications produce unintuitive and" \
                   " probably undesired results."
       introduced "12.0"
       examples <<~DOC