chef-encrypted-attributes 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9152cd93c8d694d37df7659cae3d93bf00ae85f0
-  data.tar.gz: 539393acaeef1511dd82dc035a38365ec012b043
+  metadata.gz: 9cdea59e2de10064ea5d0e3bc56bc81ceead120e
+  data.tar.gz: 0deb1f801ae0bf42f7f85b34f42240d213a45802
 SHA512:
-  metadata.gz: 5a943ad2d06b15cd9d39a00c81da3907ecbf42e7e3a9c506db815296b32245203a3d1bd3e7076a4afd0aefb06576a43c34524abc938b61965c86c10c663f3b65
-  data.tar.gz: 1f11c694453b7fc80717808159e81c242909fe2b18b271a45400d1bfd11c21fb696155978a5604eba048a5d6795caa70102f37ad9803de26f068fbd5a9b9667f
+  metadata.gz: 6c0cc800e8252f437349d0970b82182756bab2394f20de1504b8c5bd939cd692cb410b7435a9f3a139d334692fe204754eca21458002d793f1936a2b30f593f9
+  data.tar.gz: e2d69beb84580fb66183615c247a32035a872d62c74de1ca9ec313e87b50922defe13d2c71f84e7ac4f125f30d6cf036124f6da88f38dd0f11a3776e37d59fb2

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This file is used to list changes made in each version of `chef-encrypted-attributes`.
 
+## 0.7.0 (2015-05-20)
+
+* Move chef to dev dependency and remove dynamic dependency installation extension (related to [cookbook issue #2](https://github.com/onddo/encrypted_attributes-cookbook/pull/2#issuecomment-101454221) and [issue #2](https://github.com/onddo/chef-encrypted-attributes/pull/2), thanks [Lisa Danz](https://github.com/ldanz) for reporting).
+* Fix search by node name to prevent returning incorrect nodes ([issue #3](https://github.com/onddo/chef-encrypted-attributes/pull/3), thanks [Crystal Hsiung](https://github.com/chhsiung) for the help).
+* RuboCop update to `0.31.0`.
+* README: Add a link to the cookbook helper libraries.
+
 ## 0.6.0 (2015-05-08)
 
 * Conditional gem dependency installation within a gemspec ([issue #2](https://github.com/onddo/chef-encrypted-attributes/pull/2), thanks [@chhsiung](https://github.com/chhsiung) for the help).

data/README.md

@@ -2,8 +2,8 @@
 [![Gem Version](http://img.shields.io/gem/v/chef-encrypted-attributes.svg?style=flat)](http://badge.fury.io/rb/chef-encrypted-attributes)
 [![Dependency Status](http://img.shields.io/gemnasium/onddo/chef-encrypted-attributes.svg?style=flat)](https://gemnasium.com/onddo/chef-encrypted-attributes)
 [![Code Climate](http://img.shields.io/codeclimate/github/onddo/chef-encrypted-attributes.svg?style=flat)](https://codeclimate.com/github/onddo/chef-encrypted-attributes)
-[![Build Status](http://img.shields.io/travis/onddo/chef-encrypted-attributes/0.6.0.svg?style=flat)](https://travis-ci.org/onddo/chef-encrypted-attributes)
-[![Coverage Status](http://img.shields.io/coveralls/onddo/chef-encrypted-attributes/0.6.0.svg?style=flat)](https://coveralls.io/r/onddo/chef-encrypted-attributes?branch=0.6.0)
+[![Build Status](http://img.shields.io/travis/onddo/chef-encrypted-attributes/0.7.0.svg?style=flat)](https://travis-ci.org/onddo/chef-encrypted-attributes)
+[![Coverage Status](http://img.shields.io/coveralls/onddo/chef-encrypted-attributes/0.7.0.svg?style=flat)](https://coveralls.io/r/onddo/chef-encrypted-attributes?branch=0.7.0)
 [![Inline docs](http://inch-ci.org/github/onddo/chef-encrypted-attributes.svg?branch=master&style=flat)](http://inch-ci.org/github/onddo/chef-encrypted-attributes)
 
 [Chef](https://www.chef.io/) plugin to add Node encrypted attributes support using client keys.
@@ -27,6 +27,8 @@ Node attributes are encrypted using chef client and user keys with public key in
 
 ## Usage in Recipes
 
+Before reading all the documentation below, we recommend you take a look at the [`encrypted_attributes` cookbook's helper libraries](https://github.com/onddo/encrypted_attributes-cookbook#helper-libraries). Those libraries are easier to use than the underlying API and cover the most common use cases.
+
 ### Installing and Including the Gem
 
 You need to install and include the `chef-encrypted-attributes` gem before using encrypted attributes inside a cookbook.
@@ -79,7 +81,7 @@ Chef::Config[:encrypted_attributes][:client_search] = 'admin:true'
 Chef::Config[:encrypted_attributes][:node_search] = 'role:webapp'
 
 if Chef::EncryptedAttribute.exist?(node['myapp']['encrypted_data'])
-  # when can used #load here as above if we need the `encrypted_data` outside
+  # we can used #load here as above if we need the `encrypted_data` outside
   # this `if`
 
   # update with the new keys
@@ -242,7 +244,7 @@ See [TODO.md](https://github.com/onddo/chef-encrypted-attributes/blob/master/TOD
 |:---------------------|:-----------------------------------------|
 | **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@onddo.com>)
 | **Contributor:**     | [Josh Kalderimis](https://github.com/joshk)
-| **Contributor:**     | [@chhsiung](https://github.com/chhsiung)
+| **Contributor:**     | [Crystal Hsiung](https://github.com/chhsiung)
 | **Contributor:**     | [Lisa Danz](https://github.com/ldanz)
 | **Copyright:**       | Copyright (c) 2014-2015 Onddo Labs, SL. (www.onddo.com)
 | **License:**         | Apache License, Version 2.0

data/TODO.md

@@ -1,6 +1,7 @@
 TODO
 ====
 
+* Refactor `SearchHelper` class.
 * Fix all RuboCop offenses.
 * knife encrypted attribute create/edit from file.
 * Save config inside encrypted data: `:client_search`, `:node_search` and `:keys` (including user keys).

data/lib/chef/encrypted_attribute/remote_node.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
-# Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
+# Copyright:: Copyright (c) 2014-2015 Onddo Labs, SL. (www.onddo.com)
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -76,7 +76,7 @@ class Chef
         cache_key = cache_key(name, attr_ary)
         return self.class.cache[cache_key] if self.class.cache.key?(cache_key)
         keys = { 'value' => attr_ary }
-        res = search(:node, "name:#{@name}", keys, 1, partial_search)
+        res = search_by_name(:node, @name, keys, 1, partial_search)
         self.class.cache[cache_key] = parse_search_result(res)
       end
 

data/lib/chef/encrypted_attribute/search_helper.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@onddo.com>)
-# Copyright:: Copyright (c) 2014 Onddo Labs, SL. (www.onddo.com)
+# Copyright:: Copyright (c) 2014-2015 Onddo Labs, SL. (www.onddo.com)
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -119,6 +119,22 @@ class Chef
           query.is_a?(Array) && query.count == 0
       end
 
+      # Translates Chef HTTP exceptions to search exceptions.
+      #
+      # @yield [] the block doing the Chef Search.
+      # @return [Mixed] the value returned by the block.
+      # @api private
+      def catch_search_exceptions(&block)
+        block.call
+      rescue Net::HTTPServerException => e
+        unless e.response.is_a?(Net::HTTPResponse) && e.response.code == '404'
+          raise SearchFailure, "Search exception #{e.class}: #{e}"
+        end
+        return []
+      rescue Net::HTTPFatalError => e
+        raise SearchFailure, "Search exception #{e.class}: #{e}"
+      end
+
       # Does a search in the Chef Server.
       #
       # @param type [Symbol] search index to use. See [Chef Search Indexes]
@@ -138,14 +154,30 @@ class Chef
       def search(type, query, keys, rows = 1000, partial_search = true)
         return [] if empty_search?(query) # avoid empty searches
         search_method = partial_search ? :partial_search : :normal_search
-        send(search_method, type, query, keys, rows)
-      rescue Net::HTTPServerException => e
-        unless e.response.is_a?(Net::HTTPResponse) && e.response.code == '404'
-          raise SearchFailure, "Search exception #{e.class}: #{e}"
+        catch_search_exceptions do
+          send(search_method, type, nil, query, keys, rows)
+        end
+      end
+
+      # Does a search in the Chef Server by node or client name.
+      #
+      # @param type [Symbol] search index to use. See [Chef Search Indexes]
+      #   (http://docs.getchef.com/chef_search.html#search-indexes).
+      # @param name [String] node name to search.
+      # @param keys [Hash] search keys structure. For example:
+      #   `{ipaddress: %w(ipaddress), mysql_version: %w(mysql version) }`.
+      # @param rows [Fixnum, String] maximum number of rows to return.
+      # @param partial_search [Boolean] whether to use partial search.
+      # @return [Array<Hash>] An array with the response, for example:
+      #   `[{ 'ipaddress' => '192.168.1.1' }]`
+      # @raise [SearchFailure] if there is a Chef search error.
+      # @raise [SearchFatalError] if the Chef search response is wrong.
+      # @raise [InvalidSearchKeys] if search keys structure is wrong.
+      def search_by_name(type, name, keys, rows = 1000, partial_search = true)
+        search_method = partial_search ? :partial_search : :normal_search
+        catch_search_exceptions do
+          send(search_method, type, name, "name:#{name}", keys, rows)
         end
-        return []
-      rescue Net::HTTPFatalError => e
-        raise SearchFailure, "Search exception #{e.class}: #{e}"
       end
 
       # Assert that the normal (no partial) search response is correct.
@@ -177,16 +209,39 @@ class Chef
         end
       end
 
+      # Filters normal search results that do not correspond to the searched
+      # node.
+      #
+      # Used when searching by node name.
+      #
+      # @param resp [Array] normal search result.
+      # @param name [String, nil] searched node name.
+      # @return [Array] The search result removing the filtered results.
+      # @raise [SearchFatalError] if more than one result is returned when
+      #   searching by node name.
+      # @api private
+      def filter_normal_search_response(resp, name)
+        return resp if name.nil?
+        resp.select { |row| row.name == name }.tap do |r|
+          fail SearchFatalError,
+               'Multiple responses received from Partial Search:'\
+               " #{r.inspect}" if r.count > 1
+        end
+      end
+
       # Parses a normal (no partial) full search search response.
       #
       # @param resp [Array] normal search result.
       # @param keys [Hash] search keys structure. For example:
       #   `{ipaddress: %w(ipaddress), mysql_version: %w(mysql version) }`.
+      # @param name [String, nil] searched node name.
       # @return [Array<Hash>] An array with the response, for example:
       #   `[{ 'ipaddress' => '192.168.1.1' }]`
+      # @raise [SearchFatalError] if more than one result is returned when
+      #   searching by node name.
       # @api private
-      def parse_normal_search_response(resp, keys)
-        resp.map do |row|
+      def parse_normal_search_response(resp, keys, name)
+        filter_normal_search_response(resp, name).map do |row|
           Hash[keys.map do |key_name, attr_ary|
             value = parse_normal_search_row_attribute(row, attr_ary)
             [key_name, value]
@@ -198,6 +253,7 @@ class Chef
       #
       # @param type [Symbol] search index to use. See [Chef Search Indexes]
       #   (http://docs.getchef.com/chef_search.html#search-indexes).
+      # @param name [String, nil] searched node name.
       # @param query [String, Array<String>] search query. For example:
       #   `%w(admin:true)`. Results will be *OR*-ed when multiple string queries
       #   are provided.
@@ -207,7 +263,9 @@ class Chef
       # @return [Array<Hash>] An array with the response, for example:
       #   `[{ 'ipaddress' => '192.168.1.1' }]`
       # @raise [InvalidSearchKeys] if search keys structure is wrong.
-      def normal_search(type, query, keys, rows = 1000)
+      # @raise [SearchFatalError] if more than one result is returned when
+      #   searching by node name.
+      def normal_search(type, name, query, keys, rows = 1000)
         escaped_query = escape_query(query)
         Chef::Log.info(
           "Normal Search query: #{escaped_query}, keys: #{keys.inspect}"
@@ -216,7 +274,7 @@ class Chef
 
         resp = self.query.search(type, escaped_query, nil, 0, rows)[0]
         assert_normal_search_response(resp)
-        parse_normal_search_response(resp, keys)
+        parse_normal_search_response(resp, keys, name)
       end
 
       # Assert that the partial search response is correct.
@@ -233,18 +291,60 @@ class Chef
              "Wrong response received from Partial Search: #{resp.inspect}"
       end
 
+      # Adds the `name` key to the search keys structure.
+      #
+      # Used to get the node name when searching nodes by name.
+      #
+      # @param keys [Hash] search keys structure. For example:
+      #   `{ipaddress: %w(ipaddress), mysql_version: %w(mysql version) }`.
+      # @return [Hash] the search keys structure including the `name` key. For
+      #   example:
+      #   `{ipaddress: %w(ipaddress), mysql_version: %w(mysql version),
+      #     name: %w(name) }`.
+      # @api private
+      def generate_partial_search_keys(keys)
+        keys.merge('name' => %w(name))
+      end
+
+      # Filters partial search results that do not correspond to the searched
+      # node.
+      #
+      # Used when searching by node name.
+      #
+      # @param resp [Hash] partial search result. For example:
+      #   `{ 'rows' => [ 'data' => { 'ipaddress' => '192.168.1.1' } }] }`.
+      # @param name [String, nil] searched node name.
+      # @return [Hash] The search result removing the filtered results.
+      # @raise [SearchFatalError] if more than one result is returned when
+      #   searching by node name.
+      # @api private
+      def filter_partial_search_response(resp, name)
+        return resp if name.nil?
+        filtered_resp = resp.select do |row|
+          row['data']['name'] == name
+        end
+        filtered_resp.tap do |r|
+          fail SearchFatalError,
+               'Multiple responses received from Partial Search:'\
+               " #{r.inspect}" if r.count > 1
+        end
+      end
+
       # Parses a partial full search search response.
       #
       # @param resp [Hash] partial search result. For example:
       #   `{ 'rows' => [ 'data' => { 'ipaddress' => '192.168.1.1' } }] }`.
+      # @param name [String, nil] searched node name.
+      # @param keys [Hash] search keys structure. For example:
+      #   `{ipaddress: %w(ipaddress), mysql_version: %w(mysql version) }`.
       # @return [Array<Hash>] An array with the response, for example:
       #   `[{ 'ipaddress' => '192.168.1.1' }]`
       # @raise [SearchFatalError] if the Chef search response is wrong.
       # @api private
-      def parse_partial_search_response(resp)
-        resp['rows'].map do |row|
+      def parse_partial_search_response(resp, name, keys)
+        filter_partial_search_response(resp['rows'], name).map do |row|
           if row.is_a?(Hash) && row['data'].is_a?(Hash)
-            row['data']
+            row['data'].tap { |r| r.delete('name') unless keys.key?('name') }
           else
             fail SearchFatalError,
                  "Wrong row format received from Partial Search: #{row.inspect}"
@@ -256,6 +356,7 @@ class Chef
       #
       # @param type [Symbol] search index to use. See [Chef Search Indexes]
       #   (http://docs.getchef.com/chef_search.html#search-indexes).
+      # @param name [String, nil] searched node name.
       # @param query [String, Array<String>] search query. For example:
       #   `%w(admin:true)`. Results will be *OR*-ed when multiple string queries
       #   are provided.
@@ -266,7 +367,7 @@ class Chef
       #   `[{ 'ipaddress' => '192.168.1.1' }]`
       # @raise [InvalidSearchKeys] if search keys structure is wrong.
       # @raise [SearchFatalError] if the Chef search response is wrong.
-      def partial_search(type, query, keys, rows = 1000)
+      def partial_search(type, name, query, keys, rows = 1000)
         escaped_query =
           "search/#{escape(type)}?q=#{escape_query(query)}&start=0&rows=#{rows}"
         Chef::Log.info(
@@ -275,9 +376,9 @@ class Chef
         assert_search_keys(keys)
 
         rest = Chef::REST.new(Chef::Config[:chef_server_url])
-        resp = rest.post_rest(escaped_query, keys)
+        resp = rest.post_rest(escaped_query, generate_partial_search_keys(keys))
         assert_partial_search_response(resp)
-        parse_partial_search_response(resp)
+        parse_partial_search_response(resp, name, keys)
       end
     end
   end

data/lib/chef/encrypted_attribute/version.rb

@@ -20,6 +20,6 @@
 class Chef
   class EncryptedAttribute
     # `chef-encrypted-attributes` gem version.
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-encrypted-attributes
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Onddo Labs, SL.
@@ -30,7 +30,7 @@ cert_chain:
   cYe8PqNEkky7ugvF4zU3sB6TW+96XasuwDv1uJmyr35LF15U6Cs83+osMbAKJTmG
   /vqKzw==
   -----END CERTIFICATE-----
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -42,7 +42,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '13'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -195,8 +195,7 @@ dependencies:
 description: Chef plugin to add Node encrypted attributes support using client keys
 email: team@onddo.com
 executables: []
-extensions:
-- ext/mkrf_conf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
@@ -208,7 +207,6 @@ files:
 - Rakefile
 - TESTING.md
 - TODO.md
-- ext/mkrf_conf.rb
 - lib/chef-encrypted-attributes.rb
 - lib/chef/encrypted_attribute.rb
 - lib/chef/encrypted_attribute/api.rb
@@ -261,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Chef Encrypted Attributes

data/ext/mkrf_conf.rb

@@ -1,52 +0,0 @@
-# encoding: UTF-8
-#
-# Author:: Xabier de Zuazo (<xabier@onddo.com>)
-# Copyright:: Copyright (c) 2015 Onddo Labs, SL. (www.onddo.com)
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-# Conditional gem dependency installation within a gemspec.
-#
-# Based on:
-# * http://www.programmersparadox.com/2012/05/21
-#     /gemspec-loading-dependent-gems-based-on-the-users-system/
-# * https://www.tiredpixel.com/2014/01/05
-#     /curses-conditional-ruby-gem-installation-within-a-gemspec/
-
-require 'rubygems/dependency_installer'
-
-di = Gem::DependencyInstaller.new
-
-begin
-  if RUBY_VERSION < '1.9.3'
-    puts "Installing mixlib-shellout < 1.6.1 because Ruby #{RUBY_VERSION}"
-    di.install 'mixlib-shellout', '< 1.6.1'
-  end
-  if RUBY_VERSION < '2'
-    puts "Installing highline < 1.7 because Ruby #{RUBY_VERSION}"
-    di.install 'highline', '< 1.7'
-    puts "Installing ohai < 8 because Ruby #{RUBY_VERSION}"
-    di.install 'ohai', '< 8'
-  end
-rescue => e
-  warn "#{$PROGRAM_NAME}: #{e}"
-  exit!
-end
-
-puts 'Writing fake Rakefile'
-# Write fake Rakefile for rake since Makefile isn't used
-File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w') do |f|
-  f.write("task :default\n")
-end