tcce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4aa9c8b89db6fb2cfc574f7d678d819d68d5ba6278806a51f115f13b5927abec
+  data.tar.gz: 8b05f710aaa3460c44f5d277625b1266a2bc5076be96d1521b1ebae13898d6a5
+SHA512:
+  metadata.gz: a687c52182c62cc17ab4ce1da7cc53041da87f2051c0b9dbcf5817a870fe4b2f172e15000f1078e9bd3a2433a02efd127bb4f8880b0094bb86694e5fc79ab315
+  data.tar.gz: ec1bfbf72e439259729920e8df7c2877acea5ddbdad11715cbaaeb4c44a9817bac8b85ac8fbd8bc0035ce057b898baf72aa79ea4fc18159cfa4a0a3d0544adfd

data/.gitignore

@@ -0,0 +1,107 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+cmake-build-release/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+### Ruby template
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/rdoc/
+
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tcce.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    tcce (0.1.0)
+      diplomat (~> 2.0, >= 2.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diplomat (2.0.2)
+      faraday (~> 0.9)
+      json
+    docile (1.3.1)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    json (2.1.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  simplecov (~> 0.16.1)
+  tcce!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,104 @@
+# TCCE
+
+## Traefik Consul Certificate Exporter
+
+This piece of code exports Let's Encrypt certificates generated by traefik and gives access to them in an easy way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tcce'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tcce
+
+## Usage
+
+You will need a Consul ACL Token with `read` permission on the object set by [traefik](https://docs.traefik.io/configuration/acme/):
+
+    key "traefik/acme/account/object" { policy = "read" }
+
+The key can be found in your `traefik.toml` under `[acme]` => `storage`.
+
+For a complete list of methods see the files under `test/`.
+
+### Connect and export Consul object
+
+To retrieve the contents of the consul kv-object, execute the following code: 
+
+```ruby
+consul = TCCE::Consul.new url, acl_token, kv_path
+acme_json = consul.get
+# => "{"Email":"ralf.herzog@mail.com","Registration":{"body":{"status":"valid","contact":["mailto:ralf.herzog@mail.com"]},"uri":"https://acme-v02.api.letsencrypt.org/acme/acct/37963798"},"PrivateKey":"MII..."}"
+```
+
+This will decompress the stored object. For example:
+
+```ruby
+consul = TCCE::Consul.new 'http://localhost:8300', 'xxxxxxxx-yyyy-zzzz-1111-222222222222', 'traefik/acme/account'
+acme_json = consul.get
+```
+
+### Parse the json
+
+To parse the decompressed json to nice objects, run this:
+
+```ruby
+file = TCCE::File.parse acme_json
+```
+
+#### Extract the certificates
+
+You can access your [certificates](https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/X509/Certificate.html) either by
+
+```ruby
+certificates = file.certificates
+# => [TCCE::Certificate, ...]
+```
+
+or pass it with a block
+
+```ruby
+file.certificates do |cert|
+  cert
+  # => TCCE::Certificate
+
+  cert.domain
+  # => 'rherzog.de'
+  
+  cert.sans
+  # => ['www.rherzog.de', 'test.rherzog.de', ...]
+  
+  cert.certificate
+  # => OpenSSL::X509::Certificate
+  
+  cert.private_key
+  # => OpenSSL::PKey::RSA
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RalfHerzog/tcce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TCCE project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tcce/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

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

data/bin/setup

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

data/lib/tcce.rb

@@ -0,0 +1,3 @@
+require 'tcce/consul'
+require 'tcce/file'
+require 'tcce/version'

data/lib/tcce/certificate.rb

@@ -0,0 +1,38 @@
+require 'base64'
+require 'openssl'
+
+module TCCE
+  class Certificate
+    attr_accessor :json
+
+    # def to_s
+    #   JSON.pretty_generate json
+    # end
+
+    def self.parse(content)
+      file = TCCE::Certificate.new
+      file.json = content
+      file
+    end
+
+    def domain
+      json['Domains']['Main']
+    end
+
+    def sans
+      json['Domains']['SANs']
+    end
+
+    def certificate
+      certificate = Base64.decode64 json['Certificate']['Certificate']
+      OpenSSL::X509::Certificate.new certificate
+    end
+
+    def private_key
+      private_key = Base64.decode64 json['Certificate']['PrivateKey']
+      OpenSSL::PKey::RSA.new private_key
+    end
+
+    # alias names sans
+  end
+end

data/lib/tcce/consul.rb

@@ -0,0 +1,39 @@
+require 'diplomat'
+require 'stringio'
+require 'zlib'
+
+module TCCE
+  class Consul
+    attr_accessor :kv_path
+
+    # @param [String] url
+    # @param [String] acl_token
+    # @param [String] kv_path
+    def initialize(url, acl_token, kv_path = nil)
+      self.kv_path = kv_path
+
+      Diplomat.configure do |config|
+        # Set up a custom Consul URL
+        config.url = url
+        # Connect into consul with custom access token (ACL)
+        config.acl_token = acl_token
+        # Set extra Faraday configuration options
+        config.options = { ssl: { version: :TLSv1_2 } }
+      end
+    end
+
+    # Query the +kv_path+ from consul
+    # @return [String] object
+    def get(inflate = true)
+      # Query object from consul
+      consul_object = Diplomat::Kv.get kv_path
+      return consul_object unless inflate
+
+      # Inflate with gzip
+      object_stream = StringIO.new consul_object
+      gzip_stream = Zlib::GzipReader.new object_stream
+      gzip_stream.read
+    end
+  end
+end
+

data/lib/tcce/file.rb

@@ -0,0 +1,47 @@
+require_relative 'registration'
+require_relative 'certificate'
+
+module TCCE
+  class File
+    attr_accessor :json
+
+    # def to_s
+    #   JSON.pretty_generate json
+    # end
+
+    # Parse a file given by argument
+    # @param [String] content the object contents
+    # @return [TCCE::File]
+    def self.parse(content)
+      file = TCCE::File.new
+      file.json = JSON.parse content
+      file
+    end
+
+    def email
+      json['Email']
+    end
+
+    def registration
+      TCCE::Registration.parse json['Registration']
+    end
+
+    def private_key
+      json['PrivateKey']
+    end
+
+    def certificates
+      certs = []
+      json['DomainsCertificate']['Certs'].each do |cert|
+        certificate = TCCE::Certificate.parse cert
+        certs << certificate
+        yield certificate if block_given?
+      end
+      certs
+    end
+
+    def http_challenge
+      json['HTTPChallenge']
+    end
+  end
+end

data/lib/tcce/registration.rb

@@ -0,0 +1,34 @@
+module TCCE
+  class Registration
+    attr_accessor :json
+
+    # def to_s
+    #   JSON.pretty_generate json
+    # end
+
+    def self.parse(content)
+      file = TCCE::Registration.new
+      file.json = content
+      file
+    end
+
+    def uri
+      json['uri']
+    end
+
+    def status
+      json['body']['status']
+    end
+
+    def contact
+      contacts.first
+    end
+
+    def contacts
+      json['body']['contact'].map do |contact|
+        contact = contact[7..-1] if contact.start_with? 'mailto:'
+        contact
+      end
+    end
+  end
+end

data/lib/tcce/version.rb

@@ -0,0 +1,3 @@
+module TCCE
+  VERSION = '0.1.0'.freeze
+end

data/tcce.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tcce/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'tcce'
+  spec.version = TCCE::VERSION
+  spec.authors = ['Ralf Herzog']
+  spec.email = ['ralf@rherzog.de']
+
+  spec.summary = 'Traefik Consul Certificate Export'
+  spec.description = 'Export certificates from consul kv to files'
+  spec.homepage = 'https://github.com/RalfHerzog/tcce'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+    'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'diplomat', '~> 2.0', '>= 2.0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: tcce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ralf Herzog
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: Export certificates from consul kv to files
+email:
+- ralf@rherzog.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tcce.rb
+- lib/tcce/certificate.rb
+- lib/tcce/consul.rb
+- lib/tcce/file.rb
+- lib/tcce/registration.rb
+- lib/tcce/version.rb
+- tcce.gemspec
+homepage: https://github.com/RalfHerzog/tcce
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Traefik Consul Certificate Export
+test_files: []