summaryrefslogtreecommitdiff
path: root/lib/chef/encrypted_data_bag_item.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/encrypted_data_bag_item.rb')
-rw-r--r--lib/chef/encrypted_data_bag_item.rb139
1 files changed, 139 insertions, 0 deletions
diff --git a/lib/chef/encrypted_data_bag_item.rb b/lib/chef/encrypted_data_bag_item.rb
new file mode 100644
index 0000000000..048ab8d57e
--- /dev/null
+++ b/lib/chef/encrypted_data_bag_item.rb
@@ -0,0 +1,139 @@
+#
+# Author:: Seth Falcon (<seth@opscode.com>)
+# Copyright:: Copyright 2010-2011 Opscode, Inc.
+# 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.
+#
+
+require 'base64'
+require 'openssl'
+require 'chef/data_bag_item'
+require 'yaml'
+require 'open-uri'
+
+# An EncryptedDataBagItem represents a read-only data bag item where
+# all values, except for the value associated with the id key, have
+# been encrypted.
+#
+# EncrypedDataBagItem can be used in recipes to decrypt data bag item
+# members.
+#
+# Data bag item values are assumed to have been encrypted using the
+# default symmetric encryption provided by Encryptor.encrypt where
+# values are converted to YAML prior to encryption.
+#
+# If the shared secret is not specified at initialization or load,
+# then the contents of the file referred to in
+# Chef::Config[:encrypted_data_bag_secret] will be used as the
+# secret. The default path is /etc/chef/encrypted_data_bag_secret
+#
+# EncryptedDataBagItem is intended to provide a means to avoid storing
+# data bag items in the clear on the Chef server. This provides some
+# protection against a breach of the Chef server or of Chef server
+# backup data. Because the secret must be stored in the clear on any
+# node needing access to an EncryptedDataBagItem, this approach
+# provides no protection of data bag items from actors with access to
+# such nodes in the infrastructure.
+#
+class Chef::EncryptedDataBagItem
+ DEFAULT_SECRET_FILE = "/etc/chef/encrypted_data_bag_secret"
+ ALGORITHM = 'aes-256-cbc'
+
+ def initialize(enc_hash, secret)
+ @enc_hash = enc_hash
+ @secret = secret
+ end
+
+ def [](key)
+ value = @enc_hash[key]
+ if key == "id" || value.nil?
+ value
+ else
+ self.class.decrypt_value(value, @secret)
+ end
+ end
+
+ def []=(key, value)
+ raise ArgumentError, "assignment not supported for #{self.class}"
+ end
+
+ def to_hash
+ @enc_hash.keys.inject({}) { |hash, key| hash[key] = self[key]; hash }
+ end
+
+ def self.from_plain_hash(plain_hash, secret)
+ self.new(self.encrypt_data_bag_item(plain_hash, secret), secret)
+ end
+
+ def self.encrypt_data_bag_item(plain_hash, secret)
+ plain_hash.inject({}) do |h, (key, val)|
+ h[key] = if key != "id"
+ self.encrypt_value(val, secret)
+ else
+ val
+ end
+ h
+ end
+ end
+
+ def self.load(data_bag, name, secret = nil)
+ path = "data/#{data_bag}/#{name}"
+ raw_hash = Chef::DataBagItem.load(data_bag, name)
+ secret = secret || self.load_secret
+ self.new(raw_hash, secret)
+ end
+
+ def self.encrypt_value(value, key)
+ Base64.encode64(self.cipher(:encrypt, value.to_yaml, key))
+ end
+
+ def self.decrypt_value(value, key)
+ YAML.load(self.cipher(:decrypt, Base64.decode64(value), key))
+ end
+
+ def self.load_secret(path=nil)
+ path = path || Chef::Config[:encrypted_data_bag_secret] || DEFAULT_SECRET_FILE
+ secret = case path
+ when /^\w+:\/\//
+ # We have a remote key
+ begin
+ Kernel.open(path).read.strip
+ rescue Errno::ECONNREFUSED
+ raise ArgumentError, "Remote key not available from '#{path}'"
+ rescue OpenURI::HTTPError
+ raise ArgumentError, "Remote key not found at '#{path}'"
+ end
+ else
+ if !File.exists?(path)
+ raise Errno::ENOENT, "file not found '#{path}'"
+ end
+ IO.read(path).strip
+ end
+ if secret.size < 1
+ raise ArgumentError, "invalid zero length secret in '#{path}'"
+ end
+ secret
+ end
+
+ protected
+
+ def self.cipher(direction, data, key)
+ cipher = OpenSSL::Cipher::Cipher.new(ALGORITHM)
+ cipher.send(direction)
+ cipher.pkcs5_keyivgen(key)
+ ans = cipher.update(data)
+ ans << cipher.final
+ ans
+ end
+end