suricata 8.0.5

/* Copyright (C) 2017-2024 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.
 */

// written by Pierre Chifflier  <chifflier@wzdftpd.net>

use crate::applayer::{self, *};
use crate::core::*;
use crate::direction::Direction;
use crate::flow::Flow;
use asn1_rs::FromDer;
use der_parser::ber::Class;
use der_parser::der::der_read_element_header;
use kerberos_parser::krb5::{
    EncryptionType, ErrorCode, KrbError, MessageType, PrincipalName, Realm,
};
use kerberos_parser::krb5_parser;
use nom7::number::streaming::be_u32;
use nom7::{Err, IResult};
use std;
use std::ffi::CString;
use suricata_sys::sys::{
    AppLayerParserState, AppProto, SCAppLayerParserConfParserEnabled,
    SCAppLayerParserRegisterLogger, SCAppLayerProtoDetectConfProtoDetectionEnabled,
};

#[derive(AppLayerEvent)]
pub enum KRB5Event {
    MalformedData,
    WeakEncryption,
}

pub struct KRB5State {
    state_data: AppLayerStateData,

    pub req_id: u8,

    pub record_ts: usize,
    pub record_tc: usize,

    /// List of transactions for this session
    transactions: Vec<KRB5Transaction>,

    /// tx counter for assigning incrementing id's to tx's
    tx_id: u64,
}

impl State<KRB5Transaction> for KRB5State {
    fn get_transaction_count(&self) -> usize {
        self.transactions.len()
    }

    fn get_transaction_by_index(&self, index: usize) -> Option<&KRB5Transaction> {
        self.transactions.get(index)
    }
}

pub struct KRB5Transaction {
    /// The message type: AS-REQ, AS-REP, etc.
    pub msg_type: MessageType,

    /// The client PrincipalName, if present
    pub cname: Option<PrincipalName>,
    /// The server Realm, if present
    pub realm: Option<Realm>,
    /// The server PrincipalName, if present
    pub sname: Option<PrincipalName>,

    /// Encryption used (only in AS-REP and TGS-REP)
    pub etype: Option<EncryptionType>,

    /// Encryption used for ticket
    pub ticket_etype: Option<EncryptionType>,

    /// Error code, if request has failed
    pub error_code: Option<ErrorCode>,

    /// Message type of request. For using in responses.
    pub req_type: Option<MessageType>,

    /// The internal transaction id
    id: u64,

    tx_data: applayer::AppLayerTxData,
}

impl Transaction for KRB5Transaction {
    fn id(&self) -> u64 {
        self.id
    }
}

impl Default for KRB5State {
    fn default() -> Self {
        Self::new()
    }
}

impl KRB5State {
    pub fn new() -> KRB5State {
        Self {
            state_data: AppLayerStateData::new(),
            req_id: 0,
            record_ts: 0,
            record_tc: 0,
            transactions: Vec::new(),
            tx_id: 0,
        }
    }

    /// Parse a Kerberos request message
    ///
    /// Returns 0 in case of success, or -1 on error
    fn parse(&mut self, i: &[u8], flow: *mut Flow, direction: Direction) -> i32 {
        match der_read_element_header(i) {
            Ok((_rem, hdr)) => {
                // Kerberos messages start with an APPLICATION header
                if hdr.class() != Class::Application {
                    return 0;
                }
                match hdr.tag().0 {
                    10 => {
                        let req = krb5_parser::parse_as_req(i);
                        if let Ok((_, kdc_req)) = req {
                            let mut tx = self.new_tx(direction);
                            tx.msg_type = MessageType::KRB_AS_REQ;
                            tx.cname = kdc_req.req_body.cname;
                            tx.realm = Some(kdc_req.req_body.realm);
                            tx.sname = kdc_req.req_body.sname;
                            tx.etype = None;
                            self.transactions.push(tx);
                            sc_app_layer_parser_trigger_raw_stream_inspection(
                                flow,
                                direction as i32,
                            );
                        };
                        self.req_id = 10;
                    }
                    11 => {
                        let res = krb5_parser::parse_as_rep(i);
                        if let Ok((_, kdc_rep)) = res {
                            let mut tx = self.new_tx(direction);
                            tx.msg_type = MessageType::KRB_AS_REP;
                            if self.req_id > 0 {
                                // set request type only if previous message
                                // was a request
                                tx.req_type = Some(MessageType(self.req_id.into()));
                            }
                            tx.cname = Some(kdc_rep.cname);
                            tx.realm = Some(kdc_rep.crealm);
                            tx.sname = Some(kdc_rep.ticket.sname);
                            tx.ticket_etype = Some(kdc_rep.ticket.enc_part.etype);
                            tx.etype = Some(kdc_rep.enc_part.etype);
                            self.transactions.push(tx);
                            sc_app_layer_parser_trigger_raw_stream_inspection(
                                flow,
                                direction as i32,
                            );
                            if test_weak_encryption(kdc_rep.enc_part.etype) {
                                self.set_event(KRB5Event::WeakEncryption);
                            }
                        };
                        self.req_id = 0;
                    }
                    12 => {
                        let req = krb5_parser::parse_tgs_req(i);
                        if let Ok((_, kdc_req)) = req {
                            let mut tx = self.new_tx(direction);
                            tx.msg_type = MessageType::KRB_TGS_REQ;
                            tx.cname = kdc_req.req_body.cname;
                            tx.realm = Some(kdc_req.req_body.realm);
                            tx.sname = kdc_req.req_body.sname;
                            tx.etype = None;
                            self.transactions.push(tx);
                            sc_app_layer_parser_trigger_raw_stream_inspection(
                                flow,
                                direction as i32,
                            );
                        };
                        self.req_id = 12;
                    }
                    13 => {
                        let res = krb5_parser::parse_tgs_rep(i);
                        if let Ok((_, kdc_rep)) = res {
                            let mut tx = self.new_tx(direction);
                            tx.msg_type = MessageType::KRB_TGS_REP;
                            if self.req_id > 0 {
                                // set request type only if previous message
                                // was a request
                                tx.req_type = Some(MessageType(self.req_id.into()));
                            }
                            tx.cname = Some(kdc_rep.cname);
                            tx.realm = Some(kdc_rep.crealm);
                            tx.ticket_etype = Some(kdc_rep.ticket.enc_part.etype);
                            tx.sname = Some(kdc_rep.ticket.sname);
                            tx.etype = Some(kdc_rep.enc_part.etype);
                            self.transactions.push(tx);
                            sc_app_layer_parser_trigger_raw_stream_inspection(
                                flow,
                                direction as i32,
                            );
                            if test_weak_encryption(kdc_rep.enc_part.etype) {
                                self.set_event(KRB5Event::WeakEncryption);
                            }
                        };
                        self.req_id = 0;
                    }
                    14 => {
                        self.req_id = 14;
                    }
                    15 => {
                        self.req_id = 0;
                    }
                    30 => {
                        let res = KrbError::from_der(i);
                        if let Ok((_, error)) = res {
                            let mut tx = self.new_tx(direction);
                            if self.req_id > 0 {
                                // set request type only if previous message
                                // was a request
                                tx.req_type = Some(MessageType(self.req_id.into()));
                            }
                            tx.msg_type = MessageType::KRB_ERROR;
                            tx.cname = error.cname;
                            tx.realm = error.crealm;
                            tx.sname = Some(error.sname);
                            tx.error_code = Some(error.error_code);
                            self.transactions.push(tx);
                            sc_app_layer_parser_trigger_raw_stream_inspection(
                                flow,
                                direction as i32,
                            );
                        };
                        self.req_id = 0;
                    }
                    _ => {
                        SCLogDebug!("unknown/unsupported tag {}", hdr.tag());
                    }
                }
                0
            }
            Err(Err::Incomplete(_)) => {
                SCLogDebug!("Insufficient data while parsing KRB5 data");
                self.set_event(KRB5Event::MalformedData);
                -1
            }
            Err(_) => {
                SCLogDebug!("Error while parsing KRB5 data");
                self.set_event(KRB5Event::MalformedData);
                -1
            }
        }
    }

    pub fn free(&mut self) {
        // All transactions are freed when the `transactions` object is freed.
        // But let's be explicit
        self.transactions.clear();
    }

    fn new_tx(&mut self, direction: Direction) -> KRB5Transaction {
        self.tx_id += 1;
        KRB5Transaction::new(direction, self.tx_id)
    }

    fn get_tx_by_id(&mut self, tx_id: u64) -> Option<&KRB5Transaction> {
        self.transactions.iter().find(|&tx| tx.id == tx_id + 1)
    }

    fn free_tx(&mut self, tx_id: u64) {
        let tx = self.transactions.iter().position(|tx| tx.id == tx_id + 1);
        debug_assert!(tx.is_some());
        if let Some(idx) = tx {
            let _ = self.transactions.remove(idx);
        }
    }

    /// Set an event. The event is set on the most recent transaction.
    fn set_event(&mut self, event: KRB5Event) {
        if let Some(tx) = self.transactions.last_mut() {
            tx.tx_data.set_event(event as u8);
        }
    }
}

impl KRB5Transaction {
    pub fn new(direction: Direction, id: u64) -> KRB5Transaction {
        let krbtx = KRB5Transaction {
            msg_type: MessageType(0),
            cname: None,
            realm: None,
            sname: None,
            etype: None,
            ticket_etype: None,
            error_code: None,
            req_type: None,
            id,
            tx_data: applayer::AppLayerTxData::for_direction(direction),
        };
        return krbtx;
    }
}

/// Return true if Kerberos `EncryptionType` is weak
pub fn test_weak_encryption(alg: EncryptionType) -> bool {
    match alg {
        EncryptionType::AES128_CTS_HMAC_SHA1_96
        | EncryptionType::AES256_CTS_HMAC_SHA1_96
        | EncryptionType::AES128_CTS_HMAC_SHA256_128
        | EncryptionType::AES256_CTS_HMAC_SHA384_192
        | EncryptionType::CAMELLIA128_CTS_CMAC
        | EncryptionType::CAMELLIA256_CTS_CMAC => false,
        _ => true, // all other ciphers are weak or deprecated
    }
}

/// Returns *mut KRB5State
extern "C" fn krb5_state_new(
    _orig_state: *mut std::os::raw::c_void, _orig_proto: AppProto,
) -> *mut std::os::raw::c_void {
    let state = KRB5State::new();
    let boxed = Box::new(state);
    return Box::into_raw(boxed) as *mut _;
}

/// Params:
/// - state: *mut KRB5State as void pointer
extern "C" fn krb5_state_free(state: *mut std::os::raw::c_void) {
    let mut state: Box<KRB5State> = unsafe { Box::from_raw(state as _) };
    state.free();
}

unsafe extern "C" fn krb5_state_get_tx(
    state: *mut std::os::raw::c_void, tx_id: u64,
) -> *mut std::os::raw::c_void {
    let state = cast_pointer!(state, KRB5State);
    match state.get_tx_by_id(tx_id) {
        Some(tx) => tx as *const _ as *mut _,
        None => std::ptr::null_mut(),
    }
}

unsafe extern "C" fn krb5_state_get_tx_count(state: *mut std::os::raw::c_void) -> u64 {
    let state = cast_pointer!(state, KRB5State);
    state.tx_id
}

unsafe extern "C" fn krb5_state_tx_free(state: *mut std::os::raw::c_void, tx_id: u64) {
    let state = cast_pointer!(state, KRB5State);
    state.free_tx(tx_id);
}

pub extern "C" fn krb5_tx_get_alstate_progress(
    _tx: *mut std::os::raw::c_void, _direction: u8,
) -> std::os::raw::c_int {
    1
}

static mut ALPROTO_KRB5: AppProto = ALPROTO_UNKNOWN;

unsafe extern "C" fn krb5_probing_parser(
    _flow: *const Flow, _direction: u8, input: *const u8, input_len: u32, _rdir: *mut u8,
) -> AppProto {
    if input.is_null() {
        return ALPROTO_UNKNOWN;
    }
    let slice = build_slice!(input, input_len as usize);
    let alproto = ALPROTO_KRB5;
    if slice.len() <= 10 {
        return ALPROTO_FAILED;
    }
    match der_read_element_header(slice) {
        Ok((rem, ref hdr)) => {
            // Kerberos messages start with an APPLICATION header
            if hdr.class() != Class::Application {
                return ALPROTO_FAILED;
            }
            // Tag number should be <= 30
            if hdr.tag().0 > 30 {
                return ALPROTO_FAILED;
            }
            // Kerberos messages contain sequences
            if rem.is_empty() || rem[0] != 0x30 {
                return ALPROTO_FAILED;
            }
            // Check kerberos version
            if let Ok((rem, _hdr)) = der_read_element_header(rem) {
                if rem.len() > 5 {
                    #[allow(clippy::single_match)]
                    match (rem[2], rem[3], rem[4]) {
                        // Encoding of DER integer 5 (version)
                        (2, 1, 5) => {
                            return alproto;
                        }
                        _ => (),
                    }
                }
            }
            return ALPROTO_FAILED;
        }
        Err(Err::Incomplete(_)) => {
            return ALPROTO_UNKNOWN;
        }
        Err(_) => {
            return ALPROTO_FAILED;
        }
    }
}

unsafe extern "C" fn krb5_probing_parser_tcp(
    _flow: *const Flow, direction: u8, input: *const u8, input_len: u32, rdir: *mut u8,
) -> AppProto {
    if input.is_null() {
        return ALPROTO_UNKNOWN;
    }
    let slice = build_slice!(input, input_len as usize);
    if slice.len() <= 14 {
        return ALPROTO_FAILED;
    }
    match be_u32(slice) as IResult<&[u8], u32> {
        Ok((rem, record_mark)) => {
            // protocol implementations forbid very large requests
            if record_mark > 16384 {
                return ALPROTO_FAILED;
            }
            return krb5_probing_parser(_flow, direction, rem.as_ptr(), rem.len() as u32, rdir);
        }
        Err(Err::Incomplete(_)) => {
            return ALPROTO_UNKNOWN;
        }
        Err(_) => {
            return ALPROTO_FAILED;
        }
    }
}

unsafe extern "C" fn krb5_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 buf = stream_slice.as_slice();
    let state = cast_pointer!(state, KRB5State);
    if state.parse(buf, flow, Direction::ToServer) < 0 {
        return AppLayerResult::err();
    }
    AppLayerResult::ok()
}

unsafe extern "C" fn krb5_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 buf = stream_slice.as_slice();
    let state = cast_pointer!(state, KRB5State);
    if state.parse(buf, flow, Direction::ToClient) < 0 {
        return AppLayerResult::err();
    }
    AppLayerResult::ok()
}

unsafe extern "C" fn krb5_parse_request_tcp(
    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, KRB5State);
    let mut cur_i = stream_slice.as_slice();
    let start_len = cur_i.len();
    while !cur_i.is_empty() {
        if state.record_ts == 0 {
            match be_u32(cur_i) as IResult<&[u8], u32> {
                Ok((rem, record)) => {
                    state.record_ts = record as usize;
                    cur_i = rem;
                }
                Err(Err::Incomplete(_)) => {
                    return AppLayerResult::incomplete((start_len - cur_i.len()) as u32, 4u32);
                }
                _ => {
                    SCLogDebug!("krb5_parse_request_tcp: reading record mark failed!");
                    return AppLayerResult::err();
                }
            }
        }
        if cur_i.len() >= state.record_ts {
            if state.parse(cur_i, flow, Direction::ToServer) < 0 {
                return AppLayerResult::err();
            }
            cur_i = &cur_i[state.record_ts..];
            state.record_ts = 0;
        } else {
            // more fragments required
            return AppLayerResult::incomplete(
                (start_len - cur_i.len()) as u32,
                state.record_ts as u32,
            );
        }
    }
    AppLayerResult::ok()
}

unsafe extern "C" fn krb5_parse_response_tcp(
    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, KRB5State);
    let mut cur_i = stream_slice.as_slice();
    let start_len = cur_i.len();
    while !cur_i.is_empty() {
        if state.record_tc == 0 {
            match be_u32(cur_i) as IResult<&[u8], _> {
                Ok((rem, record)) => {
                    state.record_tc = record as usize;
                    cur_i = rem;
                }
                Err(Err::Incomplete(_)) => {
                    return AppLayerResult::incomplete((start_len - cur_i.len()) as u32, 4u32);
                }
                _ => {
                    SCLogDebug!("reading record mark failed!");
                    return AppLayerResult::ok();
                }
            }
        }
        if cur_i.len() >= state.record_tc {
            if state.parse(cur_i, flow, Direction::ToClient) < 0 {
                return AppLayerResult::err();
            }
            cur_i = &cur_i[state.record_tc..];
            state.record_tc = 0;
        } else {
            // more fragments required
            return AppLayerResult::incomplete(
                (start_len - cur_i.len()) as u32,
                state.record_tc as u32,
            );
        }
    }
    AppLayerResult::ok()
}

export_tx_data_get!(krb5_get_tx_data, KRB5Transaction);
export_state_data_get!(krb5_get_state_data, KRB5State);

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

#[no_mangle]
pub unsafe extern "C" fn SCRegisterKrb5Parser() {
    let default_port = CString::new("88").unwrap();
    let mut parser = RustParser {
        name: PARSER_NAME.as_ptr() as *const std::os::raw::c_char,
        default_port: default_port.as_ptr(),
        ipproto: IPPROTO_UDP,
        probe_ts: Some(krb5_probing_parser),
        probe_tc: Some(krb5_probing_parser),
        min_depth: 0,
        max_depth: 16,
        state_new: krb5_state_new,
        state_free: krb5_state_free,
        tx_free: krb5_state_tx_free,
        parse_ts: krb5_parse_request,
        parse_tc: krb5_parse_response,
        get_tx_count: krb5_state_get_tx_count,
        get_tx: krb5_state_get_tx,
        tx_comp_st_ts: 1,
        tx_comp_st_tc: 1,
        tx_get_progress: krb5_tx_get_alstate_progress,
        get_eventinfo: Some(KRB5Event::get_event_info),
        get_eventinfo_byid: Some(KRB5Event::get_event_info_by_id),
        localstorage_new: None,
        localstorage_free: None,
        get_tx_files: None,
        get_tx_iterator: Some(applayer::state_get_tx_iterator::<KRB5State, KRB5Transaction>),
        get_tx_data: krb5_get_tx_data,
        get_state_data: krb5_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,
    };
    // register UDP parser
    let ip_proto_str = CString::new("udp").unwrap();
    if SCAppLayerProtoDetectConfProtoDetectionEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
        let alproto = AppLayerRegisterProtocolDetection(&parser, 1);
        // store the allocated ID for the probe function
        ALPROTO_KRB5 = alproto;
        if SCAppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
            let _ = AppLayerRegisterParser(&parser, alproto);
        }
        SCAppLayerParserRegisterLogger(IPPROTO_UDP, ALPROTO_KRB5);
    } else {
        SCLogDebug!("Protocol detector and parser disabled for KRB5/UDP.");
    }
    // register TCP parser
    parser.ipproto = IPPROTO_TCP;
    parser.probe_ts = Some(krb5_probing_parser_tcp);
    parser.probe_tc = Some(krb5_probing_parser_tcp);
    parser.parse_ts = krb5_parse_request_tcp;
    parser.parse_tc = krb5_parse_response_tcp;
    let ip_proto_str = CString::new("tcp").unwrap();
    if SCAppLayerProtoDetectConfProtoDetectionEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
        let alproto = AppLayerRegisterProtocolDetection(&parser, 1);
        // store the allocated ID for the probe function
        ALPROTO_KRB5 = alproto;
        if SCAppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
            let _ = AppLayerRegisterParser(&parser, alproto);
        }
        SCAppLayerParserRegisterLogger(IPPROTO_TCP, ALPROTO_KRB5);
    } else {
        SCLogDebug!("Protocol detector and parser disabled for KRB5/TCP.");
    }
}