suricata 8.0.5

Suricata Rust components
Documentation
/* Copyright (C) 2017-2025 Open Information Security Foundation
 *
 * You can copy, redistribute or modify this Program under the terms of
 * the GNU General Public License version 2 as published by the Free
 * Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

/// Flow API from C.
/// cbindgen:ignore
extern "C" {
    fn FlowGetLastTimeAsParts(flow: &Flow, secs: *mut u64, usecs: *mut u64);
    fn FlowGetFlags(flow: &Flow) -> u32;
    fn FlowGetSourcePort(flow: &Flow) -> u16;
    fn FlowGetDestinationPort(flow: &Flow) -> u16;
}

// Flow flags
pub const FLOW_DIR_REVERSED: u32 = BIT_U32!(26);

/// Opaque flow type (defined in C)
pub use suricata_sys::sys::Flow;

/// Return the time of the last flow update as a `Duration`
/// since the epoch.
pub fn flow_get_last_time(flow: &Flow) -> std::time::Duration {
    unsafe {
        let mut secs: u64 = 0;
        let mut usecs: u64 = 0;
        FlowGetLastTimeAsParts(flow, &mut secs, &mut usecs);
        std::time::Duration::new(secs, usecs as u32 * 1000)
    }
}

/// Return the flow flags.
pub fn flow_get_flags(flow: &Flow) -> u32 {
    unsafe { FlowGetFlags(flow) }
}

/// Return flow ports
pub fn flow_get_ports(flow: &Flow) -> (u16, u16) {
    unsafe { (FlowGetSourcePort(flow), FlowGetDestinationPort(flow)) }
}