Crate ockam

source ·
Expand description

End-to-end encrypted, mutually authenticated, secure communication.

A hands-on guide 👉.

Data, within modern distributed applications, are rarely exchanged over a single point-to-point transport connection. Application messages routinely flow over complex, multi-hop, multi-protocol routes — across data centers, through queues and caches, via gateways and brokers — before reaching their end destination.

Transport layer security protocols are unable to protect application messages because their protection is constrained by the length and duration of the underlying transport connection.

Ockam makes it simple for our applications to guarantee end-to-end integrity, authenticity, and confidentiality of data. We no longer have to implicitly depend on the defenses of every machine or application within the same, usually porous, network boundary. Our application’s messages don’t have to be vulnerable at every point, along their journey, where a transport connection terminates.

Instead, our application can have a strikingly smaller vulnerability surface and easily make granular authorization decisions about all incoming information and commands.


  • End-to-end encrypted, mutually authenticated secure channels.
  • Multi-hop, multi-transport, application layer routing.
  • Key establishment, rotation, and revocation - for fleets, at scale.
  • Lightweight, Concurrent, Stateful Workers that enable simple APIs.
  • Attribute-based Access Control - credentials with selective disclosure.
  • Add-ons for a variety of operating environments, transport protocols, and cryptographic hardware.


Tutorials, examples and reference guides are available at





  • A generic address type.
  • A passthrough marker message type.
  • Context contains Node state and references to the runtime.
  • Allow to send message to destination address periodically after some delay Only one scheduled heartbeat allowed at a time Dropping this handle cancels scheduled heartbeat
  • The type of errors returned by Ockam functions.
  • Underlying Ockam node executor
  • A message type that is routed locally within a single node.
  • A Mailbox controls the dispatch of incoming messages for a particular Address Note that Worker, Processor and Context may have multiple Mailboxes (with different addresses), but they always have exactly one mpsc receiver (message queue)
  • A collection of Mailboxes for a specific Worker, Processor or Context
  • Full set of options to send_and_receive_extended function
  • Full set of options to send_and_receive_extended function
  • Migrator is responsible for running Sql and Rust migrations side by side in the correct order, checking for conflicts, duplicates; making sure each migration runs only once
  • Start a node with a custom setup configuration
  • A user-defined protocol identifier.
  • Alias worker to register remote workers under local names.
  • Trust Options for a Forwarding Service
  • A full route to a peer.
  • A message wrapper that provides message route information.
  • The SqlxDatabase struct is used to create a database:
  • Trust Options for a TCP connection
  • Trust Options for an Inlet
  • Trust Options for a TCP listener
  • Trust Options for an Outlet
  • High level management interface for TCP transports
  • A generic transport message type.
  • Start a Worker with a custom configuration


  • An enumeration of different error types emitted by this library.
  • This enum represents the set of types that we currently support in our database Since we support only Sqlite at the moment, those types are close to what is supported by Sqlite:


  • Clone trait for async structs.
  • This trait provides some syntax for transforming sqlx errors into ockam errors
  • A user defined message that can be serialised and deserialized.
  • This trait runs migrations on a given database
  • Defines an interface for Ockam Workers that need to continuously perform background operations.
  • Individual rust migration
  • This trait adds a create_tcp_transport method to any struct returning a Context. This is the case for an ockam::Node, so you can write node.create_tcp_transport()
  • This trait can be implemented by any type that can be converted to a database type Typically an Identifier (to a Text), a TimestampInSeconds (to an Integer) etc…
  • This trait provides some syntax to shorten queries execution returning ()
  • Defines the core interface shared by all Ockam Workers.


  • Produces Ok(true) to avoid an ambiguous reading from using the unadorned value in auth code.
  • Produces Ok(false) to avoid an ambiguous reading from using the unadorned value in auth code.

Type Aliases§

Attribute Macros§

  • Marks an async function to be run in an ockam node.
  • Mark an Ockam Processor implementation.
  • Marks an async test function to be run in an ockam node.
  • Mark an Ockam Worker implementation.

Derive Macros§