tls-checker 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 326f4de5b655454e93e3453e227d4fb05f70cd8bb3c2e55ebfcd2da42dac2dd3
-  data.tar.gz: ee887d5def9bebaf1feca5edd1a1fc400b8d4e783e690886e4562c7d8a0e5e55
+  metadata.gz: 9ccd4eba7911d06f807a01d764d0b80f093db49e89449839753ca00e2d0b6d27
+  data.tar.gz: 85b6da4d7ffb72506fa2d6faf83606bb23c433a6213c8aef97eac85f48ac93dc
 SHA512:
-  metadata.gz: 0e76c9ad4a2c28eac92217092fbade0cca5d99b389df5fe7d910cec5bc11eba26178b429fea87420724b24d4695e8561348ba87e5d0b704e7f9cae46887f1474
-  data.tar.gz: 2049b8cbfe64603900503fd4c4d75cef18b6d7693c325a1a359a3c75f34f0a420df0a27ba921ebe53954fef34134a7d07d5617fb0e70f90e3966c2ac58d1318b
+  metadata.gz: 7badaf4cd118abcc424bacb4715406aa08c6314951f6231e4729ff5f7033d49ae827da3e2ef2c6fc965b415523d0ca3dd5432676cd9e264bd55d483da8d82d84
+  data.tar.gz: eca28f0c927455a721dfe39b6ae7e61c4ec485a7d7a43c9a79391d9d78d5f4cfce373ebfe10726550e616e3db8567d3145b87a84ec99a06a05e436f143bb909a

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "0 17 * * *"
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: Run static code analysis
+        run: bundle exec rubocop
+  unit:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    strategy:
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests without uploading code coverage
+        if: ${{ matrix.ruby != '3.0' }}
+        run: bundle exec rake
+      - name: Run tests and upload coverage to Code Climate
+        if: ${{ matrix.ruby == '3.0' }}
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE_TOKEN }}
+        with:
+          coverageCommand: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  AllowSymlinksInCacheRootDirectory: true
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Metrics/LineLength:
+  Max: 160
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+RSpec/NestedGroups:
+  Max: 8
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+Metrics/ClassLength:
+  Max: 200

data/CHANGELOG.md

@@ -2,11 +2,22 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.4.0]
+## [v2.0.0](https://github.com/smortex/tls-checker/tree/v2.0.0) (2022-07-16)
 
+[Full Changelog](https://github.com/smortex/tls-checker/compare/v1.4.0...v2.0.0)
+
+**Breaking changes:**
+
+- Bump internet\_security\_event dependency [\#2](https://github.com/smortex/tls-checker/pull/2) ([smortex](https://github.com/smortex))
+
+**Merged pull requests:**
+
+- Integrate github\_changelog\_generator [\#1](https://github.com/smortex/tls-checker/pull/1) ([smortex](https://github.com/smortex))
+
+## [v1.4.0]
 ### Added
 
 - New metadata in generated events: af (address fanily, one of 'inet' and
@@ -16,38 +27,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Ensure events' ttl is an Integer.
 
-## [1.3.0]
-
+## [v1.3.0]
 ### Changed
 
 - Revert to the pre-1.2.0 behavior when a remote service is not reachable and
   emit a critical event.
 
-## [1.2.0]
-
+## [v1.2.0]
 ### Changed
 
 - Skip completely TLSA check if a connexion certificate cannot be fetched;
 - Do not generate an event when a connexion to a remote service is not
   possible.
 
-## [1.1.1]
-
+## [v1.1.1]
 ### Changed
 
 - Handle Errno::EHOSTUNREACH exceptions gracefully when attempting to fetch a
   certificate.
 
-## [1.1.0]
-
+## [v1.1.0]
 ### Added
 
 - Make it possible to test services using an IP address;
 - Report validity of certificates when a TLSA record is found in the DNS.
 
-[Unreleased]: https://github.com/smortex/tls-checker/compare/v1.4.0...HEAD
-[1.4.0]: https://github.com/smortex/tls-checker/compare/v1.3.0...v1.4.0
-[1.3.0]: https://github.com/smortex/tls-checker/compare/v1.2.0...v1.3.0
-[1.2.0]: https://github.com/smortex/tls-checker/compare/v1.1.1...v1.2.0
-[1.1.1]: https://github.com/smortex/tls-checker/compare/v1.1.0...v1.1.1
-[1.1.0]: https://github.com/smortex/tls-checker/compare/v1.0.0...v1.1.0
+[v1.4.0]: https://github.com/smortex/tls-checker/compare/v1.3.0...v1.4.0
+[v1.3.0]: https://github.com/smortex/tls-checker/compare/v1.2.0...v1.3.0
+[v1.2.0]: https://github.com/smortex/tls-checker/compare/v1.1.1...v1.2.0
+[v1.1.1]: https://github.com/smortex/tls-checker/compare/v1.1.0...v1.1.1
+[v1.1.0]: https://github.com/smortex/tls-checker/compare/v1.0.0...v1.1.0
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -2,19 +2,5 @@
 
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
 # Specify your gem's dependencies in tls-checker.gemspec
 gemspec
-
-# rubocop:disable Security/Eval
-#
-# Gemfile.local is ignored in .gitignore.  When hacking this gem, it might be
-# useful to use a pre-release version of some dependency, in this case add them
-# to Gemfile.local:
-#
-# ------------------------------------- 8< -------------------------------------
-# gem 'internet_security_event', path: '../internet_security_event'
-# ------------------------------------- 8< -------------------------------------
-eval(File.read('Gemfile.local'), binding) if File.exist? 'Gemfile.local'
-# rubocop:enable Security/Eval

data/HISTORY.md

@@ -0,0 +1,40 @@
+## [v1.4.0]
+### Added
+
+- New metadata in generated events: af (address fanily, one of 'inet' and
+  'inet6'), hostname, address and port.
+
+### Changed
+
+- Ensure events' ttl is an Integer.
+
+## [v1.3.0]
+### Changed
+
+- Revert to the pre-1.2.0 behavior when a remote service is not reachable and
+  emit a critical event.
+
+## [v1.2.0]
+### Changed
+
+- Skip completely TLSA check if a connexion certificate cannot be fetched;
+- Do not generate an event when a connexion to a remote service is not
+  possible.
+
+## [v1.1.1]
+### Changed
+
+- Handle Errno::EHOSTUNREACH exceptions gracefully when attempting to fetch a
+  certificate.
+
+## [v1.1.0]
+### Added
+
+- Make it possible to test services using an IP address;
+- Report validity of certificates when a TLSA record is found in the DNS.
+
+[v1.4.0]: https://github.com/smortex/tls-checker/compare/v1.3.0...v1.4.0
+[v1.3.0]: https://github.com/smortex/tls-checker/compare/v1.2.0...v1.3.0
+[v1.2.0]: https://github.com/smortex/tls-checker/compare/v1.1.1...v1.2.0
+[v1.1.1]: https://github.com/smortex/tls-checker/compare/v1.1.0...v1.1.1
+[v1.1.0]: https://github.com/smortex/tls-checker/compare/v1.0.0...v1.1.0

data/README.md

@@ -1,6 +1,6 @@
 # tls-checker
 
-[![Build Status](https://travis-ci.com/smortex/tls-checker.svg?branch=master)](https://travis-ci.com/smortex/tls-checker)
+[![Build Status](https://github.com/smortex/tls-checker/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/smortex/tls-checker/actions/workflows/ci.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/272ab98a6ec1b28e5f7d/maintainability)](https://codeclimate.com/github/smortex/tls-checker/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/272ab98a6ec1b28e5f7d/test_coverage)](https://codeclimate.com/github/smortex/tls-checker/test_coverage)
 
@@ -52,4 +52,4 @@ License](https://opensource.org/licenses/MIT).
 
 Everyone interacting in the tls-checker project’s codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/smortex/tls-checker/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/smortex/tls-checker/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,7 +1,27 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'github_changelog_generator/task'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec)
 
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.header = <<~HEADER.chomp
+    # Changelog
+
+    All notable changes to this project will be documented in this file.
+
+    The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+    and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+  HEADER
+  config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog ignore]
+  config.user = 'smortex'
+  config.project = 'tls-checker'
+  config.since_tag = 'v1.4.0'
+  config.issues = false
+  require 'tls_checker/version'
+  config.future_release = "v#{TLSChecker::VERSION}"
+end
+
 task default: :spec

data/exe/tls-checker

@@ -3,7 +3,7 @@
 
 require 'json'
 require 'optparse'
-require 'tls-checker'
+require 'tls_checker'
 
 options = {
   output: $stdout,
@@ -11,6 +11,7 @@ options = {
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: tls-checker [options] specification...'
+  opts.version = TLSChecker::VERSION
 
   opts.on('-o', '--output=FILE', 'Write to FILE') do |f|
     options[:output] = File.open(f, File::CREAT | File::APPEND | File::LOCK_EX)

data/lib/{tls-checker → tls_checker}/certificate_checker.rb

@@ -19,7 +19,7 @@ module TLSChecker
 
     attr_reader :hostname, :address, :port, :starttls
 
-    def to_e
+    def to_e # rubocop:disable Metrics/MethodLength
       if certificate
         InternetSecurityEvent::TLSStatus.build(hostname, certificate)
       else
@@ -134,14 +134,14 @@ module TLSChecker
       tls_socket.hostname = hostname
       begin
         tls_socket.connect
-      rescue OpenSSL::SSL::SSLError # rubocop:disable Lint/HandleExceptions
+      rescue OpenSSL::SSL::SSLError
         # This may fail for example if a client certificate is required
       end
       tls_socket
     end
 
     def my_hostname
-      Socket.gethostbyname(Socket.gethostname).first
+      Addrinfo.tcp(Socket.gethostname, 8023).getnameinfo.first
     rescue SocketError
       Socket.gethostname
     end

data/lib/{tls-checker → tls_checker}/certificate_checker_factory.rb

@@ -8,7 +8,7 @@ module TLSChecker
       @resolver = Resolv::DNS.new
     end
 
-    def certificate_checkers_for(specification)
+    def certificate_checkers_for(specification) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       hostname, port, starttls = specification.split(':', 3)
 
       port = port.to_i if port

data/lib/{tls-checker → tls_checker}/line_oriented_socket.rb

@@ -36,11 +36,9 @@ module TLSChecker
     def timed_getbyte
       recv_nonblock(1)
     rescue IO::EAGAINWaitReadable
-      if IO.select([self], nil, nil, 10)
-        recv_nonblock(1)
-      else
-        raise SocketRecvTimeout
-      end
+      raise SocketRecvTimeout unless IO.select([self], nil, nil, 10)
+
+      recv_nonblock(1)
     end
   end
 end

data/lib/{tls-checker → tls_checker}/tlsa_checker_factory.rb

@@ -43,7 +43,7 @@ module TLSChecker
       @resolver.getresources(resource, Resolv::DNS::Resource::IN::ANY).each do |rr|
         # XXX: Should we check the RRSIG here, or can we assume that the resolver
         # should have failed if it could not verify the response?
-        next unless rr.class.name == 'Resolv::DNS::Resource::Generic::Type52_Class1'
+        next unless rr.instance_of?(Resolv::DNS::Resource::Generic::Type52_Class1)
 
         record = Resolv::DNS::Resource::IN::TLSA.new(rr.data)
         yield(record)

data/lib/tls_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TLSChecker
+  VERSION = '2.0.0'
+end

data/lib/tls_checker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'tls_checker/certificate_checker'
+require 'tls_checker/certificate_checker_factory'
+require 'tls_checker/line_oriented_socket'
+require 'tls_checker/tlsa_checker'
+require 'tls_checker/tlsa_checker_factory'

data/tls-checker.gemspec

@@ -2,32 +2,37 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tls-checker/version'
+require 'tls_checker/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'tls-checker'
-  spec.version       = TlsChecker::VERSION
+  spec.version       = TLSChecker::VERSION
   spec.authors       = ['Romain Tartière']
   spec.email         = ['romain@blogreen.org']
 
   spec.summary       = 'Report expired/about to expires certificates used in TLS connexions'
   spec.homepage      = 'https://github.com/smortex/tls-checker'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   # 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(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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 'internet_security_event', '~> 1.1'
+  spec.add_dependency 'internet_security_event', '~> 2.0'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'midi-smtp-server'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tls-checker
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Romain Tartière
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2022-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: internet_security_event
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: midi-smtp-server
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - romain@blogreen.org
 executables:
@@ -102,31 +158,33 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - exe/tls-checker
-- lib/tls-checker.rb
-- lib/tls-checker/certificate_checker.rb
-- lib/tls-checker/certificate_checker_factory.rb
-- lib/tls-checker/line_oriented_socket.rb
-- lib/tls-checker/tlsa_checker.rb
-- lib/tls-checker/tlsa_checker_factory.rb
-- lib/tls-checker/version.rb
+- lib/tls_checker.rb
+- lib/tls_checker/certificate_checker.rb
+- lib/tls_checker/certificate_checker_factory.rb
+- lib/tls_checker/line_oriented_socket.rb
+- lib/tls_checker/tlsa_checker.rb
+- lib/tls_checker/tlsa_checker_factory.rb
+- lib/tls_checker/version.rb
 - tls-checker.gemspec
 homepage: https://github.com/smortex/tls-checker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,15 +192,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.3.17
+signing_key:
 specification_version: 4
 summary: Report expired/about to expires certificates used in TLS connexions
 test_files: []

data/.travis.yml

@@ -1,13 +0,0 @@
----
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/lib/tls-checker/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module TlsChecker
-  VERSION = '1.4.0'
-end

data/lib/tls-checker.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'tls-checker/certificate_checker'
-require 'tls-checker/certificate_checker_factory'
-require 'tls-checker/line_oriented_socket'
-require 'tls-checker/tlsa_checker'
-require 'tls-checker/tlsa_checker_factory'