rzmq 0.5.15

High performance, fully asynchronous, safe pure-Rust implementation of ZeroMQ (ØMQ) messaging with io_uring and TCP Cork acceleration on Linux.
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
mod common;

use rzmq::{
  Socket, SocketType, ZmqError,
  socket::{LINGER, PLAIN_PASSWORD, PLAIN_SERVER, PLAIN_USERNAME, SocketEvent},
};
use serial_test::serial; // Add necessary rzmq imports
use std::time::Duration;
use tokio::{task::JoinHandle, time::timeout};

const TEST_TIMEOUT: Duration = Duration::from_secs(5); // Timeout for async test operations

async fn setup_server(
  ctx: &rzmq::Context,
  bind_addr: &str,
  enable_plain: bool,
  expected_username: Option<&str>,
  expected_password: Option<&str>,
) -> Result<Socket, ZmqError> {
  let server = ctx.socket(SocketType::Rep)?;
  if enable_plain {
    server.set_option(PLAIN_SERVER, true).await?;
    // Apply expected credentials
    if let Some(user) = expected_username {
      server.set_option(PLAIN_USERNAME, user).await?;
    }
    if let Some(pass) = expected_password {
      server.set_option(PLAIN_PASSWORD, pass).await?;
    }
  }
  server.set_option(LINGER, 0).await?;
  server.bind(bind_addr).await?;
  Ok(server)
}

async fn setup_client(
  ctx: &rzmq::Context,
  connect_addr: &str,
  enable_plain: bool,
  username: Option<&str>,
  password: Option<&str>,
  // Add other mechanism configs
) -> Result<(Socket, fibre::mpmc::AsyncReceiver<SocketEvent>), ZmqError> {
  let client = ctx.socket(SocketType::Req)?;
  if enable_plain {
    let user_to_set = username.unwrap_or("");
    let pass_to_set = password.unwrap_or("");

    client
      .set_option_raw(PLAIN_USERNAME, user_to_set.as_bytes())
      .await?;
    client
      .set_option_raw(PLAIN_PASSWORD, pass_to_set.as_bytes())
      .await?;
    // Setting either PLAIN_USERNAME or PLAIN_PASSWORD makes client_socket.options.plain_options.enabled = true
  }
  // Add other security mechanism options here
  client.set_option_raw(LINGER, &0u32.to_ne_bytes()).await?;
  let client_monitor = client.monitor_default().await.unwrap();
  client.connect(connect_addr).await?;
  Ok((client, client_monitor))
}

// Test 1: Successful PLAIN Handshake
#[tokio::test]
#[serial]
async fn test_plain_successful_handshake() {
  let ctx = common::test_context();
  let addr = "tcp://127.0.0.1:15501";

  let server_socket = setup_server(&ctx, addr, true, Some("user"), Some("pass"))
    .await
    .expect("Server setup failed");
  let (client_socket, client_monitor) = setup_client(&ctx, addr, true, Some("user"), Some("pass"))
    .await
    .expect("Client setup failed");

  // Monitor client for handshake success
  let mut handshake_succeeded = false;

  tokio::spawn(async move {
    // Server REP logic: recv request, send reply
    let req = server_socket.recv().await.expect("Server failed to recv");
    assert_eq!(req.data().unwrap(), b"hello");
    server_socket
      .send(rzmq::Msg::from_static(b"world"))
      .await
      .expect("Server failed to send reply");
  });

  client_socket
    .send(rzmq::Msg::from_static(b"hello"))
    .await
    .expect("Client failed to send request");
  let reply = client_socket
    .recv()
    .await
    .expect("Client failed to recv reply");
  assert_eq!(reply.data().unwrap(), b"world");

  // Check monitor events for handshake success on client
  loop {
    match timeout(Duration::from_millis(200), client_monitor.recv()).await {
      Ok(Ok(SocketEvent::HandshakeSucceeded { endpoint })) => {
        if endpoint.contains("15501") {
          // Check if it's our target endpoint
          handshake_succeeded = true;
          break;
        }
      }
      Ok(Ok(event)) => {
        tracing::debug!("Client monitor event: {:?}", event);
      }
      Ok(Err(_)) => {
        /* Monitor channel closed */
        break;
      }
      Err(_) => {
        /* Timeout */
        break;
      }
    }
  }
  assert!(
    handshake_succeeded,
    "Client did not receive HandshakeSucceeded event for PLAIN"
  );

  client_socket.close().await.unwrap();
  // server_socket.close().await.unwrap(); // Server closes when client drops
  ctx.term().await.unwrap();
}

// Test 2: PLAIN Client with NO credentials vs Configured Server (Should FAIL)
#[tokio::test]
#[serial]
async fn test_plain_client_no_credentials() {
  let ctx = common::test_context();
  let addr = "tcp://127.0.0.1:15504";

  // Server expects specific credentials (admin/secret) to verify rejection
  let server_socket = setup_server(&ctx, addr, true, Some("admin"), Some("secret")).await.expect("Server setup failed");
  // Ensure server processes events
  tokio::spawn(async move {
      let _ = server_socket.recv().await;
  });

  // Client configured with None (defaults to empty strings)
  let (client_socket, client_monitor) = setup_client(&ctx, addr, true, None, None).await.expect("Client setup failed");

  // Attempt to send (should trigger handshake)
  let _ = client_socket.send(rzmq::Msg::from_static(b"empty_req")).await;
  
  // We expect the handshake to FAIL because empty != admin/secret
  let mut failure_observed = false;
  let deadline = tokio::time::Instant::now() + Duration::from_secs(2);
  loop {
    if tokio::time::Instant::now() > deadline { break; }
    match timeout(Duration::from_millis(200), client_monitor.recv()).await {
      Ok(Ok(event)) => {
        if matches!(event, SocketEvent::HandshakeFailed { .. } | SocketEvent::Disconnected { .. }) {
            failure_observed = true;
            break;
        }
      }
      Ok(Ok(_)) => {}, // Ignore other events
      _ => {}
    }
  }

  assert!(
    failure_observed,
    "Client with no credentials should have been rejected by server expecting 'admin'."
  );
  
  client_socket.close().await.unwrap();
  ctx.term().await.unwrap();
}

// Test 3: PLAIN Client connecting to PLAIN Server Wrong Credentials (should fail)

#[tokio::test]
async fn test_plain_security_enforcement() -> Result<(), ZmqError> {
  println!("--- Starting test_plain_security_enforcement ---");
  let ctx = common::test_context();
  let endpoint = "tcp://127.0.0.1:5998";

  // --- 1. Configure Server (Expects: admin / secret) ---
  let server = ctx.socket(SocketType::Rep)?;
  server.set_option(PLAIN_SERVER, true).await?;
  server.set_option(PLAIN_USERNAME, "admin").await?;
  server.set_option(PLAIN_PASSWORD, "secret").await?;
  server.bind(endpoint).await?;

  // --- 2. Configure Client (Sends: hacker / wrongpass) ---
  let client = ctx.socket(SocketType::Req)?;
  client.set_option(PLAIN_USERNAME, "hacker").await?;
  client.set_option(PLAIN_PASSWORD, "wrongpass").await?;

  let mut monitor = client.monitor_default().await?;
  client.connect(endpoint).await?;

  // --- 3. Expect Failure ---
  let result = common::wait_for_monitor_event(
    &monitor,
    Duration::from_secs(2),
    Duration::from_millis(50),
    |e| {
      matches!(
        e,
        SocketEvent::HandshakeFailed { .. } | SocketEvent::Disconnected { .. }
      )
    },
  )
  .await;

  match result {
    Ok(_) => {
      println!("Success: Connection correctly rejected.");
      Ok(())
    }
    Err(_) => {
      // If we timed out waiting for failure, check if we accidentally succeeded
      // This part is manual because wait_for_monitor_event filters.
      // But effectively, if we didn't get Failed, and the bug exists, we likely got Succeeded silently (filtered out).
      // We can assert failure here.
      panic!(
        "Regression: PLAIN auth did not report failure for bad credentials. (Server likely accepted connection)."
      );
    }
  }
}

// Test 4: PLAIN Client connecting to NULL Server (should fail)

#[tokio::test]
#[serial]
async fn test_plain_client_to_null_server_fails() {
  let ctx = common::test_context();
  let addr = "tcp://127.0.0.1:15502";

  let server_socket = setup_server(&ctx, addr, false, None, None)
    .await
    .expect("Server setup failed");
  let server_task = tokio::spawn(async move {
    // Ensure server is running
    let _ = server_socket.recv().await; // It will likely never receive
    server_socket.close().await.ok();
  });

  // Client attempts PLAIN. `setup_client` includes connect.
  // The connect itself might return an error due to rapid handshake failure.
  let client_setup_result = setup_client(&ctx, addr, true, Some("user"), Some("pass")).await;

  if let Ok((client_socket, mut client_monitor)) = client_setup_result {
    // Connect "succeeded" at some level, now wait for monitor events for actual failure.
    let mut failure_event_received = false;
    for _ in 0..10 {
      // Poll a few times
      match timeout(Duration::from_millis(500), client_monitor.recv()).await {
        // Increased timeout slightly
        Ok(Ok(event)) => {
          tracing::info!(
            "[Test Monitor - PLAIN Client to NULL Server] Event: {:?}",
            event
          );
          match event {
            SocketEvent::HandshakeFailed { .. }
            | SocketEvent::ConnectFailed { .. }
            | SocketEvent::Disconnected { .. }
            | SocketEvent::Closed { .. } => {
              failure_event_received = true;
              break;
            }
            _ => {}
          }
        }
        Ok(Err(_)) => {
          tracing::info!("[Test Monitor - PLAIN Client to NULL Server] Monitor closed.");
          failure_event_received = true;
          break;
        } // Monitor closed can also mean failure
        Err(_) => {
          tracing::info!("[Test Monitor - PLAIN Client to NULL Server] Timeout.");
        } // Just timeout, try again
      }
      if failure_event_received {
        break;
      }
    }
    assert!(
      failure_event_received,
      "PLAIN client to NULL server did not result in a failure-related monitor event."
    );
    client_socket.close().await.ok();
  } else {
    // setup_client (which includes connect) failed directly. This is also a pass.
    tracing::info!(
      "Client setup/connect failed as expected for PLAIN client to NULL server: {:?}",
      client_setup_result.as_ref().err().unwrap()
    );
    assert!(client_setup_result.is_err());
  }

  server_task.abort(); // Ensure server task is stopped
  ctx.term().await.unwrap();
}

// Test 5: NULL Client connecting to PLAIN Server (should fail)

#[tokio::test]
#[serial]
async fn test_null_client_to_plain_server_fails() {
  let ctx = common::test_context();
  let addr = "tcp://127.0.0.1:15503";

  // Server with PLAIN enabled
  let server_socket = setup_server(&ctx, addr, true, Some("u"), Some("p"))
    .await
    .expect("Server setup failed");
  let _server_task: JoinHandle<()> = tokio::spawn(async move {
    // Keep server running
    // Server might receive a connection attempt that fails handshake,
    // so recv() might error or timeout if no valid client ever fully connects.
    match server_socket.recv().await {
      Ok(_) => tracing::info!("[Test Server {}] Unexpectedly received a message.", addr),
      Err(e) => tracing::info!(
        "[Test Server {}] Recv ended (expected for failed handshake): {}",
        addr,
        e
      ),
    }
    tracing::info!("[Test Server {}] Exiting task.", addr);
  });

  // Client with NO PLAIN (defaults to NULL)
  let client_setup_result = setup_client(&ctx, addr, false, None, None).await;
  assert!(
    client_setup_result.is_ok(),
    "Client setup failed unexpectedly: {:?}",
    client_setup_result.err()
  );

  let (client_socket, client_monitor) = client_setup_result.unwrap();

  // Spawn the client operations in a separate task
  let client_task: JoinHandle<Result<(), ZmqError>> = tokio::spawn(async move {
    // Server expects HELLO, client sends NULL. Handshake should fail.
    let send_res = client_socket.send(rzmq::Msg::from_static(b"hello")).await;

    if send_res.is_ok() {
      println!("OK (client task)"); // This may or may not print depending on how fast handshake fails
      // Attempt to recv. This should now be interrupted by socket.close() from ctx.term()
      // or fail due to peer detachment if handshake failure propagates error to recv.
      let recv_res = client_socket.recv().await;
      println!("Client task recv result: {:?}", recv_res);
      if recv_res.is_ok() {
        println!("(client task) - recv succeeded unexpectedly");
        return Err(ZmqError::Internal(
          "Client recv() succeeded when handshake should have failed".into(),
        ));
      } else {
        // Check for specific errors indicating termination or peer loss
        match recv_res.as_ref().err().unwrap() {
          ZmqError::ConnectionClosed
          | ZmqError::HostUnreachable(_)
          | ZmqError::SecurityError(_)
          | ZmqError::ResourceLimitReached => {
            println!(
              "Client task recv() failed as expected: {:?}",
              recv_res.as_ref().err().unwrap()
            );
          }
          e => {
            println!(
              "NOOKSEND (client task) - recv failed with unexpected error: {}",
              e
            );
            return Err(e.clone()); // Propagate other errors
          }
        }
      }
    } else {
      println!(
        "NOOKSEND (client task) - send failed directly: {:?}",
        send_res.as_ref().err().unwrap()
      );
      // If send_res itself is an error, that's a valid failure path for handshake fail.
      // Ensure it's a relevant error.
      match send_res.as_ref().err().unwrap() {
        ZmqError::SecurityError(_)
        | ZmqError::HostUnreachable(_)
        | ZmqError::ResourceLimitReached => {
          println!("Client task send() failed as expected due to handshake issue.");
        }
        e => return Err(e.clone()), // Propagate other errors
      }
    }
    // Explicitly close the client socket from its task when done or errored.
    // This is good practice, though ctx.term() should also handle it.
    let close_res = client_socket.close().await;
    println!("Client task: client_socket.close() result: {:?}", close_res);
    Ok(())
  });

  // Main test task now waits for monitor events and then ctx.term()

  let mut handshake_failed_event_observed = false;
  let mut connect_failed_event_observed = false;
  let mut disconnected_event_observed = false;

  println!("Main test: Waiting for failure indication on client monitor...");
  // Give client task some time to attempt send/recv and for monitor events to propagate
  let monitor_check_deadline = tokio::time::Instant::now() + Duration::from_secs(3);
  loop {
    if tokio::time::Instant::now() > monitor_check_deadline {
      tracing::warn!("Main test: Timeout waiting for specific failure monitor event.");
      break;
    }
    match timeout(Duration::from_millis(200), client_monitor.recv()).await {
      Ok(Ok(event)) => {
        tracing::debug!("Main test: Client monitor event: {:?}", event);
        match event {
          SocketEvent::HandshakeFailed { .. } => {
            handshake_failed_event_observed = true;
            println!("Main test: Monitor observed HandshakeFailed.");
            break;
          }
          SocketEvent::ConnectFailed { .. } => {
            connect_failed_event_observed = true;
            println!("Main test: Monitor observed ConnectFailed.");
            break;
          }
          SocketEvent::Disconnected { .. } => {
            disconnected_event_observed = true;
            println!("Main test: Monitor observed Disconnected.");
            break;
          }
          _ => {} // Ignore other events
        }
      }
      Ok(Err(e)) => {
        tracing::warn!("Main test: Monitor channel closed or error: {:?}", e);
        break;
      }
      Err(_) => {} // Timeout on this poll, loop again
    }
  }

  assert!(
    handshake_failed_event_observed || connect_failed_event_observed || disconnected_event_observed,
    "NULL client to PLAIN server did not result in HandshakeFailed, ConnectFailed, or Disconnected monitor event"
  );

  println!("Main test: Proceeding to ctx.term()...");
  ctx.term().await.unwrap(); // This should now work as client_task will finish
  println!("Main test: ctx.term() completed.");

  // Wait for the client task to finish and check its result
  println!("Main test: Waiting for client_task to join...");
  match timeout(Duration::from_secs(2), client_task).await {
    Ok(Ok(Ok(()))) => {
      println!(
        "Main test: Client task completed successfully (meaning it handled send/recv failure correctly)."
      )
    }
    Ok(Ok(Err(e))) => panic!("Main test: Client task failed with ZmqError: {}", e),
    Ok(Err(e)) => panic!("Main test: Client task panicked: {:?}", e),
    Err(_) => panic!("Main test: Timed out waiting for client task to join!"),
  }

  // _server_task.abort(); // Not strictly needed if ctx.term() shuts down server socket too, but good for explicit cleanup
  println!("Test test_null_client_to_plain_server_fails finished.");
}