├── .yo-rc.json ├── .yardopts ├── .gitignore ├── CHANGELOG.md ├── .kitchen.yml ├── Rakefile ├── test ├── cookbooks │ └── citadel_test │ │ ├── attributes │ │ └── default.rb │ │ ├── recipes │ │ └── default.rb │ │ └── metadata.rb ├── spec │ ├── spec_helper.rb │ ├── s3_spec.rb │ └── citadel_spec.rb ├── gemfiles │ ├── chef-13.gemfile │ ├── chef-12.gemfile │ └── master.gemfile ├── integration │ ├── attr │ │ └── serverspec │ │ │ └── default_spec.rb │ └── iam │ │ └── serverspec │ │ └── default_spec.rb └── ec2 │ └── ssh.pem ├── lib ├── citadel │ ├── version.rb │ ├── chef_dsl.rb │ ├── cheftie.rb │ ├── error.rb │ ├── safe_node.rb │ └── s3.rb └── citadel.rb ├── chef └── attributes │ └── default.rb ├── Gemfile ├── .travis.yml ├── poise-citadel.gemspec ├── README.md └── LICENSE /.yo-rc.json: -------------------------------------------------------------------------------- 1 | { 2 | "generator-poise": { 3 | "created": true, 4 | "name": "poise-citadel", 5 | "cookbookName": "citadel", 6 | "noMinor": true 7 | } 8 | } -------------------------------------------------------------------------------- /.yardopts: -------------------------------------------------------------------------------- 1 | --plugin classmethods 2 | --embed-mixin ClassMethods 3 | --hide-api private 4 | --markup markdown 5 | --hide-void-return 6 | --tag provides:Provides 7 | --tag action:Actions 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Berksfile.lock 2 | Gemfile.lock 3 | test/gemfiles/*.lock 4 | .kitchen/ 5 | .kitchen.local.yml 6 | test/docker/ 7 | test/ec2/ 8 | coverage/ 9 | pkg/ 10 | .yardoc/ 11 | doc/ 12 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Citadel Changelog 2 | 3 | ## v1.1.0 4 | 5 | * Automatically retrieve IAM credentials if present. 6 | * Conversion to Halite-based gem. 7 | 8 | ## v1.0.2 9 | 10 | * Improved error messages and HTTPS verification. 11 | 12 | ## v1.0.0 13 | 14 | * Initial release! 15 | -------------------------------------------------------------------------------- /.kitchen.yml: -------------------------------------------------------------------------------- 1 | --- 2 | #<% IO.read('test/ec2/env').split.map{|s| s.split(/=/)}.each{|(k, v)| ENV[k] = v} if ::File.exist?('test/ec2/env') %> 3 | #<% require 'poise_boiler' %> 4 | <%= PoiseBoiler.kitchen(platforms: %w{ubuntu-14.04}, driver: 'ec2') %> 5 | 6 | suites: 7 | - name: iam 8 | run_list: 9 | - recipe[citadel_test] 10 | driver: 11 | iam_profile_name: citadel-role 12 | - name: attr 13 | run_list: 14 | - recipe[citadel_test] 15 | attributes: 16 | citadel: 17 | access_key_id: <%= ENV['CITADEL_ACCESS_KEY_ID'] %> 18 | secret_access_key: <%= ENV['CITADEL_SECRET_ACCESS_KEY'] %> 19 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | require 'poise_boiler/rakefile' 18 | -------------------------------------------------------------------------------- /test/cookbooks/citadel_test/attributes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | override['citadel']['bucket'] = 'citadel-kitchen' 18 | -------------------------------------------------------------------------------- /lib/citadel/version.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | 18 | class Citadel 19 | # Citadel gem version. 20 | VERSION = '1.1.1.pre' 21 | end 22 | -------------------------------------------------------------------------------- /test/cookbooks/citadel_test/recipes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | file '/mysecret' do 18 | content citadel['mysecret'].strip 19 | end 20 | -------------------------------------------------------------------------------- /test/spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | require 'poise_boiler/spec_helper' 18 | require 'citadel' 19 | require 'citadel/cheftie' 20 | -------------------------------------------------------------------------------- /test/gemfiles/chef-13.gemfile: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2017, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | eval_gemfile File.expand_path('../../../Gemfile', __FILE__) 18 | 19 | gem 'chef', '~> 13.0' 20 | -------------------------------------------------------------------------------- /test/cookbooks/citadel_test/metadata.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | name 'citadel_test' 19 | 20 | depends 'citadel' 21 | -------------------------------------------------------------------------------- /test/gemfiles/chef-12.gemfile: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015-2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | eval_gemfile File.expand_path('../../../Gemfile', __FILE__) 18 | 19 | gem 'chef', '~> 12.19' 20 | -------------------------------------------------------------------------------- /test/integration/attr/serverspec/default_spec.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | require 'serverspec' 19 | set :backend, :exec 20 | 21 | describe file('/mysecret') do 22 | its(:content) { is_expected.to eq 'allyourbase' } 23 | end 24 | -------------------------------------------------------------------------------- /test/integration/iam/serverspec/default_spec.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | require 'serverspec' 19 | set :backend, :exec 20 | 21 | describe file('/mysecret') do 22 | its(:content) { is_expected.to eq 'allyourbase' } 23 | end 24 | -------------------------------------------------------------------------------- /lib/citadel/chef_dsl.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | 19 | class Citadel 20 | # Helper module for the DSL extension. 21 | # 22 | # @since 1.0.0 23 | # @api private 24 | module ChefDSL 25 | def citadel(bucket=nil, region=nil) 26 | Citadel.new(node, bucket, region) 27 | end 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /chef/attributes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | # Default S3 bucket to use for Citadel data 19 | default['citadel']['bucket'] = nil 20 | default['citadel']['region'] = 'us-east-1' 21 | 22 | # Override these for use in Vagrant or other development environments 23 | default['citadel']['access_key_id'] = nil 24 | default['citadel']['secret_access_key'] = nil 25 | -------------------------------------------------------------------------------- /lib/citadel/cheftie.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | require 'citadel' 19 | require 'citadel/safe_node' 20 | 21 | 22 | # Patch our DSL extension into Chef. 23 | # @api private 24 | class Chef 25 | class Recipe 26 | include Citadel::ChefDSL 27 | end 28 | 29 | class Resource 30 | include Citadel::ChefDSL 31 | end 32 | 33 | class Provider 34 | include Citadel::ChefDSL 35 | end 36 | end 37 | 38 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | source 'https://rubygems.org/' 18 | 19 | gemspec path: File.expand_path('..', __FILE__) 20 | 21 | def dev_gem(name, path: File.join('..', name), github: nil) 22 | path = File.expand_path(File.join('..', path), __FILE__) 23 | if File.exist?(path) 24 | gem name, path: path 25 | elsif github 26 | gem name, git: "https://github.com/#{github}.git" 27 | end 28 | end 29 | 30 | dev_gem 'halite' 31 | dev_gem 'poise-boiler' 32 | dev_gem 'poise-profiler' 33 | -------------------------------------------------------------------------------- /test/gemfiles/master.gemfile: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2015-2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | eval_gemfile File.expand_path('../../../Gemfile', __FILE__) 18 | 19 | gem 'chef', git: 'https://github.com/chef/chef.git' 20 | gem 'chefspec', git: 'https://github.com/sethvargo/chefspec.git' 21 | gem 'fauxhai', git: 'https://github.com/customink/fauxhai.git' 22 | gem 'foodcritic', git: 'https://github.com/foodcritic/foodcritic.git' 23 | gem 'halite', git: 'https://github.com/poise/halite.git' 24 | gem 'ohai', git: 'https://github.com/chef/ohai.git' 25 | gem 'poise-boiler', git: 'https://github.com/poise/poise-boiler.git' 26 | gem 'poise-profiler', git: 'https://github.com/poise/poise-profiler.git' 27 | -------------------------------------------------------------------------------- /lib/citadel/error.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2012-2016, Brandon Adams and other contributors. 3 | # Copyright 2013-2016, Balanced, Inc. 4 | # Copyright 2016, Noah Kantrowitz 5 | # 6 | # Permission is hereby granted, free of charge, to any person obtaining 7 | # a copy of this software and associated documentation files (the 8 | # "Software"), to deal in the Software without restriction, including 9 | # without limitation the rights to use, copy, modify, merge, publish, 10 | # distribute, sublicense, and/or sell copies of the Software, and to 11 | # permit persons to whom the Software is furnished to do so, subject to 12 | # the following conditions: 13 | # 14 | # The above copyright notice and this permission notice shall be 15 | # included in all copies or substantial portions of the Software. 16 | # 17 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 18 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 19 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 20 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 21 | # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 22 | # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 23 | # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 24 | 25 | 26 | class Citadel 27 | # Base class for Citadell errors. 28 | # 29 | # @since 1.0.0 30 | # @api private 31 | class CitadelError < Exception 32 | end 33 | end 34 | -------------------------------------------------------------------------------- /lib/citadel/safe_node.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | 19 | # Block the IAM credentials from being stored to the Chef server. 20 | # @api private 21 | class Chef 22 | class Node 23 | old_save = instance_method(:save) 24 | 25 | define_method(:save) do 26 | security_credentials = nil 27 | if automatic_attrs['ec2'] && automatic_attrs['ec2']['iam'] && automatic_attrs['ec2']['iam']['security-credentials'] 28 | security_credentials = automatic_attrs['ec2']['iam']['security-credentials'] 29 | automatic_attrs['ec2']['iam']['security-credentials'] = {} 30 | end 31 | begin 32 | old_save.bind(self).call 33 | ensure 34 | unless security_credentials.nil? 35 | automatic_attrs['ec2']['iam']['security-credentials'] = security_credentials 36 | end 37 | end 38 | end 39 | 40 | end 41 | end 42 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | cache: bundler 3 | language: ruby 4 | env: 5 | global: 6 | - secure: G68O+EByjjbIZZmMVV2xQvYlAFqW8LHBj/j82E5mspvVxwhpqn5JdEUpPjR9GeD5Cjt2V13l0353hI9/KyZKwx2iuBR3lQQkyAZIb147bUpYT/yQuXLSYEmt7HxyPOrWCZ2aP0253WPGamKX+bK/OUh1PAbOq5EbTh+2qYvWXAE= 7 | - secure: xXfMmQd6zQ7GUDH2+uGHukNW6ZvJQKIiDVi1rlqTF2IHCcgFzkKGR4Pb9JwEA2c8S0z/KSZ6+3F9o66735Oe53Yvoat18WfdFNrp7q8nPk68hZY2IVA6La7/g3SUhHXvija6d8ywRMwIH3ms6r3aVk2/vQnFxojRzbgxMf54XQg= 8 | - secure: rwKhSzXKW1WAmofn+Z3Z9PfSQVU5/O84qjQjfVw0H3Cq7+vky4/ES+lnQqiMigY0E8MtxUHCidThPGMKE9rJzeLr/ARrJ+9D5xd927Pm5P+nnWsIdh8m38db914henn7AXDZzjbP+l+sbut5EdO2Hixl/qWgzoojSic276MSy9Q= 9 | - secure: T0/zwIemVsXxxqhmIPqdp62TOH+ydZ1F/Fjvz2rEfal976UAfqAOZXnE3OHXOWYC2K/JIJmB+uaFh2Cv8M+lrYa/R3KjB5SYAVwdC6R55kYTRHz7m9XO0XToSoWRi7hjssbPaVsd/v2S3lO78sdn+Ormw6Ksr2IAl8pgxVzE/YI= 10 | - secure: Fj5+nhxolLHo8nMfwsvtOpYUMaAi6nCRkL5eokLJmzAswrHsTyxYGB+u6s4gdiD1QCB4O/R0qf5PIeVKheXxi6oZPQhMpKYiB2zZhvcMmKX1gbzpVs4cmY75JaogO22P1+oPxbGInSWypyYghQODhREzAmpbDpK6RqaGvV4A2lU= 11 | before_install: 12 | - 'if [[ $BUNDLE_GEMFILE == *master.gemfile ]]; then gem update --system; fi' 13 | - gem --version 14 | - gem install bundler 15 | - bundle --version 16 | - 'bundle config --local path ${BUNDLE_PATH:-$(dirname $BUNDLE_GEMFILE)/vendor/bundle}' 17 | - bundle config --local bin $PWD/bin 18 | install: bundle update --jobs=3 --retry=3 19 | script: 20 | - ./bin/rake travis 21 | matrix: 22 | include: 23 | - rvm: 2.3.1 24 | gemfile: test/gemfiles/chef-12.gemfile 25 | - rvm: 2.4.1 26 | gemfile: test/gemfiles/chef-13.gemfile 27 | - rvm: 2.4.1 28 | gemfile: test/gemfiles/master.gemfile 29 | -------------------------------------------------------------------------------- /poise-citadel.gemspec: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | lib = File.expand_path('../lib', __FILE__) 18 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 19 | require 'citadel/version' 20 | 21 | Gem::Specification.new do |spec| 22 | spec.name = 'poise-citadel' 23 | spec.version = Citadel::VERSION 24 | spec.authors = ['Noah Kantrowitz'] 25 | spec.email = %w{noah@coderanger.net} 26 | spec.description = 'DSL for accessing secret data stored on S3 using IAM roles.' 27 | spec.summary = spec.description 28 | spec.homepage = 'https://github.com/poise/citadel' 29 | spec.license = 'Apache-2.0' 30 | spec.metadata['halite_name'] = 'citadel' 31 | spec.metadata['platforms'] = 'any' 32 | 33 | spec.files = `git ls-files`.split($/) 34 | spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } 35 | spec.test_files = spec.files.grep(%r{^(test|spec|features)/}) 36 | spec.require_paths = %w{lib} 37 | 38 | spec.add_dependency 'halite', '~> 1.2' 39 | 40 | spec.add_development_dependency 'poise-boiler', '~> 1.7' 41 | spec.add_development_dependency 'kitchen-ec2', '~> 1.0' 42 | end 43 | -------------------------------------------------------------------------------- /test/ec2/ssh.pem: -------------------------------------------------------------------------------- 1 | -----BEGIN RSA PRIVATE KEY----- 2 | Proc-Type: 4,ENCRYPTED 3 | DEK-Info: AES-256-CBC,91E78FA96193ABAEBD482CE78C16D0DC 4 | 5 | rDF0Ynk3MS01PXGFILJtw8D5tj59eJhmw7JBEoVHNcHdqqSj2F7BTxj/ml8RdWXs 6 | sNRmBesYkRoUlLnaCyHyRnTGc34hvRvR1FtSIDQ/HU2ZXfXSpO64BbSiulGXyJAD 7 | xoTq92vLS07ReAAJiykr2VCgn2IvWQ4MboYy0UWgfzplBaTwnOn0HLoEcmavEcWF 8 | qgUMSIFZUqbI7VCCqw+m/+mvWMC6W03hojPLbweefuifV5A6CByDu8xS1g4+FY/0 9 | BadnYnK4YiELvY5BY/JsOUu0XOAckW/q/3jf26pImwMtQQ/jioEfpKTWZhOUzcUT 10 | D3SUFiVyKn1tDEVMhCOhNHa2n0+ZlUVsiHopaSaSoupCLsHbAqc0kO7jSHsf2zoN 11 | bB/ujnjc+jNGV693oTmcPkxESMEFqFJSfdRQpCf+yloAE5ddztwL42gNgVKAuMJv 12 | XWCjI5bUO3QBpFJ0uoXxrcX5Zj5KDiAjsY0VGD0vrffLFjA5Wejcepy99W+V4dhO 13 | hwRjQZ+8PmseNTOVfUUBr78DVRuusssgq3WSHkTQUmPvdcJSacYAQhmpmMwqoVOR 14 | 9QIG7A/zT/RhYJW604nTvlSMeJN0O3xA12TwpycKXdeRxMstqyB1W6xqNvCvICDb 15 | Tw9BjE3Zm7EHtjCymdLU7b77iDTZbNV7iCdmABvGIT996W3gHe3Qq3UB+eNG6Y6H 16 | C4sRcIKLgtH7W2fOyQtBkXjmb7KlxTpS62gKwIuy7magecGmKmZTaoJFI+fGWK84 17 | vNEukda+2pR0rOsm2IVl5f3tme5ca6Cc4mmjC6N3+EdUxddva7eYz7kd8hghqyEH 18 | tp53Wqrjylyen5ErHRMr5SqUxTVuOCbs0CstxJrooY3xiIhnI0cGKRSpBRW4VU++ 19 | 9E8OQqRrSg18WSwpFI2LxHs3lLLS/3mS7o5hhL8iIYSTyWziGtZxQKIqcmLtdzwk 20 | vYPoN2eqdkOQfbwV2OfyGZ7jZXeSCeu3CqJn7D018afGG6UZVKrVP5bogUgtK5hB 21 | 1madxrRHguKPCLUNP3tINDd8Fw9kbYnmcBE8+ct/bBoTbM33oYfa4+EBUSKY1+5n 22 | 0U8jlgxXYetndi+xELheaabXxOY3wFOmkIYCb6ymWSH04wpXIQdgsTEGtV8MIMjF 23 | KokDKRsm3fBgh4RH1i/NgIglioBgJIi6VdCZtYCZVkG3HhOUwt8bciMcgZTWvTBM 24 | NhINYmiPFczbdf+bRUYZ/ESI3Np9IG2myOOaaby0YIt+4hbdhgSR25bIGXV3Zakk 25 | eQggASP3wZ1rjxmAwRoZfclJt23rbxLwFk2obGVfX+sB3ZJxAOZekY8Hdb1zfSyC 26 | wyWLt9losb8PcpiiiWcIAYUPqy+EvV0r9pKkFsyVNNggjVYJKwzRAEcFBQUzlALx 27 | tO2AmOLiTIdCtPCAd4CyiLo7wVSLpbkTqvs15RBKxyIXYksvVKt9L1bfNZTwlV9y 28 | aqDPyWp10xVg9mY5thm+M3BROpKeX/CUytHQkUH+UQHPQJyIYPo0INem75uzDX/Y 29 | 2vTZaPTgfE3GEJgpaXTVHczTy8HnMSzRlDqIQAinqdQqElMwszLZN6oWfWGr8RBc 30 | -----END RSA PRIVATE KEY----- 31 | -------------------------------------------------------------------------------- /lib/citadel.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2013-2016, Balanced, Inc. 3 | # Copyright 2016, Noah Kantrowitz 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | # 17 | 18 | require 'chef/http' 19 | require 'chef/json_compat' 20 | 21 | 22 | # Helper to access files in a private S3 bucket using an interface like Chef 23 | # node attributes. 24 | # 25 | # @since 1.0.0 26 | # @example 27 | # template '/etc/myapp.conf' do 28 | # variables password: citadel['myapp/password'] 29 | # end 30 | class Citadel 31 | autoload :ChefDSL, 'citadel/chef_dsl' 32 | autoload :CitadelError, 'citadel/error' 33 | autoload :S3, 'citadel/s3' 34 | autoload :VERSION, 'citadel/version' 35 | 36 | attr_reader :bucket, :region, :credentials 37 | 38 | def initialize(node, bucket=nil, region=nil) 39 | @node = node 40 | @bucket = bucket || node['citadel']['bucket'] 41 | @region = region || node['citadel']['region'] 42 | @credentials = find_credentials 43 | end 44 | 45 | def find_credentials 46 | if @node['citadel']['access_key_id'] 47 | { 48 | access_key_id: @node['citadel']['access_key_id'], 49 | secret_access_key: @node['citadel']['secret_access_key'], 50 | token: @node['citadel']['token'], 51 | } 52 | elsif @node['ec2'] 53 | role_creds = if @node['ec2']['iam'] && @node['ec2']['iam']['security-credentials'] 54 | # Creds loaded from Ohai. 55 | @node['ec2']['iam']['security-credentials'].values.first 56 | else 57 | begin 58 | metadata_service = Chef::HTTP.new('http://169.254.169.254') 59 | iam_role = metadata_service.get('latest/meta-data/iam/security-credentials/') 60 | creds_json = metadata_service.get("latest/meta-data/iam/security-credentials/#{iam_role}") 61 | Chef::JSONCompat.parse(creds_json) 62 | rescue Net::HTTPServerException 63 | raise CitadelError.new('Unable to find IAM credentials for node from EC2 metadata') 64 | end 65 | end 66 | { 67 | access_key_id: role_creds['AccessKeyId'], 68 | secret_access_key: role_creds['SecretAccessKey'], 69 | token: role_creds['Token'], 70 | } 71 | else 72 | raise CitadelError.new('Unable to find S3 credentials') 73 | end 74 | end 75 | 76 | def [](key) 77 | Chef::Log.debug("citadel: Retrieving #{@bucket}/#{key}") 78 | Citadel::S3.get(bucket: @bucket, path: key, region: @region, **@credentials).to_s 79 | end 80 | end 81 | -------------------------------------------------------------------------------- /lib/citadel/s3.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2012-2016, Brandon Adams and other contributors. 3 | # Copyright 2013-2016, Balanced, Inc. 4 | # Copyright 2016, Noah Kantrowitz 5 | # 6 | # Permission is hereby granted, free of charge, to any person obtaining 7 | # a copy of this software and associated documentation files (the 8 | # "Software"), to deal in the Software without restriction, including 9 | # without limitation the rights to use, copy, modify, merge, publish, 10 | # distribute, sublicense, and/or sell copies of the Software, and to 11 | # permit persons to whom the Software is furnished to do so, subject to 12 | # the following conditions: 13 | # 14 | # The above copyright notice and this permission notice shall be 15 | # included in all copies or substantial portions of the Software. 16 | # 17 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 18 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 19 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 20 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 21 | # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 22 | # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 23 | # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 24 | 25 | require 'time' 26 | require 'openssl' 27 | require 'base64' 28 | 29 | require 'chef/http' 30 | 31 | require 'citadel/error' 32 | 33 | 34 | class Citadel 35 | # Simple read-only S3 client. 36 | # 37 | # @since 1.0.0 38 | # @api private 39 | module S3 40 | extend self 41 | 42 | # Get an object from S3. 43 | # 44 | # @param bucket [String] Name of the bucket to use. 45 | # @param path [String] Path to the object. 46 | # @param access_key_id [String] AWS access key ID. 47 | # @param secret_access_key [String] AWS secret access key. 48 | # @param token [String, nil] AWS IAM token. 49 | # @param region [String] S3 bucket region. 50 | # @return [Net::HTTPResponse] 51 | def get(bucket:, path:, access_key_id:, secret_access_key:, token: nil, region: nil) 52 | region ||= 'us-east-1' # Most buckets. 53 | path = path[1..-1] if path[0] == '/' 54 | now = Time.now().utc.strftime('%a, %d %b %Y %H:%M:%S GMT') 55 | 56 | string_to_sign = "GET\n\n\n#{now}\n" 57 | string_to_sign << "x-amz-security-token:#{token}\n" if token 58 | string_to_sign << "/#{bucket}/#{path}" 59 | 60 | signed = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), secret_access_key, string_to_sign) 61 | signed_base64 = Base64.encode64(signed) 62 | 63 | headers = { 64 | 'date' => now, 65 | 'authorization' => "AWS #{access_key_id}:#{signed_base64}", 66 | } 67 | headers['x-amz-security-token'] = token if token 68 | 69 | hostname = case region 70 | when 'us-east-1' 71 | 's3.amazonaws.com' 72 | else 73 | "s3-#{region}.amazonaws.com" 74 | end 75 | 76 | begin 77 | Chef::HTTP.new("https://#{hostname}").get("#{bucket}/#{path}", headers) 78 | rescue Net::HTTPServerException => e 79 | raise CitadelError.new("Unable to download #{path}: #{e}") 80 | end 81 | end 82 | 83 | end 84 | end 85 | -------------------------------------------------------------------------------- /test/spec/s3_spec.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | require 'spec_helper' 18 | 19 | describe Citadel::S3 do 20 | let(:fake_http) { double('Chef::HTTP') } 21 | let(:fake_response) { double('Net::HTTPResponse') } 22 | let(:s3_hostname) { 's3.amazonaws.com' } 23 | before do 24 | # Stub out the HTTP object. 25 | expect(Chef::HTTP).to receive(:new).with("https://#{s3_hostname}").and_return(fake_http) 26 | # Freeze time so our signing is predictable. 27 | allow(Time).to receive(:now).and_return(Time.at(0)) 28 | end 29 | 30 | context 'with mybucket/mysecret' do 31 | subject { described_class.get(bucket: 'mybucket', path: 'mysecret', access_key_id: 'AKIAJMKSMHNNCQX4ILAH', secret_access_key: '0ljyHQrk1AGsc2bgx/8fbNghZNYSdckHADR4vNcL') } 32 | before do 33 | expect(fake_http).to receive(:get).with('mybucket/mysecret', 'date' => 'Thu, 01 Jan 1970 00:00:00 GMT', 'authorization' => "AWS AKIAJMKSMHNNCQX4ILAH:TQPmJfb3Mx2MblMnRHJS1EG6jus=\n").and_return(fake_response) 34 | end 35 | 36 | it { is_expected.to be fake_response } 37 | end # /context with mybucket/mysecret 38 | 39 | context 'with token' do 40 | subject { described_class.get(bucket: 'mybucket', path: 'mysecret', access_key_id: 'AKIAJMKSMHNNCQX4ILAH', secret_access_key: '0ljyHQrk1AGsc2bgx/8fbNghZNYSdckHADR4vNcL', token: 'EIZvol3NYAGhIYo3mxmF8Bw3GjRFQq6xmjrlXNQs') } 41 | before do 42 | expect(fake_http).to receive(:get).with('mybucket/mysecret', 'date' => 'Thu, 01 Jan 1970 00:00:00 GMT', 'authorization' => "AWS AKIAJMKSMHNNCQX4ILAH:ZapoW/urO8FlRSEf+y5iWYeNsrs=\n", 'x-amz-security-token' => 'EIZvol3NYAGhIYo3mxmF8Bw3GjRFQq6xmjrlXNQs').and_return(fake_response) 43 | end 44 | 45 | it { is_expected.to be fake_response } 46 | end # /context with token 47 | 48 | context 'with a region' do 49 | let(:s3_hostname) { 's3-us-west-2.amazonaws.com' } 50 | subject { described_class.get(bucket: 'mybucket', path: 'mysecret', access_key_id: 'AKIAJMKSMHNNCQX4ILAH', secret_access_key: '0ljyHQrk1AGsc2bgx/8fbNghZNYSdckHADR4vNcL', region: 'us-west-2') } 51 | before do 52 | expect(fake_http).to receive(:get).with('mybucket/mysecret', 'date' => 'Thu, 01 Jan 1970 00:00:00 GMT', 'authorization' => "AWS AKIAJMKSMHNNCQX4ILAH:TQPmJfb3Mx2MblMnRHJS1EG6jus=\n").and_return(fake_response) 53 | end 54 | 55 | it { is_expected.to be fake_response } 56 | end # /context with a region 57 | 58 | context 'with an exception' do 59 | subject { described_class.get(bucket: 'mybucket', path: 'mysecret', access_key_id: 'AKIAJMKSMHNNCQX4ILAH', secret_access_key: '0ljyHQrk1AGsc2bgx/8fbNghZNYSdckHADR4vNcL') } 60 | before do 61 | expect(fake_http).to receive(:get).with('mybucket/mysecret', 'date' => 'Thu, 01 Jan 1970 00:00:00 GMT', 'authorization' => "AWS AKIAJMKSMHNNCQX4ILAH:TQPmJfb3Mx2MblMnRHJS1EG6jus=\n").and_raise(Net::HTTPServerException.new(nil, nil)) 62 | end 63 | 64 | it { expect { subject }.to raise_error Citadel::CitadelError } 65 | end # /context with an exception 66 | end 67 | 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /test/spec/citadel_spec.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016, Noah Kantrowitz 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | 17 | require 'spec_helper' 18 | 19 | describe Citadel do 20 | let(:args) { [] } 21 | subject { described_class.new(chef_run.node, *args)['mykey'] } 22 | before do 23 | override_attributes['citadel'] ||= {} 24 | override_attributes['citadel']['bucket'] = 'mybucket' 25 | end 26 | 27 | context 'with testing node attributes' do 28 | before do 29 | override_attributes['citadel']['access_key_id'] = 'mykey' 30 | override_attributes['citadel']['secret_access_key'] = 'mysecret' 31 | end 32 | 33 | it do 34 | expect(Citadel::S3).to receive(:get).with(bucket: 'mybucket', region: 'us-east-1', path: 'mykey', access_key_id: 'mykey', secret_access_key: 'mysecret', token: nil).and_return(double(to_s: '')) 35 | subject 36 | end 37 | end # /context with testing node attributes 38 | 39 | context 'with ohai credentials' do 40 | before do 41 | override_attributes['ec2'] ||= {} 42 | override_attributes['ec2']['iam'] ||= {} 43 | override_attributes['ec2']['iam']['security-credentials'] ||= {} 44 | override_attributes['ec2']['iam']['security-credentials']['myrole'] ||= {} 45 | override_attributes['ec2']['iam']['security-credentials']['myrole']['AccessKeyId'] = 'mykey' 46 | override_attributes['ec2']['iam']['security-credentials']['myrole']['SecretAccessKey'] = 'mysecret' 47 | override_attributes['ec2']['iam']['security-credentials']['myrole']['Token'] = 'mytoken' 48 | end 49 | 50 | it do 51 | expect(Citadel::S3).to receive(:get).with(bucket: 'mybucket', region: 'us-east-1', path: 'mykey', access_key_id: 'mykey', secret_access_key: 'mysecret', token: 'mytoken').and_return(double(to_s: '')) 52 | subject 53 | end 54 | end # /context with ohai credentials 55 | 56 | context 'with direct metadata access' do 57 | before do 58 | override_attributes['ec2'] ||= {} 59 | end 60 | 61 | it do 62 | fake_http = double('metadata_service') 63 | expect(fake_http).to receive(:get).with('latest/meta-data/iam/security-credentials/').and_return('myrole') 64 | expect(fake_http).to receive(:get).with('latest/meta-data/iam/security-credentials/myrole').and_return({AccessKeyId: 'mykey', SecretAccessKey: 'mysecret', Token: 'mytoken'}.to_json) 65 | expect(Chef::HTTP).to receive(:new).with('http://169.254.169.254').and_return(fake_http) 66 | expect(Citadel::S3).to receive(:get).with(bucket: 'mybucket', region: 'us-east-1', path: 'mykey', access_key_id: 'mykey', secret_access_key: 'mysecret', token: 'mytoken').and_return(double(to_s: '')) 67 | subject 68 | end 69 | end # /context with direct metadata access 70 | 71 | context 'with no IAM role' do 72 | before do 73 | override_attributes['ec2'] ||= {} 74 | end 75 | 76 | it do 77 | fake_http = double('metadata_service') 78 | expect(fake_http).to receive(:get).with('latest/meta-data/iam/security-credentials/').and_raise(Net::HTTPServerException.new(nil, nil)) 79 | expect(Chef::HTTP).to receive(:new).with('http://169.254.169.254').and_return(fake_http) 80 | expect { subject }.to raise_error Citadel::CitadelError 81 | end 82 | end # /context with no IAM role 83 | end 84 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Citadel Cookbook 2 | 3 | [![Build Status](https://img.shields.io/travis/poise/citadel.svg)](https://travis-ci.org/poise/citadel) 4 | [![Gem Version](https://img.shields.io/gem/v/poise-citadel.svg)](https://rubygems.org/gems/poise-citadel) 5 | [![Cookbook Version](https://img.shields.io/cookbook/v/citadel.svg)](https://supermarket.chef.io/cookbooks/citadel) 6 | [![Coverage](https://img.shields.io/codecov/c/github/poise/citadel.svg)](https://codecov.io/github/poise/citadel) 7 | [![Gemnasium](https://img.shields.io/gemnasium/poise/citadel.svg)](https://gemnasium.com/poise/citadel) 8 | [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) 9 | 10 | Using a combination of IAM roles, S3 buckets, and EC2 it is possible to use AWS 11 | as a trusted-third-party for distributing secret or otherwise sensitive data. 12 | 13 | ## Overview 14 | 15 | IAM roles allow specifying snippets of IAM policies in a way that can be used 16 | from an EC2 virtual machine. Combined with a private S3 bucket, this can be 17 | used to authorize specific hosts to specific files. 18 | 19 | IAM Roles can be created [in the AWS Console](https://console.aws.amazon.com/iam/home#roles). 20 | While the policies applied to a role can be changed later, the name cannot so 21 | be careful when choosing them. 22 | 23 | ## Requirements 24 | 25 | This cookbook requires Chef 12 or newer. It also requires the EC2 ohai plugin 26 | to be active. If you are using a VPC, this may require setting the hint file 27 | depending on your version of Ohai/Chef: 28 | 29 | ```bash 30 | $ mkdir -p /etc/chef/ohai/hints 31 | $ touch /etc/chef/ohai/hints/ec2.json 32 | ``` 33 | 34 | If you use knife-ec2 to start the instance, the hint file is already set for you. 35 | 36 | In Chef 13 and newer, this plugin is automatically enabled so you don't need to do anything. 37 | 38 | ## IAM Policy 39 | 40 | By default, your role will not be able to access any files in your private S3 41 | bucket. You can create IAM policies that whitelist specific keys for each role: 42 | 43 | ```json 44 | { 45 | "Version": "2008-10-17", 46 | "Id": "", 47 | "Statement": [ 48 | { 49 | "Sid": "", 50 | "Effect": "Allow", 51 | "Principal": { 52 | "AWS": "arn:aws:iam:::role/" 53 | }, 54 | "Action": "s3:GetObject", 55 | "Resource": "arn:aws:s3:::/" 56 | } 57 | ] 58 | } 59 | ``` 60 | 61 | The key pattern can include `*` and `?` metacharacters, so for example 62 | `arn:aws:s3:::myapp.citadel/deploy_keys/*` to allow access to all files in the 63 | `deploy_keys` folder. 64 | 65 | This policy can be attached to either the IAM role or the S3 bucket with equal 66 | effect. 67 | 68 | ## Limitations 69 | 70 | Each EC2 VM can only be assigned a single IAM role. This can complicate situations 71 | where some secrets need to be shared by overlapping subsets of your servers. A 72 | possible improvement to this would be to make a script to create all needed 73 | composite IAM roles, possibly driven by Chef roles or other metadata. 74 | 75 | ## Attributes 76 | 77 | * `node['citadel']['bucket']` – The default S3 bucket to use. 78 | 79 | ## Recipe Usage 80 | 81 | You can access secret data via the `citadel` method. 82 | 83 | ```ruby 84 | file '/etc/secret' do 85 | owner 'root' 86 | group 'root' 87 | mode '600' 88 | content citadel['keys/secret.pem'] 89 | end 90 | ``` 91 | 92 | By default the node attribute `node['citadel']['bucket']` is used to find the 93 | S3 bucket to query, however you can override this: 94 | 95 | ```ruby 96 | template '/etc/secret' do 97 | owner 'root' 98 | group 'root' 99 | mode '600' 100 | variables secret: citadel('mybucket')['id_rsa'] 101 | end 102 | ``` 103 | 104 | ## Developing with Vagrant 105 | 106 | While developing in a local VM, you can use the node attributes 107 | `node['citadel']['access_key_id']` and `node['citadel']['secret_access_key']` 108 | to provide credentials. The recommended way to do this is via environment variables 109 | so that the Vagrantfile itself can still be kept in source control without 110 | leaking credentials: 111 | 112 | ```ruby 113 | config.vm.provision :chef_solo do |chef| 114 | chef.json = { 115 | citadel: { 116 | access_key_id: ENV['ACCESS_KEY_ID'], 117 | secret_access_key: ENV['SECRET_ACCESS_KEY'], 118 | }, 119 | } 120 | end 121 | ``` 122 | 123 | **WARNING:** Use of these attributes in production should be considered a likely 124 | security risk as they will end up visible in the node data, or in the role/environment/cookbook 125 | that sets them. This can be mitigated using Enterprise Chef ACLs, however such 126 | configurations are generally error-prone due to the defaults being wide open. 127 | 128 | ### Testing with Test-Kitchen 129 | 130 | Similarly you can use the same attributes with Test-Kitchen 131 | 132 | ```yaml 133 | provisioner: 134 | name: chef_solo 135 | attributes: 136 | citadel: 137 | access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %> 138 | secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %> 139 | ``` 140 | 141 | ## Recommended S3 Layout 142 | 143 | Within your S3 bucket I recommend you create one folder for each group of 144 | secrets, and in your IAM policies have one statement per group. Each group of 145 | secrets is a set of data with identical security requirements. Many groups will 146 | start out only containing a single file, however having the flexibility to 147 | change this in the future allows for things like key rotation without rewriting 148 | all of your IAM policies. 149 | 150 | An example of an IAM policy resource would be: 151 | 152 | ``` 153 | "Resource": "arn:aws:s3:::mybucket/myfolder/*" 154 | ``` 155 | 156 | ## Creating and Updating Secrets 157 | 158 | You can use any S3 client you prefer to manage your secrets, however make sure 159 | that new files are set to private (accessible only to the creating user) by 160 | default. 161 | 162 | ## Sponsors 163 | 164 | The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/). 165 | 166 | ## License 167 | 168 | Copyright 2013-2016, Balanced, Inc. 169 | Copyright 2016, Noah Kantrowitz 170 | 171 | Licensed under the Apache License, Version 2.0 (the "License"); 172 | you may not use this file except in compliance with the License. 173 | You may obtain a copy of the License at 174 | 175 | http://www.apache.org/licenses/LICENSE-2.0 176 | 177 | Unless required by applicable law or agreed to in writing, software 178 | distributed under the License is distributed on an "AS IS" BASIS, 179 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 180 | See the License for the specific language governing permissions and 181 | limitations under the License. 182 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------