Merge pull request #399 from owasp-noir/redesign-options

Refactor code to use YAML::Any for all options

Author: hahwul

docs/_advanced/configuration.md

@@ -31,7 +31,7 @@ layout: page
 base: ""
 
 # Whether to use color in the output
-color: "yes"
+color: true
 
 # The configuration file to use
 config_file: ""
@@ -40,7 +40,7 @@ config_file: ""
 concurrency: "100"
 
 # Whether to enable debug mode
-debug: "no"
+debug: false
 
 # Technologies to exclude
 exclude_techs: ""
@@ -49,10 +49,10 @@ exclude_techs: ""
 format: "plain"
 
 # Whether to include the path in the output
-include_path: "no"
+include_path: false
 
 # Whether to disable logging
-nolog: "no"
+nolog: false
 
 # The output file to write to
 output: ""
@@ -64,10 +64,12 @@ send_es: ""
 send_proxy: ""
 
 # Whether to send a request
-send_req: "no"
+send_req: false
 
 # Whether to send headers with the request
-send_with_headers: ""
+send_with_headers: 
+    - "Authorization: ABCD1234"
+    - "X-API-Key: ABCD1234"
 
 # The value to set for pvalue
 set_pvalue: ""
@@ -79,13 +81,15 @@ techs: ""
 url: ""
 
 # Whether to use filters
-use_filters: ""
+use_filters: 
+    - "/admin"
 
 # Whether to use matchers
-use_matchers: ""
+use_matchers: 
+    - "/user"
 
 # Whether to use all taggers
-all_taggers: "no"
+all_taggers: false
 
 # The taggers to use
 use_taggers: ""

spec/functional_test/func_spec.cr

@@ -17,8 +17,8 @@ class FunctionalTester
   def initialize(@path, expected_count, expected_endpoints)
     config_init = ConfigInitializer.new
     noir_options = config_init.default_options
-    noir_options["base"] = "./spec/functional_test/#{@path}"
-    noir_options["nolog"] = "yes"
+    noir_options["base"] = YAML::Any.new("./spec/functional_test/#{@path}")
+    noir_options["nolog"] = YAML::Any.new(true)
 
     if !expected_count.nil?
       @expected_count = expected_count
@@ -131,6 +131,6 @@ class FunctionalTester
   end
 
   def set_url(url)
-    @app.options["url"] = url
+    @app.options["url"] = YAML::Any.new(url)
   end
 end

spec/functional_test/testers/file_based_spec.cr

@@ -15,5 +15,5 @@ tester = FunctionalTester.new("fixtures/file_based/", {
   :endpoints => extected_endpoints.size,
 }, extected_endpoints)
 
-tester.app.options["url"] = "https://www.hahwul.com"
+tester.app.options["url"] = YAML::Any.new("https://www.hahwul.com")
 tester.test_all

spec/unit_test/models/analyzer_spec.cr

@@ -4,7 +4,7 @@ require "../../../src/options.cr"
 describe "Initialize Analyzer" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
+  options["base"] = YAML::Any.new("noir")
   object = Analyzer.new(options)
 
   it "getter - url" do
@@ -24,7 +24,7 @@ end
 describe "Initialize FileAnalyzer" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
+  options["base"] = YAML::Any.new("noir")
   object = FileAnalyzer.new(options)
 
   it "getter - url" do

spec/unit_test/models/deliver_spec.cr

@@ -4,36 +4,36 @@ require "../../../src/options.cr"
 describe "Initialize" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
-  options["send_proxy"] = "http://localhost:8090"
-  options["nolog"] = "yes"
+  options["base"] = YAML::Any.new("noir")
+  options["send_proxy"] = YAML::Any.new("http://localhost:8090")
+  options["nolog"] = YAML::Any.new(true)
 
   it "Deliver" do
     object = Deliver.new options
     object.proxy.should eq("http://localhost:8090")
   end
 
   it "Deliver with headers" do
-    options["send_with_headers"] = "X-API-Key: abcdssss"
+    options["send_with_headers"] = YAML::Any.new([YAML::Any.new("X-API-Key: abcdssss")])
     object = Deliver.new options
     object.headers["X-API-Key"].should eq("abcdssss")
   end
 
   it "Deliver with headers (bearer case)" do
-    options["send_with_headers"] = "Authorization: Bearer gAAAAABl3qwaQqol243Np"
+    options["send_with_headers"] = YAML::Any.new([YAML::Any.new("Authorization: Bearer gAAAAABl3qwaQqol243Np")])
     object = Deliver.new options
     object.headers["Authorization"].should eq("Bearer gAAAAABl3qwaQqol243Np")
   end
 
   it "Deliver with matchers" do
-    options["use_matchers"] = "/admin"
+    options["use_matchers"] = YAML::Any.new([YAML::Any.new("/admin")])
     object = Deliver.new options
-    object.matchers.should eq(["/admin"])
+    object.matchers[0].to_s.should eq("/admin")
   end
 
   it "Deliver with filters" do
-    options["use_filters"] = "/admin"
+    options["use_filters"] = YAML::Any.new([YAML::Any.new("/admin")])
     object = Deliver.new options
-    object.filters.should eq(["/admin"])
+    object.filters[0].to_s.should eq("/admin")
   end
 end

spec/unit_test/models/detector_spec.cr

@@ -4,7 +4,7 @@ require "../../../src/config_initializer.cr"
 describe "Initialize" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
+  options["base"] = YAML::Any.new("noir")
   object = Detector.new(options)
 
   it "getter - name" do

spec/unit_test/models/noir_spec.cr

@@ -5,7 +5,7 @@ require "../../../src/models/endpoint.cr"
 describe "Initialize" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
+  options["base"] = YAML::Any.new("noir")
   runner = NoirRunner.new(options)
 
   it "getter - options" do
@@ -17,9 +17,9 @@ end
 describe "Methods" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
-  options["url"] = "https://www.hahwul.com"
-  options["nolog"] = "yes"
+  options["base"] = YAML::Any.new("noir")
+  options["url"] = YAML::Any.new("https://www.hahwul.com")
+  options["nolog"] = YAML::Any.new(true)
   runner = NoirRunner.new(options)
 
   runner.endpoints << Endpoint.new("/abcd", "GET")

spec/unit_test/models/output_builder_spec.cr

@@ -4,9 +4,9 @@ require "../../../src/options.cr"
 describe "Initialize" do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
-  options["format"] = "json"
-  options["output"] = "output.json"
+  options["base"] = YAML::Any.new("noir")
+  options["format"] = YAML::Any.new("json")
+  options["output"] = YAML::Any.new("output.json")
 
   it "OutputBuilder" do
     object = OutputBuilder.new options
@@ -72,8 +72,8 @@ end
 describe OutputBuilderDiff do
   config_init = ConfigInitializer.new
   options = config_init.default_options
-  options["base"] = "noir"
-  options["format"] = "json"
+  options["base"] = YAML::Any.new("noir")
+  options["format"] = YAML::Any.new("json")
 
   it "calculates the diff correctly" do
     old_endpoints = [Endpoint.new("GET", "/old")]

spec/unit_test/utils/utils_spec.cr

@@ -54,11 +54,11 @@ describe "get_symbol" do
 end
 
 describe "str_to_bool" do
-  it "yes" do
-    str_to_bool("yes").should eq(true)
+  it true do
+    str_to_bool(true).should eq(true)
   end
-  it "no" do
-    str_to_bool("no").should eq(false)
+  it false do
+    str_to_bool(false).should eq(false)
   end
   it "any string" do
     str_to_bool("hahwul").should eq(false)

src/analyzer/analyzer.cr

@@ -3,36 +3,36 @@ require "./analyzers/file_analyzers/*"
 
 def initialize_analyzers(logger : NoirLogger)
   # Initializing analyzers
-  analyzers = {} of String => Proc(Hash(String, String), Array(Endpoint))
+  analyzers = {} of String => Proc(Hash(String, YAML::Any), Array(Endpoint))
 
   # Mapping analyzers to their respective functions
-  analyzers["c#-aspnet-mvc"] = ->analyzer_cs_aspnet_mvc(Hash(String, String))
-  analyzers["crystal_kemal"] = ->analyzer_crystal_kemal(Hash(String, String))
-  analyzers["crystal_lucky"] = ->analyzer_crystal_lucky(Hash(String, String))
-  analyzers["elixir_phoenix"] = ->analyzer_elixir_phoenix(Hash(String, String))
-  analyzers["go_beego"] = ->analyzer_go_beego(Hash(String, String))
-  analyzers["go_echo"] = ->analyzer_go_echo(Hash(String, String))
-  analyzers["go_fiber"] = ->analyzer_go_fiber(Hash(String, String))
-  analyzers["go_gin"] = ->analyzer_go_gin(Hash(String, String))
-  analyzers["har"] = ->analyzer_har(Hash(String, String))
-  analyzers["java_armeria"] = ->analyzer_armeria(Hash(String, String))
-  analyzers["java_jsp"] = ->analyzer_jsp(Hash(String, String))
-  analyzers["java_spring"] = ->analyzer_java_spring(Hash(String, String))
-  analyzers["js_express"] = ->analyzer_express(Hash(String, String))
-  analyzers["js_restify"] = ->analyzer_restify(Hash(String, String))
-  analyzers["kotlin_spring"] = ->analyzer_kotlin_spring(Hash(String, String))
-  analyzers["oas2"] = ->analyzer_oas2(Hash(String, String))
-  analyzers["oas3"] = ->analyzer_oas3(Hash(String, String))
-  analyzers["php_pure"] = ->analyzer_php_pure(Hash(String, String))
-  analyzers["python_django"] = ->analyzer_python_django(Hash(String, String))
-  analyzers["python_fastapi"] = ->analyzer_python_fastapi(Hash(String, String))
-  analyzers["python_flask"] = ->analyzer_python_flask(Hash(String, String))
-  analyzers["raml"] = ->analyzer_raml(Hash(String, String))
-  analyzers["ruby_hanami"] = ->analyzer_ruby_hanami(Hash(String, String))
-  analyzers["ruby_rails"] = ->analyzer_ruby_rails(Hash(String, String))
-  analyzers["ruby_sinatra"] = ->analyzer_ruby_sinatra(Hash(String, String))
-  analyzers["rust_axum"] = ->analyzer_rust_axum(Hash(String, String))
-  analyzers["rust_rocket"] = ->analyzer_rust_rocket(Hash(String, String))
+  analyzers["c#-aspnet-mvc"] = ->analyzer_cs_aspnet_mvc(Hash(String, YAML::Any))
+  analyzers["crystal_kemal"] = ->analyzer_crystal_kemal(Hash(String, YAML::Any))
+  analyzers["crystal_lucky"] = ->analyzer_crystal_lucky(Hash(String, YAML::Any))
+  analyzers["elixir_phoenix"] = ->analyzer_elixir_phoenix(Hash(String, YAML::Any))
+  analyzers["go_beego"] = ->analyzer_go_beego(Hash(String, YAML::Any))
+  analyzers["go_echo"] = ->analyzer_go_echo(Hash(String, YAML::Any))
+  analyzers["go_fiber"] = ->analyzer_go_fiber(Hash(String, YAML::Any))
+  analyzers["go_gin"] = ->analyzer_go_gin(Hash(String, YAML::Any))
+  analyzers["har"] = ->analyzer_har(Hash(String, YAML::Any))
+  analyzers["java_armeria"] = ->analyzer_armeria(Hash(String, YAML::Any))
+  analyzers["java_jsp"] = ->analyzer_jsp(Hash(String, YAML::Any))
+  analyzers["java_spring"] = ->analyzer_java_spring(Hash(String, YAML::Any))
+  analyzers["js_express"] = ->analyzer_express(Hash(String, YAML::Any))
+  analyzers["js_restify"] = ->analyzer_restify(Hash(String, YAML::Any))
+  analyzers["kotlin_spring"] = ->analyzer_kotlin_spring(Hash(String, YAML::Any))
+  analyzers["oas2"] = ->analyzer_oas2(Hash(String, YAML::Any))
+  analyzers["oas3"] = ->analyzer_oas3(Hash(String, YAML::Any))
+  analyzers["php_pure"] = ->analyzer_php_pure(Hash(String, YAML::Any))
+  analyzers["python_django"] = ->analyzer_python_django(Hash(String, YAML::Any))
+  analyzers["python_fastapi"] = ->analyzer_python_fastapi(Hash(String, YAML::Any))
+  analyzers["python_flask"] = ->analyzer_python_flask(Hash(String, YAML::Any))
+  analyzers["raml"] = ->analyzer_raml(Hash(String, YAML::Any))
+  analyzers["ruby_hanami"] = ->analyzer_ruby_hanami(Hash(String, YAML::Any))
+  analyzers["ruby_rails"] = ->analyzer_ruby_rails(Hash(String, YAML::Any))
+  analyzers["ruby_sinatra"] = ->analyzer_ruby_sinatra(Hash(String, YAML::Any))
+  analyzers["rust_axum"] = ->analyzer_rust_axum(Hash(String, YAML::Any))
+  analyzers["rust_rocket"] = ->analyzer_rust_rocket(Hash(String, YAML::Any))
 
   logger.success "#{analyzers.size} Analyzers initialized"
   logger.debug "Analyzers:"
@@ -42,7 +42,7 @@ def initialize_analyzers(logger : NoirLogger)
   analyzers
 end
 
-def analysis_endpoints(options : Hash(String, String), techs, logger : NoirLogger)
+def analysis_endpoints(options : Hash(String, YAML::Any), techs, logger : NoirLogger)
   result = [] of Endpoint
   file_analyzer = FileAnalyzer.new options
   logger.info "Initializing analyzers"
@@ -57,7 +57,7 @@ def analysis_endpoints(options : Hash(String, String), techs, logger : NoirLogge
 
   techs.each do |tech|
     if analyzer.has_key?(tech)
-      if NoirTechs.similar_to_tech(options["exclude_techs"]).includes?(tech)
+      if NoirTechs.similar_to_tech(options["exclude_techs"].to_s).includes?(tech)
         logger.sub "➔ Skipping #{tech} analysis"
         next
       end

src/analyzer/analyzers/analyzer_armeria.cr

@@ -63,7 +63,7 @@ class AnalyzerArmeria < Analyzer
   end
 end
 
-def analyzer_armeria(options : Hash(String, String))
+def analyzer_armeria(options : Hash(String, YAML::Any))
   instance = AnalyzerArmeria.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_crystal_kemal.cr

@@ -170,7 +170,7 @@ class AnalyzerCrystalKemal < Analyzer
   end
 end
 
-def analyzer_crystal_kemal(options : Hash(String, String))
+def analyzer_crystal_kemal(options : Hash(String, YAML::Any))
   instance = AnalyzerCrystalKemal.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_crystal_lucky.cr

@@ -135,7 +135,7 @@ class AnalyzerCrystalLucky < Analyzer
   end
 end
 
-def analyzer_crystal_lucky(options : Hash(String, String))
+def analyzer_crystal_lucky(options : Hash(String, YAML::Any))
   instance = AnalyzerCrystalLucky.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_cs_aspnet_mvc.cr

@@ -45,7 +45,7 @@ class AnalyzerCsAspNetMvc < Analyzer
   end
 end
 
-def analyzer_cs_aspnet_mvc(options : Hash(String, String))
+def analyzer_cs_aspnet_mvc(options : Hash(String, YAML::Any))
   instance = AnalyzerCsAspNetMvc.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_elixir_phoenix.cr

@@ -61,7 +61,7 @@ class AnalyzerElixirPhoenix < Analyzer
   end
 end
 
-def analyzer_elixir_phoenix(options : Hash(String, String))
+def analyzer_elixir_phoenix(options : Hash(String, YAML::Any))
   instance = AnalyzerElixirPhoenix.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_example.cr

@@ -26,7 +26,7 @@ class AnalyzerExample < Analyzer
   end
 end
 
-def analyzer_example(options : Hash(String, String))
+def analyzer_example(options : Hash(String, YAML::Any))
   instance = AnalyzerExample.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_express.cr

@@ -105,7 +105,7 @@ class AnalyzerExpress < Analyzer
   end
 end
 
-def analyzer_express(options : Hash(String, String))
+def analyzer_express(options : Hash(String, YAML::Any))
   instance = AnalyzerExpress.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_go_beego.cr

@@ -144,7 +144,7 @@ class AnalyzerGoBeego < Analyzer
   end
 end
 
-def analyzer_go_beego(options : Hash(String, String))
+def analyzer_go_beego(options : Hash(String, YAML::Any))
   instance = AnalyzerGoBeego.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_go_echo.cr

@@ -186,7 +186,7 @@ class AnalyzerGoEcho < Analyzer
   end
 end
 
-def analyzer_go_echo(options : Hash(String, String))
+def analyzer_go_echo(options : Hash(String, YAML::Any))
   instance = AnalyzerGoEcho.new(options)
   instance.analyze
 end

src/analyzer/analyzers/analyzer_go_fiber.cr

@@ -197,7 +197,7 @@ class AnalyzerGoFiber < Analyzer
   end
 end
 
-def analyzer_go_fiber(options : Hash(String, String))
+def analyzer_go_fiber(options : Hash(String, YAML::Any))
   instance = AnalyzerGoFiber.new(options)
   instance.analyze
 end