huginn_http_observatory_mozilla_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5def8a9eb7fd957624e84d0f87b5bd8cde8caa3d213567b7468646d2403603ec
+  data.tar.gz: 15e51a00ad7811aa56150dd9c7d6f6fbbfa43bad5b6df6c389bd5b527a530dc4
+SHA512:
+  metadata.gz: d22f721334f3c227049b50c7aa3630217956dd080eed629284bd809d38bb4c15dfd81fac7ce52d5940c06ab8f2668d5ffb406f67b585665b9e12a97cf5eacd61
+  data.tar.gz: d123d7789e0050fb0630687f679ded99bda7da94e4f2b52a6aa852c23fe612ff75ef8eb30062c3a7ce5c3138d620fc4cd7100f8f6b34995f83971ef6cd88f111

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Nicolas Germain
+
+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/lib/huginn_http_observatory_mozilla_agent/http_observatory_mozilla_agent.rb

@@ -0,0 +1,162 @@
+module Agents
+  class HttpObservatoryMozillaAgent < Agent
+    include FormConfigurable
+    can_dry_run!
+    no_bulk_receive!
+    default_schedule 'every_1d'
+
+    description do
+      <<-MD
+      The Http Observatory Mozilla Agent is used to test the state of security for websites on the public internet with Mozilla API.
+
+      `site` wanted hostname.
+
+      `hidden` setting to "true" will hide a scan from public results returned by getRecentScans.
+
+      `rescan` setting to "true" forces a rescan of a site.
+
+      `debug` is used to verbose mode.
+
+      `expected_receive_period_in_days` is used to determine if the Agent is working. Set it to the maximum number of days
+      that you anticipate passing without this Agent receiving an incoming Event.
+      MD
+    end
+
+    event_description <<-MD
+      Events look like this:
+
+          {
+            "algorithm_version": 2,
+            "end_time": "Wed, 15 Jun 2022 19:07:19 GMT",
+            "grade": "B-",
+            "hidden": false,
+            "likelihood_indicator": "MEDIUM",
+            "response_headers": {
+              "Cache-Control": "max-age=0, private, must-revalidate",
+              "Content-Type": "text/html; charset=utf-8",
+              "Date": "Wed, 15 Jun 2022 19:07:17 GMT",
+              "Etag": "W/\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"",
+              "Referrer-Policy": "strict-origin-when-cross-origin",
+              "Set-Cookie": "_rails_session=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX; path=/; HttpOnly",
+              "Strict-Transport-Security": "max-age=63072000; includeSubDomains",
+              "Transfer-Encoding": "chunked",
+              "Vary": "Origin",
+              "X-Content-Type-Options": "nosniff",
+              "X-Download-Options": "noopen",
+              "X-Frame-Options": "DENY",
+              "X-Permitted-Cross-Domain-Policies": "none",
+              "X-Request-Id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+              "X-Runtime": "0.011662",
+              "X-Xss-Protection": "1; mode=block"
+            },
+            "scan_id": 27190361,
+            "score": 65,
+            "start_time": "Wed, 15 Jun 2022 19:07:15 GMT",
+            "state": "FINISHED",
+            "status_code": 200,
+            "tests_failed": 2,
+            "tests_passed": 10,
+            "tests_quantity": 12
+          }
+    MD
+
+    def default_options
+      {
+        'debug' => 'false',
+        'expected_receive_period_in_days' => '2',
+        'hidden' => 'false',
+        'rescan' => 'false',
+        'changes_only' => 'true'
+      }
+    end
+
+    form_configurable :expected_receive_period_in_days, type: :string
+    form_configurable :site, type: :string
+    form_configurable :changes_only, type: :boolean
+    form_configurable :debug, type: :boolean
+    form_configurable :hidden, type: :boolean
+    form_configurable :rescan, type: :boolean
+
+    def validate_options
+      if options.has_key?('changes_only') && boolify(options['changes_only']).nil?
+        errors.add(:base, "if provided, changes_only must be true or false")
+      end
+
+      if options.has_key?('debug') && boolify(options['debug']).nil?
+        errors.add(:base, "if provided, debug must be true or false")
+      end
+
+      unless options['expected_receive_period_in_days'].present? && options['expected_receive_period_in_days'].to_i > 0
+        errors.add(:base, "Please provide 'expected_receive_period_in_days' to indicate how many days can pass before this Agent is considered to be not working")
+      end
+
+      if options.has_key?('hidden') && boolify(options['hidden']).nil?
+        errors.add(:base, "if provided, hidden must be true or false")
+      end
+
+      if options.has_key?('rescan') && boolify(options['rescan']).nil?
+        errors.add(:base, "if provided, rescan must be true or false")
+      end
+    end
+
+    def working?
+      event_created_within?(options['expected_receive_period_in_days']) && !recent_error_logs?
+    end
+
+    def check
+      check_status
+    end
+
+    private
+
+    def check_site()
+      uri = URI.parse("https://http-observatory.security.mozilla.org/api/v1/analyze?host=#{interpolated['site']}&hidden=#{interpolated['hidden']}&rescan=#{interpolated['rescan']}")
+      request = Net::HTTP::Post.new(uri)
+      
+      req_options = {
+        use_ssl: uri.scheme == "https",
+      }
+      
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      log "request  status : #{response.code}"
+
+      payload = JSON.parse(response.body)
+
+      if interpolated['debug'] == 'true'
+        log payload
+      end
+      return payload
+    end
+
+    def check_status()
+      payload = check_site()
+      if interpolated['debug'] == 'true'
+        log payload['state']
+      end
+      if payload['state'] == 'PENDING'
+        sleep(30)
+        payload = check_site()
+      end
+      if interpolated['changes_only'] == 'true'
+        if payload.to_s != memory['last_status']
+          if !memory['last_status'].nil?
+            if payload['score'] != memory['last_status']['score']
+              create_event payload: payload
+            end
+          else
+            create_event payload: payload
+          end
+          memory['last_status'] = payload.to_s
+        end
+      else
+        create_event payload: payload
+        if payload.to_s != memory['last_status']
+          memory['last_status'] = payload.to_s
+        end
+      end
+    end
+  end
+end

data/lib/huginn_http_observatory_mozilla_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_http_observatory_mozilla_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_http_observatory_mozilla_agent/http_observatory_mozilla_agent'

data/spec/http_observatory_mozilla_agent_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::HttpObservatoryMozillaAgent do
+  before(:each) do
+    @valid_options = Agents::HttpObservatoryMozillaAgent.new.default_options
+    @checker = Agents::HttpObservatoryMozillaAgent.new(:name => "HttpObservatoryMozillaAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  pending "add specs here"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_http_observatory_mozilla_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Nicolas Germain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- ngermain@hihouhou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_http_observatory_mozilla_agent.rb
+- lib/huginn_http_observatory_mozilla_agent/http_observatory_mozilla_agent.rb
+- spec/http_observatory_mozilla_agent_spec.rb
+homepage: https://github.com/hihouhou/huginn_http_observatory_mozilla_agent
+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: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because Rubygems requires one.
+test_files:
+- spec/http_observatory_mozilla_agent_spec.rb