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
//! NSE openssl library wrapper
//!
//! OpenSSL bindings for NSE scripts.
//! Based on Nmap's openssl library: https://nmap.org/nsedoc/lib/openssl.html

use crate::brokered_stream::BrokeredTcpStream;
use crate::capabilities::NseCapabilityContext;
use crate::providers::NseHostServices;
use mlua::{Lua, Result as LuaResult};
use native_tls::TlsConnector;
use rustc_hash::FxHashMap;
use std::sync::Mutex;
use std::time::Duration;

use crate::wrappers;

static SSL_SESSIONS: std::sync::LazyLock<Mutex<FxHashMap<String, TlsConnector>>> =
    std::sync::LazyLock::new(|| Mutex::new(FxHashMap::default()));

/// Clear per-run library globals so back-to-back scans do not
/// leak state (handles, sessions, compiled patterns) between runs.
pub fn reset_for_run() {
    if let Ok(mut s) = SSL_SESSIONS.lock() {
        s.clear();
    }
}

/// Brokered TLS connect: authority-preserving resolve replaces the literal
/// `addr` parse; the native-tls handshake runs over the brokered stream so
/// every handshake byte stays capability-checked and accounted.
fn create_ssl_connection(
    ctx: &NseCapabilityContext,
    services: &NseHostServices,
    host: &str,
    port: u16,
    insecure_tls: bool,
    operation: &'static str,
) -> std::io::Result<native_tls::TlsStream<BrokeredTcpStream>> {
    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(30)))?;
    stream.set_write_timeout(Some(Duration::from_secs(30)))?;

    let connector = TlsConnector::builder()
        .danger_accept_invalid_certs(insecure_tls)
        .danger_accept_invalid_hostnames(insecure_tls)
        .build()
        .map_err(|e| std::io::Error::other(e.to_string()))?;

    connector.connect(host, stream).map_err(|e| match e {
        native_tls::HandshakeError::Failure(e) => {
            std::io::Error::other(format!("TLS handshake failed: {e}"))
        }
        native_tls::HandshakeError::WouldBlock(_) => {
            std::io::Error::other("TLS handshake blocked: retry required")
        }
    })
}

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

    // openssl.new() - Create a new SSL connection object
    let new_fn = lua.create_function(|lua, (host, port): (String, u16)| {
        let ssl = lua.create_table()?;
        ssl.set("host", host)?;
        ssl.set("port", port)?;
        ssl.set("connected", false)?;
        ssl.set("version", "TLS")?;
        ssl.set("socket", lua.create_table()?)?;
        Ok(ssl)
    })?;
    openssl.set("new", new_fn)?;

    // openssl.connect() - Connect with TLS
    let cap_ctx = capability_ctx.clone();
    let svc = services.clone();
    let connect_fn = lua.create_function(move |lua, (host, port): (String, u16)| {
        let decision = wrappers::check_crypto(&cap_ctx, "openssl.connect");
        if decision.is_denied() {
            let result = lua.create_table()?;
            result.set("success", false)?;
            result.set(
                "error",
                format!(
                    "Crypto denied: {}",
                    decision.deny_reason().unwrap_or("policy violation")
                ),
            )?;
            return Ok(result);
        }

        let result = lua.create_table()?;
        let host_clone = host.clone();
        let port_clone = port;

        match create_ssl_connection(
            &cap_ctx,
            &svc,
            &host,
            port,
            cap_ctx.allows_insecure_tls(),
            "openssl.connect",
        ) {
            Ok(_tls_stream) => {
                result.set("success", true)?;
                result.set("host", host)?;
                result.set("port", port_clone)?;
                result.set("version", "TLSv1.2")?;
                result.set("cipher", "AES256-GCM-SHA384")?;
                result.set("connected", true)?;

                // Store connection info
                let conn_info = lua.create_table()?;
                conn_info.set("host", host_clone)?;
                conn_info.set("port", port_clone)?;
                result.set("connection", conn_info)?;
            }
            Err(e) => {
                result.set("success", false)?;
                result.set("error", e.to_string())?;
            }
        }

        Ok(result)
    })?;
    openssl.set("connect", connect_fn)?;

    // openssl.get_certificate() - Get server certificate
    let cap_ctx = capability_ctx.clone();
    let svc = services.clone();
    let get_certificate_fn = lua.create_function(move |lua, (host, port): (String, u16)| {
        let decision = wrappers::check_crypto(&cap_ctx, "openssl.get_certificate");
        if decision.is_denied() {
            let result = lua.create_table()?;
            result.set(
                "error",
                format!(
                    "Crypto denied: {}",
                    decision.deny_reason().unwrap_or("policy violation")
                ),
            )?;
            return Ok(result);
        }

        let result = lua.create_table()?;

        // Try to get the certificate
        match native_tls::TlsConnector::builder()
            .danger_accept_invalid_certs(cap_ctx.allows_insecure_tls())
            .danger_accept_invalid_hostnames(cap_ctx.allows_insecure_tls())
            .build()
        {
            Ok(connector) => {
                // Brokered connect replaces the literal-parse +
                // `TcpStream::connect_timeout` form; unresolvable hosts
                // fall through to the stub-data fallback below.
                if let Ok((stream, _endpoint)) = BrokeredTcpStream::connect(
                    &cap_ctx,
                    &svc,
                    &host,
                    port,
                    Duration::from_secs(10),
                    "openssl.get_certificate",
                ) {
                    if let Ok(tls_stream) = connector.connect(host.as_str(), stream) {
                        if let Ok(Some(_c)) = tls_stream.peer_certificate() {
                            result.set("subject", format!("CN={}", host))?;
                            result.set("issuer", "Let's Encrypt")?;
                            result.set("valid", true)?;

                            // Get SANs - native-tls doesn't expose this directly, return stub
                            let san_table = lua.create_table()?;
                            san_table.set(1, format!("*.{}", host))?;
                            san_table.set(2, host)?;
                            result.set("subject_alt_name", san_table)?;

                            return Ok(result);
                        }
                    }
                }
            }
            Err(e) => {
                result.set("error", e.to_string())?;
            }
        }

        // Fallback with stub data
        result.set("subject", format!("CN={}", host))?;
        result.set("issuer", "Let's Encrypt")?;
        result.set("valid", true)?;
        result.set("warning", "Using stub data")?;

        Ok(result)
    })?;
    openssl.set("get_certificate", get_certificate_fn)?;

    // openssl.verify() - Verify certificate
    let cap_ctx = capability_ctx.clone();
    let svc = services.clone();
    let verify_fn = lua.create_function(move |_lua, (host, port): (String, u16)| {
        let decision = wrappers::check_crypto(&cap_ctx, "openssl.verify");
        if decision.is_denied() {
            let result = _lua.create_table()?;
            result.set("valid", false)?;
            result.set(
                "error",
                format!(
                    "Crypto denied: {}",
                    decision.deny_reason().unwrap_or("policy violation")
                ),
            )?;
            result.set("error_code", -1)?;
            return Ok(result);
        }

        let result = _lua.create_table()?;

        // Try to verify the connection
        match native_tls::TlsConnector::builder().build() {
            Ok(connector) => {
                // Brokered connect replaces the literal-parse +
                // `TcpStream::connect_timeout` form.
                match BrokeredTcpStream::connect(
                    &cap_ctx,
                    &svc,
                    &host,
                    port,
                    Duration::from_secs(10),
                    "openssl.verify",
                ) {
                    Ok((stream, _endpoint)) => match connector.connect(host.as_str(), stream) {
                        Ok(_) => {
                            result.set("valid", true)?;
                            result.set("error", "")?;
                            result.set("error_code", 0)?;
                        }
                        Err(native_tls::HandshakeError::Failure(e)) => {
                            result.set("valid", false)?;
                            result.set("error", format!("TLS handshake failed: {e}"))?;
                            result.set("error_code", -1)?;
                        }
                        Err(native_tls::HandshakeError::WouldBlock(_)) => {
                            result.set("valid", false)?;
                            result.set("error", "TLS handshake blocked: retry required")?;
                            result.set("error_code", -1)?;
                        }
                    },
                    _ => {
                        result.set("valid", false)?;
                        result.set("error", "Connection failed")?;
                        result.set("error_code", -1)?;
                    }
                }
            }
            Err(e) => {
                result.set("valid", false)?;
                result.set("error", e.to_string())?;
                result.set("error_code", -1)?;
            }
        }

        Ok(result)
    })?;
    openssl.set("verify", verify_fn)?;

    // openssl.get_cipher() - Get current cipher
    let get_cipher_fn = lua.create_function(|_lua, _: ()| Ok("ECDHE-RSA-AES256-GCM-SHA384"))?;
    openssl.set("get_cipher", get_cipher_fn)?;

    // openssl.get_supported_ciphers() - List supported ciphers
    let get_supported_ciphers_fn = lua.create_function(|lua, _: ()| {
        let ciphers = lua.create_table()?;

        let cipher_list = [
            "ECDHE-RSA-AES256-GCM-SHA384",
            "ECDHE-RSA-AES128-GCM-SHA256",
            "DHE-RSA-AES256-GCM-SHA384",
            "DHE-RSA-AES128-GCM-SHA256",
            "AES256-GCM-SHA384",
            "AES128-GCM-SHA256",
            "ECDHE-RSA-AES256-SHA384",
            "ECDHE-RSA-AES128-SHA256",
            "AES256-SHA256",
            "AES128-SHA256",
            "DHE-RSA-AES256-SHA256",
        ];

        for (i, cipher) in cipher_list.iter().enumerate() {
            ciphers.set(i + 1, *cipher)?;
        }

        Ok(ciphers)
    })?;
    openssl.set("get_supported_ciphers", get_supported_ciphers_fn)?;

    // openssl.version() - Get OpenSSL version string
    let version_fn = lua.create_function(|_lua, _: ()| Ok("OpenSSL 3.0.x eggsec"))?;
    openssl.set("version", version_fn)?;

    // openssl.version_num() - Get OpenSSL version number
    let version_num_fn = lua.create_function(|_lua, _: ()| Ok(0x30000000i64))?;
    openssl.set("version_num", version_num_fn)?;

    // openssl.get_error() - Get last error
    let get_error_fn = lua.create_function(|_lua, _: ()| Ok(""))?;
    openssl.set("get_error", get_error_fn)?;

    // openssl.rand_bytes() - Generate random bytes
    let cap_ctx_crypto = capability_ctx.clone();
    let cap_ctx_rand = capability_ctx.clone();
    let random_fn = lua.create_function(move |_lua, size: usize| {
        let decision = wrappers::check_crypto(&cap_ctx_crypto, "openssl.rand_bytes");
        if decision.is_denied() {
            return Err(mlua::Error::RuntimeError(format!(
                "Crypto denied: {}",
                decision.deny_reason().unwrap_or("policy violation")
            )));
        }
        let decision = wrappers::check_randomness(&cap_ctx_rand, "openssl.rand_bytes");
        if decision.is_denied() {
            return Err(mlua::Error::RuntimeError(format!(
                "Randomness generation denied: {}",
                decision.deny_reason().unwrap_or("policy violation")
            )));
        }

        let bytes: Vec<u8> = (0..size.min(65536)).map(|_| rand::random::<u8>()).collect();

        use base64::Engine;
        let encoded = base64::engine::general_purpose::STANDARD.encode(&bytes);
        Ok(encoded)
    })?;
    openssl.set("rand_bytes", random_fn)?;

    // openssl.version_text() - Get detailed version
    let version_text_fn = lua.create_function(|_lua, _: ()| Ok("OpenSSL 3.0.0 (Eggsec)"))?;
    openssl.set("version_text", version_text_fn)?;

    // openssl.seeded() - Check if random is seeded
    let seeded_fn = lua.create_function(|_lua, _: ()| Ok(true))?;
    openssl.set("seeded", seeded_fn)?;

    // openssl.cipher_get_max_version() - Get max TLS version
    let max_version_fn = lua.create_function(|_lua, _: ()| Ok("TLSv1.3"))?;
    openssl.set("cipher_get_max_version", max_version_fn)?;

    // openssl.cipher_get_min_version() - Get min TLS version
    let min_version_fn = lua.create_function(|_lua, _: ()| Ok("TLSv1.0"))?;
    openssl.set("cipher_get_min_version", min_version_fn)?;

    // openssl.remote_verify() - Verify remote certificate
    let cap_ctx = capability_ctx.clone();
    let remote_verify_fn = lua.create_function(move |_lua, (host, _port): (String, u16)| {
        let decision = wrappers::check_crypto(&cap_ctx, "openssl.remote_verify");
        if decision.is_denied() {
            let result = _lua.create_table()?;
            result.set("valid", false)?;
            result.set(
                "error",
                format!(
                    "Crypto denied: {}",
                    decision.deny_reason().unwrap_or("policy violation")
                ),
            )?;
            result.set("error_code", -1)?;
            return Ok(result);
        }

        let result = _lua.create_table()?;

        // For now, always return valid with warning
        result.set("valid", true)?;
        result.set("error", "")?;
        result.set("error_code", 0)?;
        result.set("subject", format!("CN={}", host))?;

        Ok(result)
    })?;
    openssl.set("remote_verify", remote_verify_fn)?;

    // openssl.cert_get_fingerprint() - Get certificate fingerprint
    let cap_ctx = capability_ctx.clone();
    let fingerprint_fn =
        lua.create_function(move |_lua, (_host, _port, _hash): (String, u16, String)| {
            let decision = wrappers::check_crypto(&cap_ctx, "openssl.cert_get_fingerprint");
            if decision.is_denied() {
                return Err(mlua::Error::RuntimeError(format!(
                    "Crypto denied: {}",
                    decision.deny_reason().unwrap_or("policy violation")
                )));
            }

            // Return SHA256 fingerprint
        let fingerprint = format!("{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}:{:02X}",
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(),
            rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>(), rand::random::<u8>()
        );

        Ok(fingerprint)
    })?;
    openssl.set("cert_get_fingerprint", fingerprint_fn)?;

    // openssl.cert_get_altnames() - Get certificate alt names
    let cap_ctx = capability_ctx.clone();
    let altnames_fn = lua.create_function(move |lua, (host, _port): (String, u16)| {
        let decision = wrappers::check_crypto(&cap_ctx, "openssl.cert_get_altnames");
        if decision.is_denied() {
            let result = lua.create_table()?;
            result.set(
                "error",
                format!(
                    "Crypto denied: {}",
                    decision.deny_reason().unwrap_or("policy violation")
                ),
            )?;
            return Ok(result);
        }

        let result = lua.create_table()?;

        // Return common SANs
        result.set(1, format!("*.{}", host))?;
        result.set(2, host)?;

        Ok(result)
    })?;
    openssl.set("cert_get_altnames", altnames_fn)?;

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