chef-encrypted-data-bag-url 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7e3df4197b52b4f1814ca6b50037e917e19af20
+  data.tar.gz: d7ecb27d3bb9409c762f301197016b631ca06669
+SHA512:
+  metadata.gz: 9577009736ec0ecf4458c8c1e5ce57d8a79e11d66aec852bf49699317cb7284cf8818c4241fadaede1171b4bea2327af1d6add07c42bc06408c294bdbd90ba19
+  data.tar.gz: c2d9417c6dd7ff06c9cafda4df9e2fdc85760e41c64a26bf1022540e49511a1fa8690ab53c88cbfa43d606c7013798dae43b07f1d2ce78dde2e0815fc86e10c0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joe.g.yates@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chef-encrypted-data-bag-url.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Yates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Chef::EncryptedDataBagUrl
+
+Ease collaboration on your Chef kitchen's secrets by storing the data online,
+for example in private Gists.
+
+The principle use case for this gem is when you ue Chef Solo. In this case
+there is no Chef Server instance where users can go and edit secrets via a web
+interface. You have to check out the kitchen's repo, obtain a copy of the 
+`secret_file` and edit the data bag with the 'knife-solo_data_bag' gem.
+
+With this gem, you create a private Gist (or any other online secret file)
+and write your secrets in JSON format, e.g.:
+
+```json
+{
+  "foo_api_token": "fffuuuuuuuuuuuuuuu"
+  "database": {
+    "password": "secret"
+  }
+}
+```
+
+then put the URL of the **raw** Gist data in your encrypted data bag:
+
+```json
+{
+  "id": "ciao",
+  "data_url": "https://gist.githubusercontent.com/myuser/f95499c75cbe04f8cd7c42732729167d24928009/raw/7a05c4f72e41c1022d9b8d9067cc9aba601ea99e/secrets.json"
+}
+```
+
+In your Chef cookbooks, instead of using
+`Chef::EncryptedDataBagItem.load("foo", "bar").to_hash` to load your data,
+use `Chef::EncryptedDataBagUrl`.
+
+The result is a deep merge of the data in the data bag itself with the data
+from the supplied URL.
+
+Note that data bag contents are treated as defaults, and the data URL contents
+override specific values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chef-encrypted-data-bag-url'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chef-encrypted-data-bag-url
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will
+allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag for
+the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/joeyates/chef-encrypted-data-bag-url.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chef/encrypted/data/bag/url"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chef-encrypted-data-bag-url.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chef/encrypted_data_bag_url"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef-encrypted-data-bag-url"
+  spec.version       = Chef::EncryptedDataBagUrl::VERSION
+  spec.authors       = ["Joe Yates"]
+  spec.email         = ["joe.g.yates@gmail.com"]
+
+  spec.summary       = %q{Use online data with Chef data bags}
+  spec.description   = <<-EOT
+    Ease collaboration on your Chef kitchen's secrets by storing the data online,
+    for example in private Gists.
+  EOT
+
+  spec.homepage      = "https://github.com/joeyates/chef-encrypted-data-bag-url"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/chef/encrypted_data_bag_url.rb

@@ -0,0 +1,77 @@
+require "chef/encrypted_data_bag_item"
+require "json"
+require "net/http"
+
+class Chef::EncryptedDataBagUrl
+  VERSION = "0.1.0"
+
+  def self.load(data_bag, name, secret = nil)
+    encrypted_data = Chef::DataBagItem.load(data_bag, name)
+    secret_key = secret || Chef::EncryptedDataBagItem.load_secret
+    new(encrypted_data, secret_key)
+  end
+
+  def initialize(encrypted_data, secret_key)
+    @encrypted_data = encrypted_data
+    @secret_key = secret_key
+    @encrypted_data_bag_item = nil
+    @online_data = nil
+  end
+
+  def to_hash
+    deep_merge(data_bag_hash, online_data)
+  end
+
+  private
+
+  attr_reader :encrypted_data
+  attr_reader :secret_key
+
+  def encrypted_data_bag_item
+    @encrypted_data_bag_item ||= Chef::EncryptedDataBagItem.new(
+      encrypted_data, secret_key
+    )
+  end
+
+  def data_bag_hash
+    encrypted_data_bag_item.to_hash
+  end
+
+  def data_url
+    data_bag_hash["data_url"]
+  end
+
+  def online_data
+    return @online_data if @online_data
+
+    if !data_url
+      @online_data = {}
+      return @online_data
+    end
+
+    online_json = Net::HTTP.get(URI.parse(data_url))
+    @online_data = JSON.parse(online_json)
+  end
+
+  # Adapted from
+  # http://stackoverflow.com/questions/9381553/ruby-merge-nested-hash/30225093#30225093
+  def deep_merge(first, second)
+    merger = ->(key, v1, v2) do
+      if Hash === v1 && Hash === v2
+        v1.merge(v2, &merger)
+      else
+        if Array === v1 && Array === v2
+          v1 | v2
+        else
+          if [:undefined, nil, :nil].include?(v2)
+            v1
+          else
+            v2
+          end
+        end
+      end
+    end
+
+    first.merge(second.to_h, &merger)
+  end
+end

data/spec/chef/encrypted_data_bag_url_spec.rb

@@ -0,0 +1,123 @@
+require "spec_helper"
+
+class FooError < StandardError; end
+
+describe Chef::EncryptedDataBagUrl do
+  let(:encrypted_data) { "encrypted_data" }
+  let(:secret_key) { "secret_key" }
+  let(:data_bag) { "data_bag" }
+  let(:name) { "name" }
+  let(:encrypted_data_bag_item) do
+    instance_double(Chef::EncryptedDataBagItem, to_hash: data_bag_contents)
+  end
+
+  subject { described_class.load(data_bag, name) }
+
+  before do
+    allow(Chef::DataBagItem).to receive(:load).
+                                with(data_bag, name) { encrypted_data }
+    allow(Chef::EncryptedDataBagItem).to receive(:load_secret) { secret_key }
+    allow(Chef::EncryptedDataBagItem).
+      to receive(:new) { encrypted_data_bag_item }
+  end
+
+  context "when the data bag contains a `data_url`" do
+    let(:data_bag_contents) do
+      {"data_url" => data_url}
+    end
+    let(:data_url) { "http:/example.com" }
+
+    context "when the online data is available" do
+      before do
+        allow(Net::HTTP).to receive(:get) { online_json }
+      end
+
+      context "when the online data is well-formed JSON" do
+        let(:online_json) { online_data.to_json }
+        let(:online_data) { {"ciao" => "hello"} }
+
+        it "merges online data with data bag contents" do
+          expect(subject.to_hash).to eq(data_bag_contents.merge(online_data))
+        end
+
+        context "when the data bag has common keys with the online data" do
+          let(:data_bag_contents) do
+            {
+              "data_url" => data_url,
+              "shared" => {"db" => 1, "common" => "db"},
+              "data_bag_only" => "ok",
+            }
+          end
+          let(:online_data) do
+            {
+              "shared" => {"on" => 1, "common" => "on"},
+              "online_only" => "ok",
+            }
+          end
+          let(:expected) do
+            {
+              "data_url" => data_url,
+              "shared" => {"db" => 1, "on" => 1, "common" => "on"},
+              "data_bag_only" => "ok",
+              "online_only" => "ok",
+            }
+          end
+
+          it "deep merges the data" do
+            expect(subject.to_hash).to eq(expected)
+          end
+        end
+      end
+
+      context "when the online data is not well-formed JSON" do
+        let(:online_json) { "Not JSON" }
+
+        it "fails" do
+          expect do
+            subject.to_hash
+          end.to raise_error(JSON::ParserError)
+        end
+      end
+    end
+
+    context "when the online data is unavailable" do
+      before do
+        allow(Net::HTTP).to receive(:get).and_raise(FooError.new)
+      end
+
+      it "fails" do
+        expect do
+          subject.to_hash
+        end.to raise_error(FooError)
+      end
+    end
+  end
+
+  context "when the data bag doesn't contain a `data_url`" do
+    let(:data_bag_contents) { {"data_bag_contents" => "foo"} }
+
+    it "returns the data bag's contents" do
+      expect(subject.to_hash).to eq(data_bag_contents)
+    end
+  end
+
+  context "#encrypted_data" do
+    it "is private" do
+      expect do
+        subject.encrypted_data
+      end.to raise_error(NoMethodError, /private method .*?\bencrypted_data\b/)
+    end
+  end
+
+  context "#secret_key" do
+    it "is private" do
+      expect do
+        subject.secret_key
+      end.to raise_error(NoMethodError, /private method .*?\bsecret_key\b/)
+    end
+  end
+
+  it "has a version number" do
+    expect(Chef::EncryptedDataBagUrl::VERSION).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "chef/encrypted_data_bag_url"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: chef-encrypted-data-bag-url
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Ease collaboration on your Chef kitchen's secrets by storing the data online,
+      for example in private Gists.
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chef-encrypted-data-bag-url.gemspec
+- lib/chef/encrypted_data_bag_url.rb
+- spec/chef/encrypted_data_bag_url_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/joeyates/chef-encrypted-data-bag-url
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Use online data with Chef data bags
+test_files: []