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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
use crate::{
compat::{
string::{String, ToString},
vec::Vec,
},
errcode::{Kind, Origin},
Address, Error, LocalMessage, Result, Route,
};
use core::{
fmt::{self, Debug, Display, Formatter},
ops::{Deref, DerefMut},
};
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use serde_bare::ser::{Serializer, VecWrite};
/// Alias of the type used for encoded data.
pub type Encoded = Vec<u8>;
/// A user-defined protocol identifier.
///
/// When creating workers that should asynchronously speak different
/// protocols, this identifier can be used to switch message parsing
/// between delegated workers, each responsible for only one protocol.
///
/// TODO @deprecated supplanted by the new metadata message types in
/// `ockam::OckamMessage`
#[derive(Serialize, Deserialize, Clone, Debug, Hash, Ord, PartialOrd, Eq, PartialEq)]
pub struct ProtocolId(String);
impl ProtocolId {
/// Create a `None` protocol Id (with left pad).
pub fn none() -> Self {
Self(String::new())
}
/// Use the first 8 bytes of a string as the protocol ID.
#[allow(clippy::should_implement_trait)]
pub fn from_str(s: &str) -> Self {
Self(s.to_string())
}
/// Return the protocol as a `&str`.
pub fn as_str(&self) -> &str {
self.0.as_str()
}
}
impl From<&'static str> for ProtocolId {
fn from(s: &'static str) -> Self {
Self::from_str(s)
}
}
impl Display for ProtocolId {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(f, "{}", self.0)
}
}
/// Encode the type into an [`Encoded`] type.
pub trait Encodable {
/// Encode the type into an [`Encoded`] type.
fn encode(self) -> Result<Encoded>;
}
/// Decode a slice.
pub trait Decodable: Sized {
/// Decode a slice.
#[allow(clippy::ptr_arg)]
fn decode(e: &[u8]) -> Result<Self>;
}
/// A user defined message that can be serialised and deserialized.
pub trait Message: Encodable + Decodable + Send + 'static {}
impl Message for () {}
impl Message for Vec<u8> {}
impl Message for String {}
// Auto-implement message trait for types that _can_ be messages.
impl<T> Encodable for T
where
T: Serialize,
{
fn encode(self) -> Result<Encoded> {
// Serializing directly to allow better serialization
// inlining for a mesurable performance improvement.
let mut vec = Vec::new();
let mut serializer = Serializer::new(VecWrite::new(&mut vec));
self.serialize(&mut serializer)?;
Ok(vec)
}
}
// Auto-implement message trait for types that _can_ be messages.
impl<T> Decodable for T
where
T: DeserializeOwned,
{
fn decode(encoded: &[u8]) -> Result<Self> {
Ok(serde_bare::from_slice(encoded)?)
}
}
/// A message type that is not subject to any encoding or decoding.
#[derive(Debug, Clone)]
pub struct NeutralMessage(Vec<u8>);
impl NeutralMessage {
/// Returns the inner Vec<u8> of the NeutralMessage
pub fn into_vec(self) -> Vec<u8> {
self.0
}
}
impl From<Vec<u8>> for NeutralMessage {
fn from(v: Vec<u8>) -> Self {
Self(v)
}
}
impl From<NeutralMessage> for Vec<u8> {
fn from(m: NeutralMessage) -> Self {
m.0
}
}
impl Encodable for NeutralMessage {
fn encode(self) -> Result<Encoded> {
Ok(self.0)
}
}
impl Decodable for NeutralMessage {
fn decode(v: &[u8]) -> Result<Self> {
Ok(Self(v.to_vec()))
}
}
impl Message for NeutralMessage {}
impl From<serde_bare::error::Error> for Error {
#[track_caller]
fn from(e: serde_bare::error::Error) -> Self {
Error::new(Origin::Core, Kind::Io, e)
}
}
impl From<minicbor::decode::Error> for Error {
#[track_caller]
fn from(e: minicbor::decode::Error) -> Self {
Error::new(Origin::Unknown, Kind::Invalid, e)
}
}
#[cfg(feature = "std")]
impl<E> From<minicbor::encode::Error<E>> for Error
where
E: std::error::Error + Send + Sync + 'static,
{
#[track_caller]
fn from(e: minicbor::encode::Error<E>) -> Self {
Error::new(Origin::Unknown, Kind::Invalid, e)
}
}
#[cfg(not(feature = "std"))]
impl<E: Display> From<minicbor::encode::Error<E>> for Error {
#[track_caller]
fn from(e: minicbor::encode::Error<E>) -> Self {
Error::new(Origin::Unknown, Kind::Invalid, e)
}
}
/// A message wrapper that provides message route information.
///
/// Workers can accept arbitrary message types, which may not contain
/// information about their routes.
///
/// However, the Ockam worker and messaging system already keeps track
/// of this information internally.
///
/// This type makes it possible to expose this information to the
/// user, without requiring changes to the user's message types.
///
/// # Examples
///
/// See `ockam_node::WorkerRelay` for a usage example.
///
pub struct Routed<M: Message> {
/// The wrapped message.
inner: M,
/// The address of the wrapped message.
msg_addr: Address,
/// True sender of the message (guaranteed by the implementation)
/// May be different from a return_route first hop
src_addr: Address,
/// A `LocalMessage` that contains routing information for the wrapped message.
local_msg: LocalMessage,
}
impl<M: Message> Routed<M> {
/// Create a new `Routed` message wrapper from the given message,
/// message address and a local message that contains routing
/// information.
pub fn new(inner: M, msg_addr: Address, src_addr: Address, local_msg: LocalMessage) -> Self {
Self {
inner,
msg_addr,
src_addr,
local_msg,
}
}
#[doc(hidden)]
/// Return a copy of the wrapped message address and the local message.
pub fn dissolve(&self) -> (Address, LocalMessage) {
(self.msg_addr.clone(), self.local_msg.clone())
}
/// Return a copy of the message address.
#[inline]
pub fn msg_addr(&self) -> Address {
self.msg_addr.clone()
}
/// True sender of the message
#[inline]
pub fn src_addr(&self) -> Address {
self.src_addr.clone()
}
/// Return a copy of the onward route for the wrapped message.
#[inline]
pub fn onward_route(&self) -> Route {
self.local_msg.onward_route()
}
/// Return a copy of the full return route for the wrapped message.
#[inline]
pub fn return_route(&self) -> Route {
self.local_msg.return_route()
}
/// Return a copy of the sender address for the wrapped message.
#[inline]
pub fn sender(&self) -> Result<Address> {
self.local_msg.return_route().recipient()
}
/// Consume the message wrapper and return the original message.
#[inline]
pub fn body(self) -> M {
self.inner
}
/// Return a reference to the wrapped message.
#[inline]
pub fn as_body(&self) -> &M {
&self.inner
}
/// Consume the message wrapper and return the underlying local message.
#[inline]
pub fn into_local_message(self) -> LocalMessage {
self.local_msg
}
/// Return a reference to the underlying local message.
#[inline]
pub fn local_message(&self) -> &LocalMessage {
&self.local_msg
}
/// Return a reference to the underlying transport message's binary payload.
#[inline]
pub fn payload(&self) -> &[u8] {
self.local_msg.payload_ref()
}
/// Consume the message wrapper and return the underlying transport message's binary payload.
#[inline]
pub fn take_payload(self) -> Vec<u8> {
self.local_msg.into_payload()
}
}
impl Routed<Any> {
/// Try to cast an `Any` message into another valid message type
pub fn cast<M: Message>(self) -> Result<Routed<M>> {
let inner = M::decode(self.local_msg.payload_ref())?;
Ok(Routed {
inner,
msg_addr: self.msg_addr,
local_msg: self.local_msg,
src_addr: self.src_addr,
})
}
}
impl<M: Message> Deref for Routed<M> {
type Target = M;
fn deref(&self) -> &Self::Target {
&self.inner
}
}
impl<M: Message> DerefMut for Routed<M> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.inner
}
}
impl<M: Message + PartialEq> PartialEq<M> for Routed<M> {
fn eq(&self, o: &M) -> bool {
&self.inner == o
}
}
impl<M: Message + Debug> Debug for Routed<M> {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
self.inner.fmt(f)
}
}
impl<M: Message + Display> Display for Routed<M> {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
self.inner.fmt(f)
}
}
/// A passthrough marker message type.
///
/// This is a special message type which will enable your worker to
/// accept _any_ typed message, by ignoring the type information in
/// the payload.
///
/// This is especially useful for implementing middleware workers
/// which need access to the route information of a message, without
/// understanding its payload.
///
/// # Examples
///
/// ```ignore
/// use ockam::{hex, Any, Context, Result, Routed, Worker};
///
/// pub struct Logger;
///
/// #[ockam::worker]
/// impl Worker for Logger {
/// type Context = Context;
/// type Message = Any;
///
/// /// This Worker will take any incoming message, print out the payload
/// /// and then forward it to the next hop in its onward route.
/// async fn handle_message(&mut self, ctx: &mut Context, msg: Routed<Any>) -> Result<()> {
/// let mut local_msg = msg.into_local_message();///
/// let payload = local_msg.payload_ref();
///
/// if let Ok(str) = String::from_utf8(payload.to_vec()) {
/// println!("Address: {}, Received string: {}", ctx.address(), str);
/// } else {
/// println!("Address: {}, Received binary: {}", ctx.address(), hex::encode(&payload));
/// }
///
/// ctx.forward(local_msg).await
/// }
/// }
/// ```
#[derive(Clone, Debug, PartialEq, Eq, crate::Message)]
pub struct Any;
impl Display for Any {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(f, "Any Message")
}
}
impl Encodable for Any {
fn encode(self) -> Result<Encoded> {
Ok(vec![])
}
}
impl Decodable for Any {
fn decode(_: &[u8]) -> Result<Self> {
Ok(Self)
}
}