localhost 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47320a58186ec6b563f8b2f33605a8a5b089bad34372b96b8f75bcf5e46bc702
+  data.tar.gz: d5881e19b6cfc2e12dabd2b8a0fc05d1a5e58e9440f45013d0220c5f398999c1
+SHA512:
+  metadata.gz: a14c685f31632fec950b0adad3717497a1981f94ca19b3851d955a97422035d12809677106e3515a29dc2575bd3edbd457c7eb5401506c474e09b180e103e52d
+  data.tar.gz: 2e47b4b98fb60fdc885a971b744d8eeda298e29aa3cbe2d9a47586d8926758e56fd9e547ff05840fd0b34153e714c97d7f1022f100c11a4959589aff87b275c6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+sudo: required
+dist: xenial
+cache: bundler
+
+before_script:
+  - gem update --system
+  - gem install bundler
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

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 localhost.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# Localhost [![Build Status](https://travis-ci.com/socketry/localhost.svg)](https://travis-ci.com/socketry/localhost)
+
+This gem provides a convenient API for generating per-user self-signed root certificates.
+
+## Motivation
+
+HTTP/2 requires SSL in web browsers. If you want to use HTTP/2 for development (and you should), you need to start using URLs like `https://localhost:8080`. In most cases, this requires adding a self-signed certificate to your certificate store (e.g. Keychain on macOS), and storing the private key for the web-server to use.
+
+I wanted to provide a server-agnostic way of doing this, primarily because I think it makes sense to minimise the amount of junky self-signed keys you add to your certificate store for `localhost`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'localhost'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install localhost
+
+## Usage
+
+This example shows how to generate a certificate for an SSL secured web server:
+
+```ruby
+require 'localhost/authority'
+
+authority = Localhost::Authority.fetch
+
+OpenSSL::SSL::SSLContext.new.tap do |context|
+	context.cert = authority.certificate
+	context.key = authority.key
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## See Also
+
+- [falcon](https://github.com/socketry/falcon) — Uses this `Localhost::Authority` to provide HTTP/2 with minimal configuration for `localhost`.
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/localhost.rb

@@ -0,0 +1,21 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require "localhost/version"

data/lib/localhost/authority.rb

@@ -0,0 +1,112 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'yaml'
+require 'openssl'
+
+module Localhost
+	class Authority
+		def self.path
+			File.expand_path("~/.localhost")
+		end
+		
+		def self.fetch(*args)
+			authority = self.new(*args)
+			path = self.path
+			
+			unless authority.load(path)
+				Dir.mkdir(path, 0700) unless File.directory?(path)
+				
+				authority.save(path)
+			end
+			
+			return authority
+		end
+		
+		def initialize(hostname = "localhost")
+			@hostname = hostname
+			
+			@key = nil
+			@name = nil
+			@certificate = nil
+		end
+		
+		def key
+			@key ||= OpenSSL::PKey::RSA.new(1024)
+		end
+		
+		def name
+			@name ||= OpenSSL::X509::Name.parse("O=Development/CN=#{@hostname}")
+		end
+		
+		def certificate
+			@certificate ||= OpenSSL::X509::Certificate.new.tap do |certificate|
+				certificate.subject = self.name
+				# We use the same issuer as the subject, which makes this certificate self-signed:
+				certificate.issuer = self.name
+				
+				certificate.public_key = self.key.public_key
+				
+				certificate.serial = 1
+				
+				certificate.not_before = Time.now
+				certificate.not_after = Time.now + (3600 * 24 * 365 * 10)
+				
+				extension_factory = OpenSSL::X509::ExtensionFactory.new
+				extension_factory.subject_certificate = certificate
+				extension_factory.issuer_certificate = certificate
+				
+				certificate.sign self.key, OpenSSL::Digest::SHA256.new
+			end
+		end
+		
+		# The certificate store which is used for validating the server certificate:
+		def store
+			@store ||= OpenSSL::X509::Store.new.tap do |store|
+				store.add_cert(self.certificate)
+			end
+		end
+		
+		def load(path)
+			if File.directory? path
+				key_path = File.join(path, "#{@hostname}.key")
+				return false unless File.exist?(key_path)
+				@key = OpenSSL::PKey::RSA.new(File.read(key_path))
+				
+				certificate_path = File.join(path, "#{@hostname}.crt")
+				@certificate = OpenSSL::X509::Certificate.new(File.read(certificate_path))
+				
+				return true
+			end
+		end
+		
+		def save(path)
+			File.write(
+				File.join(path, "#{@hostname}.crt"),
+				self.certificate.to_pem
+			)
+			
+			File.write(
+				File.join(path, "#{@hostname}.key"),
+				self.key.to_pem
+			)
+		end
+	end
+end

data/lib/localhost/version.rb

@@ -0,0 +1,23 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Localhost
+	VERSION = "1.0.0"
+end

data/localhost.gemspec

@@ -0,0 +1,22 @@
+
+require_relative "lib/localhost/version"
+
+Gem::Specification.new do |spec|
+	spec.name          = "localhost"
+	spec.version       = Localhost::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+
+	spec.summary       = "Manage a local certificate authority for self-signed localhost development servers."
+	spec.homepage      = "https://github.com/socketry/localhost"
+
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.16"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: localhost
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-03 00:00:00.000000000 Z
+dependencies:
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/localhost.rb
+- lib/localhost/authority.rb
+- lib/localhost/version.rb
+- localhost.gemspec
+homepage: https://github.com/socketry/localhost
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Manage a local certificate authority for self-signed localhost development
+  servers.
+test_files: []