zerossl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 297b976a0e485d71411c80a4b0fc1fe64cc5731f325bdbb9ebef2ed5ee2b4297
+  data.tar.gz: c93377a58be0f2529c559263caa368a356edcf0c1c96ffc884c5c582c9c732cf
+SHA512:
+  metadata.gz: d451828123c8be153fa4a63f47c56e2687673283abd4deb576d1878cb4f24e3b18c8dc11516e1fe57de902905d9480ec423753ce37f71e8424e0699a5d33d759
+  data.tar.gz: 1d6a9a8b5a14dc262e74b5abd9c24218069fbddce69b205550c329c88d261c911f0e1e9e0b0ded9e45b83a7c4cfedfa3d6cdb372c7dd6328f99a80529b32d5fd

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zerossl.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    zerossl (0.1.0)
+      dry-configurable (~> 0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.9)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  zerossl!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 creadone
+
+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,97 @@
+# ZeroSSL
+
+Ruby client to obtain SSL certificate from [ZeroSSL](https://zerossl.com) via [REST API](https://zerossl.com/documentation/api/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zerossl'
+```
+
+And then execute:
+```ruby
+$ bundle install
+```
+Or install it yourself as:
+```ruby
+$ gem install zerossl
+```
+## Usage
+
+```ruby
+require 'zerossl'
+
+# Setup gem
+ZeroSSL::Setup.config.access_key = '123456789'
+client = ZeroSSL::Client.new
+
+# Define domain and server html path
+domain_name    = 'umbrella.llc'
+html_directory = '/var/www/html'
+
+# Set Certificate Signing Request options
+csr_opts = {
+  common_name:  domain_name,
+  organization: 'Umbrella',
+  country:      'RU',
+  state_name:   'Moscow',
+  locality:     'Moscow'
+}
+
+# Build CSR
+csr, key = ZeroSSL::CSR.new(csr_opts).call
+
+# Build certificate request
+request = {
+  certificate_domains:        [domain_name],
+  certificate_validity_days:  ZeroSSL::VALIDITY_DAYS::DAY90,
+  certificate_csr:            csr
+}
+
+# Receive request, extract certificate id and validation details
+response       = client.create(request).body
+certificate_id = response['id']
+other_methods  = response['validation']['other_methods']
+
+# Write validation content into file to the server directory
+other_methods.each do |domain_name, validation_types|
+  validation_uri     = URI(validation_types['file_validation_url_http'])
+  validation_content = validation_types['file_validation_content']
+
+  File.open(File.join(html_directory, validation_uri.path), 'w') do |io|
+    io << validation_content.join("\n")
+  end
+end
+
+# Tell ZeroSSL domain are ready for validation
+client.verify(certificate_id, ZeroSSL::VALIDATION_TYPE::HTTP)
+#=> { [...] validation => { other_methods => { <domain> => file_validation_url_http }}}
+
+# Check validation status
+client.status(certificate_id)
+#=> true
+
+# Download Certificate (inline)
+client.download(certificate_id)
+#=> {
+#    "certificate.crt": "---BEGIN CERTIFICATE---{primary_certificate}---END CERTIFICATE---",
+#    "ca_bundle.crt": "---BEGIN CERTIFICATE---{certificate_bundle}---END CERTIFICATE---"
+# }
+```
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/creadone/zerossl.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "zerossl"
+
+# 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/zerossl.rb

@@ -0,0 +1,9 @@
+require 'zerossl/version'
+require 'zerossl/config'
+require 'zerossl/constants'
+require 'zerossl/http'
+require 'zerossl/client'
+require 'zerossl/csr'
+
+# require 'zerossl/transport'
+

data/lib/zerossl/client.rb

@@ -0,0 +1,42 @@
+module ZeroSSL
+  class Client
+    def initialize
+      @config = ZeroSSL::Setup.config
+      @http   = HTTP.new
+    end
+
+    def certificates
+      @http.get('certificates')
+    end
+
+    def create(opts = {})
+      attributes = %w[
+        certificate_domains
+        certificate_validity_days
+        certificate_csr
+      ]
+
+      options = opts.transform_keys(&:to_s).slice(*attributes)
+      domains = options['certificate_domains']
+
+      if domains.is_a?(Array)
+        options['certificate_domains'] = domains.join(',')
+      end
+      @http.post('certificates', options)
+    end
+
+    def verify(id, validation_method)
+      opts = { validation_method: validation_method }
+      @http.post("certificates/#{id}/challenges", opts)
+    end
+
+    def status(id)
+      !!@http.get("certificates/#{id}/status")&.body['validation_completed']
+    end
+
+    def download(id)
+      @http.get("certificates/#{id}/download/return")&.body
+    end
+
+  end
+end

data/lib/zerossl/config.rb

@@ -0,0 +1,13 @@
+require 'logger'
+require 'dry-configurable'
+
+module ZeroSSL
+  class Setup
+    extend Dry::Configurable
+
+    setting :api_uri,    'https://api.zerossl.com'
+    setting :access_key, nil
+    setting :logger,     Logger.new(STDOUT)
+    setting :user_agent, "ZeroSSL Ruby Client / #{ZeroSSL::VERSION}"
+  end
+end

data/lib/zerossl/constants.rb

@@ -0,0 +1,13 @@
+module ZeroSSL
+  module VALIDATION_TYPE
+    EMAIL = 'EMAIL'
+    CNAME = 'CNAME_CSR_HASH'
+    HTTP  = 'HTTP_CSR_HASH'
+    HTTPS = 'HTTPS_CSR_HASH'
+  end
+
+  module VALIDITY_DAYS
+    DAY90  = 90
+    DAY360 = 365
+  end
+end

data/lib/zerossl/csr.rb

@@ -0,0 +1,45 @@
+require 'openssl'
+
+module ZeroSSL
+  class CSR
+    def initialize opts = {}
+      opts.transform_keys!(&:to_s)
+
+      @common_name  = opts.dig('common_name')
+      @organization = opts.dig('organization')
+      @country      = opts.dig('country')
+      @state_name   = opts.dig('state_name')
+      @locality     = opts.dig('locality')
+
+      @signing_key  = signing_key
+      @subject      = subject
+    end
+
+    def call
+      csr            = OpenSSL::X509::Request.new
+      csr.version    = 0
+      csr.subject    = subject
+      csr.public_key = signing_key.public_key
+      csr.sign signing_key, OpenSSL::Digest::SHA256.new
+
+      [csr.to_s, signing_key.to_s]
+    end
+
+    private
+
+      def signing_key
+        @signing_key ||= OpenSSL::PKey::RSA.new 2048
+      end
+
+      def subject
+        @subject ||= OpenSSL::X509::Name.new [
+          ['CN', @common_name],
+          ['O',  @organization],
+          ['C',  @country],
+          ['ST', @state_name],
+          ['L',  @locality]
+        ]
+      end
+
+  end
+end

data/lib/zerossl/http.rb

@@ -0,0 +1,70 @@
+require 'uri'
+require 'json'
+require 'net/http'
+
+module ZeroSSL
+  class HTTP
+
+    VERBS = {
+      get:  Net::HTTP::Get,
+      post: Net::HTTP::Post
+    }
+
+    Response = Struct.new(:code, :success, :body)
+
+    def initialize
+      @api_uri    = Setup.config.api_uri
+      @access_key = Setup.config.access_key
+      @logger     = Setup.config.logger
+      @user_agent = Setup.config.user_agent
+    end
+
+    def default_headers(opts = {})
+      {
+        'User-Agent'   => @user_agent,
+        'Content-Type' => 'application/json',
+      }.merge!(opts)
+    end
+
+    def default_params(opts = {})
+      {
+        'access_key' => @access_key
+      }.merge!(opts)
+    end
+
+    def get(path, options = {})
+      execute(path, :get, options)
+    end
+
+    def post(path, options = {})
+      execute(path, :post, options)
+    end
+
+    private
+      def execute (path, method, options = {})
+        # Build URL
+        url       = URI.join(@api_uri, path)
+        url.query = URI.encode_www_form(default_params.to_a)
+
+        # Build request
+        req = VERBS[method].new(url)
+        options.transform_keys!(&:to_s) unless options.empty?
+        default_headers.each{ |k,v| req[k] = v }
+        req.set_form_data(options.dig('body') || options || {})
+
+        # Execute request
+        ssl_conf = { :use_ssl => url.scheme == 'https' }
+        resp = Net::HTTP.start(url.hostname, url.port, ssl_conf) do |http|
+          http.request(req)
+        end
+
+        # Parse response
+        body = resp.body.empty? ? {} : JSON.parse(resp.body)
+        Response.new(resp.code.to_i, !body.dig('error'), body)
+
+        rescue => e
+          @logger.error(e.message) if @logger
+          raise e
+      end
+  end
+end

data/lib/zerossl/version.rb

@@ -0,0 +1,3 @@
+module ZeroSSL
+  VERSION = "0.1.0"
+end

data/zerossl.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/zerossl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zerossl"
+  spec.version       = ZeroSSL::VERSION
+  spec.authors       = ["creadone"]
+  spec.email         = ["creadone@gmail.com"]
+
+  spec.summary       = %q{Ruby client to obtain SSL certificate from ZeroSSL via REST API}
+  spec.description   = %q{Ruby client to obtain SSL certificate from ZeroSSL via REST API}
+  spec.homepage      = "https://github.com/creadone/zerossl"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/creadone/zerossl"
+
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.11'
+
+  # 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"]
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: zerossl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- creadone
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Ruby client to obtain SSL certificate from ZeroSSL via REST API
+email:
+- creadone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zerossl.rb
+- lib/zerossl/client.rb
+- lib/zerossl/config.rb
+- lib/zerossl/constants.rb
+- lib/zerossl/csr.rb
+- lib/zerossl/http.rb
+- lib/zerossl/version.rb
+- zerossl.gemspec
+homepage: https://github.com/creadone/zerossl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/creadone/zerossl
+  source_code_uri: https://github.com/creadone/zerossl
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby client to obtain SSL certificate from ZeroSSL via REST API
+test_files: []