yara-x 1.15.0

use bstr::{BStr, BString, ByteSlice, Utf8Error};
use std::rc::Rc;

use crate::compiler::LiteralId;
use crate::scanner::{
    RuntimeObject, RuntimeObjectHandle, ScanContext, ScanState,
};
use crate::utils::cast;

/// This trait is implemented by [RuntimeString], [FixedLenString], [Lowercase] and [Uppercase].
pub(crate) trait String: Default {
    /// Creates a new string.
    fn new<V: Into<Vec<u8>>>(s: V) -> Self;

    /// Returns this string as a primitive type suitable to be passed to WASM.
    fn into_wasm_with_ctx(self, ctx: &mut ScanContext) -> RuntimeStringWasm;
    fn from_slice(ctx: &ScanContext, s: &[u8]) -> Self;
}

/// Represents a [`RuntimeString`] as a `i64` that can be passed from WASM to
/// host and vice versa.
///
/// The types that we can pass to (and receive from) WASM functions are only
/// primitive types (i64, i32, f64 and f32). In order to be able to pass a
/// [`RuntimeString`] to and from WASM, it must be represented as one of those
/// primitive types.
///
/// The `u64` value contains all the information required for uniquely
/// identifying the string. This is how the information is encoded:
///
/// * `RuntimeString:Undef` -> `0`
///   A zero represents an undefined string.
///
/// * `RuntimeString:Literal` -> `LiteralId << 2 | 1`
///   If the two lower bits are equal to 1, it's a literal string, where the
///   remaining bits represent the `LiteralId`.
///
/// * `RuntimeString:Rc` -> `RuntimeStringId << 2 | 2`
///   If the two lower bits are equal to 2, it's a runtime string, where the
///   remaining bits represent the handle of a string object.
///
/// * `RuntimeString:ScannedDataSlice` -> `Offset << 18 | Len << 2 | 3)`
///   If the two lower bits are 3, it's a string backed by the scanned data.
///   Bits 18:3 ar used for representing the string length (up to 64KB),
///   while bits 64:19 represent the offset (up to 70,368,744,177,663).
///
pub(crate) type RuntimeStringWasm = i64;

/// String types handled by YARA's WASM runtime.
///
/// At runtime, when the WASM code generated for rule conditions is
/// being executed, text strings can adopt multiple forms. The difference
/// between them resides in the place in which the string's data is stored.
///
/// For example, literal strings appearing in the source code are stored in
/// a string pool created at compile time, these strings are identified by the
/// [`LiteralId`] returned by the pool. Instead of making copies of those
/// literal strings, the runtime passes the [`LiteralId`] around when referring
/// to them.
///
/// Similarly, functions exported by YARA modules can return strings that
/// appear verbatim in the data being scanned. Instead of making a copy, the
/// runtime passes around only the offset within the data where the string
/// starts, and its length.
///
/// In some other cases a function may need to return a string that doesn't
/// appear neither in the scanned data nor as a literal in the source code,
/// in such cases the runtime stores the string in a hash map maintained by
/// [`ScanContext`], and passes around only the handle that allows locating
/// the string in that map.
#[derive(Debug, PartialEq)]
pub(crate) enum RuntimeString {
    /// A literal string appearing in the source code. The string is identified
    /// by its [`LiteralId`] within the literal strings pool.
    Literal(LiteralId),
    /// A string found in the scanned data, represented by the offset within
    /// the data and its length.
    ScannedDataSlice { offset: usize, length: usize },
    /// A reference-counted string.
    Rc(Rc<BString>),
}

impl Default for RuntimeString {
    fn default() -> Self {
        Self::ScannedDataSlice { offset: 0, length: 0 }
    }
}

impl String for RuntimeString {
    /// Creates a [`RuntimeString`] from a [`String`], a [`Vec<u8>`] or any
    /// type that implements [`Into<Vec<u8>>`]
    fn new<S: Into<Vec<u8>>>(s: S) -> Self {
        Self::Rc(Rc::new(BString::new(s.into())))
    }

    /// Returns this string as a primitive type suitable to be passed to WASM.
    fn into_wasm_with_ctx(self, ctx: &mut ScanContext) -> RuntimeStringWasm {
        match self {
            Self::Literal(id) => i64::from(id) << 2,
            Self::Rc(s) => {
                let handle: i64 = ctx.store_string(s).into();
                (handle << 2) | 1
            }
            Self::ScannedDataSlice { offset, length } => {
                if length >= u16::MAX as usize {
                    panic!(
                        "runtime-string slices can't be larger than {}",
                        u16::MAX
                    )
                }
                ((offset as i64) << 18) | ((length as i64) << 2) | 2
            }
        }
    }

    /// Creates a [`RuntimeString`] from a reference to a byte slice.
    ///
    /// If the original slice is contained within the scanned data, this
    /// function returns the [`RuntimeString::ScannedDataSlice`] variant, which
    /// doesn't need to copy the string data.
    ///
    /// In any other case it makes a copy of the string and return the
    /// [`RuntimeString::Rc`] variant.
    fn from_slice(ctx: &ScanContext, s: &[u8]) -> Self {
        if let ScanState::ScanningData(data) = &ctx.scan_state {
            let data = data.as_ref();
            let data_start = data.as_ptr() as usize;
            let data_end = data_start + data.len();

            let s_start = s.as_ptr() as usize;
            let s_end = s_start + s.len();

            if s_start >= data_start && s_end <= data_end {
                return Self::ScannedDataSlice {
                    offset: s_start - data_start,
                    length: s.len(),
                };
            }
        }

        Self::Rc(Rc::new(BString::from(s)))
    }
}

impl RuntimeString {
    /// Returns this string as a &[`BStr`].
    pub(crate) fn as_bstr<'a>(&'a self, ctx: &'a ScanContext) -> &'a BStr {
        match self {
            Self::Literal(id) => {
                ctx.compiled_rules.lit_pool().get(*id).unwrap()
            }
            Self::ScannedDataSlice { offset, length } => {
                let data = ctx.scanned_data().unwrap();
                BStr::new(&data[*offset..*offset + *length])
            }
            Self::Rc(s) => s.as_bstr(),
        }
    }

    /// Safely converts this string to a `&str` if it's valid UTF-8.
    ///
    /// If the string is not valid UTF-8, then an error is returned.
    #[inline]
    pub(crate) fn to_str<'a>(
        &'a self,
        ctx: &'a ScanContext,
    ) -> Result<&'a str, Utf8Error> {
        self.as_bstr(ctx).to_str()
    }

    /// Returns this string as a primitive type suitable to be passed to WASM.
    pub(crate) fn into_wasm(self) -> RuntimeStringWasm {
        match self {
            Self::Literal(id) => i64::from(id) << 2,
            _ => unreachable!(),
        }
    }

    /// Creates a [`RuntimeString`] from a [`RuntimeStringWasm`].
    pub(crate) fn from_wasm(
        ctx: &mut ScanContext,
        s: RuntimeStringWasm,
    ) -> Self {
        match s & 0x3 {
            0 => Self::Literal(LiteralId::from((s >> 2) as u32)),
            1 => {
                let handle = RuntimeObjectHandle::from(s >> 2);
                let s = cast!(
                    ctx.runtime_objects.get(&handle).unwrap(),
                    RuntimeObject::String
                );
                Self::Rc(s.clone())
            }
            2 => Self::ScannedDataSlice {
                offset: (s >> 18) as usize,
                length: ((s >> 2) & 0xffff) as usize,
            },
            _ => unreachable!(),
        }
    }

    #[inline]
    pub(crate) fn len(&self, ctx: &ScanContext) -> usize {
        self.as_bstr(ctx).len()
    }

    #[inline]
    pub(crate) fn eq(&self, other: &Self, ctx: &ScanContext) -> bool {
        self.as_bstr(ctx).eq(other.as_bstr(ctx))
    }

    #[inline]
    pub(crate) fn ne(&self, other: &Self, ctx: &ScanContext) -> bool {
        self.as_bstr(ctx).ne(other.as_bstr(ctx))
    }

    #[inline]
    pub(crate) fn lt(&self, other: &Self, ctx: &ScanContext) -> bool {
        self.as_bstr(ctx).lt(other.as_bstr(ctx))
    }

    #[inline]
    pub(crate) fn gt(&self, other: &Self, ctx: &ScanContext) -> bool {
        self.as_bstr(ctx).gt(other.as_bstr(ctx))
    }

    #[inline]
    pub(crate) fn le(&self, other: &Self, ctx: &ScanContext) -> bool {
        self.as_bstr(ctx).le(other.as_bstr(ctx))
    }

    #[inline]
    pub(crate) fn ge(&self, other: &Self, ctx: &ScanContext) -> bool {
        self.as_bstr(ctx).ge(other.as_bstr(ctx))
    }

    #[inline]
    pub(crate) fn contains(
        &self,
        other: &Self,
        ctx: &ScanContext,
        case_insensitive: bool,
    ) -> bool {
        if case_insensitive {
            let this = self.as_bstr(ctx).to_lowercase();
            let other = other.as_bstr(ctx).to_lowercase();
            this.contains_str(other)
        } else {
            self.as_bstr(ctx).contains_str(other.as_bstr(ctx))
        }
    }

    #[inline]
    pub(crate) fn starts_with(
        &self,
        other: &Self,
        ctx: &ScanContext,
        case_insensitive: bool,
    ) -> bool {
        if case_insensitive {
            let this = self.as_bstr(ctx).to_lowercase();
            let other = other.as_bstr(ctx).to_lowercase();
            this.starts_with_str(other)
        } else {
            self.as_bstr(ctx).starts_with_str(other.as_bstr(ctx))
        }
    }

    #[inline]
    pub(crate) fn ends_with(
        &self,
        other: &Self,
        ctx: &ScanContext,
        case_insensitive: bool,
    ) -> bool {
        if case_insensitive {
            let this = self.as_bstr(ctx).to_lowercase();
            let other = other.as_bstr(ctx).to_lowercase();
            this.ends_with_str(other)
        } else {
            self.as_bstr(ctx).ends_with_str(other.as_bstr(ctx))
        }
    }

    #[inline]
    pub(crate) fn equals(
        &self,
        other: &Self,
        ctx: &ScanContext,
        case_insensitive: bool,
    ) -> bool {
        if case_insensitive {
            let this = self.as_bstr(ctx).to_lowercase();
            let other = other.as_bstr(ctx).to_lowercase();
            this.eq(&other)
        } else {
            self.as_bstr(ctx).eq(other.as_bstr(ctx))
        }
    }
}

/// Special kind of [RuntimeString] that has a fixed length.
///
/// The specified length is in bytes, not characters.
///
/// Trying to create a [FixedLenString] with some length that is not the one
/// specified by the `LEN` parameter will cause a panic.
#[derive(Debug, Default)]
pub(crate) struct FixedLenString<const LEN: usize>(RuntimeString);

impl<const LEN: usize> String for FixedLenString<LEN> {
    fn new<S: Into<Vec<u8>>>(s: S) -> Self {
        let s = s.into();
        assert_eq!(
            s.len(),
            LEN,
            "FixedLenString<{}>::new called with invalid length: {}",
            LEN,
            s.len(),
        );
        Self(RuntimeString::new(s))
    }

    /// Returns this string as a primitive type suitable to be passed to WASM.
    fn into_wasm_with_ctx(self, ctx: &mut ScanContext) -> RuntimeStringWasm {
        self.0.into_wasm_with_ctx(ctx)
    }

    fn from_slice(ctx: &ScanContext, s: &[u8]) -> Self {
        assert_eq!(
            s.len(),
            LEN,
            "FixedLenString<{}>::new called with invalid length: {}",
            LEN,
            s.len(),
        );
        Self(RuntimeString::from_slice(ctx, s))
    }
}

#[derive(Debug, Default)]
pub(crate) struct Lowercase<S: String>(S);

impl<S: String> String for Lowercase<S> {
    fn new<V: Into<Vec<u8>>>(s: V) -> Self {
        Self(S::new(s))
    }

    fn into_wasm_with_ctx(self, ctx: &mut ScanContext) -> RuntimeStringWasm {
        self.0.into_wasm_with_ctx(ctx)
    }

    fn from_slice(ctx: &ScanContext, s: &[u8]) -> Self {
        Self(S::from_slice(ctx, s))
    }
}

#[derive(Debug, Default)]
pub(crate) struct Uppercase<S: String>(S);

impl<S: String> String for Uppercase<S> {
    fn new<V: Into<Vec<u8>>>(s: V) -> Self {
        Self(S::new(s))
    }

    fn into_wasm_with_ctx(self, ctx: &mut ScanContext) -> RuntimeStringWasm {
        self.0.into_wasm_with_ctx(ctx)
    }

    fn from_slice(ctx: &ScanContext, s: &[u8]) -> Self {
        Self(S::from_slice(ctx, s))
    }
}