/* Copyright (C) 2018-2026 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.

 */

use suricata_sys::sys::{

    AppLayerParserState, AppProto, SCAppLayerParserConfParserEnabled,

    SCAppLayerProtoDetectConfProtoDetectionEnabled,

};

use crate::applayer::{self, *};

use crate::core::{ALPROTO_UNKNOWN, IPPROTO_UDP};

use crate::dhcp::parser::*;

use crate::direction::Direction;

use crate::flow::Flow;

use std;

use std::ffi::CString;

pub(super) static mut ALPROTO_DHCP: AppProto = ALPROTO_UNKNOWN;

static DHCP_MIN_FRAME_LEN: u32 = 232;

pub const BOOTP_REQUEST: u8 = 1;

pub const BOOTP_REPLY: u8 = 2;

// DHCP option types. Names based on IANA naming:

// https://www.iana.org/assignments/bootp-dhcp-parameters/bootp-dhcp-parameters.xhtml

pub const DHCP_OPT_SUBNET_MASK: u8 = 1;

pub const DHCP_OPT_ROUTERS: u8 = 3;

pub const DHCP_OPT_DNS_SERVER: u8 = 6;

pub const DHCP_OPT_HOSTNAME: u8 = 12;

pub const DHCP_OPT_REQUESTED_IP: u8 = 50;

pub const DHCP_OPT_ADDRESS_TIME: u8 = 51;

pub const DHCP_OPT_TYPE: u8 = 53;

//unused pub const DHCP_OPT_SERVER_ID: u8 = 54;

pub const DHCP_OPT_PARAMETER_LIST: u8 = 55;

pub const DHCP_OPT_RENEWAL_TIME: u8 = 58;

pub const DHCP_OPT_REBINDING_TIME: u8 = 59;

pub const DHCP_OPT_VENDOR_CLASS_ID: u8 = 60;

pub const DHCP_OPT_CLIENT_ID: u8 = 61;

pub const DHCP_OPT_END: u8 = 255;

/// DHCP message types.

pub const DHCP_TYPE_DISCOVER: u8 = 1;

pub const DHCP_TYPE_OFFER: u8 = 2;

pub const DHCP_TYPE_REQUEST: u8 = 3;

pub const DHCP_TYPE_DECLINE: u8 = 4;

pub const DHCP_TYPE_ACK: u8 = 5;

pub const DHCP_TYPE_NAK: u8 = 6;

pub const DHCP_TYPE_RELEASE: u8 = 7;

pub const DHCP_TYPE_INFORM: u8 = 8;

// DHCP parameter types.

// https://www.iana.org/assignments/bootp-dhcp-parameters/bootp-dhcp-parameters.txt

pub const DHCP_PARAM_SUBNET_MASK: u8 = 1;

pub const DHCP_PARAM_ROUTER: u8 = 3;

pub const DHCP_PARAM_DNS_SERVER: u8 = 6;

pub const DHCP_PARAM_DOMAIN: u8 = 15;

pub const DHCP_PARAM_ARP_TIMEOUT: u8 = 35;

pub const DHCP_PARAM_NTP_SERVER: u8 = 42;

pub const DHCP_PARAM_TFTP_SERVER_NAME: u8 = 66;

pub const DHCP_PARAM_TFTP_SERVER_IP: u8 = 150;

#[derive(AppLayerEvent)]

pub enum DHCPEvent {

    TruncatedOptions,

    MalformedOptions,

}

/// The concept of a transaction is more to satisfy the Suricata

/// app-layer. This DHCP parser is actually stateless where each

/// message is its own transaction.

pub struct DHCPTransaction {

    tx_id: u64,

    pub message: DHCPMessage,

    tx_data: applayer::AppLayerTxData,

}

impl DHCPTransaction {

    pub fn new(id: u64, message: DHCPMessage, direction: Direction) -> DHCPTransaction {

        DHCPTransaction {

            tx_id: id,

            message,

            tx_data: applayer::AppLayerTxData::for_direction(direction),

        }

    }

}

impl Transaction for DHCPTransaction {

    fn id(&self) -> u64 {

        self.tx_id

    }

}

#[derive(Default)]

pub struct DHCPState {

    state_data: AppLayerStateData,

    // Internal transaction ID.

    tx_id: u64,

    // List of transactions.

    transactions: Vec<DHCPTransaction>,

    events: u16,

}

impl State<DHCPTransaction> for DHCPState {

    fn get_transaction_count(&self) -> usize {

        self.transactions.len()

    }

    fn get_transaction_by_index(&self, index: usize) -> Option<&DHCPTransaction> {

        self.transactions.get(index)

    }

}

impl DHCPState {

    pub fn new() -> Self {

        Default::default()

    }

    pub fn parse(&mut self, input: &[u8], direction: Direction) -> bool {

        match parse_dhcp(input) {

            Ok((_, message)) => {

                let malformed_options = message.malformed_options;

                let truncated_options = message.truncated_options;

                self.tx_id += 1;

                let transaction = DHCPTransaction::new(self.tx_id, message, direction);

                self.transactions.push(transaction);

                if malformed_options {

                    self.set_event(DHCPEvent::MalformedOptions);

                }

                if truncated_options {

                    self.set_event(DHCPEvent::TruncatedOptions);

                }

                return true;

            }

            _ => {

                return false;

            }

        }

    }

    pub fn get_tx(&mut self, tx_id: u64) -> Option<&DHCPTransaction> {

        self.transactions.iter().find(|tx| tx.tx_id == tx_id + 1)

    }

    fn free_tx(&mut self, tx_id: u64) {

        let len = self.transactions.len();

        let mut found = false;

        let mut index = 0;

        for i in 0..len {

            let tx = &self.transactions[i];

            if tx.tx_id == tx_id + 1 {

                found = true;

                index = i;

                break;

            }

        }

        if found {

            self.transactions.remove(index);

        }

    }

    fn set_event(&mut self, event: DHCPEvent) {

        if let Some(tx) = self.transactions.last_mut() {

            tx.tx_data.set_event(event as u8);

            self.events += 1;

        }

    }

}

unsafe extern "C" fn dhcp_probing_parser(

    _flow: *const Flow, _direction: u8, input: *const u8, input_len: u32, _rdir: *mut u8,

) -> AppProto {

    if input_len < DHCP_MIN_FRAME_LEN || input.is_null() {

        return ALPROTO_UNKNOWN;

    }

    let slice = build_slice!(input, input_len as usize);

    match parse_header(slice) {

        Ok((_, _)) => {

            return ALPROTO_DHCP;

        }

        _ => {

            return ALPROTO_UNKNOWN;

        }

    }

}

extern "C" fn dhcp_tx_get_alstate_progress(

    _tx: *mut std::os::raw::c_void, _direction: u8,

) -> std::os::raw::c_int {

    // As this is a stateless parser, simply use 1.

    return 1;

}

unsafe extern "C" fn dhcp_state_get_tx(

    state: *mut std::os::raw::c_void, tx_id: u64,

) -> *mut std::os::raw::c_void {

    let state = cast_pointer!(state, DHCPState);

    match state.get_tx(tx_id) {

        Some(tx) => {

            return tx as *const _ as *mut _;

        }

        None => {

            return std::ptr::null_mut();

        }

    }

}

unsafe extern "C" fn dhcp_state_get_tx_count(state: *mut std::os::raw::c_void) -> u64 {

    let state = cast_pointer!(state, DHCPState);

    return state.tx_id;

}

unsafe extern "C" fn dhcp_parse_request(

    _flow: *mut Flow, state: *mut std::os::raw::c_void, _pstate: *mut AppLayerParserState,

    stream_slice: StreamSlice, _data: *const std::os::raw::c_void,

) -> AppLayerResult {

    let state = cast_pointer!(state, DHCPState);

    if state.parse(stream_slice.as_slice(), Direction::ToServer) {

        return AppLayerResult::ok();

    }

    return AppLayerResult::err();

}

unsafe extern "C" fn dhcp_parse_response(

    _flow: *mut Flow, state: *mut std::os::raw::c_void, _pstate: *mut AppLayerParserState,

    stream_slice: StreamSlice, _data: *const std::os::raw::c_void,

) -> AppLayerResult {

    let state = cast_pointer!(state, DHCPState);

    if state.parse(stream_slice.as_slice(), Direction::ToClient) {

        return AppLayerResult::ok();

    }

    return AppLayerResult::err();

}

pub unsafe extern "C" fn dhcp_state_tx_free(state: *mut std::os::raw::c_void, tx_id: u64) {

    let state = cast_pointer!(state, DHCPState);

    state.free_tx(tx_id);

}

extern "C" fn dhcp_state_new(

    _orig_state: *mut std::os::raw::c_void, _orig_proto: AppProto,

) -> *mut std::os::raw::c_void {

    let state = DHCPState::new();

    let boxed = Box::new(state);

    return Box::into_raw(boxed) as *mut _;

}

unsafe extern "C" fn dhcp_state_free(state: *mut std::os::raw::c_void) {

    std::mem::drop(Box::from_raw(state as *mut DHCPState));

}

export_tx_data_get!(dhcp_get_tx_data, DHCPTransaction);

export_state_data_get!(dhcp_get_state_data, DHCPState);

const PARSER_NAME: &[u8] = b"dhcp\0";

#[no_mangle]

pub unsafe extern "C" fn SCRegisterDhcpParser() {

    SCLogDebug!("Registering DHCP parser.");

    let ports = CString::new("[67,68]").unwrap();

    let parser = RustParser {

        name: PARSER_NAME.as_ptr() as *const std::os::raw::c_char,

        default_port: ports.as_ptr(),

        ipproto: IPPROTO_UDP,

        probe_ts: Some(dhcp_probing_parser),

        probe_tc: Some(dhcp_probing_parser),

        min_depth: 0,

        max_depth: 16,

        state_new: dhcp_state_new,

        state_free: dhcp_state_free,

        tx_free: dhcp_state_tx_free,

        parse_ts: dhcp_parse_request,

        parse_tc: dhcp_parse_response,

        get_tx_count: dhcp_state_get_tx_count,

        get_tx: dhcp_state_get_tx,

        tx_comp_st_ts: 1,

        tx_comp_st_tc: 1,

        tx_get_progress: dhcp_tx_get_alstate_progress,

        get_eventinfo: Some(DHCPEvent::get_event_info),

        get_eventinfo_byid: Some(DHCPEvent::get_event_info_by_id),

        localstorage_new: None,

        localstorage_free: None,

        get_tx_files: None,

        get_tx_iterator: Some(applayer::state_get_tx_iterator::<DHCPState, DHCPTransaction>),

        get_tx_data: dhcp_get_tx_data,

        get_state_data: dhcp_get_state_data,

        apply_tx_config: None,

        flags: 0,

        get_frame_id_by_name: None,

        get_frame_name_by_id: None,

        get_state_id_by_name: None,

        get_state_name_by_id: None,

    };

    let ip_proto_str = CString::new("udp").unwrap();

    if SCAppLayerProtoDetectConfProtoDetectionEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {

        let alproto = AppLayerRegisterProtocolDetection(&parser, 1);

        ALPROTO_DHCP = alproto;

        if SCAppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {

            let _ = AppLayerRegisterParser(&parser, alproto);

        }

    } else {

        SCLogDebug!("Protocol detector and parser disabled for DHCP.");

    }

}

#[cfg(test)]

mod tests {

    use super::*;

    #[test]

    fn test_tx_skip_inspect_direction() {

        let pcap = include_bytes!("discover.pcap");

        let payload = &pcap[24 + 16 + 42..];

        // a to-server tx should be marked to skip the to-client inspection it

        // will never be observed in, and a to-client tx the reverse

        let (_rem, message) = parse_dhcp(payload).unwrap();

        let ts_tx = DHCPTransaction::new(1, message, Direction::ToServer);

        assert_eq!(

            APP_LAYER_TX_SKIP_INSPECT_TC,

            ts_tx.tx_data.flags & APP_LAYER_TX_SKIP_INSPECT_TC

        );

        assert_eq!(0, ts_tx.tx_data.flags & APP_LAYER_TX_SKIP_INSPECT_TS);

        let (_rem, message) = parse_dhcp(payload).unwrap();

        let tc_tx = DHCPTransaction::new(2, message, Direction::ToClient);

        assert_eq!(

            APP_LAYER_TX_SKIP_INSPECT_TS,

            tc_tx.tx_data.flags & APP_LAYER_TX_SKIP_INSPECT_TS

        );

        assert_eq!(0, tc_tx.tx_data.flags & APP_LAYER_TX_SKIP_INSPECT_TC);

    }

}