rzmq 0.5.14

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

use async_trait::async_trait;
use dryoc::types::Bytes;

use crate::error::ZmqError;
use crate::security::curve::handshake::{CurveHandshake, CurveHandshakePhase};
use crate::security::framer::{ISecureFramer, LengthPrefixedFramer};
use crate::security::mechanism::ProcessTokenAction;
use crate::security::{IDataCipher, Mechanism, MechanismStatus, Metadata};

/// The public-facing wrapper for the CurveZMQ security mechanism.
/// This struct implements the `Mechanism` trait and holds the underlying handshake state machine.
#[derive(Debug)]
pub(crate) struct CurveMechanism {
  pub(crate) handshake: CurveHandshake,
  pub(crate) status: MechanismStatus,
  pub(crate) error_reason: Option<String>,
}

impl CurveMechanism {
  pub const NAME: &'static str = "CURVE";
  // ZMTP mechanism names are 20 bytes, padded with nulls.
  pub const NAME_BYTES: &'static [u8; 20] = b"CURVE\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
}

#[async_trait]
impl Mechanism for CurveMechanism {
  fn name(&self) -> &'static str {
    Self::NAME
  }

  fn status(&self) -> MechanismStatus {
    self.status
  }

  fn produce_token(&mut self) -> Result<Option<Vec<u8>>, ZmqError> {
    match self.handshake.phase {
      CurveHandshakePhase::ClientStart => {
        let hello_command_body = self.handshake.build_client_hello()?;
        self.handshake.phase = CurveHandshakePhase::ClientSentHello;
        Ok(Some(hello_command_body))
      }
      CurveHandshakePhase::ServerReadyToProduceWelcome => {
        let welcome_command_body = self.handshake.build_server_welcome()?;
        self.handshake.phase = CurveHandshakePhase::ServerAwaitingInitiate;
        Ok(Some(welcome_command_body))
      }
      CurveHandshakePhase::ClientReadyToProduceInitiate => {
        let initiate_command_body = self.handshake.build_client_initiate()?;
        // After sending INITIATE, the client handshake is complete from its perspective.
        self.handshake.phase = CurveHandshakePhase::Complete;
        self.status = MechanismStatus::Ready;
        Ok(Some(initiate_command_body))
      }
      // In all other states, we are waiting for the peer.
      _ => Ok(None),
    }
  }

  fn process_token(&mut self, token: &[u8]) -> Result<ProcessTokenAction, ZmqError> {
    match self.handshake.phase {
      CurveHandshakePhase::ServerStart => {
        self.handshake.process_client_hello(token)?;
        self.handshake.phase = CurveHandshakePhase::ServerReadyToProduceWelcome;
        Ok(ProcessTokenAction::ProduceAndSend)
      }
      CurveHandshakePhase::ClientSentHello => {
        self.handshake.process_server_welcome(token)?;
        self.handshake.phase = CurveHandshakePhase::ClientReadyToProduceInitiate;
        Ok(ProcessTokenAction::ProduceAndSend)
      }
      CurveHandshakePhase::ServerAwaitingInitiate => {
        self.handshake.process_client_initiate(token)?;
        self.handshake.phase = CurveHandshakePhase::Complete;
        self.status = MechanismStatus::Ready;
        Ok(ProcessTokenAction::HandshakeComplete)
      }
      _ => Err(ZmqError::InvalidState(
        "Received handshake token at an unexpected time.",
      )),
    }
  }

  fn into_framer(self: Box<Self>, max_msg_size: i64) -> Result<(Box<dyn ISecureFramer>, Option<Vec<u8>>), ZmqError> {
    if self.status != MechanismStatus::Ready {
      return Err(ZmqError::InvalidState("Curve handshake is not complete."));
    }

    let peer_identity = self
      .handshake
      .remote_static_public_key
      .as_ref()
      .map(|pk| pk.as_slice().to_vec());

    let cipher = self.handshake.into_data_cipher()?;
    let framer = Box::new(LengthPrefixedFramer::new(cipher, max_msg_size));

    Ok((framer, peer_identity))
  }

  fn set_error(&mut self, reason: String) {
    if self.status != MechanismStatus::Error {
      self.status = MechanismStatus::Error;
      self.error_reason = Some(reason);
      self.handshake.phase = CurveHandshakePhase::Error;
    }
  }

  fn error_reason(&self) -> Option<&str> {
    self.error_reason.as_deref()
  }

  fn peer_identity(&self) -> Option<Vec<u8>> {
    self
      .handshake
      .remote_static_public_key
      .as_ref()
      .map(|pk| pk.as_slice().to_vec())
  }

  fn zap_request_needed(&mut self) -> Option<Vec<Vec<u8>>> {
    None
  }
  fn process_zap_reply(&mut self, _reply_frames: &[Vec<u8>]) -> Result<(), ZmqError> {
    Ok(())
  }

  fn as_any(&self) -> &dyn std::any::Any {
    self
  }

  fn metadata(&self) -> Option<Metadata> {
    None
  }
}