hiera-eyaml-gkms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3ff7a2e61d6b1fe7c5015bafc68c96a144692350c7e26c4bd020332428a4c88
+  data.tar.gz: ba0216fc5ea66eae04148b0e3024cb5b71f219f7ffb902fac108512a07e20b5c
+SHA512:
+  metadata.gz: 92d33d1e1080644691fe179b78374b4347576ffdda006fe9078fadb34a94447391af0cfbde5fc6eab8cfc3537424a57986ccd218ec656e640f7ba12fb5332f1b
+  data.tar.gz: 0c5a05fa5a519c8fd70bd16487969e46cbe64fd052c7c3130d433fcf259bc089ffd754001da7c4a291b4d662b824728d89e03db73194feb1a6f490f26f7c827c

data/.gitignore

@@ -0,0 +1,9 @@
+.idea
+*.iml
+*.gradle
+keys/*.pem
+pkg/
+tmp/
+.DS_Store
+.ruby-version
+hiera-eyaml-google-kms-*.gem

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org/'
+
+gemspec
+
+group :dev do
+  gem 'hiera-eyaml'
+  gem 'rake'
+  gem 'google-cloud-kms'
+end

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,97 @@
+# hiera-eyaml-google-kms
+
+This is a plugin encryptor for the [hiera-eyaml](https://github.com/voxpupuli/hiera-eyaml) project, which encrypts and decrypts Hiera data using Google Cloud KMS, based on [hiera-eyaml-kms](https://github.com/adenot/hiera-eyaml-kms) by [Allan Denot](https://github.com/adenot).
+
+[Google Cloud KMS](https://cloud.google.com/kms) is a service that encrypts and decrypts data through API calls. Permissions are controlled by IAM.
+
+Using KMS avoids having to expose private keys to decrypt information when running Puppet.
+
+# Requirements
+
+The Google Cloud Ruby SDK and the `hiera-eyaml` Gem are dependencies:
+
+```
+$ gem install hiera-eyaml google-cloud-kms
+```
+
+# Installation
+
+```
+$ gem install hiera-eyaml-google-kms
+```
+
+Then see [hiera-eyaml documentation](https://github.com/voxpupuli/hiera-eyaml) for how to use the eyaml tool to encrypt and use the 'GKMS' encryption_type for values to be
+encrypted with this plugin.
+
+## Configuration
+
+This plugin adds several options to `hiera-eyaml`:
+
+```
+--gkms-project      Required: GCP Project
+--gkms-keyring      Required: Google Cloud KMS Keyring
+--gkms-crypto-key   Required: Google Cloud KMS Key
+--gkms-location     Google Cloud KMS Keyring location (default: europe-west1)
+--gkms-auth-type    Authentication type for Google API (default: serviceaccount)
+--gkms-credentials  Path to service account JSON file (Required when using serviceaccount authentication type)
+```
+
+The minimum configuration required is the GCP project, keyring and crypto-key to use. If using a service account, you will also need to point the plugin to the JSON file containing the service account key.
+
+If using a configuration YAML file:
+
+```
+---
+gkms_project: 'graphite-melon-123567'
+gkms_auth_type: 'machineaccount'
+gkms_location: 'europe-west1'
+gkms_keyring: 'keyring'
+gkms_crypto_key: 'puppet_eyaml'
+```
+
+## Usage with Google Compute Engine
+
+The plugin can also be run using Google Compute Engine's service account by passing `--gke-auth-type=machineaccount`, and will need to be configured with the following IAM permissions:
+
+- Authentication scope: https://www.googleapis.com/auth/cloudkms
+- IAM role: `roles/cloudkms.cryptoKeyEncrypterDecrypter`
+
+## Terraform Example
+
+```
+resource "google_kms_key_ring" "keyring" {
+  name     = "keyring"
+  location = "europe-west1"
+}
+
+resource "google_kms_crypto_key" "puppet_eyaml" {
+  name     = "puppet_eyaml"
+  key_ring = "${google_kms_key_ring.keyring.self_link}"
+
+  lifecycle {
+    prevent_destroy = true
+  }
+}
+
+resource "google_kms_crypto_key_iam_member" "eyaml" {
+  crypto_key_id = "${google_kms_crypto_key.puppet_eyaml.self_link}"
+  role          = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
+  member        = "serviceAccount:${data.google_project.project.number}-compute@developer.gserviceaccount.com"
+}
+
+resource "google_compute_instance_template" "template" {
+  ...
+
+  service_account {
+    scopes = ["https://www.googleapis.com/auth/cloudkms"]
+  }
+
+  ...
+}
+```
+
+# Development
+
+- Distributed under the terms of the Apache License v2.0 - see [LICENSE.txt](/LICENSE.txt) for details.
+- Copyright 2019 [Craig Watson](http://github.com/craigwatson)
+- This project has been heavily based on [hiera-eyaml-kms](https://github.com/adenot/hiera-eyaml-kms) by [Allan Denot](https://github.com/adenot)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hiera-eyaml-gkms.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hiera/backend/eyaml/encryptors/gkms/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hiera-eyaml-gkms"
+  gem.version       = Hiera::Backend::Eyaml::Encryptors::Gkms::VERSION
+  gem.description   = "Google Cloud KMS plugin for Hiera-EYAML"
+  gem.summary       = "Encryption plugin for hiera-eyaml backend for Hiera, using Google Cloud KMS"
+  gem.author        = "Craig Watson"
+  gem.license       = "Apache-2.0"
+
+  gem.homepage      = "http://github.com/craigwatson/hiera-eyaml-google-kms"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('hiera-eyaml', '>=1.3.8')
+  gem.add_runtime_dependency('google-cloud-kms')
+end

data/lib/hiera/backend/eyaml/encryptors/gkms.rb

@@ -0,0 +1,93 @@
+begin
+  require 'google/cloud/kms'
+rescue LoadError
+  fail "hiera-eyaml-gkms requires the 'google-cloud-kms' gem"
+end
+
+require 'hiera/backend/eyaml/encryptor'
+require 'hiera/backend/eyaml/utils'
+require 'hiera/backend/eyaml/options'
+
+class Hiera
+  module Backend
+    module Eyaml
+      module Encryptors
+        class Gkms < Encryptor
+
+          self.tag     = "GKMS"
+          self.options = {
+            :project => {
+              :desc    => "GCP Project",
+              :type    => :string,
+              :default => ""
+            },
+            :location => {
+              :desc    => "GCP Region of the KMS Keyring",
+              :type    => :string,
+              :default => "europe-west1"
+            },
+            :keyring => {
+              :desc    => "GCP KMS Keyring name",
+              :type    => :string,
+              :default => ""
+            },
+            :crypto_key => {
+              :desc    => "GCP KMS Crypto Key name",
+              :type    => :string,
+              :default => ""
+            },
+            :auth_type => {
+              :desc    => "Authentication type for GCP SDK",
+              :type    => :string,
+              :default => "serviceaccount"
+            },
+            :credentials => {
+              :desc    => "GCP Service Account credentials",
+              :type    => :string,
+              :default => ""
+            },
+          }
+
+          def self.kms_client
+            auth_type = self.option :auth_type
+
+            if auth_type == "serviceaccount"
+              credentials = self.option :credentials
+              raise StandardError, "gkms_credentials is not defined" unless credentials
+              client_opts = { version: 'v1', credentials: credentials }
+            else
+              client_opts = { version: 'v1' }
+            end
+
+            return Google::Cloud::Kms.new(client_opts)
+          end
+
+          def self.key_path
+            project     = self.option :project
+            location    = self.option :location
+            keyring     = self.option :keyring
+            crypto_key  = self.option :crypto_key
+
+            raise StandardError, "gkms_project is not defined" unless project
+            raise StandardError, "gkms_keyring is not defined" unless keyring
+            raise StandardError, "gkms_crypto_key is not defined" unless crypto_key
+
+            return Google::Cloud::Kms::V1::KeyManagementServiceClient.crypto_key_path(project, location, keyring, crypto_key)
+          end
+
+          def self.encrypt plaintext
+            kms_client = self.kms_client
+            key_path = self.key_path
+            kms_client.encrypt(key_path, plaintext).ciphertext
+          end
+
+          def self.decrypt ciphertext
+            kms_client = self.kms_client
+            key_path = self.key_path
+            kms_client.decrypt(key_path, ciphertext).plaintext
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hiera/backend/eyaml/encryptors/gkms/eyaml_init.rb

@@ -0,0 +1,3 @@
+require 'hiera/backend/eyaml/encryptors/gkms'
+
+Hiera::Backend::Eyaml::Encryptors::Gkms.register

data/lib/hiera/backend/eyaml/encryptors/gkms/version.rb

@@ -0,0 +1,11 @@
+class Hiera
+  module Backend
+    module Eyaml
+      module Encryptors
+        module Gkms
+          VERSION = "0.0.1"
+        end
+      end
+    end
+  end
+end

data/tools/regem.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+GEM_NAME="hiera-eyaml-gkms"
+
+gem uninstall "${GEM_NAME}" --executables
+RAKE_OUT=$(rake build)
+VERSION=$(echo "${RAKE_OUT}" | awk '{print $2}')
+echo "Installing version: ${VERSION} ..."
+gem install "pkg/${GEM_NAME}-${VERSION}.gem"
+
+if [ ! -z "$(which eyaml)" ];then
+  eyaml version
+else
+  echo "install hiera-eyaml to see if gem imports correctly"
+fi

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: hiera-eyaml-gkms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Craig Watson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hiera-eyaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+- !ruby/object:Gem::Dependency
+  name: google-cloud-kms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Cloud KMS plugin for Hiera-EYAML
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hiera-eyaml-gkms.gemspec
+- lib/hiera/backend/eyaml/encryptors/gkms.rb
+- lib/hiera/backend/eyaml/encryptors/gkms/eyaml_init.rb
+- lib/hiera/backend/eyaml/encryptors/gkms/version.rb
+- tools/regem.sh
+homepage: http://github.com/craigwatson/hiera-eyaml-google-kms
+licenses:
+- Apache-2.0
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Encryption plugin for hiera-eyaml backend for Hiera, using Google Cloud KMS
+test_files: []