-
Notifications
You must be signed in to change notification settings - Fork 621
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: Preference handler for openvasctl (#1567)
* Add: preference handler module This module gets a scan config and prepare the data to be stored in redis as openvas-scanner expected. The data is stored in redis as well. For that, a new module openvas_redis was added as well, which adds an implements the RedisHelper struct. * Add: excluded hosts to the target model.
- Loading branch information
Showing
15 changed files
with
1,064 additions
and
86 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,9 @@ | ||
| // SPDX-FileCopyrightText: 2024 Greenbone AG | ||
| // | ||
| // SPDX-License-Identifier: GPL-2.0-or-later | ||
|
|
||
| pub mod cmd; | ||
| pub mod ctl; | ||
| pub mod error; | ||
| pub mod openvas_redis; | ||
| pub mod pref_handler; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| // SPDX-FileCopyrightText: 2024 Greenbone AG | ||
| // | ||
| // SPDX-License-Identifier: GPL-2.0-or-later | ||
|
|
||
| use redis_storage::{ | ||
| dberror::{DbError, RedisStorageResult}, | ||
| NameSpaceSelector, RedisCtx, RedisGetNvt, RedisWrapper, | ||
| }; | ||
| use std::{ | ||
| collections::HashMap, | ||
| sync::{Arc, Mutex}, | ||
| }; | ||
| use storage::item::Nvt; | ||
|
|
||
| #[derive(Debug, Default)] | ||
| pub struct RedisHelper<R> | ||
| where | ||
| R: RedisWrapper, | ||
| { | ||
| cache: Arc<Mutex<R>>, | ||
| task_kb: Arc<Mutex<R>>, | ||
| } | ||
|
|
||
| impl<R> RedisHelper<R> | ||
| where | ||
| R: RedisWrapper, | ||
| { | ||
| /// Initialize a RedisHelper struct with the connection to access the NVT cache | ||
| /// and a empty task knowledge base to store the scan configuration to be sent to openvas. | ||
| pub fn init( | ||
| redis_url: &str, | ||
| selector: &[NameSpaceSelector], | ||
| ) -> RedisStorageResult<RedisHelper<RedisCtx>> { | ||
| let mut rctx = RedisCtx::open(redis_url, selector)?; | ||
| rctx.delete_namespace()?; | ||
| let cache = RedisCtx::open(redis_url, selector)?; | ||
|
|
||
| Ok(RedisHelper::<RedisCtx> { | ||
| cache: Arc::new(Mutex::new(cache)), | ||
| task_kb: Arc::new(Mutex::new(rctx)), | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| pub trait KbAccess { | ||
| fn push_kb_item<T: redis::ToRedisArgs>( | ||
| &mut self, | ||
| key: &str, | ||
| value: T, | ||
| ) -> RedisStorageResult<()>; | ||
| fn kb_id(&self) -> RedisStorageResult<u32>; | ||
| } | ||
|
|
||
| impl KbAccess for RedisHelper<RedisCtx> { | ||
| fn push_kb_item<T: redis::ToRedisArgs>( | ||
| &mut self, | ||
| key: &str, | ||
| value: T, | ||
| ) -> RedisStorageResult<()> { | ||
| let mut kb = Arc::as_ref(&self.task_kb) | ||
| .lock() | ||
| .map_err(|e| DbError::SystemError(format!("{e:?}")))?; | ||
|
|
||
| kb.lpush(key, value)?; | ||
| Ok(()) | ||
| } | ||
| /// Provide access to the cache | ||
| fn kb_id(&self) -> RedisStorageResult<u32> { | ||
| let cache = Arc::as_ref(&self.cache) | ||
| .lock() | ||
| .map_err(|e| DbError::SystemError(format!("{e:?}")))?; | ||
| Ok(cache.db) | ||
| } | ||
| } | ||
|
|
||
| pub trait VtHelper { | ||
| fn get_vt(&self, oid: &str) -> RedisStorageResult<Option<Nvt>>; | ||
| } | ||
|
|
||
| impl VtHelper for RedisHelper<RedisCtx> { | ||
| fn get_vt(&self, oid: &str) -> RedisStorageResult<Option<Nvt>> { | ||
| let mut cache = Arc::as_ref(&self.cache) | ||
| .lock() | ||
| .map_err(|e| DbError::SystemError(format!("{e:?}")))?; | ||
|
|
||
| cache.redis_get_vt(oid) | ||
| } | ||
| } | ||
|
|
||
| pub struct FakeRedis { | ||
| pub data: HashMap<String, Vec<Vec<u8>>>, | ||
| } | ||
|
|
||
| impl FakeRedis { | ||
| pub fn item_exists(&self, key: &str, value: &str) -> bool { | ||
| let mut v: Vec<String> = Vec::new(); | ||
| if let Some(item) = self.data.get(key) { | ||
| for i in item { | ||
| v.push(String::from_utf8(i.to_vec()).unwrap()); | ||
| } | ||
| } | ||
| v.contains(&value.to_string()) | ||
| } | ||
| } | ||
|
|
||
| impl VtHelper for FakeRedis { | ||
| fn get_vt(&self, _: &str) -> RedisStorageResult<Option<Nvt>> { | ||
| Ok(None) | ||
| } | ||
| } | ||
|
|
||
| impl KbAccess for FakeRedis { | ||
| fn push_kb_item<T: redis::ToRedisArgs>( | ||
| &mut self, | ||
| key: &str, | ||
| value: T, | ||
| ) -> RedisStorageResult<()> { | ||
| self.data.insert(key.to_string(), value.to_redis_args()); | ||
| Ok(()) | ||
| } | ||
| fn kb_id(&self) -> RedisStorageResult<u32> { | ||
| Ok(3) | ||
| } | ||
| } |
Oops, something went wrong.