New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add chef_vault_secret resource from chef-vault cookbook #9364
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# | ||
# Cookbook:: end_to_end | ||
# Recipe:: chef-vault | ||
# | ||
# Copyright:: 2020, Chef Software, Inc. | ||
# | ||
|
||
chef_data_bag 'creds' | ||
|
||
openssl_rsa_private_key '/root/bob_bobberson.pem' do | ||
key_length 2048 | ||
action :create | ||
end | ||
|
||
chef_client 'bob_bobberson' do | ||
source_key_path '/root/bob_bobberson.pem' | ||
end | ||
|
||
chef_node 'bob_bobberson' | ||
|
||
chef_vault_secret 'super_secret_1' do | ||
data_bag 'creds' | ||
raw_data('auth' => '1234') | ||
admins 'bob_bobberson' | ||
search '*:*' | ||
end | ||
|
||
chef_vault_secret 'super_secret_2' do | ||
data_bag 'creds' | ||
raw_data('auth' => '4321') | ||
admins 'bob_bobberson' | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
# | ||
# Author:: Joshua Timberman <joshua@chef.io> | ||
# Copyright:: 2014-2020, Chef Software Inc. | ||
# | ||
# 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_relative "../resource" | ||
require "chef-vault" | ||
|
||
class Chef | ||
class Resource | ||
class ChefVaultSecret < Chef::Resource | ||
resource_name :chef_vault_secret | ||
provides :chef_vault_secret | ||
|
||
introduced "16.0" | ||
description "Use the chef_vault_secret resource to store secrets in Chef Vault items. Where possible and relevant, this resource attempts to map behavior and functionality to the knife vault sub-commands." | ||
examples <<~DOC | ||
To create a 'foo' item in an existing 'bar' data bag: | ||
|
||
```ruby | ||
chef_vault_secret 'foo' do | ||
data_bag 'bar' | ||
raw_data({'auth' => 'baz'}) | ||
admins 'jtimberman' | ||
search '*:*' | ||
end | ||
``` | ||
|
||
To allow multiple admins access to an item: | ||
|
||
```ruby | ||
chef_vault_secret 'root-password' do | ||
admins 'jtimberman,paulmooring' | ||
data_bag 'secrets' | ||
raw_data({'auth' => 'DontUseThisPasswordForRoot'}) | ||
search '*:*' | ||
end | ||
``` | ||
DOC | ||
|
||
property :id, String, name_property: true, | ||
description: "The name of the data bag item if it differs from the name of the resource block" | ||
|
||
property :data_bag, String, required: true, desired_state: false, | ||
description: "The data bag that contains the item." | ||
|
||
property :admins, [String, Array], required: true, desired_state: false, | ||
description: "A list of admin users who should have access to the item. Corresponds to the 'admin' option when using the chef-vault knife plugin. Can be specified as a comma separated string or an array." | ||
|
||
property :clients, [String, Array], desired_state: false, | ||
description: "A search query for the nodes' API clients that should have access to the item." | ||
|
||
property :search, String, default: "*:*", desired_state: false, | ||
description: "Search query that would match the same used for the clients, gets stored as a field in the item." | ||
|
||
property :raw_data, [Hash, Mash], default: {}, | ||
description: "The raw data, as a Ruby Hash, that will be stored in the item." | ||
|
||
property :environment, [String, NilClass], desired_state: false, | ||
description: "The Chef environment of the data if storing per environment values." | ||
|
||
load_current_value do | ||
begin | ||
item = ChefVault::Item.load(data_bag, id) | ||
raw_data item.raw_data | ||
clients item.get_clients | ||
admins item.get_admins | ||
search item.search | ||
rescue ChefVault::Exceptions::KeysNotFound | ||
current_value_does_not_exist! | ||
rescue Net::HTTPServerException => e | ||
current_value_does_not_exist! if e.response_code == "404" | ||
end | ||
end | ||
|
||
action :create do | ||
description "Creates the item, or updates it if it already exists." | ||
|
||
converge_if_changed do | ||
item = ChefVault::Item.new(new_resource.data_bag, new_resource.id) | ||
|
||
Chef::Log.debug("#{new_resource.id} environment: '#{new_resource.environment}'") | ||
item.raw_data = if new_resource.environment.nil? | ||
new_resource.raw_data.merge("id" => new_resource.id) | ||
else | ||
{ "id" => new_resource.id, new_resource.environment => new_resource.raw_data } | ||
end | ||
|
||
Chef::Log.debug("#{new_resource.id} search query: '#{new_resource.search}'") | ||
item.search(new_resource.search) | ||
Chef::Log.debug("#{new_resource.id} clients: '#{new_resource.clients}'") | ||
item.clients([new_resource.clients].flatten.join(",")) unless new_resource.clients.nil? | ||
Chef::Log.debug("#{new_resource.id} admins (users): '#{new_resource.admins}'") | ||
item.admins([new_resource.admins].flatten.join(",")) | ||
item.save | ||
end | ||
end | ||
|
||
action :create_if_missing do | ||
description "Calls the create action unless it exists." | ||
|
||
action_create if current_resource.nil? | ||
end | ||
|
||
action :delete do | ||
description "Deletes the item and the item's keys ('id'_keys)." | ||
|
||
converge_by("remove #{new_resource.id} and #{new_resource.id}_keys from #{new_resource.data_bag}") do | ||
chef_data_bag_item new_resource.id do | ||
data_bag new_resource.data_bag | ||
action :delete | ||
end | ||
|
||
chef_data_bag_item [new_resource.id, "keys"].join("_") do | ||
data_bag new_resource.data_bag | ||
action :delete | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# | ||
# Copyright:: 2020, Chef Software, 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 "spec_helper" | ||
|
||
describe Chef::Resource::ChefVaultSecret do | ||
let(:resource) { Chef::Resource::ChefVaultSecret.new("foo") } | ||
|
||
it "has a resource name of :chef_vault_secret" do | ||
expect(resource.resource_name).to eql(:chef_vault_secret) | ||
end | ||
|
||
it "sets the default action as :create" do | ||
expect(resource.action).to eql([:create]) | ||
end | ||
|
||
it "id is the name property" do | ||
expect(resource.id).to eql("foo") | ||
end | ||
|
||
it "supports :create, :create_if_missing, and :delete actions" do | ||
expect { resource.action :create }.not_to raise_error | ||
expect { resource.action :create_if_missing }.not_to raise_error | ||
expect { resource.action :delete }.not_to raise_error | ||
end | ||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
delete doesn't look properly idempotent here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Totally isn't