ockam_transport_uds/
lib.rs

1//! This crate provides a Unix Domain Socket Transport for Ockam's Routing Protocol.
2//!
3#![cfg_attr(not(feature = "std"), no_std)]
4
5#[cfg(feature = "alloc")]
6extern crate alloc;
7// TODO: Are there any known uses cases for no_std with UDS
8#[cfg(feature = "std")]
9extern crate core;
10
11mod router;
12mod transport;
13mod workers;
14use tokio::net::unix::SocketAddr as TokioSocketAddr;
15use tracing::error;
16pub use transport::*;
17
18use std::os::unix::net::SocketAddr;
19
20use ockam_core::{Address, Result, TransportType};
21use ockam_transport_core::TransportError;
22
23// TODO: Should have documentation or enum for this
24pub const UDS: TransportType = TransportType::new(5);
25
26pub const CLUSTER_NAME: &str = "_internals.transport.uds";
27
28fn parse_socket_addr<S: AsRef<str>>(s: S) -> Result<SocketAddr> {
29    Ok(SocketAddr::from_pathname(s.as_ref())
30        .map_err(|_| TransportError::InvalidAddress(s.as_ref().to_string()))?)
31}
32
33fn std_socket_addr_from_tokio(sock_addr: &TokioSocketAddr) -> Result<SocketAddr> {
34    let path = match sock_addr.as_pathname() {
35        Some(p) => p,
36        None => {
37            error!("Error retrieving path from tokio Socket Addr");
38            Err(TransportError::InvalidAddress(format!("{:?}", sock_addr)))?
39        }
40    };
41
42    let sock = match SocketAddr::from_pathname(path) {
43        Ok(s) => s,
44        Err(e) => {
45            error!("Error parsing std SocketAddr from Tokio SocketAddr: {}", e);
46            Err(TransportError::InvalidAddress(
47                path.to_string_lossy().to_string(),
48            ))?
49        }
50    };
51
52    Ok(sock)
53}
54
55fn address_from_socket_addr(sock_addr: &SocketAddr) -> Result<Address> {
56    let path = match sock_addr.as_pathname() {
57        Some(p) => p,
58        None => Err(TransportError::InvalidAddress(format!("{:?}", sock_addr)))?,
59    };
60
61    let path_str = match path.to_str() {
62        Some(s) => s,
63        None => Err(TransportError::InvalidAddress(
64            path.to_string_lossy().to_string(),
65        ))?,
66    };
67
68    let address: Address = format!("{UDS}#{path_str}").into();
69
70    Ok(address)
71}
72
73#[test]
74fn test_parse_socket_address() {
75    let result = parse_socket_addr("/tmp/sock");
76    assert!(result.is_ok());
77}
ockam_transport_uds/lib.rs

ockam_transport_uds/
lib.rs
