Coverage Report

Created: 2026-09-28 07:39

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/suricata8/rust/src/ike/logger.rs
Line
Count
Source
1
/* Copyright (C) 2020 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::ike::{IKEState, IKETransaction};
19
use super::ipsec_parser::IKEV2_FLAG_INITIATOR;
20
use crate::direction::Direction;
21
use crate::ike::parser::{ExchangeType, IsakmpPayloadType, SaAttribute};
22
use crate::jsonbuilder::{JsonBuilder, JsonError};
23
use num_traits::FromPrimitive;
24
use std;
25
use std::collections::HashSet;
26
use std::convert::TryFrom;
27
28
const LOG_EXTENDED: u32 = 0x01;
29
30
0
fn add_attributes(transform: &Vec<SaAttribute>, js: &mut JsonBuilder) -> Result<(), JsonError> {
31
0
    let mut logged: HashSet<String> = HashSet::new();
32
33
0
    for attribute in transform {
34
0
        let key = attribute.attribute_type.to_string();
35
36
0
        if logged.contains(&key) {
37
0
            continue;
38
0
        }
39
0
        logged.insert(key.clone());
40
41
0
        js.set_string(
42
0
            &key,
43
0
            attribute.attribute_value.to_string().as_str(),
44
0
        )?;
45
46
0
        if let Some(numeric_value) = attribute.numeric_value {
47
0
            js.set_uint(
48
0
                format!("{}_raw", attribute.attribute_type).as_str(),
49
0
                numeric_value as u64,
50
0
            )?;
51
0
        } else if let Some(hex_value) = &attribute.hex_value {
52
0
            js.set_string(
53
0
                format!("{}_raw", attribute.attribute_type).as_str(),
54
0
                hex_value,
55
0
            )?;
56
0
        }
57
    }
58
59
0
    return Ok(());
60
0
}
61
62
0
fn log_ike(
63
0
    state: &IKEState, tx: &IKETransaction, flags: u32, jb: &mut JsonBuilder,
64
0
) -> Result<(), JsonError> {
65
0
    jb.open_object("ike")?;
66
67
0
    jb.set_uint("version_major", tx.hdr.maj_ver as u64)?;
68
0
    jb.set_uint("version_minor", tx.hdr.min_ver as u64)?;
69
0
    jb.set_string("init_spi", &tx.hdr.spi_initiator)?;
70
0
    jb.set_string("resp_spi", &tx.hdr.spi_responder)?;
71
0
    jb.set_uint("message_id", tx.hdr.msg_id as u64)?;
72
73
0
    if tx.ike_version == 1 {
74
0
        if let Some(exchange_type) = tx.hdr.ikev1_header.exchange_type {
75
0
            jb.set_uint("exchange_type", exchange_type as u64)?;
76
0
            if (flags & LOG_EXTENDED) == LOG_EXTENDED {
77
0
                if let Some(etype) = ExchangeType::from_u8(exchange_type) {
78
0
                    jb.set_string("exchange_type_verbose", etype.to_string().as_str())?;
79
0
                };
80
0
            }
81
0
        }
82
0
    } else if tx.ike_version == 2 {
83
0
        jb.set_uint("exchange_type", tx.hdr.ikev2_header.exch_type.0 as u64)?;
84
0
    }
85
86
0
    if tx.ike_version == 1 {
87
0
        if state.ikev1_container.server.nb_transforms > 0 {
88
            // log the first transform as the chosen one
89
0
            add_attributes(&state.ikev1_container.server.transform, jb)?;
90
0
        }
91
0
        if tx.direction == Direction::ToClient && tx.hdr.ikev1_transforms.len() > 1 {
92
            // in case we have multiple server transforms log them in a list
93
0
            jb.open_array("server_proposals")?;
94
0
            for server_transform in &tx.hdr.ikev1_transforms {
95
0
                jb.start_object()?;
96
0
                add_attributes(server_transform, jb)?;
97
0
                jb.close()?;
98
            }
99
0
            jb.close()?;
100
0
        }
101
0
    } else if tx.ike_version == 2 {
102
0
        if tx.hdr.flags & IKEV2_FLAG_INITIATOR != 0 {
103
0
            jb.set_string("role", "initiator")?;
104
        } else {
105
0
            jb.set_string("role", "responder")?;
106
0
            jb.set_string("alg_enc", &format!("{:?}", state.ikev2_container.alg_enc))?;
107
0
            jb.set_string("alg_auth", &format!("{:?}", state.ikev2_container.alg_auth))?;
108
0
            jb.set_string("alg_prf", &format!("{:?}", state.ikev2_container.alg_prf))?;
109
0
            jb.set_string("alg_dh", &format!("{:?}", state.ikev2_container.alg_dh))?;
110
0
            jb.set_string("alg_esn", &format!("{:?}", state.ikev2_container.alg_esn))?;
111
        }
112
0
    }
113
114
    // payloads in packet
115
0
    jb.open_array("payload")?;
116
0
    if tx.ike_version == 1 {
117
0
        if let Some(payload_types) = &tx.payload_types.ikev1_payload_types {
118
0
            for pt in payload_types {
119
0
                append_payload_type_extended(jb, pt)?;
120
            }
121
0
        }
122
0
    } else if tx.ike_version == 2 {
123
0
        for payload in tx.payload_types.ikev2_payload_types.iter() {
124
0
            jb.append_string(&format!("{:?}", payload))?;
125
        }
126
0
    }
127
0
    jb.close()?;
128
129
0
    if tx.ike_version == 1 {
130
0
        log_ikev1(state, tx, jb)?;
131
0
    } else if tx.ike_version == 2 {
132
0
        log_ikev2(tx, jb)?;
133
0
    }
134
0
    jb.close()?;
135
0
    return Ok(());
136
0
}
137
138
0
fn log_ikev1(state: &IKEState, tx: &IKETransaction, jb: &mut JsonBuilder) -> Result<(), JsonError> {
139
0
    jb.open_object("ikev1")?;
140
141
0
    if let Some(doi) = state.ikev1_container.domain_of_interpretation {
142
0
        jb.set_uint("doi", doi as u64)?;
143
0
    }
144
0
    jb.set_bool("encrypted_payloads", tx.hdr.ikev1_header.encrypted_payloads)?;
145
146
0
    if !tx.hdr.ikev1_header.encrypted_payloads {
147
        // enable logging of collected state if not-encrypted payloads
148
149
        // client data
150
0
        jb.open_object("client")?;
151
0
        if !state.ikev1_container.client.key_exchange.is_empty() {
152
0
            jb.set_string(
153
0
                "key_exchange_payload",
154
0
                &state.ikev1_container.client.key_exchange,
155
0
            )?;
156
0
            if let Ok(client_key_length) =
157
0
                u64::try_from(state.ikev1_container.client.key_exchange.len())
158
            {
159
0
                jb.set_uint("key_exchange_payload_length", client_key_length / 2)?;
160
0
            }
161
0
        }
162
0
        if !state.ikev1_container.client.nonce.is_empty() {
163
0
            jb.set_string("nonce_payload", &state.ikev1_container.client.nonce)?;
164
0
            if let Ok(client_nonce_length) = u64::try_from(state.ikev1_container.client.nonce.len())
165
            {
166
0
                jb.set_uint("nonce_payload_length", client_nonce_length / 2)?;
167
0
            }
168
0
        }
169
170
0
        if tx.direction == Direction::ToServer && !tx.hdr.ikev1_transforms.is_empty() {
171
0
            jb.open_array("proposals")?;
172
0
            for client_transform in &tx.hdr.ikev1_transforms {
173
0
                jb.start_object()?;
174
0
                add_attributes(client_transform, jb)?;
175
0
                jb.close()?;
176
            }
177
0
            jb.close()?; // proposals
178
0
        }
179
0
        jb.close()?; // client
180
181
        // server data
182
0
        jb.open_object("server")?;
183
0
        if !state.ikev1_container.server.key_exchange.is_empty() {
184
0
            jb.set_string(
185
0
                "key_exchange_payload",
186
0
                &state.ikev1_container.server.key_exchange,
187
0
            )?;
188
0
            if let Ok(server_key_length) =
189
0
                u64::try_from(state.ikev1_container.server.key_exchange.len())
190
            {
191
0
                jb.set_uint("key_exchange_payload_length", server_key_length / 2)?;
192
0
            }
193
0
        }
194
0
        if !state.ikev1_container.server.nonce.is_empty() {
195
0
            jb.set_string("nonce_payload", &state.ikev1_container.server.nonce)?;
196
0
            if let Ok(server_nonce_length) = u64::try_from(state.ikev1_container.server.nonce.len())
197
            {
198
0
                jb.set_uint("nonce_payload_length", server_nonce_length / 2)?;
199
0
            }
200
0
        }
201
0
        jb.close()?; // server
202
203
0
        if !tx.hdr.ikev1_header.vendor_ids.is_empty() {
204
0
            jb.open_array("vendor_ids")?;
205
0
            for vendor in &tx.hdr.ikev1_header.vendor_ids {
206
0
                jb.append_string(vendor)?;
207
            }
208
0
            jb.close()?; // vendor_ids
209
0
        }
210
0
    }
211
0
    jb.close()?;
212
213
0
    return Ok(());
214
0
}
215
216
0
fn append_payload_type_extended(js: &mut JsonBuilder, pt: &u8) -> Result<(), JsonError> {
217
0
    if let Some(v) = IsakmpPayloadType::from_u8(*pt) {
218
0
        js.append_string(&format!("{:?}", v))?;
219
0
    }
220
0
    Ok(())
221
0
}
222
223
0
fn log_ikev2(tx: &IKETransaction, jb: &mut JsonBuilder) -> Result<(), JsonError> {
224
0
    jb.open_object("ikev2")?;
225
226
0
    jb.set_uint("errors", tx.errors as u64)?;
227
0
    if !tx.notify_types.is_empty() {
228
0
        jb.open_array("notify")?;
229
0
        for notify in tx.notify_types.iter() {
230
0
            jb.append_string(&format!("{:?}", notify))?;
231
        }
232
0
        jb.close()?;
233
0
    }
234
0
    jb.close()?;
235
0
    Ok(())
236
0
}
237
238
#[no_mangle]
239
0
pub unsafe extern "C" fn SCIkeLoggerLog(
240
0
    state: &mut IKEState, tx: *mut std::os::raw::c_void, flags: u32, js: &mut JsonBuilder,
241
0
) -> bool {
242
0
    let tx = cast_pointer!(tx, IKETransaction);
243
0
    log_ike(state, tx, flags, js).is_ok()
244
0
}