Add: File type script preferences related functions and other nasl builtin (#1965)

* Fix: builtin_coverage.nasl
after fixing the make_array() nasl function, this nasl script didn't run anymore.

* Add: safe_checks and get_script_oid() nasl functions

* Add: function to get file type script preferences and also thefunctions to store the preference in a temporary file

* make function visible to nasl

* fix some stuff after rebase

Author: jjnicola

rust/Cargo.lock

@@ -51,6 +51,8 @@ pub enum BuiltinError {
     #[cfg(feature = "nasl-builtin-raw-ip")]
     #[error("{0}")]
     RawIp(RawIpError),
+    #[error("{0}")]
+    Preference(String),
 }
 
 macro_rules! builtin_error_variant (

rust/doc/misc/builtin_coverage.nasl

@@ -15,3 +15,4 @@
 - defined_func
 - gettimeofday
 - dump_ctxt
+- vendor_version

rust/src/nasl/builtin/error.rs

@@ -290,6 +290,20 @@ fn vendor_version(context: &ScanCtx<'_>) -> Result<NaslValue, MiscError> {
     }
 }
 
+/// Are safe checks enabled ?
+#[nasl_function]
+fn safe_checks(context: &ScanCtx<'_>) -> bool {
+    context
+        .scan_preferences
+        .get_preference_bool("safe_checks")
+        .unwrap_or(false)
+}
+
+#[nasl_function]
+fn get_script_oid(context: &ScanCtx<'_>) -> Option<Vec<u8>> {
+    context.nvt().clone().map(|nvt| nvt.oid.into_bytes())
+}
+
 pub struct Misc;
 
 function_set! {
@@ -311,6 +325,8 @@ function_set! {
         gettimeofday,
         dump_ctxt,
         vendor_version,
+        safe_checks,
+        get_script_oid,
     )
 }
 

rust/src/nasl/builtin/misc/README.md

@@ -4,8 +4,9 @@
 use crate::models::PreferenceValue;
 use crate::nasl::prelude::*;
 use crate::scanner::preferences::preference::PREFERENCES;
-#[nasl_function(named(id))]
-fn script_get_preference(
+use base64::Engine as _;
+
+fn script_get_preference_shared(
     register: &Register,
     config: &ScanCtx,
     name: Option<String>,
@@ -42,6 +43,39 @@ fn script_get_preference(
     None
 }
 
+fn script_get_preference_file_content_shared(
+    register: &Register,
+    config: &ScanCtx,
+    name: Option<String>,
+    id: Option<usize>,
+) -> Option<Vec<u8>> {
+    let content = script_get_preference_shared(register, config, name, id)?;
+    let content = content.as_string().unwrap();
+    base64::engine::general_purpose::STANDARD
+        .decode(content)
+        .ok()
+}
+
+#[nasl_function(named(id))]
+fn script_get_preference_file_content(
+    register: &Register,
+    config: &ScanCtx,
+    name: Option<String>,
+    id: Option<usize>,
+) -> Option<Vec<u8>> {
+    script_get_preference_file_content_shared(register, config, name, id)
+}
+
+#[nasl_function(named(id))]
+fn script_get_preference(
+    register: &Register,
+    config: &ScanCtx,
+    name: Option<String>,
+    id: Option<usize>,
+) -> Option<NaslValue> {
+    script_get_preference_shared(register, config, name, id)
+}
+
 #[nasl_function]
 fn get_preference(config: &ScanCtx, name: String) -> Option<NaslValue> {
     let val = if let Some(pref) = config.scan_params().find(|p| p.id == name) {
@@ -76,5 +110,6 @@ function_set! {
     (
         script_get_preference,
         get_preference,
+        script_get_preference_file_content,
     )
 }

rust/src/nasl/builtin/misc/mod.rs

@@ -11,7 +11,7 @@ use crate::models::{AliveTestMethods, Port, PortRange, Protocol, ScanPreference}
 use crate::nasl::builtin::{KBError, NaslSockets};
 use crate::nasl::syntax::Loader;
 use crate::nasl::{FromNaslValue, WithErrorInfo};
-use crate::scanner::preferences::preference::ScanPrefs;
+use crate::scanner::preferences::preference::{ScanPrefs, pref_is_true};
 use crate::storage::error::StorageError;
 use crate::storage::infisto::json::JsonStorage;
 use crate::storage::inmemory::InMemoryStorage;
@@ -568,10 +568,8 @@ impl<'a> ScanCtx<'a> {
     }
 
     fn get_preference_bool(&self, key: &str) -> Option<bool> {
-        self.scan_preferences
-            .iter()
-            .find(|x| x.id == key)
-            .map(|x| matches!(x.value.as_str(), "true" | "1" | "yes"))
+        let prefs = &self.scan_preferences;
+        pref_is_true(prefs, key)
     }
 
     pub fn get_port_state(&self, port: u16, protocol: Protocol) -> Result<bool, FnError> {

rust/src/nasl/builtin/preferences/mod.rs

@@ -233,6 +233,13 @@ lazy_static! {
     pub static ref PREFERENCES_JSON: String = serde_json::to_string(&PREFERENCES).unwrap();
 }
 
+pub fn pref_is_true(prefs: &ScanPrefs, key: &str) -> Option<bool> {
+    prefs
+        .iter()
+        .find(|x| x.id == key)
+        .map(|x| matches!(x.value.as_str(), "true" | "1" | "yes"))
+}
+
 #[derive(Deserialize, Serialize, Debug, Clone, Eq, PartialEq)]
 #[serde(untagged)]
 pub enum ScanPrefValue {
@@ -384,6 +391,10 @@ impl ScanPrefs {
         self.0.iter().find(|x| x.id == key).map(|x| x.value.clone())
     }
 
+    pub fn get_preference_bool(&self, key: &str) -> Option<bool> {
+        pref_is_true(self, key)
+    }
+
     pub fn iter(&self) -> impl Iterator<Item = &ScanPreference> {
         self.0.iter()
     }