cookstyle 7.27.0 → 7.28.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 897bcf0f8e234120fb9cfcb1077210e70fbe23e1fb82bde3d7eac7a549eee3ec
-  data.tar.gz: 15a3664f0d54c8b1c4404d4c21d000d328090fc73280ee888819b8d6f1a8625b
+  metadata.gz: 205f14a7f600dc2fe712e9407e16165b72cadab5624913efba78a6f0748f65ae
+  data.tar.gz: c03813392f90967e5036e49a8886d6c1b7e31ea7319da75c12008d3a01c635f8
 SHA512:
-  metadata.gz: 7d8ea69d16659e4fdb8c13a33cffd486321f44b9040d308702f3018c4ab4372becd941701bbf21127d6bd5db3b35b235a9295d12a2c7276a33b17e41a2066366
-  data.tar.gz: afcf222bfddc0bdc6816b0221beb4a975f9d215e36a809a32af45ea1ccd1dbda2c31eb5ebbd5f2fbd9e253b4dce84ed8ad6c5a43cf105f77626f8b48a07af228
+  metadata.gz: 6f7f8c8c719dbb83b740882be2f247250c95fb7f330a82a0cf8d7b5b96fa7071ca7b55761a8a599ac4801f2c75eb403f64c04bde4245f31fc12b8f753418d3f5
+  data.tar.gz: 8a32adeedb7654948337162eeb9a8c660f66ab13655ec537aa584b15a156f726130f16630dddb2f1fa0169d10e5dd4a84b7353392591431490f12129ed0245c4

data/config/cookstyle.yml

@@ -514,6 +514,16 @@ Chef/Correctness/InvalidCookbookName:
   Include:
     - '**/metadata.rb'
 
+Chef/Correctness/InvalidNotificationResource:
+  Description: The resource to notify when calling `notifies` or `subscribes` must be a string.
+  StyleGuide: 'chef_correctness_invalidnotificationresource'
+  Enabled: true
+  VersionAdded: '7.28'
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # Chef/Sharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -2289,6 +2299,24 @@ InSpec/Deprecations/AttributeDefault:
   Include:
     - '**/controls/*.rb'
 
+#### Security Cops
+
+Chef/Security:
+  StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
+
+Chef/Security/ :
+  Description: Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.
+  StyleGuide: 'chef_security_sshprivatekey'
+  Enabled: true
+  VersionAdded: '7.28'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+    - '**/recipes/*.rb'
+    - '**/attributes/*.rb'
+    - '**/definitions/*.rb'
+    
 #### The base rubocop 0.37 enabled.yml file we started with ####
 
 Layout/AccessModifierIndentation:

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.27.0" # rubocop: disable Style/StringLiterals
+  VERSION = "7.28.2" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.24.1'
 end

data/lib/rubocop/cop/chef/correctness/invalid_notification_resource.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2022, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Correctness
+        # The resource to notify when calling `notifies` or `subscribes` must be a string.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, service['apache'], :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, service[apache], :immediately
+        #   end
+        #
+        #   #### correct
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class InvalidNotificationResource < Base
+          MSG = 'The resource to notify when calling `notifies` or `subscribes` must be a string.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :invalid_notification?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(send (send nil? _) :[] ...) ...)
+          PATTERN
+
+          def on_send(node)
+            invalid_notification?(node) do |resource|
+              add_offense(resource, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/security/ssh_private_key.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021-2022, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Security
+        # Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   file '/Users/bob_bobberson/.ssh/id_rsa' do
+        #     content '-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----'
+        #     mode '600'
+        #   end
+        #
+        class SshPrivateKey < Base
+          MSG = 'Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.'
+
+          def on_send(node)
+            return unless node.arguments?
+            node.arguments.each do |arg|
+              next unless arg.str_type? || arg.dstr_type?
+
+              if arg.value.start_with?('-----BEGIN RSA PRIVATE', '-----BEGIN EC PRIVATE') # cookstyle: disable Chef/Security/SshPrivateKey
+                add_offense(node, message: MSG, severity: :warning)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.27.0
+  version: 7.28.2
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -57,6 +57,7 @@ files:
 - lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb
 - lib/rubocop/cop/chef/correctness/invalid_cookbook_name.rb
 - lib/rubocop/cop/chef/correctness/invalid_default_action.rb
+- lib/rubocop/cop/chef/correctness/invalid_notification_resource.rb
 - lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb
@@ -274,6 +275,7 @@ files:
 - lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb
 - lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb
 - lib/rubocop/cop/chef/redundant/use_create_if_missing.rb
+- lib/rubocop/cop/chef/security/ssh_private_key.rb
 - lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb
 - lib/rubocop/cop/chef/sharing/empty_metadata_field.rb
 - lib/rubocop/cop/chef/sharing/include_property_descriptions.rb