Change: move osp specific Scanner implementation from openvasd into osp

greenbone · Feb 28, 2024 · c885d35 · c885d35
1 parent ab901d6
commit c885d35
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 23 deletions.
diff --git a/rust/Cargo.lock b/rust/Cargo.lock
diff --git a/rust/openvasd/src/main.rs b/rust/openvasd/src/main.rs
@@ -12,15 +12,11 @@ pub mod feed;
 pub mod notus;
 pub mod request;
 pub mod response;
-pub mod scan;
 pub mod storage;
 pub mod tls;
 
-fn create_context<DB>(
-    db: DB,
-    config: &config::Config,
-) -> controller::Context<scan::OSPDWrapper, DB> {
-    let scanner = scan::OSPDWrapper::new(config.ospd.socket.clone(), config.ospd.read_timeout);
+fn create_context<DB>(db: DB, config: &config::Config) -> controller::Context<osp::Scanner, DB> {
+    let scanner = osp::Scanner::new(config.ospd.socket.clone(), config.ospd.read_timeout);
     let rc = config.ospd.result_check_interval;
     let fc = (
         config.feed.path.clone(),

diff --git a/rust/openvasd/src/storage/mod.rs b/rust/openvasd/src/storage/mod.rs
@@ -45,6 +45,11 @@ impl From<std::string::FromUtf8Error> for Error {
     }
 }
 
+impl From<crate::storage::Error> for models::scanner::Error {
+    fn from(value: crate::storage::Error) -> Self {
+        Self::Unexpected(format!("{value:?}"))
+    }
+}
 #[async_trait]
 pub trait ScanIDClientMapper {
     async fn add_scan_client_id(&self, scan_id: String, client_id: ClientHash)

diff --git a/rust/osp/Cargo.toml b/rust/osp/Cargo.toml
@@ -12,3 +12,5 @@ serde = { version = "1.0", features = ["derive"]}
 quick-xml = { version = "0.28.1", features = ["serialize"] }
 serde_json = "1.0"
 urlencoding = "2.1.2"
+async-trait = "0.1.77"
+tokio = { version = "1.36.0", features = [ "full" ] }
diff --git a/rust/osp/src/lib.rs b/rust/osp/src/lib.rs
@@ -6,10 +6,12 @@
 mod commands;
 mod connection;
 mod response;
+mod scanner;
 pub use commands::Error;
 pub use commands::ScanCommand;
 pub use connection::*;
 pub use response::*;
+pub use scanner::Scanner;
 
 /// The id of a scan
 pub type ScanID = String;
diff --git a/rust/openvasd/src/scan/mod.rs → rust/osp/src/scanner.rs b/rust/openvasd/src/scan/mod.rs → rust/osp/src/scanner.rs
@@ -1,28 +1,24 @@
 // SPDX-FileCopyrightText: 2023 Greenbone AG
 //
 // SPDX-License-Identifier: GPL-2.0-or-later
-
+//!Contains the scanner implementation for ospd.
+//!
+//!The scanner is used in openvasd to control scans.
 use std::{path::PathBuf, time::Duration};
 
 use async_trait::async_trait;
 use models::scanner::{ScanDeleter, ScanResultFetcher, ScanResults, ScanStarter, ScanStopper};
 
 #[derive(Debug, Clone)]
 /// OSPD wrapper, is used to utilize ospd
-pub struct OSPDWrapper {
+pub struct Scanner {
     /// Path to the socket
     socket: PathBuf,
     /// Read timeout in seconds
     r_timeout: Option<Duration>,
 }
 
-impl From<crate::storage::Error> for models::scanner::Error {
-    fn from(value: crate::storage::Error) -> Self {
-        Self::Unexpected(format!("{value:?}"))
-    }
-}
-
-impl OSPDWrapper {
+impl Scanner {
     /// Creates a new instance of OSPDWrapper
     pub fn new(socket: PathBuf, r_timeout: Option<Duration>) -> Self {
         Self { socket, r_timeout }
@@ -51,11 +47,11 @@ impl OSPDWrapper {
 }
 
 #[async_trait]
-impl ScanStarter for OSPDWrapper {
+impl ScanStarter for Scanner {
     async fn start_scan(&self, scan: models::Scan) -> Result<(), models::scanner::Error> {
         let rtimeout = self.r_timeout;
         self.spawn_blocking(move |socket| {
-            osp::start_scan(socket, rtimeout, &scan)
+            crate::start_scan(socket, rtimeout, &scan)
                 .map(|_| ())
                 .map_err(models::scanner::Error::from)
         })
@@ -64,14 +60,14 @@ impl ScanStarter for OSPDWrapper {
 }
 
 #[async_trait]
-impl ScanStopper for OSPDWrapper {
+impl ScanStopper for Scanner {
     async fn stop_scan<I>(&self, id: I) -> Result<(), models::scanner::Error>
     where
         I: AsRef<str> + Send + 'static,
     {
         let rtimeout = self.r_timeout;
         self.spawn_blocking(move |socket| {
-            osp::stop_scan(socket, rtimeout, id)
+            crate::stop_scan(socket, rtimeout, id)
                 .map(|_| ())
                 .map_err(models::scanner::Error::from)
         })
@@ -80,14 +76,14 @@ impl ScanStopper for OSPDWrapper {
 }
 
 #[async_trait]
-impl ScanDeleter for OSPDWrapper {
+impl ScanDeleter for Scanner {
     async fn delete_scan<I>(&self, id: I) -> Result<(), models::scanner::Error>
     where
         I: AsRef<str> + Send + 'static,
     {
         let rtimeout = self.r_timeout;
         self.spawn_blocking(move |socket| {
-            osp::delete_scan(socket, rtimeout, id)
+            crate::delete_scan(socket, rtimeout, id)
                 .map(|_| ())
                 .map_err(models::scanner::Error::from)
         })
@@ -96,14 +92,14 @@ impl ScanDeleter for OSPDWrapper {
 }
 
 #[async_trait]
-impl ScanResultFetcher for OSPDWrapper {
+impl ScanResultFetcher for Scanner {
     async fn fetch_results<I>(&self, id: I) -> Result<ScanResults, models::scanner::Error>
     where
         I: AsRef<str> + Send + 'static,
     {
         let rtimeout = self.r_timeout;
         self.spawn_blocking(move |socket| {
-            osp::get_delete_scan_results(socket, rtimeout, id)
+            crate::get_delete_scan_results(socket, rtimeout, id)
                 .map(|r| ScanResults {
                     id: r.clone().id,
                     status: r.clone().into(),