Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: use #filled #1035

Merged
merged 1 commit into from
Jan 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/mihari/schemas/alert.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
module Mihari
module Schemas
Alert = Dry::Schema.Params do
required(:rule_id).value(:string)
required(:artifacts).value(array[:string])
optional(:source).value(:string)
required(:rule_id).filled(:string)
required(:artifacts).array { filled(:string) }
optional(:source).filled(:string)
end

#
Expand Down
54 changes: 27 additions & 27 deletions lib/mihari/schemas/analyzer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ module Analyzers
key = keys.first
const_set(key.upcase, Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*keys))
required(:query).value(:string)
optional(:api_key).value(:string)
required(:query).filled(:string)
optional(:api_key).filled(:string)
optional(:options).hash(AnalyzerPaginationOptions)
end)
end
Expand All @@ -36,83 +36,83 @@ module Analyzers
key = keys.first
const_set(key.upcase, Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*keys))
required(:query).value(:string)
optional(:api_key).value(:string)
required(:query).filled(:string)
optional(:api_key).filled(:string)
optional(:options).hash(AnalyzerOptions)
end)
end

DNSTwister = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::DNSTwister.keys))
required(:query).value(:string)
required(:query).filled(:string)
optional(:options).hash(AnalyzerOptions)
end

Censys = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::Censys.keys))
required(:query).value(:string)
optional(:id).value(:string)
optional(:secret).value(:string)
required(:query).filled(:string)
optional(:id).filled(:string)
optional(:secret).filled(:string)
optional(:options).hash(AnalyzerPaginationOptions)
end

CIRCL = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::CIRCL.keys))
required(:query).value(:string)
optional(:username).value(:string)
optional(:password).value(:string)
required(:query).filled(:string)
optional(:username).filled(:string)
optional(:password).filled(:string)
optional(:options).hash(AnalyzerOptions)
end

Fofa = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::Fofa.keys))
required(:query).value(:string)
optional(:api_key).value(:string)
optional(:email).value(:string)
required(:query).filled(:string)
optional(:api_key).filled(:string)
optional(:email).filled(:string)
optional(:options).hash(AnalyzerPaginationOptions)
end

PassiveTotal = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::PassiveTotal.keys))
required(:query).value(:string)
optional(:username).value(:string)
optional(:api_key).value(:string)
required(:query).filled(:string)
optional(:username).filled(:string)
optional(:api_key).filled(:string)
optional(:options).hash(AnalyzerOptions)
end

ZoomEye = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::ZoomEye.keys))
required(:query).value(:string)
required(:query).filled(:string)
required(:type).value(Types::String.enum("host", "web"))
optional(:options).hash(AnalyzerPaginationOptions)
end

Crtsh = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::Crtsh.keys))
required(:query).value(:string)
required(:query).filled(:string)
optional(:exclude_expired).value(:bool).default(true)
optional(:match).value(Types::String.enum("=", "ILIKE", "LIKE", "single", "any", "FTS")).default(nil)
optional(:options).hash(AnalyzerOptions)
end

HunterHow = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::HunterHow.keys))
required(:query).value(:string)
required(:query).filled(:string)
required(:start_time).value(:date)
required(:end_time).value(:date)
optional(:api_key).value(:string)
optional(:api_key).filled(:string)
optional(:options).hash(AnalyzerPaginationOptions)
end

Feed = Dry::Schema.Params do
required(:analyzer).value(Types::String.enum(*Mihari::Analyzers::Feed.keys))
required(:query).value(:string)
required(:selector).value(:string)
required(:query).filled(:string)
required(:selector).filled(:string)
optional(:method).value(Types::HTTPRequestMethods).default("GET")
optional(:headers).value(:hash).default({})
optional(:params).value(:hash)
optional(:form).value(:hash)
optional(:json).value(:hash)
optional(:headers).filled(:hash)
optional(:params).filled(:hash)
optional(:form).filled(:hash)
optional(:json).filled(:hash)
optional(:options).hash(AnalyzerOptions)
end
end
Expand Down
18 changes: 9 additions & 9 deletions lib/mihari/schemas/emitter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,31 @@ module Emitters

MISP = Dry::Schema.Params do
required(:emitter).value(Types::String.enum(*Mihari::Emitters::MISP.keys))
optional(:url).value(:string)
optional(:api_key).value(:string)
optional(:url).filled(:string)
optional(:api_key).filled(:string)
optional(:options).hash(Options)
end

TheHive = Dry::Schema.Params do
required(:emitter).value(Types::String.enum(*Mihari::Emitters::TheHive.keys))
optional(:url).value(:string)
optional(:api_key).value(:string)
optional(:url).filled(:string)
optional(:api_key).filled(:string)
optional(:options).hash(Options)
end

Slack = Dry::Schema.Params do
required(:emitter).value(Types::String.enum(*Mihari::Emitters::Slack.keys))
optional(:webhook_url).value(:string)
optional(:channel).value(:string)
optional(:webhook_url).filled(:string)
optional(:channel).filled(:string)
optional(:options).hash(Options)
end

Webhook = Dry::Schema.Params do
required(:emitter).value(Types::String.enum(*Mihari::Emitters::Webhook.keys))
required(:url).value(:string)
required(:url).filled(:string)
optional(:method).value(Types::HTTPRequestMethods).default("POST")
optional(:headers).value(:hash).default({})
optional(:template).value(:string)
optional(:headers).filled(:hash)
optional(:template).filled(:string)
optional(:options).hash(Options)
end
end
Expand Down
24 changes: 12 additions & 12 deletions lib/mihari/schemas/rule.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,27 @@
module Mihari
module Schemas
Rule = Dry::Schema.Params do
required(:id).value(:string)
required(:title).value(:string)
required(:description).value(:string)
required(:id).filled(:string)
required(:title).filled(:string)
required(:description).filled(:string)

optional(:tags).value(array[:string]).default([])
optional(:author).filled(:string)
optional(:status).filled(:string)

optional(:author).value(:string)
optional(:references).value(array[:string])
optional(:related).value(array[:string])
optional(:status).value(:string)
optional(:tags).array { filled(:string) }.default([])
optional(:references).array { filled(:string) }
optional(:related).array { filled(:string) }

optional(:created_on).value(:date)
optional(:updated_on).value(:date)

required(:queries).value(:array).each { Analyzer } # rubocop:disable Lint/Void

optional(:emitters).value(:array).each { Emitter }.default(DEFAULT_EMITTERS) # rubocop:disable Lint/Void
optional(:enrichers).value(:array).each { Enricher }.default(DEFAULT_ENRICHERS) # rubocop:disable Lint/Void

optional(:data_types).value(array[Types::DataTypes]).default(Mihari::Types::DataTypes.values)
optional(:falsepositives).value(array[:string]).default([])
optional(:data_types).filled(array[Types::DataTypes]).default(Mihari::Types::DataTypes.values)

optional(:falsepositives).array { filled(:string) }.default([])

optional(:artifact_ttl).value(:integer)
end
Expand All @@ -42,7 +42,7 @@ class RuleContract < Dry::Validation::Contract

rule(:falsepositives) do
value.each do |v|
key.failure("#{v} is not a valid format.") unless valid_falsepositive?(v)
key.failure("#{v} is not a valid format") unless valid_falsepositive?(v)
end
end

Expand Down