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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
use std::os::unix::net::SocketAddr;

use ockam_core::{
    async_trait, compat::sync::Arc, Address, AsyncTryClone, DenyAll, Mailbox, Mailboxes, Result,
};
use ockam_node::Context;
use ockam_transport_core::TransportError;

use crate::{
    address_from_socket_addr, parse_socket_addr,
    workers::{UdsListenProcessor, WorkerPair},
    UDS,
};

use super::{UdsRouterRequest, UdsRouterResponse};

/// A handle to connect to a [`UdsRouter`](crate::router::UdsRouter)
///
/// Dropping this handle is harmless
pub(crate) struct UdsRouterHandle {
    ctx: Context,
    main_addr: Address,
    api_addr: Address,
}

#[async_trait]
impl AsyncTryClone for UdsRouterHandle {
    async fn async_try_clone(&self) -> Result<Self> {
        let mailboxes = Mailboxes::new(
            Mailbox::new(
                Address::random_tagged("UdsRouterHandle.async_try_clone.detached"),
                Arc::new(DenyAll),
                Arc::new(DenyAll),
            ),
            vec![],
        );
        let child_ctx = self.ctx.new_detached_with_mailboxes(mailboxes).await?;

        Ok(Self::new(
            child_ctx,
            self.main_addr.clone(),
            self.api_addr.clone(),
        ))
    }
}

impl UdsRouterHandle {
    /// Create a new [`UdsRouterHandle`] with the given address
    pub(crate) fn new(ctx: Context, main_addr: Address, api_addr: Address) -> Self {
        UdsRouterHandle {
            ctx,
            main_addr,
            api_addr,
        }
    }

    /// Return a reference to the router handle's [`Context`]
    pub fn ctx(&self) -> &Context {
        &self.ctx
    }

    /// Return a reference to the router handle's [`Main Address`](ockam_core::Address)
    pub(crate) fn main_addr(&self) -> &Address {
        &self.main_addr
    }
}

impl UdsRouterHandle {
    /// Bind an incoming connection listener for this router
    pub async fn bind(&self, addr: impl Into<SocketAddr>) -> Result<SocketAddr> {
        let socket_addr = addr.into();
        UdsListenProcessor::start(&self.ctx, self.async_try_clone().await?, socket_addr).await
    }

    /// Establish an outgoing UDS connection on an existing transport
    pub async fn connect<S: AsRef<str>>(&self, peer: S) -> Result<Address> {
        let response = self
            .ctx
            .send_and_receive(
                self.api_addr.clone(),
                UdsRouterRequest::Connect {
                    peer: peer.as_ref().to_string(),
                },
            )
            .await?;

        if let UdsRouterResponse::Connect(res) = response {
            res
        } else {
            Err(TransportError::InvalidRouterResponseType.into())
        }
    }

    /// Disconnect an outgoing UDS connection on an existing transport
    pub async fn disconnect<S: AsRef<str>>(&self, peer: S) -> Result<()> {
        let response = self
            .ctx
            .send_and_receive(
                self.api_addr.clone(),
                UdsRouterRequest::Disconnect {
                    peer: peer.as_ref().to_string(),
                },
            )
            .await?;

        if let UdsRouterResponse::Disconnect(res) = response {
            res
        } else {
            Err(TransportError::InvalidRouterResponseType.into())
        }
    }

    /// Register a new connection worker with this router
    pub async fn register(&self, pair: &WorkerPair) -> Result<()> {
        let uds_address: Address = address_from_socket_addr(pair.peer())?;

        let mut accepts = vec![uds_address];
        accepts.extend(
            pair.paths()
                .iter()
                .map(|x| Address::from_string(format!("{UDS}#{x}"))),
        );
        let self_addr = pair.tx_addr();

        let response: UdsRouterResponse = self
            .ctx()
            .send_and_receive(
                self.api_addr.clone(),
                UdsRouterRequest::Register { accepts, self_addr },
            )
            .await?;

        if let UdsRouterResponse::Register(res) = response {
            res
        } else {
            Err(TransportError::InvalidRouterResponseType.into())
        }
    }

    /// Unregister the connection worker for the given [`Address`]
    pub async fn unregister(&self, self_addr: Address) -> Result<()> {
        let response = self
            .ctx
            .send_and_receive(
                self.api_addr.clone(),
                UdsRouterRequest::Unregister { self_addr },
            )
            .await?;
        if let UdsRouterResponse::Unregister(res) = response {
            res
        } else {
            Err(TransportError::InvalidRouterResponseType.into())
        }
    }

    /// Resovle the given peer to a [`SocketAddr`](std::os::unix::net::SocketAddr)
    pub(crate) fn resolve_peer(peer: impl Into<String>) -> Result<(SocketAddr, Vec<String>)> {
        let peer_str = peer.into();
        let peer_addr;
        let pathnames;

        // Then continue working on resolve_route, so that the UdsRouter can have a complete worker definition which requires `handle_message`
        if let Ok(p) = parse_socket_addr(peer_str) {
            peer_addr = p;
            pathnames = vec![];
        } else {
            return Err(TransportError::InvalidAddress.into());
        }

        Ok((peer_addr, pathnames))
    }
}