vyre 0.4.0

GPU compute intermediate representation with a standard operation library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! Shared bounds, result records, byte helpers, and detector primitives.

pub mod attacks;
pub mod bytes;
pub mod decode;
pub mod entropy;
pub mod magic;
pub mod spans;
pub mod xor;

pub use attacks::{
    detect_command_injection, detect_lfi, detect_obfuscated_js, detect_path_traversal, detect_rfi,
    detect_sql_injection, detect_ssrf, detect_xss, detect_xxe,
};
pub use bytes::{
    contains_ci, find_bytes, find_ci, is_alnum, is_base64_char, is_base64url_char, is_boundary,
    is_email_domain, is_email_local, is_uri_char, lower_ascii, starts_ci,
};
pub use decode::{
    hex_nibble, parse_ipv4, parse_ipv6, parse_jwt, parse_octet, percent_decode_lower,
};
pub use entropy::{high_entropy_offsets, high_entropy_spans, shannon_bits};
pub use magic::{
    detect_packed_binary, file_magic_detect, push_if, MagicFinding, MAGIC_CLASS, MAGIC_ELF,
    MAGIC_GZIP, MAGIC_MACHO32, MAGIC_MACHO64, MAGIC_PDF, MAGIC_PE, MAGIC_PNG, MAGIC_ZIP,
};
pub use spans::{
    advance_while, base64_run_offsets, email_spans, hex_run_offsets, ipv4_spans, ipv6_spans,
    jwt_spans, matches_uuid, pem_spans, push_run, rewind_while, run_offsets, span, url_spans,
    uuid_spans, ByteSpan,
};
pub use xor::{
    best_key, dedupe, detect_xor_single_byte, english_score, looks_like_plaintext, ranges_overlap,
    XorSingleByteFinding,
};

/// Maximum accepted detector input length.
pub const MAX_INPUT_LEN: usize = 64 * 1024 * 1024;

/// Actionable detector error text.
pub type DetectionError = String;

/// Convert a byte offset or length to the public u32 ABI.
///
/// # Errors
///
/// Returns `Fix: ...` when the value cannot be represented in the ABI.
pub fn to_u32(value: usize, field: &str) -> Result<u32, DetectionError> {
    u32::try_from(value)
        .map_err(|_| format!("Fix: reduce input length so {field} {value} fits in U32"))
}

/// Reject inputs above the detector-wide maximum.
///
/// # Errors
///
/// Returns `Fix: ...` when the byte slice exceeds [`MAX_INPUT_LEN`].
pub fn validate_input(input: &[u8]) -> Result<(), DetectionError> {
    if input.len() > MAX_INPUT_LEN {
        return Err(format!(
            "Fix: reduce security detector input length to <= {MAX_INPUT_LEN} bytes, got {}",
            input.len()
        ));
    }
    Ok(())
}