You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
suricata/rust/src/ldap/ldap.rs

786 lines
27 KiB
Rust

/* Copyright (C) 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.
*/
// Author: Giuseppe Longo <giuseppe@glongo.it>
// Author: Pierre Chifflier <chifflier@wzdftpd.net>
use crate::applayer::{self, *};
use crate::conf::conf_get;
use crate::core::*;
use crate::direction::Direction;
use crate::flow::Flow;
use crate::frames::*;
use ldap_parser::asn1_rs::ToStatic;
use nom7 as nom;
use std;
use std::collections::VecDeque;
use std::ffi::CString;
use std::os::raw::{c_char, c_int, c_void};
use suricata_sys::sys::{
AppLayerParserState, AppProto, SCAppLayerParserConfParserEnabled,
SCAppLayerParserRegisterLogger, SCAppLayerParserStateIssetFlag,
SCAppLayerProtoDetectConfProtoDetectionEnabled, SCAppLayerRequestProtocolTLSUpgrade,
};
use super::types::*;
use ldap_parser::ldap::*;
static LDAP_MAX_TX_DEFAULT: usize = 256;
static mut LDAP_MAX_TX: usize = LDAP_MAX_TX_DEFAULT;
pub(super) static mut ALPROTO_LDAP: AppProto = ALPROTO_UNKNOWN;
const STARTTLS_OID: &str = "1.3.6.1.4.1.1466.20037";
#[derive(AppLayerFrameType)]
pub enum LdapFrameType {
Pdu,
}
#[derive(AppLayerEvent)]
enum LdapEvent {
TooManyTransactions,
InvalidData,
RequestNotFound,
IncompleteData,
}
#[derive(Debug)]
pub struct LdapTransaction {
pub tx_id: u64,
pub request: Option<LdapMessage<'static>>,
pub responses: VecDeque<LdapMessage<'static>>,
complete: bool,
tx_data: AppLayerTxData,
}
impl Default for LdapTransaction {
fn default() -> Self {
Self::new()
}
}
impl LdapTransaction {
pub fn new() -> LdapTransaction {
Self {
tx_id: 0,
request: None,
responses: VecDeque::new(),
complete: false,
tx_data: AppLayerTxData::new(),
}
}
}
impl Transaction for LdapTransaction {
fn id(&self) -> u64 {
self.tx_id
}
}
#[derive(Default)]
pub struct LdapState {
state_data: AppLayerStateData,
tx_id: u64,
transactions: VecDeque<LdapTransaction>,
request_frame: Option<Frame>,
response_frame: Option<Frame>,
request_gap: bool,
response_gap: bool,
request_tls: bool,
has_starttls: bool,
}
impl State<LdapTransaction> for LdapState {
fn get_transaction_count(&self) -> usize {
self.transactions.len()
}
fn get_transaction_by_index(&self, index: usize) -> Option<&LdapTransaction> {
self.transactions.get(index)
}
}
impl LdapState {
pub fn new() -> Self {
Self {
state_data: AppLayerStateData::new(),
tx_id: 0,
transactions: VecDeque::new(),
request_frame: None,
response_frame: None,
request_gap: false,
response_gap: false,
request_tls: false,
has_starttls: false,
}
}
// Free a transaction by ID.
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);
}
}
pub fn get_tx(&mut self, tx_id: u64) -> Option<&LdapTransaction> {
self.transactions.iter().find(|tx| tx.tx_id == tx_id + 1)
}
pub fn new_tx(&mut self) -> Option<LdapTransaction> {
if self.transactions.len() > unsafe { LDAP_MAX_TX } {
for tx_old in &mut self.transactions {
if !tx_old.complete {
tx_old.tx_data.updated_tc = true;
tx_old.tx_data.updated_ts = true;
tx_old.complete = true;
tx_old
.tx_data
.set_event(LdapEvent::TooManyTransactions as u8);
}
}
return None;
}
let mut tx = LdapTransaction::new();
self.tx_id += 1;
tx.tx_id = self.tx_id;
return Some(tx);
}
fn set_event(&mut self, e: LdapEvent) {
if let Some(tx) = self.transactions.back_mut() {
tx.tx_data.set_event(e as u8);
}
}
fn find_request(&mut self, message_id: MessageID) -> Option<&mut LdapTransaction> {
self.transactions.iter_mut().find(|tx| {
tx.request
.as_ref()
.is_some_and(|req| req.message_id == message_id)
})
}
fn parse_request(&mut self, flow: *mut Flow, stream_slice: StreamSlice) -> AppLayerResult {
let input = stream_slice.as_slice();
if input.is_empty() {
return AppLayerResult::ok();
}
if self.has_starttls {
unsafe {
SCAppLayerRequestProtocolTLSUpgrade(flow);
}
return AppLayerResult::ok();
}
if self.request_gap {
match ldap_parse_msg(input) {
Ok((_, _msg)) => {
AppLayerResult::ok();
}
Err(_e) => {
return AppLayerResult::err();
}
}
self.request_gap = false;
}
let mut start = input;
while !start.is_empty() {
if self.request_frame.is_none() {
self.request_frame = Frame::new(
flow,
&stream_slice,
start,
-1_i64,
LdapFrameType::Pdu as u8,
None,
);
SCLogDebug!("ts: pdu {:?}", self.request_frame);
}
match ldap_parse_msg(start) {
Ok((rem, request)) => {
let tx = self.new_tx();
if tx.is_none() {
return AppLayerResult::err();
}
let mut tx = tx.unwrap();
let tx_id = tx.id();
// check if STARTTLS was requested
if let ProtocolOp::ExtendedRequest(request) = &request.protocol_op {
if request.request_name.0 == STARTTLS_OID {
self.request_tls = true;
}
}
tx.complete |= tx_is_complete(&request.protocol_op, Direction::ToServer);
tx.request = Some(request.to_static());
self.transactions.push_back(tx);
sc_app_layer_parser_trigger_raw_stream_inspection(
flow,
Direction::ToServer as i32,
);
let consumed = start.len() - rem.len();
start = rem;
self.set_frame_ts(flow, tx_id, consumed as i64);
}
Err(nom::Err::Incomplete(_)) => {
let consumed = input.len() - start.len();
let needed = start.len() + 1;
return AppLayerResult::incomplete(consumed as u32, needed as u32);
}
Err(_) => {
self.set_event(LdapEvent::InvalidData);
return AppLayerResult::err();
}
}
}
return AppLayerResult::ok();
}
fn parse_response(&mut self, flow: *mut Flow, stream_slice: StreamSlice) -> AppLayerResult {
let input = stream_slice.as_slice();
if input.is_empty() {
return AppLayerResult::ok();
}
if self.response_gap {
match ldap_parse_msg(input) {
Ok((_, _msg)) => {
AppLayerResult::ok();
}
Err(_e) => {
return AppLayerResult::err();
}
}
self.response_gap = false;
}
let mut start = input;
while !start.is_empty() {
if self.response_frame.is_none() {
self.response_frame = Frame::new(
flow,
&stream_slice,
start,
-1_i64,
LdapFrameType::Pdu as u8,
None,
);
SCLogDebug!("tc: pdu {:?}", self.response_frame);
}
match ldap_parse_msg(start) {
Ok((rem, response)) => {
// check if STARTTLS was requested
if self.request_tls {
if let ProtocolOp::ExtendedResponse(response) = &response.protocol_op {
if response.result.result_code == ResultCode(0) {
SCLogDebug!("LDAP: STARTTLS detected");
self.has_starttls = true;
}
self.request_tls = false;
}
}
if let Some(tx) = self.find_request(response.message_id) {
tx.complete |= tx_is_complete(&response.protocol_op, Direction::ToClient);
let tx_id = tx.id();
tx.tx_data.updated_tc = true;
tx.responses.push_back(response.to_static());
sc_app_layer_parser_trigger_raw_stream_inspection(
flow,
Direction::ToClient as i32,
);
let consumed = start.len() - rem.len();
self.set_frame_tc(flow, tx_id, consumed as i64);
} else if let ProtocolOp::ExtendedResponse(_) = response.protocol_op {
// this is an unsolicited notification, which means
// there is no request
let tx = self.new_tx();
if tx.is_none() {
return AppLayerResult::err();
}
let mut tx = tx.unwrap();
let tx_id = tx.id();
tx.complete = true;
tx.responses.push_back(response.to_static());
self.transactions.push_back(tx);
sc_app_layer_parser_trigger_raw_stream_inspection(
flow,
Direction::ToClient as i32,
);
let consumed = start.len() - rem.len();
self.set_frame_tc(flow, tx_id, consumed as i64);
} else {
let tx = self.new_tx();
if tx.is_none() {
return AppLayerResult::err();
}
let mut tx = tx.unwrap();
tx.complete = true;
let tx_id = tx.id();
tx.responses.push_back(response.to_static());
self.transactions.push_back(tx);
sc_app_layer_parser_trigger_raw_stream_inspection(
flow,
Direction::ToClient as i32,
);
self.set_event(LdapEvent::RequestNotFound);
let consumed = start.len() - rem.len();
self.set_frame_tc(flow, tx_id, consumed as i64);
};
start = rem;
}
Err(nom::Err::Incomplete(_)) => {
let consumed = input.len() - start.len();
let needed = start.len() + 1;
return AppLayerResult::incomplete(consumed as u32, needed as u32);
}
Err(_) => {
self.set_event(LdapEvent::InvalidData);
return AppLayerResult::err();
}
}
}
return AppLayerResult::ok();
}
fn parse_request_udp(
&mut self, flow: *const Flow, stream_slice: StreamSlice,
) -> AppLayerResult {
let input = stream_slice.as_slice();
let _pdu = Frame::new(
flow,
&stream_slice,
input,
input.len() as i64,
LdapFrameType::Pdu as u8,
None,
);
SCLogDebug!("ts: pdu {:?}", self.request_frame);
match ldap_parse_msg(input) {
Ok((_, request)) => {
let tx = self.new_tx();
if tx.is_none() {
return AppLayerResult::err();
}
let mut tx = tx.unwrap();
tx.complete |= tx_is_complete(&request.protocol_op, Direction::ToServer);
tx.request = Some(request.to_static());
self.transactions.push_back(tx);
}
Err(nom::Err::Incomplete(_)) => {
self.set_event(LdapEvent::IncompleteData);
return AppLayerResult::err();
}
Err(_) => {
self.set_event(LdapEvent::InvalidData);
return AppLayerResult::err();
}
}
return AppLayerResult::ok();
}
fn parse_response_udp(
&mut self, flow: *const Flow, stream_slice: StreamSlice,
) -> AppLayerResult {
let input = stream_slice.as_slice();
if input.is_empty() {
return AppLayerResult::ok();
}
let mut start = input;
while !start.is_empty() {
if self.response_frame.is_none() {
self.response_frame = Frame::new(
flow,
&stream_slice,
start,
-1_i64,
LdapFrameType::Pdu as u8,
None,
);
SCLogDebug!("tc: pdu {:?}", self.response_frame);
}
match ldap_parse_msg(start) {
Ok((rem, response)) => {
if let Some(tx) = self.find_request(response.message_id) {
tx.complete |= tx_is_complete(&response.protocol_op, Direction::ToClient);
let tx_id = tx.id();
tx.responses.push_back(response.to_static());
let consumed = start.len() - rem.len();
self.set_frame_tc(flow, tx_id, consumed as i64);
} else if let ProtocolOp::ExtendedResponse(_) = response.protocol_op {
// this is an unsolicited notification, which means
// there is no request
let tx = self.new_tx();
if tx.is_none() {
return AppLayerResult::err();
}
let mut tx = tx.unwrap();
tx.complete = true;
let tx_id = tx.id();
tx.responses.push_back(response.to_static());
self.transactions.push_back(tx);
let consumed = start.len() - rem.len();
self.set_frame_tc(flow, tx_id, consumed as i64);
} else {
let tx = self.new_tx();
if tx.is_none() {
return AppLayerResult::err();
}
let mut tx = tx.unwrap();
tx.complete = true;
let tx_id = tx.id();
tx.responses.push_back(response.to_static());
self.transactions.push_back(tx);
self.set_event(LdapEvent::RequestNotFound);
let consumed = start.len() - rem.len();
self.set_frame_tc(flow, tx_id, consumed as i64);
};
start = rem;
}
Err(nom::Err::Incomplete(_)) => {
self.set_event(LdapEvent::IncompleteData);
return AppLayerResult::err();
}
Err(_) => {
self.set_event(LdapEvent::InvalidData);
return AppLayerResult::err();
}
}
}
return AppLayerResult::ok();
}
fn set_frame_ts(&mut self, flow: *const Flow, tx_id: u64, consumed: i64) {
if let Some(frame) = &self.request_frame {
frame.set_len(flow, consumed);
frame.set_tx(flow, tx_id);
self.request_frame = None;
}
}
fn set_frame_tc(&mut self, flow: *const Flow, tx_id: u64, consumed: i64) {
if let Some(frame) = &self.response_frame {
frame.set_len(flow, consumed);
frame.set_tx(flow, tx_id);
self.response_frame = None;
}
}
fn on_request_gap(&mut self, _size: u32) {
self.request_gap = true;
}
fn on_response_gap(&mut self, _size: u32) {
self.response_gap = true;
}
}
fn tx_is_complete(op: &ProtocolOp, dir: Direction) -> bool {
match dir {
Direction::ToServer => match op {
ProtocolOp::UnbindRequest => true,
ProtocolOp::AbandonRequest(_) => true,
_ => false,
},
Direction::ToClient => match op {
ProtocolOp::SearchResultDone(_)
| ProtocolOp::BindResponse(_)
| ProtocolOp::ModifyResponse(_)
| ProtocolOp::AddResponse(_)
| ProtocolOp::DelResponse(_)
| ProtocolOp::ModDnResponse(_)
| ProtocolOp::CompareResponse(_)
| ProtocolOp::ExtendedResponse(_) => true,
_ => false,
},
}
}
fn probe(input: &[u8], direction: Direction, rdir: *mut u8) -> AppProto {
match ldap_parse_msg(input) {
Ok((_, ldap_msg)) => {
if direction == Direction::ToServer && !ldap_is_request(&ldap_msg) {
unsafe {
*rdir = Direction::ToClient.into();
}
}
if direction == Direction::ToClient && !ldap_is_response(&ldap_msg) {
unsafe {
*rdir = Direction::ToServer.into();
}
}
return unsafe { ALPROTO_LDAP };
}
Err(nom::Err::Incomplete(_)) => {
return ALPROTO_UNKNOWN;
}
Err(_e) => {
return ALPROTO_FAILED;
}
}
}
unsafe extern "C" fn ldap_probing_parser(
_flow: *const Flow, direction: u8, input: *const u8, input_len: u32, rdir: *mut u8,
) -> AppProto {
if input_len > 1 && !input.is_null() {
let slice = build_slice!(input, input_len as usize);
return probe(slice, direction.into(), rdir);
}
return ALPROTO_UNKNOWN;
}
extern "C" fn ldap_state_new(_orig_state: *mut c_void, _orig_proto: AppProto) -> *mut c_void {
let state = LdapState::new();
let boxed = Box::new(state);
return Box::into_raw(boxed) as *mut c_void;
}
unsafe extern "C" fn ldap_state_free(state: *mut c_void) {
std::mem::drop(Box::from_raw(state as *mut LdapState));
}
unsafe extern "C" fn ldap_state_tx_free(state: *mut c_void, tx_id: u64) {
let state = cast_pointer!(state, LdapState);
state.free_tx(tx_id);
}
unsafe extern "C" fn ldap_parse_request(
flow: *mut Flow, state: *mut c_void, pstate: *mut AppLayerParserState,
stream_slice: StreamSlice, _data: *const c_void,
) -> AppLayerResult {
if stream_slice.is_empty() {
if SCAppLayerParserStateIssetFlag(pstate, APP_LAYER_PARSER_EOF_TS) > 0 {
return AppLayerResult::ok();
} else {
return AppLayerResult::err();
}
}
let state = cast_pointer!(state, LdapState);
if stream_slice.is_gap() {
state.on_request_gap(stream_slice.gap_size());
} else {
return state.parse_request(flow, stream_slice);
}
AppLayerResult::ok()
}
unsafe extern "C" fn ldap_parse_response(
flow: *mut Flow, state: *mut c_void, pstate: *mut AppLayerParserState,
stream_slice: StreamSlice, _data: *const c_void,
) -> AppLayerResult {
if stream_slice.is_empty() {
if SCAppLayerParserStateIssetFlag(pstate, APP_LAYER_PARSER_EOF_TC) > 0 {
return AppLayerResult::ok();
} else {
return AppLayerResult::err();
}
}
let state = cast_pointer!(state, LdapState);
if stream_slice.is_gap() {
state.on_response_gap(stream_slice.gap_size());
} else {
return state.parse_response(flow, stream_slice);
}
AppLayerResult::ok()
}
unsafe extern "C" fn ldap_parse_request_udp(
flow: *mut Flow, state: *mut c_void, _pstate: *mut AppLayerParserState,
stream_slice: StreamSlice, _data: *const c_void,
) -> AppLayerResult {
let state = cast_pointer!(state, LdapState);
state.parse_request_udp(flow, stream_slice)
}
unsafe extern "C" fn ldap_parse_response_udp(
flow: *mut Flow, state: *mut c_void, _pstate: *mut AppLayerParserState,
stream_slice: StreamSlice, _data: *const c_void,
) -> AppLayerResult {
let state = cast_pointer!(state, LdapState);
state.parse_response_udp(flow, stream_slice)
}
unsafe extern "C" fn ldap_state_get_tx(state: *mut c_void, tx_id: u64) -> *mut c_void {
let state = cast_pointer!(state, LdapState);
match state.get_tx(tx_id) {
Some(tx) => {
return tx as *const _ as *mut _;
}
None => {
return std::ptr::null_mut();
}
}
}
unsafe extern "C" fn ldap_state_get_tx_count(state: *mut c_void) -> u64 {
let state = cast_pointer!(state, LdapState);
return state.tx_id;
}
unsafe extern "C" fn ldap_tx_get_alstate_progress(tx: *mut c_void, _direction: u8) -> c_int {
let tx = cast_pointer!(tx, LdapTransaction);
if tx.complete {
return 1;
}
return 0;
}
export_tx_data_get!(ldap_get_tx_data, LdapTransaction);
export_state_data_get!(ldap_get_state_data, LdapState);
const PARSER_NAME: &[u8] = b"ldap\0";
#[no_mangle]
pub unsafe extern "C" fn SCRegisterLdapTcpParser() {
let default_port = CString::new("[389, 3268]").unwrap();
let parser = RustParser {
name: PARSER_NAME.as_ptr() as *const c_char,
default_port: default_port.as_ptr(),
ipproto: IPPROTO_TCP,
probe_ts: Some(ldap_probing_parser),
probe_tc: Some(ldap_probing_parser),
min_depth: 0,
max_depth: 16,
state_new: ldap_state_new,
state_free: ldap_state_free,
tx_free: ldap_state_tx_free,
parse_ts: ldap_parse_request,
parse_tc: ldap_parse_response,
get_tx_count: ldap_state_get_tx_count,
get_tx: ldap_state_get_tx,
tx_comp_st_ts: 1,
tx_comp_st_tc: 1,
tx_get_progress: ldap_tx_get_alstate_progress,
get_eventinfo: Some(LdapEvent::get_event_info),
get_eventinfo_byid: Some(LdapEvent::get_event_info_by_id),
localstorage_new: None,
localstorage_free: None,
get_tx_files: None,
get_tx_iterator: Some(applayer::state_get_tx_iterator::<LdapState, LdapTransaction>),
get_tx_data: ldap_get_tx_data,
get_state_data: ldap_get_state_data,
apply_tx_config: None,
flags: APP_LAYER_PARSER_OPT_ACCEPT_GAPS,
get_frame_id_by_name: Some(LdapFrameType::ffi_id_from_name),
get_frame_name_by_id: Some(LdapFrameType::ffi_name_from_id),
get_state_id_by_name: None,
get_state_name_by_id: None,
};
let ip_proto_str = CString::new("tcp").unwrap();
if SCAppLayerProtoDetectConfProtoDetectionEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
let alproto = AppLayerRegisterProtocolDetection(&parser, 1);
ALPROTO_LDAP = alproto;
if SCAppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
let _ = AppLayerRegisterParser(&parser, alproto);
}
if let Some(val) = conf_get("app-layer.protocols.ldap.max-tx") {
if let Ok(v) = val.parse::<usize>() {
if LDAP_MAX_TX == LDAP_MAX_TX_DEFAULT {
LDAP_MAX_TX = v;
}
} else {
SCLogError!("Invalid value for ldap.max-tx");
}
}
SCAppLayerParserRegisterLogger(IPPROTO_TCP, ALPROTO_LDAP);
} else {
SCLogDebug!("Protocol detection and parser disabled for LDAP/TCP.");
}
}
#[no_mangle]
pub unsafe extern "C" fn SCRegisterLdapUdpParser() {
let default_port = CString::new("[389, 3268]").unwrap();
let parser = RustParser {
name: PARSER_NAME.as_ptr() as *const c_char,
default_port: default_port.as_ptr(),
ipproto: IPPROTO_UDP,
probe_ts: Some(ldap_probing_parser),
probe_tc: Some(ldap_probing_parser),
min_depth: 0,
max_depth: 16,
state_new: ldap_state_new,
state_free: ldap_state_free,
tx_free: ldap_state_tx_free,
parse_ts: ldap_parse_request_udp,
parse_tc: ldap_parse_response_udp,
get_tx_count: ldap_state_get_tx_count,
get_tx: ldap_state_get_tx,
tx_comp_st_ts: 1,
tx_comp_st_tc: 1,
tx_get_progress: ldap_tx_get_alstate_progress,
get_eventinfo: Some(LdapEvent::get_event_info),
get_eventinfo_byid: Some(LdapEvent::get_event_info_by_id),
localstorage_new: None,
localstorage_free: None,
get_tx_files: None,
get_tx_iterator: Some(applayer::state_get_tx_iterator::<LdapState, LdapTransaction>),
get_tx_data: ldap_get_tx_data,
get_state_data: ldap_get_state_data,
apply_tx_config: None,
flags: 0,
get_frame_id_by_name: Some(LdapFrameType::ffi_id_from_name),
get_frame_name_by_id: Some(LdapFrameType::ffi_name_from_id),
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_LDAP = alproto;
if SCAppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
let _ = AppLayerRegisterParser(&parser, alproto);
}
if let Some(val) = conf_get("app-layer.protocols.ldap.max-tx") {
if let Ok(v) = val.parse::<usize>() {
if LDAP_MAX_TX == LDAP_MAX_TX_DEFAULT {
LDAP_MAX_TX = v;
}
} else {
SCLogError!("Invalid value for ldap.max-tx");
}
}
SCAppLayerParserRegisterLogger(IPPROTO_UDP, ALPROTO_LDAP);
} else {
SCLogDebug!("Protocol detection and parser disabled for LDAP/UDP.");
}
}