• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

OISF / suricata / 22771398406

06 Mar 2026 04:05PM UTC coverage: 60.821% (-18.5%) from 79.291%
22771398406

Pull #14969

github

web-flow
Merge 4bff826f9 into 6ec9e5c95
Pull Request #14969: suricata.yaml: add missing modbus logger v2

132766 of 218288 relevant lines covered (60.82%)

2431625.5 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.56
/rust/src/ssh/ssh.rs
1
/* Copyright (C) 2020-2025 Open Information Security Foundation
2
 *
3
 * You can copy, redistribute or modify this Program under the terms of
4
 * the GNU General Public License version 2 as published by the Free
5
 * Software Foundation.
6
 *
7
 * This program is distributed in the hope that it will be useful,
8
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 * GNU General Public License for more details.
11
 *
12
 * You should have received a copy of the GNU General Public License
13
 * version 2 along with this program; if not, write to the Free Software
14
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15
 * 02110-1301, USA.
16
 */
17

18
use super::parser;
19
use crate::applayer::*;
20
use crate::core::*;
21
use crate::direction::Direction;
22
use crate::encryption::EncryptionHandling;
23
use crate::flow::Flow;
24
use crate::frames::Frame;
25
use nom8::Err;
26
use std::ffi::CString;
27
use std::sync::atomic::{AtomicBool, Ordering};
28
use suricata_sys::sys::{
29
    AppLayerParserState, AppProto, SCAppLayerParserConfParserEnabled,
30
    SCAppLayerParserRegisterLogger, SCAppLayerParserStateSetFlag,
31
    SCAppLayerProtoDetectConfProtoDetectionEnabled,
32
};
33

34
pub(super) static mut ALPROTO_SSH: AppProto = ALPROTO_UNKNOWN;
35
static HASSH_ENABLED: AtomicBool = AtomicBool::new(false);
36
static HASSH_DISABLED: AtomicBool = AtomicBool::new(false);
37

38
static mut ENCRYPTION_BYPASS_ENABLED: EncryptionHandling =
39
    EncryptionHandling::ENCRYPTION_HANDLING_TRACK_ONLY;
40

41
fn hassh_is_enabled() -> bool {
21,572✔
42
    HASSH_ENABLED.load(Ordering::Relaxed)
21,572✔
43
}
21,572✔
44

45
fn encryption_bypass_mode() -> EncryptionHandling {
33✔
46
    unsafe { ENCRYPTION_BYPASS_ENABLED }
33✔
47
}
33✔
48

49
#[derive(AppLayerFrameType)]
50
pub enum SshFrameType {
51
    RecordHdr,
52
    RecordData,
53
    RecordPdu,
54
}
55

56
#[derive(AppLayerEvent)]
374✔
57
pub enum SSHEvent {
58
    InvalidBanner,
59
    LongBanner,
60
    InvalidRecord,
61
    LongKexRecord,
62
}
63

64
#[repr(u8)]
65
#[derive(AppLayerState, Copy, Clone, PartialOrd, PartialEq, Eq)]
66
#[suricata(alstate_strip_prefix = "SshState")]
67
pub enum SSHConnectionState {
68
    SshStateInProgress = 0,
69
    SshStateBannerWaitEol = 1,
70
    SshStateBannerDone = 2,
71
    SshStateFinished = 3,
72
}
73

74
pub const SSH_MAX_BANNER_LEN: usize = 256;
75
const SSH_RECORD_HEADER_LEN: usize = 6;
76
const SSH_MAX_REASSEMBLED_RECORD_LEN: usize = 65535;
77

78
pub struct SshHeader {
79
    record_left: u32,
80
    record_left_msg: parser::MessageCode,
81

82
    flags: SSHConnectionState,
83
    pub protover: Vec<u8>,
84
    pub swver: Vec<u8>,
85

86
    pub hassh: Vec<u8>,
87
    pub hassh_string: Vec<u8>,
88
}
89

90
impl Default for SshHeader {
91
    fn default() -> Self {
316✔
92
        Self::new()
316✔
93
    }
316✔
94
}
95

96
impl SshHeader {
97
    pub fn new() -> SshHeader {
316✔
98
        Self {
316✔
99
            record_left: 0,
316✔
100
            record_left_msg: parser::MessageCode::Undefined(0),
316✔
101

316✔
102
            flags: SSHConnectionState::SshStateInProgress,
316✔
103
            protover: Vec::new(),
316✔
104
            swver: Vec::new(),
316✔
105

316✔
106
            hassh: Vec::new(),
316✔
107
            hassh_string: Vec::new(),
316✔
108
        }
316✔
109
    }
316✔
110
}
111

112
#[derive(Default)]
113
pub struct SSHTransaction {
114
    pub srv_hdr: SshHeader,
115
    pub cli_hdr: SshHeader,
116

117
    tx_data: AppLayerTxData,
118
}
119

120
#[derive(Default)]
121
pub struct SSHState {
122
    state_data: AppLayerStateData,
123
    transaction: SSHTransaction,
124
}
125

126
impl SSHState {
127
    pub fn new() -> Self {
158✔
128
        Default::default()
158✔
129
    }
158✔
130

131
    fn set_event(&mut self, event: SSHEvent) {
12✔
132
        self.transaction.tx_data.set_event(event as u8);
12✔
133
    }
12✔
134

135
    fn parse_record(
1,026✔
136
        &mut self, mut input: &[u8], resp: bool, pstate: *mut AppLayerParserState,
1,026✔
137
        flow: *mut Flow, stream_slice: &StreamSlice,
1,026✔
138
    ) -> AppLayerResult {
1,026✔
139
        let (hdr, ohdr) = if !resp {
1,026✔
140
            (&mut self.transaction.cli_hdr, &self.transaction.srv_hdr)
453✔
141
        } else {
142
            (&mut self.transaction.srv_hdr, &self.transaction.cli_hdr)
573✔
143
        };
144
        let il = input.len();
1,026✔
145
        //first skip record left bytes
1,026✔
146
        if hdr.record_left > 0 {
1,026✔
147
            //should we check for overflow ?
148
            let ilen = input.len() as u32;
388✔
149
            if hdr.record_left > ilen {
388✔
150
                hdr.record_left -= ilen;
358✔
151
                return AppLayerResult::ok();
358✔
152
            } else {
153
                let start = hdr.record_left as usize;
30✔
154
                match hdr.record_left_msg {
29✔
155
                    // parse reassembled tcp segments
156
                    parser::MessageCode::Kexinit if hassh_is_enabled() => {
29✔
157
                        if let Ok((_rem, key_exchange)) =
20✔
158
                            parser::ssh_parse_key_exchange(&input[..start])
29✔
159
                        {
20✔
160
                            key_exchange.generate_hassh(
20✔
161
                                &mut hdr.hassh_string,
20✔
162
                                &mut hdr.hassh,
20✔
163
                                &resp,
20✔
164
                            );
20✔
165
                        }
20✔
166
                        hdr.record_left_msg = parser::MessageCode::Undefined(0);
29✔
167
                    }
168
                    _ => {}
1✔
169
                }
170
                input = &input[start..];
30✔
171
                hdr.record_left = 0;
30✔
172
            }
173
        }
638✔
174
        //parse records out of input
175
        while !input.is_empty() {
1,052✔
176
            match parser::ssh_parse_record(input) {
552✔
177
                Ok((rem, head)) => {
384✔
178
                    let _pdu = Frame::new(
384✔
179
                        flow,
384✔
180
                        stream_slice,
384✔
181
                        input,
384✔
182
                        SSH_RECORD_HEADER_LEN as i64,
384✔
183
                        SshFrameType::RecordHdr as u8,
384✔
184
                        Some(0),
384✔
185
                    );
384✔
186
                    let _pdu = Frame::new(
384✔
187
                        flow,
384✔
188
                        stream_slice,
384✔
189
                        &input[SSH_RECORD_HEADER_LEN..],
384✔
190
                        (head.pkt_len - 2) as i64,
384✔
191
                        SshFrameType::RecordData as u8,
384✔
192
                        Some(0),
384✔
193
                    );
384✔
194
                    let _pdu = Frame::new(
384✔
195
                        flow,
384✔
196
                        stream_slice,
384✔
197
                        input,
384✔
198
                        (head.pkt_len + 4) as i64,
384✔
199
                        SshFrameType::RecordPdu as u8,
384✔
200
                        Some(0),
384✔
201
                    );
384✔
202
                    SCLogDebug!("SSH valid record {}", head);
203
                    match head.msg_code {
147✔
204
                        parser::MessageCode::Kexinit if hassh_is_enabled() => {
147✔
205
                            //let endkex = SSH_RECORD_HEADER_LEN + head.pkt_len - 2;
147✔
206
                            let endkex = input.len() - rem.len();
147✔
207
                            if let Ok((_, key_exchange)) = parser::ssh_parse_key_exchange(
147✔
208
                                &input[SSH_RECORD_HEADER_LEN..endkex],
147✔
209
                            ) {
147✔
210
                                key_exchange.generate_hassh(
124✔
211
                                    &mut hdr.hassh_string,
124✔
212
                                    &mut hdr.hassh,
124✔
213
                                    &resp,
124✔
214
                                );
124✔
215
                            }
124✔
216
                        }
217
                        parser::MessageCode::NewKeys => {
218
                            hdr.flags = SSHConnectionState::SshStateFinished;
94✔
219
                            if ohdr.flags >= SSHConnectionState::SshStateFinished {
94✔
220
                                let mut flags = 0;
33✔
221

33✔
222
                                match encryption_bypass_mode() {
33✔
223
                                    EncryptionHandling::ENCRYPTION_HANDLING_BYPASS => {
×
224
                                        flags |= APP_LAYER_PARSER_NO_INSPECTION
×
225
                                            | APP_LAYER_PARSER_NO_REASSEMBLY
×
226
                                            | APP_LAYER_PARSER_BYPASS_READY;
×
227
                                    }
×
228
                                    EncryptionHandling::ENCRYPTION_HANDLING_TRACK_ONLY => {
33✔
229
                                        flags |= APP_LAYER_PARSER_NO_INSPECTION;
33✔
230
                                    }
33✔
231
                                    _ => {}
×
232
                                }
233

234
                                if flags != 0 {
33✔
235
                                    unsafe {
33✔
236
                                        SCAppLayerParserStateSetFlag(pstate, flags);
33✔
237
                                    }
33✔
238
                                }
×
239
                            }
61✔
240
                        }
241
                        _ => {}
143✔
242
                    }
243

244
                    input = rem;
384✔
245
                    //header and complete data (not returned)
246
                }
247
                Err(Err::Incomplete(_)) => {
248
                    match parser::ssh_parse_record_header(input) {
168✔
249
                        Ok((rem, head)) => {
149✔
250
                            let _pdu = Frame::new(
149✔
251
                                flow,
149✔
252
                                stream_slice,
149✔
253
                                input,
149✔
254
                                SSH_RECORD_HEADER_LEN as i64,
149✔
255
                                SshFrameType::RecordHdr as u8,
149✔
256
                                Some(0),
149✔
257
                            );
149✔
258
                            let _pdu = Frame::new(
149✔
259
                                flow,
149✔
260
                                stream_slice,
149✔
261
                                &input[SSH_RECORD_HEADER_LEN..],
149✔
262
                                (head.pkt_len - 2) as i64,
149✔
263
                                SshFrameType::RecordData as u8,
149✔
264
                                Some(0),
149✔
265
                            );
149✔
266
                            let _pdu = Frame::new(
149✔
267
                                flow,
149✔
268
                                stream_slice,
149✔
269
                                input,
149✔
270
                                // cast first to avoid unsigned integer overflow
149✔
271
                                (head.pkt_len as u64 + 4) as i64,
149✔
272
                                SshFrameType::RecordPdu as u8,
149✔
273
                                Some(0),
149✔
274
                            );
149✔
275
                            SCLogDebug!("SSH valid record header {}", head);
149✔
276
                            let remlen = rem.len() as u32;
149✔
277
                            hdr.record_left = head.pkt_len - 2 - remlen;
149✔
278
                            //header with rem as incomplete data
279
                            match head.msg_code {
44✔
280
                                parser::MessageCode::NewKeys => {
4✔
281
                                    hdr.flags = SSHConnectionState::SshStateFinished;
4✔
282
                                }
4✔
283
                                parser::MessageCode::Kexinit if hassh_is_enabled() => {
44✔
284
                                    // check if buffer is bigger than maximum reassembled packet size
44✔
285
                                    hdr.record_left = head.pkt_len - 2;
44✔
286
                                    if hdr.record_left < SSH_MAX_REASSEMBLED_RECORD_LEN as u32 {
44✔
287
                                        // saving type of incomplete kex message
288
                                        hdr.record_left_msg = parser::MessageCode::Kexinit;
43✔
289
                                        return AppLayerResult::incomplete(
43✔
290
                                            (il - rem.len()) as u32,
43✔
291
                                            head.pkt_len - 2,
43✔
292
                                        );
43✔
293
                                    } else {
1✔
294
                                        SCLogDebug!("SSH buffer is bigger than maximum reassembled packet size");
1✔
295
                                        self.set_event(SSHEvent::LongKexRecord);
1✔
296
                                    }
1✔
297
                                }
298
                                _ => {}
101✔
299
                            }
300
                            return AppLayerResult::ok();
106✔
301
                        }
302
                        Err(Err::Incomplete(_)) => {
303
                            //we may have consumed data from previous records
304
                            debug_validate_bug_on!(input.len() >= SSH_RECORD_HEADER_LEN);
305
                            //do not trust nom incomplete value
306
                            return AppLayerResult::incomplete(
19✔
307
                                (il - input.len()) as u32,
19✔
308
                                SSH_RECORD_HEADER_LEN as u32,
19✔
309
                            );
19✔
310
                        }
311
                        Err(_e) => {
×
312
                            SCLogDebug!("SSH invalid record header {}", _e);
×
313
                            self.set_event(SSHEvent::InvalidRecord);
×
314
                            return AppLayerResult::err();
×
315
                        }
316
                    }
317
                }
318
                Err(_e) => {
×
319
                    SCLogDebug!("SSH invalid record {}", _e);
×
320
                    self.set_event(SSHEvent::InvalidRecord);
×
321
                    return AppLayerResult::err();
×
322
                }
323
            }
324
        }
325
        return AppLayerResult::ok();
500✔
326
    }
1,026✔
327

328
    fn parse_banner(
296✔
329
        &mut self, input: &[u8], resp: bool, pstate: *mut AppLayerParserState, flow: *mut Flow,
296✔
330
        stream_slice: &StreamSlice,
296✔
331
    ) -> AppLayerResult {
296✔
332
        let hdr = if !resp {
296✔
333
            &mut self.transaction.cli_hdr
152✔
334
        } else {
335
            &mut self.transaction.srv_hdr
144✔
336
        };
337
        if hdr.flags == SSHConnectionState::SshStateBannerWaitEol {
296✔
338
            match parser::ssh_parse_line(input) {
1✔
339
                Ok((rem, _)) => {
1✔
340
                    let mut r = self.parse_record(rem, resp, pstate, flow, stream_slice);
1✔
341
                    if r.is_incomplete() {
1✔
342
                        //adds bytes consumed by banner to incomplete result
×
343
                        r.consumed += (input.len() - rem.len()) as u32;
×
344
                    } else if r.is_ok() {
1✔
345
                        let mut dir = Direction::ToServer as i32;
1✔
346
                        if resp {
1✔
347
                            dir = Direction::ToClient as i32;
1✔
348
                        }
1✔
349
                        sc_app_layer_parser_trigger_raw_stream_inspection(flow, dir);
1✔
350
                    }
×
351
                    return r;
1✔
352
                }
353
                Err(Err::Incomplete(_)) => {
354
                    // we do not need to retain these bytes
355
                    // we parsed them, we skip them
356
                    return AppLayerResult::ok();
×
357
                }
358
                Err(_e) => {
×
359
                    SCLogDebug!("SSH invalid banner {}", _e);
×
360
                    self.set_event(SSHEvent::InvalidBanner);
×
361
                    return AppLayerResult::err();
×
362
                }
363
            }
364
        }
295✔
365
        match parser::ssh_parse_line(input) {
295✔
366
            Ok((rem, line)) => {
281✔
367
                if let Ok((_, banner)) = parser::ssh_parse_banner(line) {
281✔
368
                    hdr.protover.extend(banner.protover);
276✔
369
                    if !banner.swver.is_empty() {
276✔
370
                        hdr.swver.extend(banner.swver);
276✔
371
                    }
276✔
372
                    hdr.flags = SSHConnectionState::SshStateBannerDone;
276✔
373
                } else {
374
                    SCLogDebug!("SSH invalid banner");
375
                    self.set_event(SSHEvent::InvalidBanner);
5✔
376
                    return AppLayerResult::err();
5✔
377
                }
378
                if line.len() >= SSH_MAX_BANNER_LEN {
276✔
379
                    SCLogDebug!(
2✔
380
                        "SSH banner too long {} vs {}",
2✔
381
                        line.len(),
2✔
382
                        SSH_MAX_BANNER_LEN
2✔
383
                    );
2✔
384
                    self.set_event(SSHEvent::LongBanner);
2✔
385
                }
274✔
386
                let mut r = self.parse_record(rem, resp, pstate, flow, stream_slice);
276✔
387
                if r.is_incomplete() {
276✔
388
                    //adds bytes consumed by banner to incomplete result
60✔
389
                    r.consumed += (input.len() - rem.len()) as u32;
60✔
390
                } else if r.is_ok() {
216✔
391
                    let mut dir = Direction::ToServer as i32;
216✔
392
                    if resp {
216✔
393
                        dir = Direction::ToClient as i32;
124✔
394
                    }
124✔
395
                    sc_app_layer_parser_trigger_raw_stream_inspection(flow, dir);
216✔
396
                }
×
397
                return r;
276✔
398
            }
399
            Err(Err::Incomplete(_)) => {
400
                // see https://github.com/rust-lang/rust-clippy/issues/15158
401
                #[allow(clippy::collapsible_else_if)]
402
                if input.len() < SSH_MAX_BANNER_LEN {
14✔
403
                    //0 consumed, needs at least one more byte
404
                    return AppLayerResult::incomplete(0_u32, (input.len() + 1) as u32);
10✔
405
                } else {
406
                    SCLogDebug!(
407
                        "SSH banner too long {} vs {} and waiting for eol",
408
                        input.len(),
409
                        SSH_MAX_BANNER_LEN
410
                    );
411
                    if let Ok((_, banner)) = parser::ssh_parse_banner(input) {
4✔
412
                        hdr.protover.extend(banner.protover);
2✔
413
                        if !banner.swver.is_empty() {
2✔
414
                            hdr.swver.extend(banner.swver);
2✔
415
                        }
2✔
416
                        hdr.flags = SSHConnectionState::SshStateBannerWaitEol;
2✔
417
                        self.set_event(SSHEvent::LongBanner);
2✔
418
                        return AppLayerResult::ok();
2✔
419
                    } else {
420
                        self.set_event(SSHEvent::InvalidBanner);
2✔
421
                        return AppLayerResult::err();
2✔
422
                    }
423
                }
424
            }
425
            Err(_e) => {
×
426
                SCLogDebug!("SSH invalid banner {}", _e);
×
427
                self.set_event(SSHEvent::InvalidBanner);
×
428
                return AppLayerResult::err();
×
429
            }
430
        }
431
    }
296✔
432
}
433

434
// C exports.
435

436
export_tx_data_get!(ssh_get_tx_data, SSHTransaction);
437
export_state_data_get!(ssh_get_state_data, SSHState);
438

439
extern "C" fn ssh_state_new(
158✔
440
    _orig_state: *mut std::os::raw::c_void, _orig_proto: AppProto,
158✔
441
) -> *mut std::os::raw::c_void {
158✔
442
    let state = SSHState::new();
158✔
443
    let boxed = Box::new(state);
158✔
444
    return Box::into_raw(boxed) as *mut _;
158✔
445
}
158✔
446

447
unsafe extern "C" fn ssh_state_free(state: *mut std::os::raw::c_void) {
158✔
448
    std::mem::drop(Box::from_raw(state as *mut SSHState));
158✔
449
}
158✔
450

451
extern "C" fn ssh_state_tx_free(_state: *mut std::os::raw::c_void, _tx_id: u64) {
22✔
452
    //do nothing
22✔
453
}
22✔
454

455
unsafe extern "C" fn ssh_parse_request(
465✔
456
    flow: *mut Flow, state: *mut std::os::raw::c_void, pstate: *mut AppLayerParserState,
465✔
457
    stream_slice: StreamSlice, _data: *mut std::os::raw::c_void,
465✔
458
) -> AppLayerResult {
465✔
459
    let state = &mut cast_pointer!(state, SSHState);
465✔
460
    let buf = stream_slice.as_slice();
465✔
461
    let hdr = &mut state.transaction.cli_hdr;
465✔
462
    state.transaction.tx_data.0.updated_ts = true;
465✔
463
    if hdr.flags < SSHConnectionState::SshStateBannerDone {
465✔
464
        return state.parse_banner(buf, false, pstate, flow, &stream_slice);
152✔
465
    } else {
466
        return state.parse_record(buf, false, pstate, flow, &stream_slice);
313✔
467
    }
468
}
465✔
469

470
unsafe extern "C" fn ssh_parse_response(
580✔
471
    flow: *mut Flow, state: *mut std::os::raw::c_void, pstate: *mut AppLayerParserState,
580✔
472
    stream_slice: StreamSlice, _data: *mut std::os::raw::c_void,
580✔
473
) -> AppLayerResult {
580✔
474
    let state = &mut cast_pointer!(state, SSHState);
580✔
475
    let buf = stream_slice.as_slice();
580✔
476
    let hdr = &mut state.transaction.srv_hdr;
580✔
477
    state.transaction.tx_data.0.updated_tc = true;
580✔
478
    if hdr.flags < SSHConnectionState::SshStateBannerDone {
580✔
479
        return state.parse_banner(buf, true, pstate, flow, &stream_slice);
144✔
480
    } else {
481
        return state.parse_record(buf, true, pstate, flow, &stream_slice);
436✔
482
    }
483
}
580✔
484

485
#[no_mangle]
486
pub unsafe extern "C" fn SCSshStateGetTx(
6,498✔
487
    state: *mut std::os::raw::c_void, _tx_id: u64,
6,498✔
488
) -> *mut std::os::raw::c_void {
6,498✔
489
    let state = cast_pointer!(state, SSHState);
6,498✔
490
    return &state.transaction as *const _ as *mut _;
6,498✔
491
}
6,498✔
492

493
extern "C" fn ssh_state_get_tx_count(_state: *mut std::os::raw::c_void) -> u64 {
9,603✔
494
    return 1;
9,603✔
495
}
9,603✔
496

497
#[no_mangle]
498
pub unsafe extern "C" fn SCSshTxGetFlags(
×
499
    tx: *mut std::os::raw::c_void, direction: u8,
×
500
) -> SSHConnectionState {
×
501
    let tx = cast_pointer!(tx, SSHTransaction);
×
502
    if direction == u8::from(Direction::ToServer) {
×
503
        return tx.cli_hdr.flags;
×
504
    } else {
505
        return tx.srv_hdr.flags;
×
506
    }
507
}
×
508

509
#[no_mangle]
510
pub unsafe extern "C" fn SCSshTxGetAlStateProgress(
8,388✔
511
    tx: *mut std::os::raw::c_void, direction: u8,
8,388✔
512
) -> std::os::raw::c_int {
8,388✔
513
    let tx = cast_pointer!(tx, SSHTransaction);
8,388✔
514

8,388✔
515
    if tx.cli_hdr.flags >= SSHConnectionState::SshStateFinished
8,388✔
516
        && tx.srv_hdr.flags >= SSHConnectionState::SshStateFinished
2,778✔
517
    {
518
        return SSHConnectionState::SshStateFinished as i32;
248✔
519
    }
8,140✔
520

8,140✔
521
    if direction == u8::from(Direction::ToServer) {
8,140✔
522
        if tx.cli_hdr.flags >= SSHConnectionState::SshStateBannerDone {
3,377✔
523
            return SSHConnectionState::SshStateBannerDone as i32;
3,002✔
524
        }
375✔
525
    } else if tx.srv_hdr.flags >= SSHConnectionState::SshStateBannerDone {
4,763✔
526
        return SSHConnectionState::SshStateBannerDone as i32;
4,209✔
527
    }
554✔
528

529
    return SSHConnectionState::SshStateInProgress as i32;
929✔
530
}
8,388✔
531

532
// Parser name as a C style string.
533
const PARSER_NAME: &[u8] = b"ssh\0";
534

535
#[no_mangle]
536
pub unsafe extern "C" fn SCRegisterSshParser() {
37✔
537
    let parser = RustParser {
37✔
538
        name: PARSER_NAME.as_ptr() as *const std::os::raw::c_char,
37✔
539
        default_port: std::ptr::null(),
37✔
540
        ipproto: IPPROTO_TCP,
37✔
541
        //simple patterns, no probing
37✔
542
        probe_ts: None,
37✔
543
        probe_tc: None,
37✔
544
        min_depth: 0,
37✔
545
        max_depth: 0,
37✔
546
        state_new: ssh_state_new,
37✔
547
        state_free: ssh_state_free,
37✔
548
        tx_free: ssh_state_tx_free,
37✔
549
        parse_ts: ssh_parse_request,
37✔
550
        parse_tc: ssh_parse_response,
37✔
551
        get_tx_count: ssh_state_get_tx_count,
37✔
552
        get_tx: SCSshStateGetTx,
37✔
553
        tx_comp_st_ts: SSHConnectionState::SshStateFinished as i32,
37✔
554
        tx_comp_st_tc: SSHConnectionState::SshStateFinished as i32,
37✔
555
        tx_get_progress: SCSshTxGetAlStateProgress,
37✔
556
        get_eventinfo: Some(SSHEvent::get_event_info),
37✔
557
        get_eventinfo_byid: Some(SSHEvent::get_event_info_by_id),
37✔
558
        localstorage_new: None,
37✔
559
        localstorage_free: None,
37✔
560
        get_tx_files: None,
37✔
561
        get_tx_iterator: None,
37✔
562
        get_tx_data: ssh_get_tx_data,
37✔
563
        get_state_data: ssh_get_state_data,
37✔
564
        apply_tx_config: None,
37✔
565
        flags: 0,
37✔
566
        get_frame_id_by_name: Some(SshFrameType::ffi_id_from_name),
37✔
567
        get_frame_name_by_id: Some(SshFrameType::ffi_name_from_id),
37✔
568
        get_state_id_by_name: Some(SSHConnectionState::ffi_id_from_name),
37✔
569
        get_state_name_by_id: Some(SSHConnectionState::ffi_name_from_id),
37✔
570
    };
37✔
571

37✔
572
    let ip_proto_str = CString::new("tcp").unwrap();
37✔
573

37✔
574
    if SCAppLayerProtoDetectConfProtoDetectionEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
37✔
575
        let alproto = applayer_register_protocol_detection(&parser, 1);
37✔
576
        ALPROTO_SSH = alproto;
37✔
577
        if SCAppLayerParserConfParserEnabled(ip_proto_str.as_ptr(), parser.name) != 0 {
37✔
578
            let _ = AppLayerRegisterParser(&parser, alproto);
37✔
579
        }
37✔
580
        SCAppLayerParserRegisterLogger(IPPROTO_TCP, ALPROTO_SSH);
37✔
581
        SCLogDebug!("Rust ssh parser registered.");
582
    } else {
583
        SCLogNotice!("Protocol detector and parser disabled for SSH.");
×
584
    }
585
}
37✔
586

587
#[no_mangle]
588
pub extern "C" fn SCSshEnableHassh() {
19,697✔
589
    if !HASSH_DISABLED.load(Ordering::Relaxed) {
19,697✔
590
        HASSH_ENABLED.store(true, Ordering::Relaxed)
19,697✔
591
    }
×
592
}
19,697✔
593

594
#[no_mangle]
595
pub extern "C" fn SCSshHasshIsEnabled() -> bool {
21,352✔
596
    hassh_is_enabled()
21,352✔
597
}
21,352✔
598

599
#[no_mangle]
600
pub extern "C" fn SCSshDisableHassh() {
×
601
    HASSH_DISABLED.store(true, Ordering::Relaxed)
×
602
}
×
603

604
#[no_mangle]
605
pub extern "C" fn SCSshEnableBypass(mode: EncryptionHandling) {
×
606
    unsafe {
×
607
        ENCRYPTION_BYPASS_ENABLED = mode;
×
608
    }
×
609
}
×
610

611
#[no_mangle]
612
pub unsafe extern "C" fn SCSshTxGetLogCondition(tx: *mut std::os::raw::c_void) -> bool {
1,657✔
613
    let tx = cast_pointer!(tx, SSHTransaction);
1,657✔
614

1,657✔
615
    if SCSshHasshIsEnabled() {
1,657✔
616
        if tx.cli_hdr.flags == SSHConnectionState::SshStateFinished
1,657✔
617
            && tx.srv_hdr.flags == SSHConnectionState::SshStateFinished
566✔
618
        {
619
            return true;
×
620
        }
1,657✔
621
    } else if tx.cli_hdr.flags == SSHConnectionState::SshStateBannerDone
×
622
        && tx.srv_hdr.flags == SSHConnectionState::SshStateBannerDone
×
623
    {
624
        return true;
×
625
    }
×
626
    return false;
1,657✔
627
}
1,657✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE TRIAL · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc