rust_mqtt/packet/v5/
auth_packet.rs

1/*
2 * MIT License
3 *
4 * Copyright (c) [2022] [Ondrej Babec <ond.babec@gmail.com>]
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25use heapless::Vec;
26
27use crate::encoding::variable_byte_integer::VariableByteIntegerEncoder;
28use crate::packet::v5::mqtt_packet::Packet;
29use crate::utils::buffer_reader::BuffReader;
30use crate::utils::buffer_writer::BuffWriter;
31use crate::utils::types::BufferError;
32
33use super::packet_type::PacketType;
34use super::property::Property;
35
36/// Auth packets serves MQTTv5 extended authentication. This packet is not currently supported
37/// by rust-mqtt client but decoding and encoding of packet is prepared for future development.
38pub struct AuthPacket<'a, const MAX_PROPERTIES: usize> {
39    pub fixed_header: u8,
40    pub remain_len: u32,
41    pub auth_reason: u8,
42    pub property_len: u32,
43    pub properties: Vec<Property<'a>, MAX_PROPERTIES>,
44}
45
46impl<'a, const MAX_PROPERTIES: usize> AuthPacket<'a, MAX_PROPERTIES> {
47    pub fn add_reason_code(&mut self, code: u8) {
48        if code != 0 && code != 24 && code != 25 {
49            error!("Provided reason code is not supported!");
50            return;
51        }
52        self.auth_reason = code;
53    }
54
55    pub fn add_property(&mut self, p: Property<'a>) {
56        if p.auth_property() {
57            self.push_to_properties(p);
58        } else {
59            error!("Provided property is not correct AUTH packet property!");
60        }
61    }
62}
63
64impl<'a, const MAX_PROPERTIES: usize> Packet<'a> for AuthPacket<'a, MAX_PROPERTIES> {
65    fn new() -> Self {
66        Self {
67            fixed_header: PacketType::Auth.into(),
68            remain_len: 0,
69            auth_reason: 0x00,
70            property_len: 0,
71            properties: Vec::<Property<'a>, MAX_PROPERTIES>::new(),
72        }
73    }
74
75    fn encode(&mut self, buffer: &mut [u8], buff_len: usize) -> Result<usize, BufferError> {
76        let mut buff_writer = BuffWriter::new(buffer, buff_len);
77
78        let mut rm_ln = self.property_len;
79        let property_len_enc: [u8; 4] = VariableByteIntegerEncoder::encode(self.property_len)?;
80        let property_len_len = VariableByteIntegerEncoder::len(property_len_enc);
81        rm_ln += property_len_len as u32;
82        rm_ln += 1;
83
84        buff_writer.write_u8(self.fixed_header)?;
85        buff_writer.write_variable_byte_int(rm_ln)?;
86        buff_writer.write_u8(self.auth_reason)?;
87        buff_writer.write_variable_byte_int(self.property_len)?;
88        buff_writer.write_properties::<MAX_PROPERTIES>(&self.properties)?;
89        Ok(buff_writer.position)
90    }
91
92    fn decode(&mut self, buff_reader: &mut BuffReader<'a>) -> Result<(), BufferError> {
93        self.decode_fixed_header(buff_reader)?;
94        self.auth_reason = buff_reader.read_u8()?;
95        self.decode_properties(buff_reader)
96    }
97
98    fn set_property_len(&mut self, value: u32) {
99        self.property_len = value;
100    }
101
102    fn get_property_len(&mut self) -> u32 {
103        self.property_len
104    }
105
106    fn push_to_properties(&mut self, property: Property<'a>) {
107        self.properties.push(property);
108    }
109
110    fn property_allowed(&mut self, property: &Property<'a>) -> bool {
111        property.auth_property()
112    }
113
114    fn set_fixed_header(&mut self, header: u8) {
115        self.fixed_header = header;
116    }
117
118    fn set_remaining_len(&mut self, remaining_len: u32) {
119        self.remain_len = remaining_len;
120    }
121}
rust_mqtt/packet/v5/auth_packet.rs

rust_mqtt/packet/v5/
auth_packet.rs
