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.

Sign up for GitHub

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

Fix: Reverse lookup options #1787

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Fix: Reverse lookup options #1787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions rust/src/openvas/openvas_redis.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
//
// SPDX-License-Identifier: GPL-2.0-or-later WITH x11vnc-openssl-exception

use crate::storage::item::Nvt;
use crate::nasl::syntax::ACT;
use crate::storage::item::{Nvt, NvtPreference, PreferenceType};
use crate::storage::redis::{DbError, RedisCtx, RedisGetNvt, RedisStorageResult, RedisWrapper};
use std::collections::BTreeMap;
use std::{
collections::HashMap,
sync::{Arc, Mutex, MutexGuard},
Expand Down Expand Up @@ -133,8 +135,39 @@ impl FakeRedis {
}

impl VtHelper for FakeRedis {
fn get_vt(&self, _: &str) -> RedisStorageResult<Option<Nvt>> {
Ok(None)
fn get_vt(&self, oid: &str) -> RedisStorageResult<Option<Nvt>> {
match oid {
"123" => Ok(Some(Nvt {
oid: "123".to_string(),
name: "test".to_string(),
filename: "test.nasl".to_string(),
tag: BTreeMap::new(),
dependencies: Vec::new(),
required_keys: Vec::new(),
mandatory_keys: Vec::new(),
excluded_keys: Vec::new(),
required_ports: Vec::new(),
required_udp_ports: Vec::new(),
references: Vec::new(),
preferences: vec![
NvtPreference {
id: Some(1),
class: PreferenceType::CheckBox,
name: "test1".to_string(),
default: "no".to_string(),
},
NvtPreference {
id: Some(2),
class: PreferenceType::Entry,
name: "test2".to_string(),
default: "".to_string(),
},
],
category: ACT::Init,
family: "test".to_string(),
})),
_ => Ok(None),
}
}
}

Expand Down
182 changes: 141 additions & 41 deletions rust/src/openvas/pref_handler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,17 @@ where

// prepare vt preferences
for pref in &vt.parameters {
if let Some((prefid, class, name, _value)) =
nvt.preferences.iter().find_map(|p| {
if let Some(i) = p.id {
if i as u16 == pref.id {
Some(p.into())
} else {
None
}
if let Some((prefid, class, name, _)) = nvt.preferences.iter().find_map(|p| {
if let Some(i) = p.id {
if i as u16 == pref.id {
Some(p.into())
} else {
None
}
})
{
} else {
None
}
}) {
let value_aux: String = if class == *"checkbox" {
bool_to_str(&pref.value)
} else {
Expand Down Expand Up @@ -293,30 +291,31 @@ where
async fn prepare_reverse_lookup_opt_for_openvas(&mut self) -> RedisStorageResult<()> {
let mut lookup_opts: Vec<String> = vec![];

if let Some(reverse_lookup_only) = self.scan_config.target.reverse_lookup_only {
if reverse_lookup_only {
lookup_opts.push("reverse_lookup_only|||yes".to_string());
} else {
lookup_opts.push("reverse_lookup_only|||no".to_string());
}
}

if let Some(reverse_lookup_unify) = self.scan_config.target.reverse_lookup_unify {
if reverse_lookup_unify {
lookup_opts.push("reverse_lookup_unify|||yes".to_string());
} else {
lookup_opts.push("reverse_lookup_unify|||no ".to_string());
}
if self
.scan_config
.target
.reverse_lookup_only
.is_some_and(|x| x)
{
lookup_opts.push("reverse_lookup_only|||yes".to_string());
} else {
lookup_opts.push("reverse_lookup_only|||no".to_string());
}

if !lookup_opts.is_empty() {
self.redis_connector.push_kb_item(
format!("internal/{}/scanprefs", self.scan_config.scan_id.clone()).as_str(),
lookup_opts,
)?
if self
.scan_config
.target
.reverse_lookup_unify
.is_some_and(|x| x)
{
lookup_opts.push("reverse_lookup_unify|||yes".to_string());
} else {
lookup_opts.push("reverse_lookup_unify|||no".to_string());
}

Ok(())
self.redis_connector.push_kb_item(
format!("internal/{}/scanprefs", self.scan_config.scan_id.clone()).as_str(),
lookup_opts,
)
}

async fn prepare_target_for_openvas(&mut self) -> RedisStorageResult<()> {
Expand Down Expand Up @@ -549,6 +548,7 @@ mod tests {
scan_id: "123-456".to_string(),
..Default::default()
};
scan.target.hosts = vec!["127.0.0.1".to_string(), "10.0.0.1".to_string()];
scan.target.alive_test_methods = vec![AliveTestMethods::Icmp, AliveTestMethods::TcpSyn];
scan.target.credentials = vec![Credential {
service: Service::SSH,
Expand All @@ -573,48 +573,148 @@ mod tests {
},
],
}];
scan.scan_preferences = vec![
crate::models::ScanPreference {
id: "testParam1".to_string(),
value: "1".to_string(),
},
crate::models::ScanPreference {
id: "testParam2".to_string(),
value: "abc".to_string(),
},
];
scan.vts = vec![crate::models::VT {
oid: "123".to_string(),
parameters: vec![
crate::models::Parameter {
id: 1,
value: "yes".to_string(),
},
crate::models::Parameter {
id: 2,
value: "abc".to_string(),
},
],
}];

let mut rc = FakeRedis {
data: HashMap::new(),
};

let mut prefh = PreferenceHandler::new(scan, &mut rc);
assert_eq!(prefh.redis_connector.kb_id().unwrap(), 3);
// Prepare and test Scan ID
assert!(prefh.prepare_scan_id_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/scanid", "123-456"));
assert!(prefh.redis_connector.item_exists("internal/123-456", "new"));

assert!(prefh.prepare_main_kbindex_for_openvas().await.is_ok());
// Prepare and test Target
assert!(prefh.prepare_target_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "ov_maindbid|||3"));
.item_exists("internal/123-456/scanprefs", "TARGET|||127.0.0.1,10.0.0.1"));

assert!(prefh.prepare_boreas_alive_test().await.is_ok());
// Prepare and test Ports
assert!(prefh.prepare_ports_for_openvas().await.is_ok());
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"port_range|||T:22,23,24,25,80,"
));

// Prepare and test Credentials
assert!(prefh.prepare_credentials_for_openvas().await.is_ok());
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.103591:3:password:SSH password (unsafe!):|||pass"
));
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.103591:1:entry:SSH login name:|||user"
));

// Prepare and test Plugins
assert!(prefh.prepare_plugins_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "ALIVE_TEST|||18"));
.item_exists("internal/123-456/scanprefs", "plugin_set|||123"));

// Prepare and test Main KB Index
assert!(prefh.prepare_main_kbindex_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "ov_maindbid|||3"));

// Prepare and test Host Options
assert!(prefh.prepare_host_options_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "exclude_hosts|||127.0.0.1"));

assert!(prefh.prepare_credentials_for_openvas().await.is_ok());
// Prepare and test Scan Params
assert!(prefh.prepare_scan_params_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "testParam1|||1"));
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "testParam2|||abc"));

// Prepare and test Reverse Lookup Options
assert!(prefh.prepare_reverse_lookup_opt_for_openvas().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "reverse_lookup_only|||no"));
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "reverse_lookup_unify|||no"));

// Prepare Alive Test Options
// To test this options we have to call prepare_nvt_preferences first
assert!(prefh.prepare_alive_test_option_for_openvas().await.is_ok());

// Prepare NVT Preferences
assert!(prefh.prepare_nvt_preferences().await.is_ok());

// Test Alive Test Options
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.103591:3:password:SSH password (unsafe!):|||pass"
"1.3.6.1.4.1.25623.1.0.100315:1:checkbox:Do a TCP ping|||yes"
));
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.103591:1:entry:SSH login name:|||user"
"1.3.6.1.4.1.25623.1.0.100315:2:checkbox:TCP ping tries also TCP-SYN ping|||no"
));

assert!(prefh.prepare_ports_for_openvas().await.is_ok());
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"port_range|||T:22,23,24,25,80,"
"1.3.6.1.4.1.25623.1.0.100315:7:checkbox:TCP ping tries only TCP-SYN ping|||yes"
));
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.100315:3:checkbox:Do an ICMP ping|||yes"
));
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.100315:4:checkbox:Use ARP|||no"
));
assert!(prefh.redis_connector.item_exists(
"internal/123-456/scanprefs",
"1.3.6.1.4.1.25623.1.0.100315:5:checkbox:Mark unreachable Hosts as dead (not scanning)|||yes"
));

// Test NVT Preferences
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "123:1:checkbox:test1|||yes"));
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "123:2:entry:test2|||abc"));

// Prepare Boreas Alive Test
assert!(prefh.prepare_boreas_alive_test().await.is_ok());
assert!(prefh
.redis_connector
.item_exists("internal/123-456/scanprefs", "ALIVE_TEST|||18"));
}
}
Loading