ockam_core 0.125.0

Core types of the Ockam 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
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

use crate::compat::boxed::Box;
use crate::compat::vec::Vec;
use crate::{async_trait, Address, IncomingAccessControl, RelayMessage, Result};

/// An Access Control type that allows messages from the given source address to go through
/// Note that it's based on source address, not a first hop of return_route, which may be different
/// in some scenarios
#[derive(Debug)]
pub struct AllowSourceAddress(pub Address);

impl AllowSourceAddress {
    /// Convenience constructor
    pub fn new(address: impl Into<Address>) -> Self {
        Self(address.into())
    }
}

#[async_trait]
impl IncomingAccessControl for AllowSourceAddress {
    async fn is_authorized(&self, relay_msg: &RelayMessage) -> Result<bool> {
        if &self.0 == relay_msg.source() {
            crate::allow()
        } else {
            crate::deny()
        }
    }
}

/// An Access Control type that allows messages from the given source addresses to go through
/// Note that it's based on source address, not a first hop of return_route, which may be different
/// in some scenarios
#[derive(Debug)]
pub struct AllowSourceAddresses(pub Vec<Address>);

#[async_trait]
impl IncomingAccessControl for AllowSourceAddresses {
    async fn is_authorized(&self, relay_msg: &RelayMessage) -> Result<bool> {
        if self.0.contains(relay_msg.source()) {
            crate::allow()
        } else {
            crate::deny()
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::compat::future::poll_once;
    use crate::{
        route, Address, AllowSourceAddress, AllowSourceAddresses, IncomingAccessControl,
        LocalMessage, RelayMessage, Result,
    };

    #[test]
    fn test_1_address() -> Result<()> {
        // Testing situation when source and return addresses are different
        let source_address = Address::random_local();
        let return_address = Address::random_local();
        let onward_address = Address::random_local();

        let ac = AllowSourceAddress(source_address.clone());

        let msg = LocalMessage::new()
            .with_onward_route(route![onward_address.clone()])
            .with_return_route(route![return_address.clone()]);
        let msg = RelayMessage::new(source_address.clone(), onward_address.clone(), msg);

        assert!(poll_once(async { ac.is_authorized(&msg).await })?);

        let msg = LocalMessage::new()
            .with_onward_route(route![onward_address.clone()])
            .with_return_route(route![source_address]);
        let msg = RelayMessage::new(return_address, onward_address, msg);

        assert!(!poll_once(async { ac.is_authorized(&msg).await })?);

        Ok(())
    }

    #[test]
    fn test_2_addresses() -> Result<()> {
        // Testing situation when source and return addresses are different
        let source_address1 = Address::random_local();
        let source_address2 = Address::random_local();
        let return_address = Address::random_local();
        let onward_address = Address::random_local();

        let ac = AllowSourceAddresses(vec![source_address1.clone(), source_address2.clone()]);

        let msg = LocalMessage::new()
            .with_onward_route(route![onward_address.clone()])
            .with_return_route(route![return_address.clone()]);
        let msg = RelayMessage::new(source_address1.clone(), onward_address.clone(), msg);

        assert!(poll_once(async { ac.is_authorized(&msg).await })?);

        let msg = LocalMessage::new()
            .with_onward_route(route![onward_address.clone()])
            .with_return_route(route![return_address.clone()]);

        let msg = RelayMessage::new(source_address2, onward_address.clone(), msg);

        assert!(poll_once(async { ac.is_authorized(&msg).await })?);

        let msg = LocalMessage::new()
            .with_onward_route(route![onward_address.clone()])
            .with_return_route(route![source_address1]);

        let msg = RelayMessage::new(return_address, onward_address, msg);

        assert!(!poll_once(async { ac.is_authorized(&msg).await })?);

        Ok(())
    }
}