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
use std::{fmt, marker::PhantomData, rc::Rc};
use ntex::io::{DispatchItem, DispatcherConfig, IoBoxed};
use ntex::service::{IntoServiceFactory, Service, ServiceCtx, ServiceFactory};
use ntex::time::{timeout_checked, Millis, Seconds};
use crate::error::{HandshakeError, MqttError, ProtocolError};
use crate::{service, types::QoS};
use super::control::{Control, ControlAck};
use super::default::{DefaultControlService, DefaultPublishService};
use super::handshake::{Handshake, HandshakeAck};
use super::shared::{MqttShared, MqttSinkPool};
use super::{codec as mqtt, dispatcher::factory, MqttSink, Publish, Session};
/// Mqtt v3.1.1 server
///
/// `St` - connection state
/// `H` - handshake service
/// `C` - service for handling control messages
/// `P` - service for handling publish
///
/// Every mqtt connection is handled in several steps. First step is handshake. Server calls
/// handshake service with `Handshake` message, during this step service can authenticate connect
/// packet, it must return instance of connection state `St`.
///
/// Handshake service could be expressed as simple function:
///
/// ```rust,ignore
/// use ntex_mqtt::v3::{Handshake, HandshakeAck};
///
/// async fn handshake(hnd: Handshake) -> Result<HandshakeAkc<MyState>, MyError> {
/// Ok(hnd.ack(MyState::new(), false))
/// }
/// ```
///
/// During next stage, control and publish services get constructed,
/// both factories receive `Session<St>` state object as an argument. Publish service
/// handles `Publish` packet. On success, server server sends `PublishAck` packet to
/// the client, in case of error connection get closed. Control service receives all
/// other packets, like `Subscribe`, `Unsubscribe` etc. Also control service receives
/// errors from publish service and connection disconnect.
pub struct MqttServer<St, H, C, P> {
handshake: H,
control: C,
publish: P,
max_qos: QoS,
max_size: u32,
max_receive: u16,
max_receive_size: usize,
max_send: u16,
max_send_size: (u32, u32),
handle_qos_after_disconnect: Option<QoS>,
connect_timeout: Seconds,
config: DispatcherConfig,
pub(super) pool: Rc<MqttSinkPool>,
_t: PhantomData<St>,
}
impl<St, H>
MqttServer<St, H, DefaultControlService<St, H::Error>, DefaultPublishService<St, H::Error>>
where
St: 'static,
H: ServiceFactory<Handshake, Response = HandshakeAck<St>> + 'static,
H::Error: fmt::Debug,
{
/// Create server factory and provide handshake service
pub fn new<F>(handshake: F) -> Self
where
F: IntoServiceFactory<H, Handshake>,
{
let config = DispatcherConfig::default();
config.set_disconnect_timeout(Seconds(3));
MqttServer {
config,
handshake: handshake.into_factory(),
control: DefaultControlService::default(),
publish: DefaultPublishService::default(),
max_qos: QoS::AtLeastOnce,
max_size: 0,
max_receive: 16,
max_receive_size: 65535,
max_send: 16,
max_send_size: (65535, 512),
handle_qos_after_disconnect: None,
connect_timeout: Seconds::ZERO,
pool: Default::default(),
_t: PhantomData,
}
}
}
impl<St, H, C, P> MqttServer<St, H, C, P>
where
St: 'static,
H: ServiceFactory<Handshake, Response = HandshakeAck<St>> + 'static,
C: ServiceFactory<Control<H::Error>, Session<St>, Response = ControlAck> + 'static,
P: ServiceFactory<Publish, Session<St>, Response = ()> + 'static,
H::Error:
From<C::Error> + From<C::InitError> + From<P::Error> + From<P::InitError> + fmt::Debug,
{
/// Set client timeout for first `Connect` frame.
///
/// Defines a timeout for reading `Connect` frame. If a client does not transmit
/// the entire frame within this time, the connection is terminated with
/// Mqtt::Handshake(HandshakeError::Timeout) error.
///
/// By default, connect timeout is disabled.
pub fn connect_timeout(mut self, timeout: Seconds) -> Self {
self.connect_timeout = timeout;
self
}
/// Set server connection disconnect timeout.
///
/// Defines a timeout for disconnect connection. If a disconnect procedure does not complete
/// within this time, the connection get dropped.
///
/// To disable timeout set value to 0.
///
/// By default disconnect timeout is set to 3 seconds.
pub fn disconnect_timeout(self, val: Seconds) -> Self {
self.config.set_disconnect_timeout(val);
self
}
/// Set read rate parameters for single frame.
///
/// Set read timeout, max timeout and rate for reading payload. If the client
/// sends `rate` amount of data within `timeout` period of time, extend timeout by `timeout` seconds.
/// But no more than `max_timeout` timeout.
///
/// By default frame read rate is disabled.
pub fn frame_read_rate(self, timeout: Seconds, max_timeout: Seconds, rate: u16) -> Self {
self.config.set_frame_read_rate(timeout, max_timeout, rate);
self
}
/// Set max allowed QoS.
///
/// If peer sends publish with higher qos then ProtocolError::MaxQoSViolated(..)
/// By default max qos is set to `ExactlyOnce`.
pub fn max_qos(mut self, qos: QoS) -> Self {
self.max_qos = qos;
self
}
/// Set max inbound frame size.
///
/// If max size is set to `0`, size is unlimited.
/// By default max size is set to `0`
pub fn max_size(mut self, size: u32) -> Self {
self.max_size = size;
self
}
/// Number of inbound in-flight concurrent messages.
///
/// By default inbound is set to 16 messages
pub fn max_receive(mut self, val: u16) -> Self {
self.max_receive = val;
self
}
#[deprecated]
#[doc(hidden)]
pub fn max_inflight(mut self, val: u16) -> Self {
self.max_receive = val;
self
}
/// Total size of inbound in-flight messages.
///
/// By default total inbound in-flight size is set to 64Kb
pub fn max_receive_size(mut self, val: usize) -> Self {
self.max_receive_size = val;
self
}
#[deprecated]
#[doc(hidden)]
pub fn max_inflight_size(mut self, val: usize) -> Self {
self.max_receive_size = val;
self
}
/// Number of outgoing concurrent messages.
///
/// By default outgoing is set to 16 messages
pub fn max_send(mut self, val: u16) -> Self {
self.max_send = val;
self
}
/// Total size of outgoing messages.
///
/// By default total outgoing size is set to 64Kb
pub fn max_send_size(mut self, val: u32) -> Self {
self.max_send_size = (val, val / 10);
self
}
/// Handle max received QoS messages after client disconnect.
///
/// By default, messages received before dispatched to the publish service will be dropped if
/// the client disconnect is detected on the server.
///
/// If this option is set to `Some(QoS::AtMostOnce)`, only the received QoS 0 messages will
/// always be handled by the server's publish service no matter if the client is disconnected
/// or not.
///
/// If this option is set to `Some(QoS::AtLeastOnce)`, the received QoS 0 and QoS 1 messages
/// will always be handled by the server's publish service no matter if the client
/// is disconnected or not. The QoS 2 messages will be dropped if the client disconnecting is
/// detected before the server dispatches them to the publish service.
///
/// If this option is set to `Some(QoS::ExactlyOnce)`, all the messages received will always
/// be handled by the server's publish service no matter if the client is disconnected or not.
///
/// The received messages which QoS larger than the `max_handle_qos` will not be guaranteed to
/// be handled or not after the client disconnect. It depends on the network condition.
///
/// By default handle-qos-after-disconnect is set to `None`
pub fn handle_qos_after_disconnect(mut self, max_handle_qos: Option<QoS>) -> Self {
self.handle_qos_after_disconnect = max_handle_qos;
self
}
/// Service to handle control packets
///
/// All control packets are processed sequentially, max number of buffered
/// control packets is 16.
pub fn control<F, Srv>(self, service: F) -> MqttServer<St, H, Srv, P>
where
F: IntoServiceFactory<Srv, Control<H::Error>, Session<St>>,
Srv: ServiceFactory<Control<H::Error>, Session<St>, Response = ControlAck> + 'static,
H::Error: From<Srv::Error> + From<Srv::InitError>,
{
MqttServer {
handshake: self.handshake,
publish: self.publish,
control: service.into_factory(),
config: self.config,
max_qos: self.max_qos,
max_size: self.max_size,
max_receive: self.max_receive,
max_receive_size: self.max_receive_size,
max_send: self.max_send,
max_send_size: self.max_send_size,
handle_qos_after_disconnect: self.handle_qos_after_disconnect,
connect_timeout: self.connect_timeout,
pool: self.pool,
_t: PhantomData,
}
}
/// Set service to handle publish packets and create mqtt server factory
pub fn publish<F, Srv>(self, publish: F) -> MqttServer<St, H, C, Srv>
where
F: IntoServiceFactory<Srv, Publish, Session<St>>,
Srv: ServiceFactory<Publish, Session<St>, Response = ()> + 'static,
H::Error: From<Srv::Error> + From<Srv::InitError> + fmt::Debug,
{
MqttServer {
handshake: self.handshake,
publish: publish.into_factory(),
control: self.control,
config: self.config,
max_qos: self.max_qos,
max_size: self.max_size,
max_receive: self.max_receive,
max_receive_size: self.max_receive_size,
max_send: self.max_send,
max_send_size: self.max_send_size,
handle_qos_after_disconnect: self.handle_qos_after_disconnect,
connect_timeout: self.connect_timeout,
pool: self.pool,
_t: PhantomData,
}
}
/// Finish server configuration and create mqtt server factory
pub fn finish(
self,
) -> service::MqttServer<
Session<St>,
impl ServiceFactory<
IoBoxed,
Response = (IoBoxed, Rc<MqttShared>, Session<St>, Seconds),
Error = MqttError<H::Error>,
InitError = H::InitError,
>,
impl ServiceFactory<
DispatchItem<Rc<MqttShared>>,
Session<St>,
Response = Option<mqtt::Packet>,
Error = MqttError<H::Error>,
InitError = MqttError<H::Error>,
>,
Rc<MqttShared>,
> {
service::MqttServer::new(
HandshakeFactory {
factory: self.handshake,
max_size: self.max_size,
max_send: self.max_send,
max_send_size: self.max_send_size,
connect_timeout: self.connect_timeout,
pool: self.pool.clone(),
_t: PhantomData,
},
factory(
self.publish,
self.control,
self.max_receive,
self.max_receive_size,
self.max_qos,
self.handle_qos_after_disconnect,
),
self.config,
)
}
}
struct HandshakeFactory<St, H> {
factory: H,
max_size: u32,
max_send: u16,
max_send_size: (u32, u32),
connect_timeout: Seconds,
pool: Rc<MqttSinkPool>,
_t: PhantomData<St>,
}
impl<St, H> ServiceFactory<IoBoxed> for HandshakeFactory<St, H>
where
H: ServiceFactory<Handshake, Response = HandshakeAck<St>> + 'static,
H::Error: fmt::Debug,
{
type Response = (IoBoxed, Rc<MqttShared>, Session<St>, Seconds);
type Error = MqttError<H::Error>;
type Service = HandshakeService<St, H::Service>;
type InitError = H::InitError;
async fn create(&self, _: ()) -> Result<Self::Service, Self::InitError> {
Ok(HandshakeService {
max_size: self.max_size,
max_send: self.max_send,
max_send_size: self.max_send_size,
pool: self.pool.clone(),
service: self.factory.create(()).await?,
connect_timeout: self.connect_timeout.into(),
_t: PhantomData,
})
}
}
struct HandshakeService<St, H> {
service: H,
max_size: u32,
max_send: u16,
max_send_size: (u32, u32),
pool: Rc<MqttSinkPool>,
connect_timeout: Millis,
_t: PhantomData<St>,
}
impl<St, H> Service<IoBoxed> for HandshakeService<St, H>
where
H: Service<Handshake, Response = HandshakeAck<St>> + 'static,
H::Error: fmt::Debug,
{
type Response = (IoBoxed, Rc<MqttShared>, Session<St>, Seconds);
type Error = MqttError<H::Error>;
ntex::forward_poll_ready!(service, MqttError::Service);
ntex::forward_poll_shutdown!(service);
async fn call(
&self,
io: IoBoxed,
ctx: ServiceCtx<'_, Self>,
) -> Result<Self::Response, Self::Error> {
log::trace!("Starting mqtt v3 handshake");
let (h, l) = self.max_send_size;
io.memory_pool().set_write_params(h, l);
let codec = mqtt::Codec::default();
codec.set_max_size(self.max_size);
let shared = Rc::new(MqttShared::new(io.get_ref(), codec, false, self.pool.clone()));
// read first packet
let packet = timeout_checked(self.connect_timeout, io.recv(&shared.codec))
.await
.map_err(|_| MqttError::Handshake(HandshakeError::Timeout))?
.map_err(|err| {
log::trace!("Error is received during mqtt handshake: {:?}", err);
MqttError::Handshake(HandshakeError::from(err))
})?
.ok_or_else(|| {
log::trace!("Server mqtt is disconnected during handshake");
MqttError::Handshake(HandshakeError::Disconnected(None))
})?;
match packet {
(mqtt::Packet::Connect(connect), size) => {
// authenticate mqtt connection
let ack = ctx
.call(&self.service, Handshake::new(connect, size, io, shared))
.await
.map_err(MqttError::Service)?;
match ack.session {
Some(session) => {
let pkt = mqtt::Packet::ConnectAck(mqtt::ConnectAck {
session_present: ack.session_present,
return_code: mqtt::ConnectAckReason::ConnectionAccepted,
});
log::trace!("Sending success handshake ack: {:#?}", pkt);
ack.shared.set_cap(ack.max_send.unwrap_or(self.max_send) as usize);
ack.io.encode(pkt, &ack.shared.codec)?;
Ok((
ack.io,
ack.shared.clone(),
Session::new(session, MqttSink::new(ack.shared)),
ack.keepalive,
))
}
None => {
let pkt = mqtt::Packet::ConnectAck(mqtt::ConnectAck {
session_present: false,
return_code: ack.return_code,
});
log::trace!("Sending failed handshake ack: {:#?}", pkt);
ack.io.encode(pkt, &ack.shared.codec)?;
let _ = ack.io.shutdown().await;
Err(MqttError::Handshake(HandshakeError::Disconnected(None)))
}
}
}
(packet, _) => {
log::info!("MQTT-3.1.0-1: Expected CONNECT packet, received {:?}", packet);
Err(MqttError::Handshake(HandshakeError::Protocol(
ProtocolError::unexpected_packet(
packet.packet_type(),
"MQTT-3.1.0-1: Expected CONNECT packet",
),
)))
}
}
}
}