diff --git a/etc/schema.json b/etc/schema.json index 1b49cf5af1fc..7c27262edda8 100644 --- a/etc/schema.json +++ b/etc/schema.json @@ -3777,7 +3777,10 @@ "rfb": { "$ref": "#/$defs/stats_applayer_error" }, - "sip": { + "sip_udp": { + "$ref": "#/$defs/stats_applayer_error" + }, + "sip_tcp": { "$ref": "#/$defs/stats_applayer_error" }, "smb": { @@ -3894,7 +3897,10 @@ "rfb": { "type": "integer" }, - "sip": { + "sip_udp": { + "type": "integer" + }, + "sip_tcp": { "type": "integer" }, "smb": { @@ -4005,7 +4011,10 @@ "rfb": { "type": "integer" }, - "sip": { + "sip_udp": { + "type": "integer" + }, + "sip_tcp": { "type": "integer" }, "smb": { diff --git a/rust/src/sip/detect.rs b/rust/src/sip/detect.rs index 63f636529a34..91df4fb29932 100644 --- a/rust/src/sip/detect.rs +++ b/rust/src/sip/detect.rs @@ -23,9 +23,7 @@ use std::ptr; #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_method( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, ) -> u8 { if let Some(ref r) = tx.request { let m = &r.method; @@ -44,9 +42,7 @@ pub unsafe extern "C" fn rs_sip_tx_get_method( #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_uri( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, ) -> u8 { if let Some(ref r) = tx.request { let p = &r.path; @@ -65,10 +61,7 @@ pub unsafe extern "C" fn rs_sip_tx_get_uri( #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_protocol( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, - direction: u8, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, direction: u8, ) -> u8 { match direction.into() { Direction::ToServer => { @@ -101,9 +94,7 @@ pub unsafe extern "C" fn rs_sip_tx_get_protocol( #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_stat_code( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, ) -> u8 { if let Some(ref r) = tx.response { let c = &r.code; @@ -122,9 +113,7 @@ pub unsafe extern "C" fn rs_sip_tx_get_stat_code( #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_stat_msg( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, ) -> u8 { if let Some(ref r) = tx.response { let re = &r.reason; @@ -143,9 +132,7 @@ pub unsafe extern "C" fn rs_sip_tx_get_stat_msg( #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_request_line( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, ) -> u8 { if let Some(ref r) = tx.request_line { if !r.is_empty() { @@ -163,9 +150,7 @@ pub unsafe extern "C" fn rs_sip_tx_get_request_line( #[no_mangle] pub unsafe extern "C" fn rs_sip_tx_get_response_line( - tx: &mut SIPTransaction, - buffer: *mut *const u8, - buffer_len: *mut u32, + tx: &mut SIPTransaction, buffer: *mut *const u8, buffer_len: *mut u32, ) -> u8 { if let Some(ref r) = tx.response_line { if !r.is_empty() { diff --git a/rust/src/sip/log.rs b/rust/src/sip/log.rs index 792acfa49021..a7a98d5eb1b3 100644 --- a/rust/src/sip/log.rs +++ b/rust/src/sip/log.rs @@ -51,4 +51,4 @@ fn log(tx: &SIPTransaction, js: &mut JsonBuilder) -> Result<(), JsonError> { #[no_mangle] pub extern "C" fn rs_sip_log_json(tx: &mut SIPTransaction, js: &mut JsonBuilder) -> bool { log(tx, js).is_ok() -} \ No newline at end of file +} diff --git a/rust/src/sip/parser.rs b/rust/src/sip/parser.rs index a34bc2615e53..9b813d5ace7d 100644 --- a/rust/src/sip/parser.rs +++ b/rust/src/sip/parser.rs @@ -15,7 +15,7 @@ * 02110-1301, USA. */ -// written by Giuseppe Longo +// written by Giuseppe Longo use nom7::bytes::streaming::{take, take_while, take_while1}; use nom7::character::streaming::{char, crlf}; @@ -59,7 +59,7 @@ pub struct Response { #[inline] fn is_token_char(b: u8) -> bool { - is_alphanumeric(b) || b"!%'*+-._`".contains(&b) + is_alphanumeric(b) || b"!%'*+-._`~".contains(&b) } #[inline] @@ -69,7 +69,7 @@ fn is_method_char(b: u8) -> bool { #[inline] fn is_request_uri_char(b: u8) -> bool { - is_alphanumeric(b) || is_token_char(b) || b"~#@:".contains(&b) + is_alphanumeric(b) || is_token_char(b) || b"~#@:;=?+&$,/".contains(&b) } #[inline] diff --git a/rust/src/sip/sip.rs b/rust/src/sip/sip.rs index 4e86f5ea476d..771d06fbd5ee 100755 --- a/rust/src/sip/sip.rs +++ b/rust/src/sip/sip.rs @@ -17,10 +17,10 @@ // written by Giuseppe Longo -use crate::frames::*; use crate::applayer::{self, *}; use crate::core; -use crate::core::{AppProto, Flow, ALPROTO_UNKNOWN}; +use crate::core::{AppProto, Flow, ALPROTO_FAILED, ALPROTO_UNKNOWN}; +use crate::frames::*; use crate::sip::parser::*; use nom7::Err; use std; @@ -86,9 +86,9 @@ impl SIPState { self.transactions.clear(); } - fn new_tx(&mut self, _direction: crate::core::Direction) -> SIPTransaction { + fn new_tx(&mut self, direction: crate::core::Direction) -> SIPTransaction { self.tx_id += 1; - SIPTransaction::new(self.tx_id) + SIPTransaction::new(self.tx_id, direction) } fn get_tx_by_id(&mut self, tx_id: u64) -> Option<&SIPTransaction> { @@ -96,10 +96,7 @@ impl SIPState { } fn free_tx(&mut self, tx_id: u64) { - let tx = self - .transactions - .iter() - .position(|tx| tx.id == tx_id + 1); + 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); @@ -112,6 +109,15 @@ impl SIPState { } } + fn append_request(&mut self, input: &[u8], request: Request) { + let mut tx = self.new_tx(crate::core::Direction::ToServer); + tx.request = Some(request); + if let Ok((_, req_line)) = sip_take_line(input) { + tx.request_line = req_line; + } + self.transactions.push(tx); + } + // app-layer-frame-documentation tag start: parse_request fn parse_request(&mut self, flow: *const core::Flow, stream_slice: StreamSlice) -> bool { let input = stream_slice.as_slice(); @@ -127,12 +133,7 @@ impl SIPState { match sip_parse_request(input) { Ok((_, request)) => { sip_frames_ts(flow, &stream_slice, &request); - let mut tx = self.new_tx(crate::core::Direction::ToServer); - tx.request = Some(request); - if let Ok((_, req_line)) = sip_take_line(input) { - tx.request_line = req_line; - } - self.transactions.push(tx); + self.append_request(input, request); return true; } // app-layer-frame-documentation tag end: parse_request @@ -147,20 +148,75 @@ impl SIPState { } } + fn parse_request_tcp( + &mut self, flow: *const core::Flow, stream_slice: StreamSlice, + ) -> AppLayerResult { + let input = stream_slice.as_slice(); + if input.is_empty() { + return AppLayerResult::ok(); + } + let _pdu = Frame::new( + flow, + &stream_slice, + input, + input.len() as i64, + SIPFrameType::Pdu as u8, + ); + SCLogDebug!("ts: pdu {:?}", _pdu); + + let mut start = input; + while !start.is_empty() { + match sip_parse_request(input) { + Ok((rem, request)) => { + start = rem; + sip_frames_ts(flow, &stream_slice, &request); + self.append_request(input, request); + } + Err(Err::Incomplete(_needed)) => { + let consumed = input.len() - start.len(); + let needed_estimation = start.len() + 1; + SCLogDebug!( + "Needed: {:?}, estimated needed: {:?}", + _needed, + needed_estimation + ); + return AppLayerResult::incomplete(consumed as u32, needed_estimation as u32); + } + Err(_) => { + self.set_event(SIPEvent::InvalidData); + return AppLayerResult::err(); + } + } + } + + // input fully consumed. + return AppLayerResult::ok(); + } + + fn append_response(&mut self, input: &[u8], response: Response) { + let mut tx = self.new_tx(crate::core::Direction::ToClient); + tx.response = Some(response); + if let Ok((_, resp_line)) = sip_take_line(input) { + tx.response_line = resp_line; + } + self.transactions.push(tx); + } + fn parse_response(&mut self, flow: *const core::Flow, stream_slice: StreamSlice) -> bool { let input = stream_slice.as_slice(); - let _pdu = Frame::new(flow, &stream_slice, input, input.len() as i64, SIPFrameType::Pdu as u8); + let _pdu = Frame::new( + flow, + &stream_slice, + input, + input.len() as i64, + SIPFrameType::Pdu as u8, + ); SCLogDebug!("tc: pdu {:?}", _pdu); match sip_parse_response(input) { Ok((_, response)) => { sip_frames_tc(flow, &stream_slice, &response); - let mut tx = self.new_tx(crate::core::Direction::ToClient); - tx.response = Some(response); - if let Ok((_, resp_line)) = sip_take_line(input) { - tx.response_line = resp_line; - } - self.transactions.push(tx); + self.append_response(input, response); return true; } Err(Err::Incomplete(_)) => { @@ -173,17 +229,62 @@ impl SIPState { } } } + + fn parse_response_tcp( + &mut self, flow: *const core::Flow, stream_slice: StreamSlice, + ) -> AppLayerResult { + let input = stream_slice.as_slice(); + if input.is_empty() { + return AppLayerResult::ok(); + } + let _pdu = Frame::new( + flow, + &stream_slice, + input, + input.len() as i64, + SIPFrameType::Pdu as u8, + ); + SCLogDebug!("tc: pdu {:?}", _pdu); + + let mut start = input; + while !start.is_empty() { + match sip_parse_response(input) { + Ok((rem, response)) => { + start = rem; + sip_frames_tc(flow, &stream_slice, &response); + self.append_response(input, response); + } + Err(Err::Incomplete(_needed)) => { + let consumed = input.len() - start.len(); + let needed_estimation = start.len() + 1; + SCLogDebug!( + "Needed: {:?}, estimated needed: {:?}", + _needed, + needed_estimation + ); + return AppLayerResult::incomplete(consumed as u32, needed_estimation as u32); + } + Err(_) => { + self.set_event(SIPEvent::InvalidData); + return AppLayerResult::err(); + } + } + } + + // input fully consumed. + return AppLayerResult::ok(); + } } impl SIPTransaction { - pub fn new(id: u64) -> SIPTransaction { + pub fn new(id: u64, direction: crate::core::Direction) -> SIPTransaction { SIPTransaction { id, request: None, response: None, request_line: None, response_line: None, - tx_data: applayer::AppLayerTxData::new(), + tx_data: applayer::AppLayerTxData::for_direction(direction), } } } @@ -224,20 +325,40 @@ fn sip_frames_ts(flow: *const core::Flow, stream_slice: &StreamSlice, r: &Reques fn sip_frames_tc(flow: *const core::Flow, stream_slice: &StreamSlice, r: &Response) { let oi = stream_slice.as_slice(); - let _f = Frame::new(flow, stream_slice, oi, r.response_line_len as i64, SIPFrameType::ResponseLine as u8); - let hi = &oi[r.response_line_len as usize ..]; + let _f = Frame::new( + flow, + stream_slice, + oi, + r.response_line_len as i64, + SIPFrameType::ResponseLine as u8, + ); + let hi = &oi[r.response_line_len as usize..]; SCLogDebug!("tc: response_line {:?}", _f); - let _f = Frame::new(flow, stream_slice, hi, r.headers_len as i64, SIPFrameType::ResponseHeaders as u8); + let _f = Frame::new( + flow, + stream_slice, + hi, + r.headers_len as i64, + SIPFrameType::ResponseHeaders as u8, + ); SCLogDebug!("tc: response_headers {:?}", _f); if r.body_len > 0 { - let bi = &oi[r.body_offset as usize ..]; - let _f = Frame::new(flow, stream_slice, bi, r.body_len as i64, SIPFrameType::ResponseBody as u8); + let bi = &oi[r.body_offset as usize..]; + let _f = Frame::new( + flow, + stream_slice, + bi, + r.body_len as i64, + SIPFrameType::ResponseBody as u8, + ); SCLogDebug!("tc: response_body {:?}", _f); } } #[no_mangle] -pub extern "C" fn rs_sip_state_new(_orig_state: *mut std::os::raw::c_void, _orig_proto: AppProto) -> *mut std::os::raw::c_void { +pub extern "C" fn rs_sip_state_new( + _orig_state: *mut std::os::raw::c_void, _orig_proto: AppProto, +) -> *mut std::os::raw::c_void { let state = SIPState::new(); let boxed = Box::new(state); return Box::into_raw(boxed) as *mut _; @@ -251,8 +372,7 @@ pub extern "C" fn rs_sip_state_free(state: *mut std::os::raw::c_void) { #[no_mangle] pub unsafe extern "C" fn rs_sip_state_get_tx( - state: *mut std::os::raw::c_void, - tx_id: u64, + state: *mut std::os::raw::c_void, tx_id: u64, ) -> *mut std::os::raw::c_void { let state = cast_pointer!(state, SIPState); match state.get_tx_by_id(tx_id) { @@ -275,8 +395,7 @@ pub unsafe extern "C" fn rs_sip_state_tx_free(state: *mut std::os::raw::c_void, #[no_mangle] pub extern "C" fn rs_sip_tx_get_alstate_progress( - _tx: *mut std::os::raw::c_void, - _direction: u8, + _tx: *mut std::os::raw::c_void, _direction: u8, ) -> std::os::raw::c_int { 1 } @@ -285,11 +404,7 @@ static mut ALPROTO_SIP: AppProto = ALPROTO_UNKNOWN; #[no_mangle] pub unsafe extern "C" fn rs_sip_probing_parser_ts( - _flow: *const Flow, - _direction: u8, - input: *const u8, - input_len: u32, - _rdir: *mut u8, + _flow: *const Flow, _direction: u8, input: *const u8, input_len: u32, _rdir: *mut u8, ) -> AppProto { let buf = build_slice!(input, input_len as usize); if sip_parse_request(buf).is_ok() { @@ -298,13 +413,30 @@ pub unsafe extern "C" fn rs_sip_probing_parser_ts( return ALPROTO_UNKNOWN; } +#[no_mangle] +pub unsafe extern "C" fn rs_sip_probing_parser_tcp_ts( + _flow: *const Flow, _direction: u8, input: *const u8, input_len: u32, _rdir: *mut u8, +) -> AppProto { + if input_len >= 3 && !input.is_null() { + let buf = build_slice!(input, input_len as usize); + match sip_parse_request(buf) { + Ok((_, _request)) => { + return ALPROTO_SIP; + } + Err(Err::Incomplete(_)) => { + return ALPROTO_UNKNOWN; + } + Err(_e) => { + return ALPROTO_FAILED; + } + } + } + return ALPROTO_UNKNOWN; +} + #[no_mangle] pub unsafe extern "C" fn rs_sip_probing_parser_tc( - _flow: *const Flow, - _direction: u8, - input: *const u8, - input_len: u32, - _rdir: *mut u8, + _flow: *const Flow, _direction: u8, input: *const u8, input_len: u32, _rdir: *mut u8, ) -> AppProto { let buf = build_slice!(input, input_len as usize); if sip_parse_response(buf).is_ok() { @@ -313,30 +445,79 @@ pub unsafe extern "C" fn rs_sip_probing_parser_tc( return ALPROTO_UNKNOWN; } +#[no_mangle] +pub unsafe extern "C" fn rs_sip_probing_parser_tcp_tc( + _flow: *const Flow, _direction: u8, input: *const u8, input_len: u32, _rdir: *mut u8, +) -> AppProto { + if input_len >= 3 && !input.is_null() { + let buf = build_slice!(input, input_len as usize); + match sip_parse_response(buf) { + Ok((_, _response)) => { + return ALPROTO_SIP; + } + Err(Err::Incomplete(_)) => { + return ALPROTO_UNKNOWN; + } + Err(_e) => { + return ALPROTO_FAILED; + } + } + } + return ALPROTO_UNKNOWN; +} + #[no_mangle] pub unsafe extern "C" fn rs_sip_parse_request( - flow: *const core::Flow, - state: *mut std::os::raw::c_void, - _pstate: *mut std::os::raw::c_void, - stream_slice: StreamSlice, - _data: *const std::os::raw::c_void, + flow: *const core::Flow, state: *mut std::os::raw::c_void, _pstate: *mut std::os::raw::c_void, + stream_slice: StreamSlice, _data: *const std::os::raw::c_void, ) -> AppLayerResult { let state = cast_pointer!(state, SIPState); state.parse_request(flow, stream_slice).into() } +#[no_mangle] +pub unsafe extern "C" fn rs_sip_parse_request_tcp( + flow: *const core::Flow, state: *mut std::os::raw::c_void, pstate: *mut std::os::raw::c_void, + stream_slice: StreamSlice, _data: *const std::os::raw::c_void, +) -> AppLayerResult { + if stream_slice.is_empty() { + if AppLayerParserStateIssetFlag(pstate, APP_LAYER_PARSER_EOF_TS) > 0 { + return AppLayerResult::ok(); + } else { + return AppLayerResult::err(); + } + } + + let state = cast_pointer!(state, SIPState); + state.parse_request_tcp(flow, stream_slice) +} + #[no_mangle] pub unsafe extern "C" fn rs_sip_parse_response( - flow: *const core::Flow, - state: *mut std::os::raw::c_void, - _pstate: *mut std::os::raw::c_void, - stream_slice: StreamSlice, - _data: *const std::os::raw::c_void, + flow: *const core::Flow, state: *mut std::os::raw::c_void, _pstate: *mut std::os::raw::c_void, + stream_slice: StreamSlice, _data: *const std::os::raw::c_void, ) -> AppLayerResult { let state = cast_pointer!(state, SIPState); state.parse_response(flow, stream_slice).into() } +#[no_mangle] +pub unsafe extern "C" fn rs_sip_parse_response_tcp( + flow: *const core::Flow, state: *mut std::os::raw::c_void, pstate: *mut std::os::raw::c_void, + stream_slice: StreamSlice, _data: *const std::os::raw::c_void, +) -> AppLayerResult { + if stream_slice.is_empty() { + if AppLayerParserStateIssetFlag(pstate, APP_LAYER_PARSER_EOF_TC) > 0 { + return AppLayerResult::ok(); + } else { + return AppLayerResult::err(); + } + } + + let state = cast_pointer!(state, SIPState); + state.parse_response_tcp(flow, stream_slice) +} + export_tx_data_get!(rs_sip_get_tx_data, SIPTransaction); export_state_data_get!(rs_sip_get_state_data, SIPState); @@ -345,7 +526,7 @@ const PARSER_NAME: &[u8] = b"sip\0"; #[no_mangle] pub unsafe extern "C" fn rs_sip_register_parser() { let default_port = CString::new("[5060,5061]").unwrap(); - let parser = RustParser { + let mut parser = RustParser { name: PARSER_NAME.as_ptr() as *const std::os::raw::c_char, default_port: default_port.as_ptr(), ipproto: core::IPPROTO_UDP, @@ -388,4 +569,22 @@ pub unsafe extern "C" fn rs_sip_register_parser() { } else { SCLogDebug!("Protocol detecter and parser disabled for SIP/UDP."); } + + // register TCP parser + parser.ipproto = core::IPPROTO_TCP; + parser.probe_ts = Some(rs_sip_probing_parser_tcp_ts); + parser.probe_tc = Some(rs_sip_probing_parser_tcp_tc); + parser.parse_ts = rs_sip_parse_request_tcp; + parser.parse_tc = rs_sip_parse_response_tcp; + + let ip_proto_str = CString::new("tcp").unwrap(); + if AppLayerProtoDetectConfProtoDetectionEnabled(ip_proto_str.as_ptr(), parser.name) != 0 { + let alproto = AppLayerRegisterProtocolDetection(&parser, 1); + ALPROTO_SIP = alproto; + if AppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 { + let _ = AppLayerRegisterParser(&parser, alproto); + } + } else { + SCLogDebug!("Protocol detector and parser disabled for SIP/TCP."); + } } diff --git a/src/output-json-sip.c b/src/output-json-sip.c index 8297be1cc3eb..394f53cc4124 100644 --- a/src/output-json-sip.c +++ b/src/output-json-sip.c @@ -88,6 +88,7 @@ static OutputInitResult OutputSIPLogInitSub(ConfNode *conf, OutputCtx *parent_ctx) { AppLayerParserRegisterLogger(IPPROTO_UDP, ALPROTO_SIP); + AppLayerParserRegisterLogger(IPPROTO_TCP, ALPROTO_SIP); return OutputJsonLogInitSub(conf, parent_ctx); } diff --git a/suricata.yaml.in b/suricata.yaml.in index 630399126dbe..7b337e11bff9 100644 --- a/suricata.yaml.in +++ b/suricata.yaml.in @@ -50,6 +50,7 @@ vars: GENEVE_PORTS: 6081 VXLAN_PORTS: 4789 TEREDO_PORTS: 3544 + SIP_PORTS: "[5060, 5061]" ## ## Step 2: Select outputs to enable