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: made host, hostname, port, test_id, severity optional #1754

Merged
merged 1 commit into from
Nov 6, 2024
Merged

Fix: made host, hostname, port, test_id, severity optional #1754

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
6 changes: 0 additions & 6 deletions rust/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

69 changes: 18 additions & 51 deletions rust/src/openvas/result_collector.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use std::{
};

use crate::openvas::openvas_redis::{KbAccess, VtHelper};
use crate::osp::{OspResultType, OspScanResult, StringF32};
use crate::osp::{OspResultType, OspScanResult};
use crate::storage::redis::RedisStorageResult;

/// Structure to hold the results retrieve from redis main kb
Expand Down Expand Up @@ -111,62 +111,29 @@ where
}
};
}

if error_msg {
let mut push_result = |x| {
scan_results.push(OspScanResult {
result_type: OspResultType::Error,
host: current_host,
hostname: host_name,
port,
test_id: roid.to_string(),
description: value,
severity: StringF32::from(0.0),
name: rname,
result_type: x,
host: Some(current_host.clone()),
hostname: Some(host_name.clone()),
port: Some(port.clone()),
test_id: Some(roid.to_string()),
description: value.clone(),
severity: None,
name: rname.clone(),
});
};

if error_msg {
push_result(OspResultType::Error);
} else if result_type == "LOG" {
scan_results.push(OspScanResult {
result_type: OspResultType::Log,
host: current_host,
hostname: host_name,
port,
test_id: roid.to_string(),
description: value,
severity: StringF32::from(0.0),
name: rname,
});
push_result(OspResultType::Log);
} else if result_type == "HOST_START" {
scan_results.push(OspScanResult {
result_type: OspResultType::HostStart,
host: current_host,
hostname: host_name,
port,
test_id: roid.to_string(),
description: value,
severity: StringF32::from(0.0),
name: rname,
});
push_result(OspResultType::HostStart);
} else if result_type == "HOST_END" {
scan_results.push(OspScanResult {
result_type: OspResultType::HostEnd,
host: current_host,
hostname: host_name,
port,
test_id: roid.to_string(),
description: value,
severity: StringF32::from(0.0),
name: rname,
});
push_result(OspResultType::HostEnd);
} else if result_type == "ALARM" {
scan_results.push(OspScanResult {
result_type: OspResultType::Alarm,
host: current_host,
hostname: host_name,
port,
test_id: roid.to_string(),
description: value,
severity: StringF32::from(0.0),
name: rname,
});
push_result(OspResultType::Alarm);
} else if result_type == "DEADHOST" {
new_dead += i64::from_str(&value).expect("Valid amount of dead hosts");
} else if host_count {
Expand Down
123 changes: 93 additions & 30 deletions rust/src/osp/response.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ use serde::{de::Visitor, Deserialize};
use super::commands::Error;

/// StringU32 is a wrapper around u32 to allow deserialization of strings
#[derive(Clone, Copy, Debug, PartialEq)]
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct StringU64(u64);


impl From<i64> for StringU64 {
fn from(value: i64) -> Self {
StringU64(value as u64)
Expand Down Expand Up @@ -41,6 +42,12 @@ impl From<StringU64> for i32 {
#[derive(Clone, Debug, PartialEq)]
pub struct StringF32(f32);

impl Default for StringF32 {
fn default() -> Self {
StringF32(0.0)
}
}

impl From<f32> for StringF32 {
fn from(value: f32) -> Self {
StringF32(value)
Expand All @@ -59,6 +66,16 @@ impl From<StringF32> for f64 {
}
}

fn invalid_number_msg<V, E>(value: &str) -> Result<V, E>
where
V: Default,
{
if !value.trim().is_empty() {
tracing::warn!(value, "invalid number, returning default");
}
Ok(V::default())
}

impl<'de> Deserialize<'de> for StringF32 {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
Expand All @@ -77,7 +94,7 @@ impl<'de> Deserialize<'de> for StringF32 {
{
match value.parse::<f32>() {
Ok(value) => Ok(StringF32(value)),
Err(_) => Err(E::custom("invalid number")),
Err(_) => invalid_number_msg::<Self::Value, E>(value),
}
}
}
Expand All @@ -104,7 +121,7 @@ impl<'de> Deserialize<'de> for StringU64 {
{
match value.parse::<u64>() {
Ok(value) => Ok(StringU64(value)),
Err(_) => Err(E::custom("invalid number")),
Err(_) => invalid_number_msg::<Self::Value, E>(value),
}
}
}
Expand Down Expand Up @@ -326,19 +343,19 @@ pub enum ResultType {
pub struct ScanResult {
#[serde(rename = "@host")]
/// Host
pub host: String,
pub host: Option<String>,
#[serde(rename = "@hostname")]
/// Hostname
pub hostname: String,
pub hostname: Option<String>,
#[serde(rename = "@severity")]
/// Severity
pub severity: StringF32,
pub severity: Option<StringF32>,
#[serde(rename = "@port")]
/// Port
pub port: String,
pub port: Option<String>,
#[serde(rename = "@test_id")]
/// Test ID
pub test_id: String,
pub test_id: Option<String>,
#[serde(rename = "@name")]
/// Name
pub name: String,
Expand Down Expand Up @@ -383,14 +400,13 @@ impl From<&ScanResult> for crate::models::Result {
fn from(result: &ScanResult) -> Self {
// name == script_name can be found via oid and is ignored here
let (port, protocol) = {
let (m_port, m_protocol) = result
.port
.split_once('/')
.unwrap_or((result.port.as_str(), ""));
(
m_port.parse().ok(),
crate::models::Protocol::try_from(m_protocol).ok(),
)
result.clone().port.map_or((None, None), |port| {
let (m_port, m_protocol) = port.split_once('/').unwrap_or((port.as_str(), ""));
(
m_port.parse().ok(),
crate::models::Protocol::try_from(m_protocol).ok(),
)
})
};
let r_type = result.into();
let message = match result.description.as_str() {
Expand All @@ -408,17 +424,11 @@ impl From<&ScanResult> for crate::models::Result {

crate::models::Result {
id: 0,
hostname: match result.hostname.as_str() {
"" => None,
_ => Some(result.hostname.clone()),
},
ip_address: match result.host.as_str() {
"" => None,
_ => Some(result.host.clone()),
},
hostname: result.hostname.clone(),
ip_address: result.host.clone(),
port,
protocol,
oid: Some(result.test_id.clone()),
oid: result.test_id.clone(),
r_type,
message,
detail: detail.extract(),
Expand Down Expand Up @@ -673,6 +683,59 @@ mod tests {
);
}

#[test]
fn empty_optional_fields() {
// types Alarm, Log Message, nn
// TODO write tests for Log Message, Error Message, Alarm
let xml = r#"
<get_scans_response status_text="OK"
status="200">
<scan id="9750f1f8-07aa-49cc-9c31-2f9e469c8f65"
target="192.168.1.252"
end_time="0"
progress="78"
status="finished"
start_time="1432824206">
<results>
<result host="192.168.1.252"
hostname=""
severity=""
port="443/tcp"
test_id=""
name="Path disclosure vulnerability"
type="Log Message">
bla
</result>
<result port="443/tcp"
test_id=""
name="Path disclosure vulnerability"
type="Log Message">
bla
</result>
</results>
</scan>
</get_scans_response>
"#;
let response: Response = from_str(xml).unwrap();
match response {
Response::GetScans { status, scan } => {
assert_eq!(status.text, "OK");
assert_eq!(status.code, 200.into());
if let Some(scan) = scan {
assert_eq!(scan.results.result[0].severity, None);
assert_eq!(scan.results.result[1].severity, None);
assert_eq!(scan.results.result[1].hostname, None);
assert_eq!(scan.results.result[1].host, None);
assert_eq!(scan.results.result[1].test_id, None);
} else {
panic!("no scan");
}
}
_ => panic!("wrong type: {:?}", response),
}
}


#[test]
fn init_response() {
let xml = r#"
Expand Down Expand Up @@ -753,11 +816,11 @@ mod tests {
assert_eq!(scan.progress, 78.into());
assert_eq!(scan.status, "finished".into());
assert_eq!(scan.start_time, Some(1432824206.into()));
assert_eq!(scan.results.result[0].host, "192.168.1.252");
assert_eq!(scan.results.result[0].hostname, "");
assert_eq!(scan.results.result[0].severity, 2.5.into());
assert_eq!(scan.results.result[0].port, "443/tcp");
assert_eq!(scan.results.result[0].test_id, "");
assert_eq!(scan.results.result[0].host, Some("192.168.1.252".into()));
assert_eq!(scan.results.result[0].hostname, None);
assert_eq!(scan.results.result[0].severity, Some(2.5.into()));
assert_eq!(scan.results.result[0].port, Some("443/tcp".into()));
assert_eq!(scan.results.result[0].test_id, None);
assert_eq!(scan.results.result[0].name, "Path disclosure vulnerability");
assert_eq!(scan.results.result[0].result_type, ResultType::Log);
assert_eq!(scan.results.result[0].description, "bla");
Expand Down
Loading