internet_security_event 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4983418aad1987cf8bb74e94f9d472aa766977d301b9fd213cc500b3887edc1c
+  data.tar.gz: d45b6627aca7593463b8c6d082311a4bd457642620263f36458a6556d301aae2
+SHA512:
+  metadata.gz: f746311b39c632eabebad17a08b91e89f6f89ae5f0b893cafdcce8be8364ce5bbde6176803f2dd47ff73a30ae7ac4156ba00767bcffea4640c8749821ab7728c
+  data.tar.gz: d28ead27e04380af4131b97c6f5c18629cc0b165b94f6c07560f08138534671c405b780fb45f46a1c4ccff4fe8e8b0079e81259421e7c8320b7fe276f90a27a5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+spec/examples.txt

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+language: ruby
+rvm:
+  - 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/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 romain@blogreen.org. 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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tls_event.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Romain Tartière
+
+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,84 @@
+# InternetSecurityEvent
+
+[![Build Status](https://travis-ci.com/smortex/internet_security_event.svg?branch=master)](https://travis-ci.com/smortex/internet_security_event)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bc64fb4f1c1088c15b8c/maintainability)](https://codeclimate.com/github/smortex/internet_security_event/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/bc64fb4f1c1088c15b8c/test_coverage)](https://codeclimate.com/github/smortex/internet_security_event/test_coverage)
+
+Build events describing the status of various internet services
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'internet_security_event'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install internet_security_event
+
+## Usage
+
+This gem can generate events about:
+
+* `TLSStatus` — Status of a TLS connexions (combining the status of the X.509
+  certificate and the validity of the hostname hostname);
+* `X509Status` — Status of an X.509 certificates.
+
+Usage is basically:
+
+```ruby
+
+certificate = OpenSSL::X509::Certificate.new(...)
+
+event = InternetSecurityEvent::X509Status.build(certificate)
+
+event[:state]       #=> 'ok', 'warn', 'critical'
+event[:description] #=> Human readable state
+event[:metric]      #=> an optional Float
+```
+
+With just a bit more context (e.g. setting `:host` and `:service`), these
+events are tailored to be send to [Riemann](http://riemann.io/).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` 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/smortex/internet_security_event. 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.
+
+1. Fork it (https://github.com/smortex/internet_security_event/fork)
+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 a new Pull Request
+
+## 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 InternetSecurityEvent project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/smortex/internet_security_event/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'internet_security_event'
+
+# 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/internet_security_event.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'internet_security_event/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'internet_security_event'
+  spec.version       = InternetSecurityEvent::VERSION
+  spec.authors       = ['Romain Tartière']
+  spec.email         = ['romain@blogreen.org']
+
+  spec.summary       = 'Build events describing the status of various internet services'
+  spec.homepage      = 'https://github.com/smortex/internet_security_event'
+  spec.license       = 'MIT'
+
+  # 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
+    `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 'actionview', '~> 5.2'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/internet_security_event/now.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module InternetSecurityEvent
+  class Now
+    include Singleton
+
+    def initialize
+      @now = Time.at(Time.now.to_i)
+    end
+
+    attr_reader :now
+  end
+end

data/lib/internet_security_event/tls_status.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'internet_security_event/x509_status'
+
+module InternetSecurityEvent
+  class TLSStatus < X509Status
+    def initialize(hostname, certificate)
+      @hostname = hostname
+      super(certificate)
+    end
+
+    def self.build(hostname, certificate)
+      obj = new(hostname, certificate)
+      obj.to_e
+    end
+
+    private
+
+    def description
+      return 'certificate subject does not match hostname' unless hostname_is_valid_for_this_certificate?
+
+      super
+    end
+
+    def state
+      if !hostname_is_valid_for_this_certificate?
+        'critical'
+      else
+        super
+      end
+    end
+
+    def hostname_is_valid_for_this_certificate?
+      return true if hostname.nil?
+
+      hostname_match_subject? || hostname_match_subject_alternative_name?
+    end
+
+    def hostname_match_subject?
+      common_name == hostname
+    end
+
+    def hostname_match_subject_alternative_name?
+      return false unless certificate
+
+      san = certificate.extensions.select { |ext| ext.oid == 'subjectAltName' }.first
+      return san.value.split(', ').map { |name| name.sub(/\ADNS:/, '') }.include?(hostname) if san
+
+      false
+    end
+
+    def common_name
+      certificate.subject.to_a.select { |data| data[0] == 'CN' }.map { |data| data[1] }.first if certificate
+    end
+  end
+end

data/lib/internet_security_event/version.rb

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

data/lib/internet_security_event/x509_status.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require 'action_view/helpers'
+
+module InternetSecurityEvent
+  class X509Status
+    include ActionView::Helpers::DateHelper
+
+    attr_reader :certificate, :hostname
+
+    def initialize(certificate)
+      @certificate = certificate
+    end
+
+    def self.build(certificate)
+      obj = new(certificate)
+      obj.to_e
+    end
+
+    def to_e
+      {
+        state:       state,
+        description: description,
+        metric:      metric,
+        subject:     certificate.subject.to_s,
+        issuer:      certificate.issuer.to_s,
+        serial:      certificate.serial.to_i,
+        not_before:  certificate.not_before.to_s,
+        not_after:   certificate.not_after.to_s,
+      }
+    end
+
+    private
+
+    def description
+      return "certificate will become valid in #{distance_of_time_in_words_to_now(certificate.not_before)}" if not_valid_yet?
+      return "certificate has expired #{distance_of_time_in_words_to_now(certificate.not_after)} ago" if expired?
+
+      "certificate will expire in #{distance_of_time_in_words_to_now(certificate.not_after)}"
+    end
+
+    def state
+      if not_valid_yet? || expired_or_expire_soon?
+        'critical'
+      elsif expire_soonish?
+        'warn'
+      else
+        'ok'
+      end
+    end
+
+    def metric
+      certificate.not_after - now
+    end
+
+    def not_valid_yet?
+      now < certificate.not_before
+    end
+
+    def expired_or_expire_soon?
+      now + 3600 * 24 * 2 > certificate.not_after
+    end
+
+    def expired?
+      now > certificate.not_after
+    end
+
+    def expire_soonish?
+      now + 3600 * 24 * 14 > certificate.not_after
+    end
+
+    def now
+      Now.instance.now
+    end
+  end
+end

data/lib/internet_security_event.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'internet_security_event/now'
+require 'internet_security_event/tls_status'
+require 'internet_security_event/x509_status'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: internet_security_event
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Romain Tartière
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- romain@blogreen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- internet_security_event.gemspec
+- lib/internet_security_event.rb
+- lib/internet_security_event/now.rb
+- lib/internet_security_event/tls_status.rb
+- lib/internet_security_event/version.rb
+- lib/internet_security_event/x509_status.rb
+homepage: https://github.com/smortex/internet_security_event
+licenses:
+- MIT
+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.8
+signing_key: 
+specification_version: 4
+summary: Build events describing the status of various internet services
+test_files: []