knowngithub 0.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1558981157ccbd8a9a6813f322c35ca067144616
-  data.tar.gz: 2f7725e9cf5b14c844d68dab2034587608674ec8
+SHA256:
+  metadata.gz: 2d7d7da09ed4907c9f2219edce99f97c0b165ea6b574a8a174f4257f5c995fe3
+  data.tar.gz: bbb565d8cdda162d8dc329f538663b4ae3b9d660c854de47677f5a7cd9f591da
 SHA512:
-  metadata.gz: 7b725ce302e80464a62e7520f2a3a6bb597895bc25d34e37b9c97d21a29a4f8335cfb00dd3c3d77f5745faf07c91f03e4270521b723cfede4633ff6ae1e50e94
-  data.tar.gz: a2ab935cb1cc4c7ca0cb10b22ab60b72264e0abd70c2bd43321c06f5ef9ec4ccda3d07c4513dcb13681e979990e53cc5eddb8414d69185487675616365ad8847
+  metadata.gz: 0c9ad27a0cd4a57fb79d543847e407d2436ced6a5baa754be1d9959c467d3815cd35fdcdce704a073fe05e07aeb1640c719ee311402f27437dce816f792d679d
+  data.tar.gz: 6778ef1990e4dda27773330ef3b79aab6a472679715a0086f8558df92d491b09495178c3153e4ec236057c5079dd97caf3f6737febc47c581ca3939d2bee7c48

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -1,18 +1,20 @@
 PATH
   remote: .
   specs:
-    knowngithub (0.1.0)
+    knowngithub (1.0.0)
       net-ssh (~> 4.2)
-      nokogiri (~> 1.8)
+      nokogiri (~> 1.10.8)
+      thor (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     net-ssh (4.2.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    rake (10.5.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.3)
+    thor (0.20.3)
 
 PLATFORMS
   ruby
@@ -20,7 +22,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   knowngithub!
-  rake (~> 10.0)
+  rake (~> 12.3.3)
 
 BUNDLED WITH
-   1.16.0
+   1.17.2

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "knowngithub"
+require 'bundler/setup'
+require 'knowngithub'
 
 # 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.
@@ -10,5 +10,5 @@ require "knowngithub"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/knowngithub

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'knowngithub'
+require 'thor'
+
+module Application
+  # Thor class for CLI doage.
+  # @return [Null]
+  # @since 0.2.0
+  class CLI < Thor
+    desc 'hosts', 'writes out a list of known hosts to a target file'
+    def hosts(target=nil)
+      knownhosts = Knowngithub.known_hosts.sort { |x, y| x <=> y }
+
+      if target
+        File.open(target, 'w') do |file|
+          file.puts(knownhosts.join("\n"))
+        end
+        STDERR.puts "Wrote #{knownhosts.length} hosts to #{target}"
+      else
+        $stdout << knownhosts.join("\n")
+      end
+    end
+  end
+end
+
+Application::CLI.start(ARGV)

data/knowngithub.gemspec

@@ -1,36 +1,37 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "knowngithub/version"
+require 'knowngithub/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "knowngithub"
+  spec.name          = 'knowngithub'
   spec.version       = Knowngithub::VERSION
-  spec.authors       = ["Alexis Vanier"]
-  spec.email         = ["alexis@amonoid.io"]
+  spec.authors       = ['Alexis Vanier']
+  spec.email         = ['alexis@amonoid.io']
 
   spec.summary       = "Don't blindly trust GitHub hosts"
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/avanier/knowngithub"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/avanier/knowngithub'
+  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'
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_runtime_dependency "net-ssh", "~> 4.2"
-  spec.add_runtime_dependency "nokogiri", "~> 1.8"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_runtime_dependency 'net-ssh', '~> 4.2'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.10.8'
+  spec.add_runtime_dependency 'thor', '~> 0.20'
 end

data/lib/knowngithub.rb

@@ -5,7 +5,7 @@ require 'uri'
 
 require 'net/ssh'
 require 'nokogiri'
-require "knowngithub/version"
+require 'knowngithub/version'
 
 module Knowngithub
   # Make a call enforcing the strict use of SSL.
@@ -25,20 +25,21 @@ module Knowngithub
 
   # Queries and parses the GitHub help page for the SSH key fingerprints.
   # @return [Array<String>] SSH key fingerprints as an array of strings.
-  # @since 0.1.0
+  # @since 1.0.0
   def self.fingerprints
     pattern = /^(sha256:[a-z0-9\+\/]{43})|([0-9a-f\:]{32,47})$/i
-    res = self.safe_call('https://help.github.com/articles/github-s-ssh-key-fingerprints/')
+    res = safe_call('https://help.github.com/en/github/authenticating-to-github/githubs-ssh-key-fingerprints')
+
     output = Nokogiri::HTML(res.body)
-    fields = output.xpath("//code")
-    return fields.children.map(&:content).select{ |x| pattern =~ x }
+    fields = output.xpath('//code')
+    fields.children.map(&:content).select { |x| pattern =~ x }
   end
 
   # Instantiates a Net::SSH session with GitHub to get the host key and closes it.
   # @return [Net:SSH] Returns a closed Net::SSH session
   # @since 0.1.0
   def self.session
-    s = Net::SSH::Transport::Session.new('github.com', { :verify_host_key => true })
+    s = Net::SSH::Transport::Session.new('github.com', verify_host_key: true)
     s.close
     s
   end
@@ -48,13 +49,13 @@ module Knowngithub
   # @raise [SecurityError] If the host keys fail validation or if the https call fails, this will be raised.
   # @since 0.1.0
   def self.host
-    s = self.session
-    if self.fingerprints.any?{|f| f == s.host_keys.first.fingerprint}
-      base64_key = [Net::SSH::Buffer.from(:key, s.host_keys.first).to_s].pack("m*").gsub(/\s/, "")
+    s = session
+    if fingerprints.any? { |f| f == s.host_keys.first.fingerprint }
+      base64_key = [Net::SSH::Buffer.from(:key, s.host_keys.first).to_s].pack('m*').gsub(/\s/, '')
       return {
-        "host_as_string" => s.host_as_string,
-        "ssh_type" => s.host_keys.first.ssh_type,
-        "base64_key" => base64_key
+        'host_as_string' => s.host_as_string,
+        'ssh_type' => s.host_keys.first.ssh_type,
+        'base64_key' => base64_key
       }
     else
       raise SecurityError # while this is inappropriate, it sounds cool
@@ -65,22 +66,22 @@ module Knowngithub
   # @return [String] Returns a `known_hosts` entry for the fqdn only with no ip address binding as a string.
   # @since 0.1.0
   def self.known_host
-    h = self.host
-    return [ h["host_as_string"], h["ssh_type"], h["base64_key"] ].join(' ')
+    h = host
+    [h['host_as_string'], h['ssh_type'], h['base64_key']].join(' ')
   end
 
-  # Composes a block of text ready for appending to a known_hosts file
-  # @return [String] Returns a `known_hosts` multiline string enunciating every known IP GitHub may serve SSH on.
+  # Calls the `/meta` endpoint on GitHub's API via a safe https call and composes an array of entries ready for appending to a known_hosts file.
+  # @return [Array<String>] Returns an array of strings enunciating `known_hosts` entries for every known IP GitHub may serve SSH on.
   # @since 0.1.0
   def self.known_hosts
-    h = self.host
-    cidr_ranges = JSON.parse(self.safe_call('https://api.github.com/meta').body)["git"]
+    h = host
+    cidr_ranges = JSON.parse(safe_call('https://api.github.com/meta').body)['git']
     known_hosts = []
     cidr_ranges.each do |range|
-      IPAddr.new(range).to_range.to_a.map { |a| a.to_s }.each do |ip|
-        known_hosts << 'github.com,' + ip + ' ' + h["base64_key"]
+      IPAddr.new(range).to_range.to_a.map(&:to_s).each do |ip|
+        known_hosts << ["github.com,#{ip}", h['ssh_type'], h['base64_key']].join(' ')
       end
     end
-    return known_hosts
+    known_hosts
   end
 end

data/lib/knowngithub/version.rb

@@ -1,3 +1,3 @@
 module Knowngithub
-  VERSION = "0.1.0"
+  VERSION = '1.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knowngithub
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Alexis Vanier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -58,18 +58,33 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.10.8
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 description: Don't blindly trust GitHub hosts
 email:
 - alexis@amonoid.io
-executables: []
+executables:
+- knowngithub
 extensions: []
 extra_rdoc_files: []
 files:
@@ -81,6 +96,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/knowngithub
 - knowngithub.gemspec
 - lib/knowngithub.rb
 - lib/knowngithub/version.rb
@@ -104,8 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Don't blindly trust GitHub hosts