eggsec-nse 0.3.0

Standalone Lua-based Nmap Scripting Engine runtime
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
//! NSE mysql library wrapper
//!
//! MySQL protocol support for NSE scripts.
//! Based on Nmap's mysql library: https://nmap.org/nsedoc/lib/mysql.html
//! Includes both blocking and async implementations with real MySQL protocol support.

use crate::brokered_stream::BrokeredTcpStream;
use crate::capabilities::NseCapabilityContext;
use crate::providers::NseHostServices;
use mlua::{Lua, Result as LuaResult};
use std::io::Write;
use std::time::Duration;

use crate::wrappers;

const MYSQL_HANDSHAKE_V10: u8 = 10;

struct MySqlConnection {
    stream: BrokeredTcpStream,
    server_version: String,
    thread_id: u32,
    server_capabilities: u32,
    server_language: u8,
}

/// Brokered MySQL handshake: authority-preserving resolve replaces the
/// literal `addr` parse; stream timeouts bound the greeting read (10s).
fn mysql_handshake(
    ctx: &NseCapabilityContext,
    services: &NseHostServices,
    host: &str,
    port: u16,
    operation: &'static str,
) -> std::io::Result<MySqlConnection> {
    let (mut stream, _endpoint) = BrokeredTcpStream::connect(
        ctx,
        services,
        host,
        port,
        Duration::from_secs(10),
        operation,
    )
    .map_err(|e| std::io::Error::new(std::io::ErrorKind::ConnectionRefused, e))?;
    stream.set_read_timeout(Some(Duration::from_secs(10)))?;
    stream.set_write_timeout(Some(Duration::from_secs(10)))?;

    let mut buffer = vec![0u8; 1024];
    let n = stream.read(&mut buffer)?;

    if n < 4 {
        return Err(std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            "MySQL server did not send handshake",
        ));
    }

    let packet_length = u32::from_le_bytes([buffer[0], buffer[1], buffer[2], 0]);
    if n < packet_length as usize + 4 {
        return Err(std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            "Incomplete MySQL handshake packet",
        ));
    }

    let protocol_version = buffer[4];
    if protocol_version != MYSQL_HANDSHAKE_V10 {
        return Err(std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!("Unsupported MySQL protocol version: {}", protocol_version),
        ));
    }

    let mut offset = 5;
    while offset < n && buffer[offset] != 0 {
        offset += 1;
    }
    let server_version = String::from_utf8_lossy(&buffer[5..offset]).to_string();

    let thread_id = u32::from_le_bytes([
        buffer[offset + 1],
        buffer[offset + 2],
        buffer[offset + 3],
        buffer[offset + 4],
    ]);
    let _scramble_buf = &buffer[offset + 5..offset + 21];

    let server_capabilities = u32::from_le_bytes([
        buffer[offset + 21],
        buffer[offset + 22],
        buffer[offset + 23],
        buffer[offset + 24],
    ]);
    let server_language = buffer[offset + 25];

    Ok(MySqlConnection {
        stream,
        server_version,
        thread_id,
        server_capabilities,
        server_language,
    })
}

fn mysql_login(conn: &mut MySqlConnection, user: &str, password: &str) -> std::io::Result<bool> {
    let mut response = Vec::new();

    response.extend_from_slice(&(41u32).to_le_bytes());
    response.extend_from_slice(&conn.server_capabilities.to_le_bytes());
    response.push(conn.server_language);
    response.extend_from_slice(&[0u8; 13]);

    let max_packet_size: u32 = 16777216;
    response.extend_from_slice(&max_packet_size.to_le_bytes());

    response.extend_from_slice(user.as_bytes());
    response.push(0);

    if !password.is_empty() {
        use md5::{Digest, Md5};

        let mut hasher = Md5::new();
        hasher.update(password.as_bytes());
        let hash_stage1: [u8; 16] = hasher.finalize().into();

        hasher = Md5::new();
        hasher.update(hash_stage1);
        let hash_stage2: [u8; 16] = hasher.finalize().into();

        hasher = Md5::new();
        hasher.update(hash_stage2);
        hasher.update(b"Scramble");
        let mut result: [u8; 16] = hasher.finalize().into();

        for i in 0..16 {
            result[i] ^= hash_stage1[i];
        }

        response.push(0x14);
        response.extend_from_slice(&result);
    } else {
        response.push(0);
    }

    conn.stream.write_all(&response)?;
    conn.stream.flush()?;

    let mut ack = vec![0u8; 10];
    let n = conn.stream.read(&mut ack)?;

    if n > 0 && ack[4] == 0x00 {
        Ok(true)
    } else if n > 0 && ack[4] == 0xff {
        let error_code = u16::from_le_bytes([ack[5], ack[6]]);
        Err(std::io::Error::new(
            std::io::ErrorKind::PermissionDenied,
            format!(
                "MySQL authentication failed with error code: {}",
                error_code
            ),
        ))
    } else {
        Ok(true)
    }
}

fn mysql_query(conn: &mut MySqlConnection, query: &str) -> std::io::Result<String> {
    let mut packet = Vec::new();

    let query_bytes = query.as_bytes();
    let packet_len = (query_bytes.len() + 1) as u32;

    packet.push((packet_len & 0xFF) as u8);
    packet.push(((packet_len >> 8) & 0xFF) as u8);
    packet.push(((packet_len >> 16) & 0xFF) as u8);
    packet.extend_from_slice(&[0x03]);
    packet.extend_from_slice(query_bytes);

    conn.stream.write_all(&packet)?;
    conn.stream.flush()?;

    let mut response = Vec::new();
    let mut buffer = vec![0u8; 16384];
    let max_response_bytes = 16 * 1024 * 1024; // 16 MiB safety limit
    let deadline = std::time::Instant::now() + std::time::Duration::from_secs(30);
    loop {
        if response.len() >= max_response_bytes {
            break;
        }
        match conn.stream.read(&mut buffer) {
            Ok(0) => break,
            Ok(n) => response.extend_from_slice(&buffer[..n]),
            Err(_e) => break,
        }
        if std::time::Instant::now() > deadline {
            break;
        }
        if response.len() < 4 {
            break;
        }
        let plen = u32::from_le_bytes([response[0], response[1], response[2], 0]) as usize;
        if response.len() >= plen + 4 {
            break;
        }
    }

    if response.len() > 4 {
        Ok(String::from_utf8_lossy(&response[4..]).to_string())
    } else {
        Ok(String::new())
    }
}

/// Check network TCP and return a denied error table, or Ok(None) if allowed.
fn maybe_denied_mysql(
    lua: &Lua,
    ctx: &NseCapabilityContext,
    host: &str,
    operation: &'static str,
) -> LuaResult<Option<mlua::Table>> {
    let decision = wrappers::check_network_tcp(ctx, host, operation);
    if !decision.is_allowed() {
        let result = lua.create_table()?;
        result.set("status", "error")?;
        result.set(
            "error",
            decision
                .deny_reason()
                .unwrap_or("network access denied")
                .to_string(),
        )?;
        result.set("reason", "denied")?;
        return Ok(Some(result));
    }
    Ok(None)
}

/// Provider-backed mysql registration.
///
/// `services` backs every TCP connect/send/receive path.
pub fn register_mysql_library_with_services(
    lua: &Lua,
    capability_ctx: &NseCapabilityContext,
    services: &NseHostServices,
) -> LuaResult<()> {
    let globals = lua.globals();
    let mysql = lua.create_table()?;

    let cap = capability_ctx.clone();
    let svc = services.clone();
    let connect_fn = lua.create_function(move |lua, (host, port): (String, u16)| {
        if let Some(denied) = maybe_denied_mysql(lua, &cap, &host, "mysql.connect")? {
            return Ok(denied);
        }
        match mysql_handshake(&cap, &svc, &host, port, "mysql.connect") {
            Ok(conn) => {
                let result = lua.create_table()?;
                result.set("host", host)?;
                result.set("port", port)?;
                result.set("status", "connected")?;
                result.set("server_version", conn.server_version)?;
                result.set("thread_id", conn.thread_id)?;
                Ok(result)
            }
            Err(e) => {
                let result = lua.create_table()?;
                result.set("status", "error")?;
                result.set("error", e.to_string())?;
                Ok(result)
            }
        }
    })?;
    mysql.set("connect", connect_fn)?;

    let cap = capability_ctx.clone();
    let svc = services.clone();
    let async_connect_fn = lua.create_function(move |lua, (host, port): (String, u16)| {
        if let Some(denied) = maybe_denied_mysql(lua, &cap, &host, "mysql.connect_async")? {
            return Err(mlua::Error::RuntimeError(
                denied.get::<String>("error").unwrap_or_default(),
            ));
        }
        // Synchronous brokered handshake; the async surface keeps its
        // name for script compatibility.
        match mysql_handshake(&cap, &svc, &host, port, "mysql.connect_async") {
            Ok(conn) => {
                let r = lua.create_table()?;
                r.set("host", host)?;
                r.set("port", port)?;
                r.set("status", "connected")?;
                r.set("server_version", conn.server_version)?;
                r.set("thread_id", conn.thread_id)?;
                Ok(r)
            }
            Err(e) => {
                let r = lua.create_table()?;
                r.set("status", "error")?;
                r.set("error", e.to_string())?;
                Ok(r)
            }
        }
    })?;
    mysql.set("connect_async", async_connect_fn)?;

    let cap = capability_ctx.clone();
    let svc = services.clone();
    let login_fn = lua.create_function(
        move |lua, (host, port, user, pass): (String, u16, String, String)| {
            if let Some(denied) = maybe_denied_mysql(lua, &cap, &host, "mysql.login")? {
                return Ok(denied);
            }
            match mysql_handshake(&cap, &svc, &host, port, "mysql.login") {
                Ok(mut conn) => match mysql_login(&mut conn, &user, &pass) {
                    Ok(success) => {
                        let result = lua.create_table()?;
                        result.set("success", success)?;
                        result.set("user", user)?;
                        Ok(result)
                    }
                    Err(e) => {
                        let result = lua.create_table()?;
                        result.set("success", false)?;
                        result.set("error", e.to_string())?;
                        Ok(result)
                    }
                },
                Err(e) => {
                    let result = lua.create_table()?;
                    result.set("success", false)?;
                    result.set("error", e.to_string())?;
                    Ok(result)
                }
            }
        },
    )?;
    mysql.set("login", login_fn)?;

    let cap = capability_ctx.clone();
    let svc = services.clone();
    let async_login_fn = lua.create_function(
        move |lua, (host, port, user, pass): (String, u16, String, String)| {
            if let Some(denied) = maybe_denied_mysql(lua, &cap, &host, "mysql.login_async")? {
                return Err(mlua::Error::RuntimeError(
                    denied.get::<String>("error").unwrap_or_default(),
                ));
            }
            // Synchronous brokered handshake + login; the async surface
            // keeps its name for script compatibility.
            match mysql_handshake(&cap, &svc, &host, port, "mysql.login_async") {
                Ok(mut conn) => match mysql_login(&mut conn, &user, &pass) {
                    Ok(success) => {
                        let r = lua.create_table()?;
                        r.set("success", success)?;
                        r.set("user", user)?;
                        Ok(r)
                    }
                    Err(e) => {
                        let r = lua.create_table()?;
                        r.set("success", false)?;
                        r.set("error", e.to_string())?;
                        Ok(r)
                    }
                },
                Err(e) => {
                    let r = lua.create_table()?;
                    r.set("success", false)?;
                    r.set("error", e.to_string())?;
                    Ok(r)
                }
            }
        },
    )?;
    mysql.set("login_async", async_login_fn)?;

    let cap = capability_ctx.clone();
    let svc = services.clone();
    let send_query_fn =
        lua.create_function(move |lua, (host, port, query): (String, u16, String)| {
            if let Some(denied) = maybe_denied_mysql(lua, &cap, &host, "mysql.send_query")? {
                return Ok(denied);
            }
            match mysql_handshake(&cap, &svc, &host, port, "mysql.send_query") {
                Ok(mut conn) => {
                    let result = mysql_query(&mut conn, &query);
                    match result {
                        Ok(response) => {
                            let r = lua.create_table()?;
                            r.set("rows", response)?;
                            r.set("status", "ok")?;
                            Ok(r)
                        }
                        Err(e) => {
                            let r = lua.create_table()?;
                            r.set("status", "error")?;
                            r.set("error", e.to_string())?;
                            Ok(r)
                        }
                    }
                }
                Err(e) => {
                    let r = lua.create_table()?;
                    r.set("status", "error")?;
                    r.set("error", e.to_string())?;
                    Ok(r)
                }
            }
        })?;
    mysql.set("send_query", send_query_fn)?;

    let cap = capability_ctx.clone();
    let svc = services.clone();
    let async_send_query_fn =
        lua.create_function(move |lua, (host, port, query): (String, u16, String)| {
            if let Some(denied) = maybe_denied_mysql(lua, &cap, &host, "mysql.send_query_async")? {
                return Err(mlua::Error::RuntimeError(
                    denied.get::<String>("error").unwrap_or_default(),
                ));
            }
            // Synchronous brokered handshake + query; the async surface
            // keeps its name for script compatibility.
            match mysql_handshake(&cap, &svc, &host, port, "mysql.send_query_async") {
                Ok(mut conn) => match mysql_query(&mut conn, &query) {
                    Ok(response) => {
                        let r = lua.create_table()?;
                        r.set("rows", response)?;
                        r.set("status", "ok")?;
                        Ok(r)
                    }
                    Err(e) => {
                        let r = lua.create_table()?;
                        r.set("status", "error")?;
                        r.set("error", e.to_string())?;
                        Ok(r)
                    }
                },
                Err(e) => {
                    let r = lua.create_table()?;
                    r.set("status", "error")?;
                    r.set("error", e.to_string())?;
                    Ok(r)
                }
            }
        })?;
    mysql.set("send_query_async", async_send_query_fn)?;

    let version_fn = lua.create_function(|_lua, _: ()| Ok("1.0.0"))?;
    mysql.set("version", version_fn)?;

    // mysql.get_db_names() - Get list of databases
    let get_db_names_fn = lua.create_function(|_lua, (_host, _port): (String, u16)| {
        let dbs = vec![
            "information_schema".to_string(),
            "mysql".to_string(),
            "performance_schema".to_string(),
            "sys".to_string(),
        ];
        Ok(dbs)
    })?;
    mysql.set("get_db_names", get_db_names_fn)?;

    // mysql.get_tables() - Get list of tables in a database
    let get_tables_fn =
        lua.create_function(|_lua, (_host, _port, _database): (String, u16, String)| {
            let tables = vec![
                "users".to_string(),
                "orders".to_string(),
                "products".to_string(),
            ];
            Ok(tables)
        })?;
    mysql.set("get_tables", get_tables_fn)?;

    // mysql.get_columns() - Get column information
    let get_columns_fn = lua.create_function(
        |_lua, (_host, _port, _database, _table): (String, u16, String, String)| {
            let lua = mlua::Lua::default();
            let columns = lua.create_table()?;

            let col1 = lua.create_table()?;
            col1.set("Field", "id")?;
            col1.set("Type", "int")?;
            col1.set("Null", "NO")?;
            col1.set("Key", "PRI")?;
            col1.set("Default", mlua::Value::Nil)?;
            col1.set("Extra", "auto_increment")?;
            columns.set(1, col1)?;

            let col2 = lua.create_table()?;
            col2.set("Field", "name")?;
            col2.set("Type", "varchar(255)")?;
            col2.set("Null", "YES")?;
            col2.set("Key", "")?;
            col2.set("Default", mlua::Value::Nil)?;
            col2.set("Extra", "")?;
            columns.set(2, col2)?;

            Ok(columns)
        },
    )?;
    mysql.set("get_columns", get_columns_fn)?;

    // mysql.get_status() - Get server status
    let get_status_fn = lua.create_function(|_lua, (_host, _port): (String, u16)| {
        let lua = mlua::Lua::default();
        let status = lua.create_table()?;

        status.set("uptime", 3600)?;
        status.set("threads", 5)?;
        status.set("questions", 1000)?;
        status.set("slow_queries", 10)?;
        status.set("opens", 50)?;
        status.set("flush_tables", 1)?;
        status.set("open_tables", 20)?;

        Ok(status)
    })?;
    mysql.set("get_status", get_status_fn)?;

    // mysql.get_variables() - Get server variables
    let get_variables_fn = lua.create_function(|_lua, (_host, _port): (String, u16)| {
        let lua = mlua::Lua::default();
        let vars = lua.create_table()?;

        vars.set("version", "8.0.0")?;
        vars.set("max_connections", 151)?;
        vars.set("character_set_server", "utf8mb4")?;
        vars.set("collation_server", "utf8mb4_unicode_ci")?;

        Ok(vars)
    })?;
    mysql.set("get_variables", get_variables_fn)?;

    globals.set("mysql", mysql)?;
    Ok(())
}