mihari 5.6.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9131a7f69be7cde564ec00479ae3fa3723a3e80d28690c3e989119de3feab5f5
-  data.tar.gz: b115531cc635b7767e6bcf75c8ca0376e4ade45772e98aa9fc07df3b2dcc2e96
+  metadata.gz: d661d9c83ba421776c4ca19e4a6fe19b980bbcbe86fe5e7628c1c3a15205e8a9
+  data.tar.gz: d3a26407b8f8146b86c70cbc443865ff895390ad6f32816f5873464c3f6b4e9d
 SHA512:
-  metadata.gz: 9a893bb138e769bf082bbea057229726f9b2e353fa539c9a1fb64aabcc8a622ed22315a0aa42e5dc873f6a13e3ec145776afe75203db93b7a3d2352d46b026b9
-  data.tar.gz: cd11791f340b58ffc39a03fba8ee2aad1da58fcf47fd8a00281fe8984d0149fa1e448aff4b55860b47e5fb424d994a40ab00f7691b416f315b3fbfdcd5737509
+  metadata.gz: 35a3783578b46a62dd3eafada97f27ad1701df53ad2b53179155daf4e9545feca0ba912d35c9ca9e8ccaf1f5ce5a15760850d723d55af51f80388b14fc41d95d
+  data.tar.gz: 8f7b3a5624c0ea5b677b32983e21ca731afb396c1904737b923c2b0082c7d1e3cac141e655eeae441150d01d4a26cd83b50665685211118efe9c4bfad512eeef

data/docs/analyzers/binaryedge.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
 ---
 
 # BinaryEdge

data/docs/analyzers/censys.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
 ---
 
 # Censys

data/docs/analyzers/circl.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
   - Passive DNS
   - Passive SSL
 ---

data/docs/analyzers/crtsh.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - Domain
+  - Artifact:Domain
 ---
 
 # crt.sh

data/docs/analyzers/dnstwister.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - Domain
+  - Artifact:Domain
 ---
 
 # dnstwister

data/docs/analyzers/greynoise.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
 ---
 
 # GreyNoise

data/docs/analyzers/hunterhow.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
 ---
 
 # Hunter How

data/docs/analyzers/index.md

@@ -26,29 +26,28 @@ All the analyzers can have optional `options`.
 analyzer: ...
 query: ...
 options:
-  timeout: ...
-  pagination_interval: ...
-  pagination_limit: ...
   retry_times: ...
   retry_interval: ...
   retry_exponential_backoff: ...
+  timeout: ...
   ignore_error: ...
 ```
 
-### Timeout
-
-`timeout` (`integer`) is an HTTP timeout in seconds. Optional.
-
-### Pagination Interval
-
-`pagination_interval` (`integer`) is an interval in seconds between pagination. Optional. Defaults to 0.
+Also the following analyzers can have pagination options.
 
-### Pagination Limit
-
-`pagination_limit` (`integer`) is an limit for pagination. Optional. Defaults to 100.
+- [Shodan](./shodan.md)
+- [BinaryEdge](./binaryedge.md)
+- [Censys](./censys.md)
+- [ZoomEye](./zoomeye.md)
+- [urlscan.io](./urlscan.md)
+- [VirusTotal Intelligence](./virustotal_intelligence.md)
+- [HunterHow](./hunterhow.md)
 
-In the worst case, if something wrong with Mihari or a service, Mihari can drain API quota by doing pagination forever.
-`pagination_limit` is a safety valve for that. A number of pagination is limited as `pagination_limit` times.
+```yaml
+options:
+  pagination_interval: ...
+  pagination_limit: ...
+```
 
 ### Retry Times
 
@@ -62,6 +61,10 @@ In the worst case, if something wrong with Mihari or a service, Mihari can drain
 
 `retry_exponential_backoff` (`bool`) controls whether to do exponential backoff. Optional. Defaults to `true`.
 
+### Timeout
+
+`timeout` (`integer`) is an HTTP timeout in seconds. Optional.
+
 ### Ignore Error
 
 `ignore_error` (`bool`) controls whether to ignore an error or not. Optional. Defaults to `false`.
@@ -87,3 +90,14 @@ queries:
   - analyzer: censys
     query: ip:8.8.8.8
 ```
+
+### Pagination Interval
+
+`pagination_interval` (`integer`) is an interval in seconds between pagination. Optional. Defaults to 0.
+
+### Pagination Limit
+
+`pagination_limit` (`integer`) is an limit for pagination. Optional. Defaults to 100.
+
+In the worst case, if something wrong with Mihari or a service, Mihari can drain API quota by doing pagination forever.
+`pagination_limit` is a safety valve for that. A number of pagination is limited as `pagination_limit` times.

data/docs/analyzers/onyphe.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
 ---
 
 # ONYPHE

data/docs/analyzers/otx.md

@@ -1,7 +1,7 @@
 ---
 tags:
-  - IP address
-  - Domain
+  - Artifact:IP
+  - Artifact:Domain
   - Passive DNS
 ---
 

data/docs/analyzers/passivetotal.md

@@ -1,7 +1,7 @@
 ---
 tags:
-  - IP address
-  - Domain
+  - Artifact:IP
+  - Artifact:Domain
   - Passive DNS
   - Passive SSL
   - Reverse Whois

data/docs/analyzers/pulsedive.md

@@ -1,7 +1,7 @@
 ---
 tags:
-  - IP address
-  - Domain
+  - Artifact:IP
+  - Artifact:Domain
   - Passive DNS
 ---
 

data/docs/analyzers/securitytrails.md

@@ -1,7 +1,7 @@
 ---
 tags:
-  - IP address
-  - Domain
+  - Artifact:IP
+  - Artifact:Domain
   - Passive DNS
   - Reverse Whois
 ---

data/docs/analyzers/shodan.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - IP address
+  - Artifact:IP
 ---
 
 # Shodan

data/docs/analyzers/urlscan.md

@@ -1,8 +1,8 @@
 ---
 tags:
-  - IP address
-  - Domain
-  - URL
+  - Artifact:IP
+  - Artifact:Domain
+  - Artifact:URL
 ---
 
 # urlscan.io

data/docs/analyzers/virustotal.md

@@ -1,7 +1,7 @@
 ---
 tags:
-  - IP address
-  - Domain
+  - Artifact:IP
+  - Artifact:Domain
   - Passive DNS
 ---
 

data/docs/analyzers/virustotal_intelligence.md

@@ -1,9 +1,9 @@
 ---
 tags:
-  - IP address
-  - Domain
-  - URL
-  - Hash
+  - Artifact:IP
+  - Artifact:Domain
+  - Artifact:URL
+  - Artifact:Hash
 ---
 
 # VirusTotal Intelligence

data/docs/analyzers/zoomeye.md

@@ -1,3 +1,8 @@
+---
+tags:
+  - Artifact:IP
+---
+
 # ZoomEye
 
 - [https://zoomeye.org/](https://zoomeye.org/)

data/docs/enrichers/google_public_dns.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - DNS record
+  - Enrichment:DNS_Record
 ---
 
 # Google Public DNS

data/docs/enrichers/ipinfo.md

@@ -1,7 +1,7 @@
 ---
 tags:
-  - Autonomous system
-  - Geolocation
+  - Enrichment:Autonomous_System
+  - Enrichment:Geolocation
 ---
 
 # ipinfo.io

data/docs/enrichers/shodan.md

@@ -1,11 +1,11 @@
 ---
 tags:
-  - Port
-  - CPE
-  - DNS record
+  - Enrichment:Port
+  - Enrichment:CPE
+  - Enrichment:DNS_Record
 ---
 
-# Shodan
+# Shodan (The InternetDB API)
 
 - [https://www.shodan.io/](https://www.shodan.io/dashboard)
 

data/docs/enrichers/whois.md

@@ -1,6 +1,6 @@
 ---
 tags:
-  - Whois
+  - Enrichment:Whois
 ---
 
 # Whois

data/frontend/package-lock.json

@@ -6925,9 +6925,9 @@
       }
     },
     "node_modules/vue-template-compiler": {
-      "version": "2.7.14",
-      "resolved": "https://registry.npmjs.org/vue-template-compiler/-/vue-template-compiler-2.7.14.tgz",
-      "integrity": "sha512-zyA5Y3ArvVG0NacJDkkzJuPQDF8RFeRlzV2vLeSnhSpieO6LK2OVbdLPi5MPPs09Ii+gMO8nY4S3iKQxBxDmWQ==",
+      "version": "2.7.15",
+      "resolved": "https://registry.npmjs.org/vue-template-compiler/-/vue-template-compiler-2.7.15.tgz",
+      "integrity": "sha512-yQxjxMptBL7UAog00O8sANud99C6wJF+7kgbcwqkvA38vCGF7HWE66w0ZFnS/kX5gSoJr/PQ4/oS3Ne2pW37Og==",
       "dev": true,
       "dependencies": {
         "de-indent": "^1.0.2",

data/lib/mihari/analyzers/circl.rb

@@ -51,7 +51,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::CIRCL.new(username: username, password: password)
+        @client ||= Clients::CIRCL.new(username: username, password: password, timeout: timeout)
       end
 
       def username?

data/lib/mihari/analyzers/crtsh.rb

@@ -28,7 +28,7 @@ module Mihari
       # @return [Mihari::Clients::Crtsh]
       #
       def client
-        @client ||= Mihari::Clients::Crtsh.new
+        @client ||= Mihari::Clients::Crtsh.new(timeout: timeout)
       end
     end
   end

data/lib/mihari/analyzers/dnstwister.rb

@@ -39,7 +39,7 @@ module Mihari
       end
 
       def client
-        @client ||= Clients::DNSTwister.new
+        @client ||= Clients::DNSTwister.new(timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/otx.rb

@@ -42,7 +42,7 @@ module Mihari
       private
 
       def client
-        @client ||= Mihari::Clients::OTX.new(api_key: api_key)
+        @client ||= Mihari::Clients::OTX.new(api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/passivetotal.rb

@@ -62,7 +62,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::PassiveTotal.new(username: username, api_key: api_key)
+        @client ||= Clients::PassiveTotal.new(username: username, api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/pulsedive.rb

@@ -47,7 +47,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::PulseDive.new(api_key: api_key)
+        @client ||= Clients::PulseDive.new(api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/analyzers/securitytrails.rb

@@ -56,7 +56,7 @@ module Mihari
       private
 
       def client
-        @client ||= Clients::SecurityTrails.new(api_key: api_key)
+        @client ||= Clients::SecurityTrails.new(api_key: api_key, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/base.rb

@@ -18,10 +18,10 @@ module Mihari
       #
       # @param [String] base_url
       # @param [Hash] headers
-      # @param [Integer] interval
+      # @param [Integer] pagination_interval
       # @param [Integer, nil] timeout
       #
-      def initialize(base_url, headers: {}, pagination_interval: 0, timeout: nil)
+      def initialize(base_url, headers: {}, pagination_interval: Mihari.config.pagination_interval, timeout: nil)
         @base_url = base_url
         @headers = headers || {}
         @pagination_interval = pagination_interval

data/lib/mihari/clients/binaryedge.rb

@@ -7,21 +7,19 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
-      # @param [Integer] pagnation_interval
       # @param [Integer, nil] timeout
+      # @param [Integer] pagination_interval
       #
       def initialize(
         base_url = "https://api.binaryedge.io/v2",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
-
         headers["x-key"] = api_key
 
-        super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
+        super(base_url, headers: headers, timeout: timeout, pagination_interval: pagination_interval)
       end
 
       #

data/lib/mihari/clients/censys.rb

@@ -18,11 +18,11 @@ module Mihari
         id:,
         secret:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'id' argument is required") if id.nil?
-        raise(ArgumentError, "'secret' argument is required") if secret.nil?
+        raise(ArgumentError, "id is required") if id.nil?
+        raise(ArgumentError, "secret is required") if secret.nil?
 
         headers["authorization"] = "Basic #{Base64.strict_encode64("#{id}:#{secret}")}"
 

data/lib/mihari/clients/circl.rb

@@ -10,14 +10,15 @@ module Mihari
       # @param [String, nil] username
       # @param [String, nil] password
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://www.circl.lu", username:, password:, headers: {})
-        raise(ArgumentError, "'username' argument is required") if username.nil?
-        raise(ArgumentError, "'password' argument is required") if password.nil?
+      def initialize(base_url = "https://www.circl.lu", username:, password:, headers: {}, timeout: nil)
+        raise(ArgumentError, "username is required") if username.nil?
+        raise(ArgumentError, "password is required") if password.nil?
 
         headers["authorization"] = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
 
-        super(base_url, headers: headers)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/crtsh.rb

@@ -6,9 +6,10 @@ module Mihari
       #
       # @param [String] base_url
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://crt.sh", headers: {})
-        super(base_url, headers: headers)
+      def initialize(base_url = "https://crt.sh", headers: {}, timeout: nil)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/dnstwister.rb

@@ -6,9 +6,10 @@ module Mihari
       #
       # @param [String] base_url
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://dnstwister.report", headers: {})
-        super(base_url, headers: headers)
+      def initialize(base_url = "https://dnstwister.report", headers: {}, timeout: nil)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/greynoise.rb

@@ -16,10 +16,10 @@ module Mihari
         base_url = "https://api.greynoise.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["key"] = api_key
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)

data/lib/mihari/clients/hunterhow.rb

@@ -21,10 +21,10 @@ module Mihari
         base_url = "https://api.hunter.how/",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
 

data/lib/mihari/clients/misp.rb

@@ -10,7 +10,7 @@ module Mihari
       # @param [Integer, nil] timeout
       #
       def initialize(base_url, api_key:, headers: {}, timeout: nil)
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["authorization"] = api_key
         headers["accept"] = "application/json"

data/lib/mihari/clients/onyphe.rb

@@ -19,10 +19,10 @@ module Mihari
         base_url = "https://www.onyphe.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?
+        raise(ArgumentError, "api_key is required") if api_key.nil?
 
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
 

data/lib/mihari/clients/otx.rb

@@ -7,12 +7,13 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://otx.alienvault.com", api_key:, headers: {})
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+      def initialize(base_url = "https://otx.alienvault.com", api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["x-otx-api-key"] = api_key
-        super(base_url, headers: headers)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/passivetotal.rb

@@ -10,14 +10,15 @@ module Mihari
       # @param [String, nil] username
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://api.passivetotal.org", username:, api_key:, headers: {})
-        raise(ArgumentError, "'username' argument is required") if username.nil?
-        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?
+      def initialize(base_url = "https://api.passivetotal.org", username:, api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "username is required") if username.nil?
+        raise(ArgumentError, "api_key is required") if api_key.nil?
 
         headers["authorization"] = "Basic #{Base64.strict_encode64("#{username}:#{api_key}")}"
 
-        super(base_url, headers: headers)
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/publsedive.rb

@@ -10,13 +10,14 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://pulsedive.com", api_key:, headers: {})
-        super(base_url, headers: headers)
+      def initialize(base_url = "https://pulsedive.com", api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "api_key is required") unless api_key
 
         @api_key = api_key
 
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/securitytrails.rb

@@ -7,12 +7,14 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
+      # @param [Integer, nil] timeout
       #
-      def initialize(base_url = "https://api.securitytrails.com", api_key:, headers: {})
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+      def initialize(base_url = "https://api.securitytrails.com", api_key:, headers: {}, timeout: nil)
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["apikey"] = api_key
-        super(base_url, headers: headers)
+
+        super(base_url, headers: headers, timeout: timeout)
       end
 
       #

data/lib/mihari/clients/shodan.rb

@@ -19,10 +19,10 @@ module Mihari
         base_url = "https://api.shodan.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)
 

data/lib/mihari/clients/the_hive.rb

@@ -11,7 +11,7 @@ module Mihari
       # @param [Integer, nil] timeout
       #
       def initialize(base_url, api_key:, api_version:, headers: {}, timeout: nil)
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         base_url += "/#{api_version}" unless api_version.nil?
         headers["authorization"] = "Bearer #{api_key}"

data/lib/mihari/clients/urlscan.rb

@@ -7,17 +7,17 @@ module Mihari
       # @param [String] base_url
       # @param [String, nil] api_key
       # @param [Hash] headers
-      # @param [Interval, nil] interval
-      # @param [Interval, nil] timeout
+      # @param [Integer, nil] interval
+      # @param [Integer, nil] timeout
       #
       def initialize(
         base_url = "https://urlscan.io",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?
+        raise(ArgumentError, "api_key is required") if api_key.nil?
 
         headers["api-key"] = api_key
 

data/lib/mihari/clients/virustotal.rb

@@ -14,10 +14,10 @@ module Mihari
         base_url = "https://www.virustotal.com",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?
+        raise(ArgumentError, "api_key is required") if api_key.nil?
 
         headers["x-apikey"] = api_key
 

data/lib/mihari/clients/zoomeye.rb

@@ -18,10 +18,10 @@ module Mihari
         base_url = "https://api.zoomeye.org",
         api_key:,
         headers: {},
-        pagination_interval: 0,
+        pagination_interval: Mihari.config.pagination_interval,
         timeout: nil
       )
-        raise(ArgumentError, "'api_key' argument is required") unless api_key
+        raise(ArgumentError, "api_key is required") unless api_key
 
         headers["api-key"] = api_key
         super(base_url, headers: headers, pagination_interval: pagination_interval, timeout: timeout)

data/lib/mihari/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mihari
-  VERSION = "5.6.0"
+  VERSION = "5.6.1"
 end

data/mkdocs.yml

@@ -8,9 +8,6 @@ plugins:
   tags:
     enabled: true
     tags_file: tags.md
-    tags_slugify: !!python/object/apply:pymdownx.slugs.slugify
-      kwds:
-        case: lower
 
 nav:
   - Requirements: requirements.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mihari
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler