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 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
use crate::compat::rand::{distributions::Standard, prelude::Distribution, random, Rng};
use crate::compat::{
string::{String, ToString},
vec::Vec,
};
use crate::{AddressParseError, AddressParseErrorKind, Result, TransportType, LOCAL};
use core::fmt::{self, Debug, Display};
use core::ops::Deref;
use core::str::from_utf8;
use minicbor::{Decode, Encode};
use serde::{Deserialize, Serialize};
/// A generic address type.
///
/// The address type is parsed by routers to determine the next local
/// hop in the router chain to resolve a route to a remote connection.
///
/// ## Parsing addresses
///
/// While addresses are concrete types, creating them from strings is
/// possible for ergonomic reasons.
///
/// When parsing an address from a string, the first `#` symbol is
/// used to separate the transport type from the rest of the address.
/// If no `#` symbol is found, the address is assumed to be of `transport =
/// 0`, the Local Worker transport type.
///
/// For example:
/// * `"0#alice"` represents a local worker with the address: `alice`.
/// * `"1#carol"` represents a remote worker with the address `carol`, reachable over TCP transport.
///
#[derive(Serialize, Deserialize, Decode, Encode, Clone, Hash, Ord, PartialOrd, Eq, PartialEq)]
#[rustfmt::skip]
#[cbor(map)]
pub struct Address {
#[n(1)] tt: TransportType,
// It's binary but in most cases we assume it to be an UTF-8 string
#[n(2)] inner: Vec<u8>,
}
impl Address {
/// Creates a new address from separate transport type and data parts.
///
/// # Examples
///
/// ```
/// # use ockam_core::{Address, TransportType};
/// # pub const TCP: TransportType = TransportType::new(1);
/// // create a new remote worker address from a transport type and data
/// let tcp_worker: Address = Address::new(TCP, "carol");
/// ```
pub fn new<S: Into<String>>(tt: TransportType, data: S) -> Self {
Self {
tt,
inner: data.into().as_bytes().to_vec(),
}
}
/// Parses an address from a string.
///
/// # Panics
///
/// This function will panic if passed an invalid address string.
///
/// # Examples
///
/// ```
/// # use ockam_core::Address;
/// // parse a local worker address
/// let local_worker: Address = Address::from_string("alice");
///
/// // parse a remote worker address reachable over tcp transport
/// let tcp_worker: Address = Address::from_string("1#carol");
/// ```
pub fn from_string<S: Into<String>>(s: S) -> Self {
match s.into().parse::<Address>() {
Ok(a) => a,
Err(e) => {
panic!("Invalid address string {}", e)
}
}
}
/// Get the string value of this address without the address type
#[doc(hidden)]
pub fn without_type(&self) -> &str {
from_utf8(&self.inner).unwrap_or("<unprintable>")
}
/// Generate a random address with the given transport type.
///
/// # Examples
///
/// ```
/// # use ockam_core::{Address, LOCAL};
/// // generate a random local address
/// let local_worker: Address = Address::random(LOCAL);
/// ```
pub fn random(tt: TransportType) -> Self {
Self { tt, ..random() }
}
/// Generate a random address with transport type [`LOCAL`].
pub fn random_local() -> Self {
Self {
tt: LOCAL,
..random()
}
}
// TODO: Replace with macro to take less space when "debugger" feature is disabled?
/// Generate a random address with a debug tag and transport type [`LOCAL`].
pub fn random_tagged(_tag: &str) -> Self {
#[cfg(feature = "debugger")]
{
use core::sync::atomic::{AtomicU32, Ordering};
static COUNTER: AtomicU32 = AtomicU32::new(0);
let address = format!("{}_{}", _tag, COUNTER.fetch_add(1, Ordering::Relaxed),).into();
let address = Self {
tt: LOCAL,
..address
};
tracing::trace!("random_tagged => {}", address);
address
}
#[cfg(not(feature = "debugger"))]
Self::random_local()
}
/// Get transport type of this address.
pub fn transport_type(&self) -> TransportType {
self.tt
}
/// Get address portion of this address
pub fn address(&self) -> &str {
from_utf8(self.inner.as_slice()).unwrap_or("Invalid UTF-8")
}
/// Check if address is local
pub fn is_local(&self) -> bool {
self.tt == LOCAL
}
}
impl core::str::FromStr for Address {
type Err = AddressParseError;
/// Parse an address from a string.
///
/// See type documentation for more detail.
fn from_str(s: &str) -> Result<Address, Self::Err> {
let buf: String = s.into();
let mut vec: Vec<_> = buf.split('#').collect();
// If after the split we only have one element, there was no
// `#` separator, so the type needs to be implicitly `= 0`
if vec.len() == 1 {
Ok(Address {
tt: LOCAL,
inner: vec.remove(0).as_bytes().to_vec(),
})
}
// If after the split we have 2 elements, we extract the type
// value from the string, and use the rest as the address
else if vec.len() == 2 {
match str::parse(vec.remove(0)) {
Ok(tt) => Ok(Address {
tt: TransportType::new(tt),
inner: vec.remove(0).as_bytes().to_vec(),
}),
Err(e) => Err(AddressParseError::new(AddressParseErrorKind::InvalidType(
e,
))),
}
} else {
Err(AddressParseError::new(AddressParseErrorKind::MultipleSep))
}
}
}
impl Display for Address {
fn fmt<'a>(&'a self, f: &mut fmt::Formatter) -> fmt::Result {
let inner: &'a str = from_utf8(self.inner.as_slice()).unwrap_or("Invalid UTF-8");
write!(f, "{}#{}", self.tt, inner)
}
}
impl Debug for Address {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
<Self as Display>::fmt(self, f)
}
}
impl Deref for Address {
type Target = Vec<u8>;
fn deref(&self) -> &Self::Target {
&self.inner
}
}
impl From<String> for Address {
fn from(s: String) -> Self {
Self::from_string(s)
}
}
impl From<&String> for Address {
fn from(s: &String) -> Self {
Self::from_string(s.as_str())
}
}
impl<'a> From<&'a str> for Address {
fn from(s: &'a str) -> Self {
Self::from_string(s)
}
}
impl From<Vec<u8>> for Address {
fn from(data: Vec<u8>) -> Self {
Self {
tt: LOCAL,
inner: data,
}
}
}
impl From<(TransportType, Vec<u8>)> for Address {
fn from((tt, data): (TransportType, Vec<u8>)) -> Self {
Self { tt, inner: data }
}
}
impl<'a> From<(TransportType, &'a str)> for Address {
fn from((tt, data): (TransportType, &'a str)) -> Self {
Self {
tt,
inner: data.as_bytes().to_vec(),
}
}
}
impl<'a> From<(TransportType, &'a String)> for Address {
fn from((tt, inner): (TransportType, &'a String)) -> Self {
Self::from((tt, inner.as_str()))
}
}
impl From<(TransportType, String)> for Address {
fn from((transport, data): (TransportType, String)) -> Self {
Self::from((transport, data.as_str()))
}
}
impl<'a> From<&'a [u8]> for Address {
fn from(data: &'a [u8]) -> Self {
Self {
tt: LOCAL,
inner: data.to_vec(),
}
}
}
impl<'a> From<&'a [&u8]> for Address {
fn from(data: &'a [&u8]) -> Self {
Self {
tt: LOCAL,
inner: data.iter().map(|x| **x).collect(),
}
}
}
impl From<Address> for String {
fn from(address: Address) -> Self {
address.to_string()
}
}
impl Distribution<Address> for Standard {
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Address {
let address: [u8; 16] = rng.gen();
hex::encode(address).as_bytes().into()
}
}
#[test]
fn parse_addr_simple() {
let addr = Address::from_string("local_friend");
assert_eq!(
addr,
Address {
tt: LOCAL,
inner: "local_friend".as_bytes().to_vec()
}
);
}
#[test]
fn parse_addr_with_type() {
let addr = Address::from_string("1#remote_friend");
assert_eq!(
addr,
Address {
tt: TransportType::new(1),
inner: "remote_friend".as_bytes().to_vec()
}
);
}
#[test]
#[should_panic(expected = "Failed to parse address type:")]
fn parse_addr_invalid() {
Address::from_string("#,my_friend");
}
#[test]
#[should_panic(expected = "Invalid address string:")]
fn parse_addr_invalid_multiple_separators() {
let _ = Address::from_string("1#invalid#");
}