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

use crate::compat::boxed::Box;
use crate::flow_control::{FlowControlId, FlowControls};
use crate::{async_trait, Address, Result};
use crate::{OutgoingAccessControl, RelayMessage};
use core::fmt::{Debug, Formatter};

/// Flow Control Outgoing Access Control
///
/// Allows to send messages only to members of the given [`FlowControlId`] or message a Spawner
/// with given [`FlowControlId`]. Optionally, only 1 message can be passed to the Spawner.
pub struct FlowControlOutgoingAccessControl {
    flow_controls: FlowControls,
    flow_control_id: FlowControlId,
    spawner_flow_control_id: Option<FlowControlId>,
}

impl Debug for FlowControlOutgoingAccessControl {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("FlowControlOutgoingAccessControl")
            .field("flow_control_id", &self.flow_control_id)
            .field("spawner_flow_control_id", &self.spawner_flow_control_id)
            .finish()
    }
}

impl FlowControlOutgoingAccessControl {
    /// Constructor
    pub fn new(
        flow_controls: &FlowControls,
        flow_control_id: FlowControlId,
        spawner_flow_control_id: Option<FlowControlId>,
    ) -> Self {
        Self {
            flow_controls: flow_controls.clone(),
            flow_control_id,
            spawner_flow_control_id,
        }
    }
}

impl FlowControlOutgoingAccessControl {
    fn is_consumer(&self, next: &Address, flow_control_id: &FlowControlId) -> bool {
        let consumers_info = self.flow_controls.get_consumers_info(flow_control_id);

        consumers_info.contains(next)
    }
}

#[async_trait]
impl OutgoingAccessControl for FlowControlOutgoingAccessControl {
    async fn is_authorized(&self, relay_msg: &RelayMessage) -> Result<bool> {
        let onward_route = relay_msg.onward_route();

        let next = onward_route.next()?;

        if self.is_consumer(next, &self.flow_control_id) {
            return crate::allow();
        }

        if let Some(spawner_flow_control_id) = &self.spawner_flow_control_id {
            if self.is_consumer(next, spawner_flow_control_id) {
                return crate::allow();
            }
        }

        self.flow_controls.debug_denied_message(
            relay_msg.source(),
            &self.flow_control_id,
            &self.spawner_flow_control_id,
            next,
        );

        crate::deny()
    }
}