use crate::MqttString;
use super::{
len_len, length, property, read_mqtt_bytes, read_mqtt_string, read_u16, read_u32, read_u8,
write_mqtt_bytes, write_mqtt_string, write_remaining_length, Debug, Error, FixedHeader,
PropertyType,
};
use bytes::{Buf, BufMut, Bytes, BytesMut};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConnectReturnCode {
Success,
RefusedProtocolVersion,
BadClientId,
ServiceUnavailable,
UnspecifiedError,
MalformedPacket,
ProtocolError,
ImplementationSpecificError,
UnsupportedProtocolVersion,
ClientIdentifierNotValid,
BadUserNamePassword,
NotAuthorized,
ServerUnavailable,
ServerBusy,
Banned,
BadAuthenticationMethod,
TopicNameInvalid,
PacketTooLarge,
QuotaExceeded,
PayloadFormatInvalid,
RetainNotSupported,
QoSNotSupported,
UseAnotherServer,
ServerMoved,
ConnectionRateExceeded,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ConnAck {
pub session_present: bool,
pub code: ConnectReturnCode,
pub properties: Option<ConnAckProperties>,
}
impl ConnAck {
fn len(&self) -> usize {
let mut len = 1 + 1; if let Some(p) = &self.properties {
let properties_len = p.len();
let properties_len_len = len_len(properties_len);
len += properties_len_len + properties_len;
} else {
len += 1;
}
len
}
pub fn size(&self) -> usize {
let len = self.len();
let remaining_len_size = len_len(len);
1 + remaining_len_size + len
}
pub fn read(fixed_header: FixedHeader, mut bytes: Bytes) -> Result<ConnAck, Error> {
let variable_header_index = fixed_header.fixed_header_len;
bytes.advance(variable_header_index);
let flags = read_u8(&mut bytes)?;
let return_code = read_u8(&mut bytes)?;
let properties = ConnAckProperties::read(&mut bytes)?;
let session_present = (flags & 0x01) == 1;
let code = connect_return(return_code)?;
let connack = ConnAck {
session_present,
code,
properties,
};
Ok(connack)
}
pub fn write(&self, buffer: &mut BytesMut) -> Result<usize, Error> {
let len = Self::len(self);
buffer.put_u8(0x20);
let count = write_remaining_length(buffer, len)?;
buffer.put_u8(u8::from(self.session_present));
buffer.put_u8(connect_code(self.code));
if let Some(p) = &self.properties {
p.write(buffer)?;
} else {
write_remaining_length(buffer, 0)?;
}
Ok(1 + count + len)
}
}
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct ConnAckProperties {
pub session_expiry_interval: Option<u32>,
pub receive_max: Option<u16>,
pub max_qos: Option<u8>,
pub retain_available: Option<u8>,
pub max_packet_size: Option<u32>,
pub assigned_client_identifier: Option<MqttString>,
pub topic_alias_max: Option<u16>,
pub reason_string: Option<MqttString>,
pub user_properties: Vec<(MqttString, MqttString)>,
pub wildcard_subscription_available: Option<u8>,
pub subscription_identifiers_available: Option<u8>,
pub shared_subscription_available: Option<u8>,
pub server_keep_alive: Option<u16>,
pub response_information: Option<MqttString>,
pub server_reference: Option<MqttString>,
pub authentication_method: Option<MqttString>,
pub authentication_data: Option<Bytes>,
}
impl ConnAckProperties {
#[must_use]
pub fn new() -> Self {
Self::default()
}
fn len(&self) -> usize {
let mut len = 0;
if self.session_expiry_interval.is_some() {
len += 1 + 4;
}
if self.receive_max.is_some() {
len += 1 + 2;
}
if self.max_qos.is_some() {
len += 1 + 1;
}
if self.retain_available.is_some() {
len += 1 + 1;
}
if self.max_packet_size.is_some() {
len += 1 + 4;
}
if let Some(id) = &self.assigned_client_identifier {
len += 1 + 2 + id.len();
}
if self.topic_alias_max.is_some() {
len += 1 + 2;
}
if let Some(reason) = &self.reason_string {
len += 1 + 2 + reason.len();
}
for (key, value) in &self.user_properties {
len += 1 + 2 + key.len() + 2 + value.len();
}
if self.wildcard_subscription_available.is_some() {
len += 1 + 1;
}
if self.subscription_identifiers_available.is_some() {
len += 1 + 1;
}
if self.shared_subscription_available.is_some() {
len += 1 + 1;
}
if self.server_keep_alive.is_some() {
len += 1 + 2;
}
if let Some(info) = &self.response_information {
len += 1 + 2 + info.len();
}
if let Some(reference) = &self.server_reference {
len += 1 + 2 + reference.len();
}
if let Some(authentication_method) = &self.authentication_method {
len += 1 + 2 + authentication_method.len();
}
if let Some(authentication_data) = &self.authentication_data {
len += 1 + 2 + authentication_data.len();
}
len
}
#[allow(clippy::too_many_lines)]
pub fn read(bytes: &mut Bytes) -> Result<Option<ConnAckProperties>, Error> {
let mut session_expiry_interval = None;
let mut receive_max = None;
let mut max_qos = None;
let mut retain_available = None;
let mut max_packet_size = None;
let mut assigned_client_identifier = None;
let mut topic_alias_max = None;
let mut reason_string = None;
let mut user_properties = Vec::new();
let mut wildcard_subscription_available = None;
let mut subscription_identifiers_available = None;
let mut shared_subscription_available = None;
let mut server_keep_alive = None;
let mut response_information = None;
let mut server_reference = None;
let mut authentication_method = None;
let mut authentication_data = None;
let (properties_len_len, properties_len) = length(bytes.iter())?;
bytes.advance(properties_len_len);
if properties_len == 0 {
return Ok(None);
}
let mut cursor = 0;
while cursor < properties_len {
let prop = read_u8(bytes)?;
cursor += 1;
match property(prop)? {
PropertyType::SessionExpiryInterval => {
session_expiry_interval = Some(read_u32(bytes)?);
cursor += 4;
}
PropertyType::ReceiveMaximum => {
receive_max = Some(read_u16(bytes)?);
cursor += 2;
}
PropertyType::MaximumQos => {
max_qos = Some(read_u8(bytes)?);
cursor += 1;
}
PropertyType::RetainAvailable => {
retain_available = Some(read_u8(bytes)?);
cursor += 1;
}
PropertyType::AssignedClientIdentifier => {
let id = read_mqtt_string(bytes)?;
cursor += 2 + id.len();
assigned_client_identifier = Some(id);
}
PropertyType::MaximumPacketSize => {
max_packet_size = Some(read_u32(bytes)?);
cursor += 4;
}
PropertyType::TopicAliasMaximum => {
topic_alias_max = Some(read_u16(bytes)?);
cursor += 2;
}
PropertyType::ReasonString => {
let reason = read_mqtt_string(bytes)?;
cursor += 2 + reason.len();
reason_string = Some(reason);
}
PropertyType::UserProperty => {
let key = read_mqtt_string(bytes)?;
let value = read_mqtt_string(bytes)?;
cursor += 2 + key.len() + 2 + value.len();
user_properties.push((key, value));
}
PropertyType::WildcardSubscriptionAvailable => {
wildcard_subscription_available = Some(read_u8(bytes)?);
cursor += 1;
}
PropertyType::SubscriptionIdentifierAvailable => {
subscription_identifiers_available = Some(read_u8(bytes)?);
cursor += 1;
}
PropertyType::SharedSubscriptionAvailable => {
shared_subscription_available = Some(read_u8(bytes)?);
cursor += 1;
}
PropertyType::ServerKeepAlive => {
server_keep_alive = Some(read_u16(bytes)?);
cursor += 2;
}
PropertyType::ResponseInformation => {
let info = read_mqtt_string(bytes)?;
cursor += 2 + info.len();
response_information = Some(info);
}
PropertyType::ServerReference => {
let reference = read_mqtt_string(bytes)?;
cursor += 2 + reference.len();
server_reference = Some(reference);
}
PropertyType::AuthenticationMethod => {
let method = read_mqtt_string(bytes)?;
cursor += 2 + method.len();
authentication_method = Some(method);
}
PropertyType::AuthenticationData => {
let data = read_mqtt_bytes(bytes)?;
cursor += 2 + data.len();
authentication_data = Some(data);
}
_ => return Err(Error::InvalidPropertyType(prop)),
}
}
Ok(Some(ConnAckProperties {
session_expiry_interval,
receive_max,
max_qos,
retain_available,
max_packet_size,
assigned_client_identifier,
topic_alias_max,
reason_string,
user_properties,
wildcard_subscription_available,
subscription_identifiers_available,
shared_subscription_available,
server_keep_alive,
response_information,
server_reference,
authentication_method,
authentication_data,
}))
}
pub fn write(&self, buffer: &mut BytesMut) -> Result<(), Error> {
let len = self.len();
write_remaining_length(buffer, len)?;
if let Some(session_expiry_interval) = self.session_expiry_interval {
buffer.put_u8(PropertyType::SessionExpiryInterval as u8);
buffer.put_u32(session_expiry_interval);
}
if let Some(receive_maximum) = self.receive_max {
buffer.put_u8(PropertyType::ReceiveMaximum as u8);
buffer.put_u16(receive_maximum);
}
if let Some(qos) = self.max_qos {
buffer.put_u8(PropertyType::MaximumQos as u8);
buffer.put_u8(qos);
}
if let Some(retain_available) = self.retain_available {
buffer.put_u8(PropertyType::RetainAvailable as u8);
buffer.put_u8(retain_available);
}
if let Some(max_packet_size) = self.max_packet_size {
buffer.put_u8(PropertyType::MaximumPacketSize as u8);
buffer.put_u32(max_packet_size);
}
if let Some(id) = &self.assigned_client_identifier {
buffer.put_u8(PropertyType::AssignedClientIdentifier as u8);
write_mqtt_string(buffer, id)?;
}
if let Some(topic_alias_max) = self.topic_alias_max {
buffer.put_u8(PropertyType::TopicAliasMaximum as u8);
buffer.put_u16(topic_alias_max);
}
if let Some(reason) = &self.reason_string {
buffer.put_u8(PropertyType::ReasonString as u8);
write_mqtt_string(buffer, reason)?;
}
for (key, value) in &self.user_properties {
buffer.put_u8(PropertyType::UserProperty as u8);
write_mqtt_string(buffer, key)?;
write_mqtt_string(buffer, value)?;
}
if let Some(w) = self.wildcard_subscription_available {
buffer.put_u8(PropertyType::WildcardSubscriptionAvailable as u8);
buffer.put_u8(w);
}
if let Some(s) = self.subscription_identifiers_available {
buffer.put_u8(PropertyType::SubscriptionIdentifierAvailable as u8);
buffer.put_u8(s);
}
if let Some(s) = self.shared_subscription_available {
buffer.put_u8(PropertyType::SharedSubscriptionAvailable as u8);
buffer.put_u8(s);
}
if let Some(keep_alive) = self.server_keep_alive {
buffer.put_u8(PropertyType::ServerKeepAlive as u8);
buffer.put_u16(keep_alive);
}
if let Some(info) = &self.response_information {
buffer.put_u8(PropertyType::ResponseInformation as u8);
write_mqtt_string(buffer, info)?;
}
if let Some(reference) = &self.server_reference {
buffer.put_u8(PropertyType::ServerReference as u8);
write_mqtt_string(buffer, reference)?;
}
if let Some(authentication_method) = &self.authentication_method {
buffer.put_u8(PropertyType::AuthenticationMethod as u8);
write_mqtt_string(buffer, authentication_method)?;
}
if let Some(authentication_data) = &self.authentication_data {
buffer.put_u8(PropertyType::AuthenticationData as u8);
write_mqtt_bytes(buffer, authentication_data)?;
}
Ok(())
}
}
fn connect_return(num: u8) -> Result<ConnectReturnCode, Error> {
let code = match num {
0 => ConnectReturnCode::Success,
128 => ConnectReturnCode::UnspecifiedError,
129 => ConnectReturnCode::MalformedPacket,
130 => ConnectReturnCode::ProtocolError,
131 => ConnectReturnCode::ImplementationSpecificError,
132 => ConnectReturnCode::UnsupportedProtocolVersion,
133 => ConnectReturnCode::ClientIdentifierNotValid,
134 => ConnectReturnCode::BadUserNamePassword,
135 => ConnectReturnCode::NotAuthorized,
136 => ConnectReturnCode::ServerUnavailable,
137 => ConnectReturnCode::ServerBusy,
138 => ConnectReturnCode::Banned,
140 => ConnectReturnCode::BadAuthenticationMethod,
144 => ConnectReturnCode::TopicNameInvalid,
149 => ConnectReturnCode::PacketTooLarge,
151 => ConnectReturnCode::QuotaExceeded,
153 => ConnectReturnCode::PayloadFormatInvalid,
154 => ConnectReturnCode::RetainNotSupported,
155 => ConnectReturnCode::QoSNotSupported,
156 => ConnectReturnCode::UseAnotherServer,
157 => ConnectReturnCode::ServerMoved,
159 => ConnectReturnCode::ConnectionRateExceeded,
num => return Err(Error::InvalidConnectReturnCode(num)),
};
Ok(code)
}
fn connect_code(return_code: ConnectReturnCode) -> u8 {
match return_code {
ConnectReturnCode::Success => 0,
ConnectReturnCode::UnspecifiedError => 128,
ConnectReturnCode::MalformedPacket => 129,
ConnectReturnCode::ProtocolError => 130,
ConnectReturnCode::ImplementationSpecificError => 131,
ConnectReturnCode::UnsupportedProtocolVersion => 132,
ConnectReturnCode::ClientIdentifierNotValid => 133,
ConnectReturnCode::BadUserNamePassword => 134,
ConnectReturnCode::NotAuthorized => 135,
ConnectReturnCode::ServerUnavailable => 136,
ConnectReturnCode::ServerBusy => 137,
ConnectReturnCode::Banned => 138,
ConnectReturnCode::BadAuthenticationMethod => 140,
ConnectReturnCode::TopicNameInvalid => 144,
ConnectReturnCode::PacketTooLarge => 149,
ConnectReturnCode::QuotaExceeded => 151,
ConnectReturnCode::PayloadFormatInvalid => 153,
ConnectReturnCode::RetainNotSupported => 154,
ConnectReturnCode::QoSNotSupported => 155,
ConnectReturnCode::UseAnotherServer => 156,
ConnectReturnCode::ServerMoved => 157,
ConnectReturnCode::ConnectionRateExceeded => 159,
_ => unreachable!(),
}
}
#[cfg(test)]
mod test {
use crate::test::read_write_packets;
use crate::Packet;
use super::super::test::{USER_PROP_KEY, USER_PROP_VAL};
use super::*;
use bytes::BytesMut;
use pretty_assertions::assert_eq;
#[test]
fn length_calculation() {
let mut dummy_bytes = BytesMut::new();
let connack_props = ConnAckProperties {
session_expiry_interval: None,
receive_max: None,
max_qos: None,
retain_available: None,
max_packet_size: None,
assigned_client_identifier: None,
topic_alias_max: None,
reason_string: None,
user_properties: vec![(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
wildcard_subscription_available: None,
subscription_identifiers_available: None,
shared_subscription_available: None,
server_keep_alive: None,
response_information: None,
server_reference: None,
authentication_method: None,
authentication_data: None,
};
let connack_pkt = ConnAck {
session_present: false,
code: ConnectReturnCode::Success,
properties: Some(connack_props),
};
let size_from_size = connack_pkt.size();
let size_from_write = connack_pkt.write(&mut dummy_bytes).unwrap();
let size_from_bytes = dummy_bytes.len();
assert_eq!(size_from_write, size_from_bytes);
assert_eq!(size_from_size, size_from_bytes);
}
#[test]
fn test_write_read() {
read_write_packets(write_read_provider());
}
fn write_read_provider() -> Vec<Packet> {
vec![
Packet::ConnAck(ConnAck {
session_present: false,
code: ConnectReturnCode::Success,
properties: None,
}),
Packet::ConnAck(ConnAck {
session_present: true,
code: ConnectReturnCode::BadAuthenticationMethod,
properties: None,
}),
Packet::ConnAck(ConnAck {
session_present: true,
code: ConnectReturnCode::Success,
properties: Some(ConnAckProperties {
session_expiry_interval: Some(10),
receive_max: Some(20),
max_qos: Some(1),
retain_available: Some(1),
max_packet_size: Some(30),
assigned_client_identifier: Some("client".into()),
topic_alias_max: Some(40),
reason_string: Some("reason".into()),
user_properties: vec![(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
wildcard_subscription_available: Some(1),
subscription_identifiers_available: Some(1),
shared_subscription_available: Some(1),
server_keep_alive: Some(50),
response_information: Some("info".into()),
server_reference: Some("ref".into()),
authentication_method: Some("method".into()),
authentication_data: Some(Bytes::from_static(&[1, 2, 3])),
}),
}),
]
}
}