cloudmqtt 0.4.0

A pure Rust MQTT client and server library
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

//
//   This Source Code Form is subject to the terms of the Mozilla Public
//   License, v. 2.0. If a copy of the MPL was not distributed with this
//   file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
use std::sync::Arc;

use mqtt_format::v3::{
    connect_return::MConnectReturnCode, qos::MQualityOfService,
    subscription_request::MSubscriptionRequest,
};

use crate::server::ClientId;

/// Errors that can occur during login
#[derive(Debug, thiserror::Error)]
pub enum LoginError {
    /// The given password did not match
    #[error("The given password did not match")]
    InvalidPassword,
}

impl LoginError {
    /// Convert the error into a rejection code
    pub fn as_rejection_code(&self) -> MConnectReturnCode {
        match self {
            LoginError::InvalidPassword => MConnectReturnCode::BadUsernamePassword,
        }
    }
}

/// Objects that can handle authentication implement this trait
#[async_trait::async_trait]
pub trait LoginHandler: Send + Sync + 'static {
    /// Check whether to allow this client to log in
    async fn allow_login(
        &self,
        client_id: Arc<ClientId>,
        username: Option<&str>,
        password: Option<&[u8]>,
    ) -> Result<(), LoginError>;
}

/// A [`LoginHandler`] that simply allows all login attempts
pub struct AllowAllLogins;

#[async_trait::async_trait]
impl LoginHandler for AllowAllLogins {
    async fn allow_login(
        &self,
        _client_id: Arc<ClientId>,
        _username: Option<&str>,
        _password: Option<&[u8]>,
    ) -> Result<(), LoginError> {
        Ok(())
    }
}

/// Objects that can handle authentication implement this trait
#[async_trait::async_trait]
pub trait SubscriptionHandler: Send + Sync + 'static {
    /// Check whether to allow this client to log in
    async fn allow_subscription(
        &self,
        client_id: Arc<ClientId>,
        subscription: MSubscriptionRequest<'_>,
    ) -> Option<MQualityOfService>;
}

/// A [`SubscriptionHandler`] that simply allows all subscription requests
pub struct AllowAllSubscriptions;

#[async_trait::async_trait]
impl SubscriptionHandler for AllowAllSubscriptions {
    /// Check whether to allow this client to log in
    async fn allow_subscription(
        &self,
        _client_id: Arc<ClientId>,
        subscription: MSubscriptionRequest<'_>,
    ) -> Option<MQualityOfService> {
        Some(subscription.qos)
    }
}