Crate ockam

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.

Features

• 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.

Documentation

Tutorials, examples and reference guides are available at docs.ockam.io.

Re-exports

• pub use ockam_abac as abac;
• pub use ockam_identity as identity;
• pub use node::*;

Modules

• access_control
  Access Control
• application_migration_set
  This module defines the migrations to apply to the application database
• compat
  Compatibility adapter, mostly for no_std use.
• debugger
  Debugger
• errcode
  A module to export the error code in a meaningful way
• flow_control
  Flow Controls
• node
  List of all top-level services
• node_migration_set
  This module defines the migrations to apply to the application database
• remote
  RemoteRelay allows registering node within a Cloud Node with dynamic or static alias, which allows other nodes forward messages to local workers on this node using that alias.
• sqlite
  SQLite rust migrations
• tcp
  TCP transport
• transport
  Transport
• udp
  UDP transport
• vault
  Types and traits relating to ockam vaults.
• workers
  Helper workers

Macros

• route
  Creates a new Route from a comma-delimited list of Addresses.

Structs

• Address
  A generic address type.
• Any
  A passthrough marker message type.
• Boolean
  This type is used to map boolean fields for the types deriving FrowRow. Postgres provides a proper boolean type but SQLite maps them as integers.
• Context
  Context contains Node state and references to the runtime.
• DatabaseUser
  User of the Postgres database
• DelayedEvent
  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
• Error
  The type of errors returned by Ockam functions.
• Executor
  Underlying Ockam node executor
• LocalMessage
  A message type that is routed locally within a single node.
• Mailbox
  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)
• Mailboxes
  A collection of Mailboxes for a specific Worker, Processor or Context
• MessageReceiveOptions
  Full set of options to send_and_receive_extended function
• MessageSendReceiveOptions
  Full set of options to send_and_receive_extended function
• Migrator
  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
• NodeBuilder
  Start a node with a custom setup configuration
• Nullable
  This type is used to map Option fields for the types deriving FromRow
• ProtocolId
  A user-defined protocol identifier.
• RelayService
  Alias worker to register remote workers under local names.
• RelayServiceOptions
  Trust Options for a Forwarding Service
• Route
  A full route to a peer.
• Routed
  A message wrapper that provides message route information.
• SqlxDatabase
  The SqlxDatabase struct is used to create a database:
• TransportMessage
  A generic transport message type.
• WorkerBuilder
  Start a Worker with a custom configuration

Enums

• DatabaseConfiguration
  Configuration for the database. We either use Sqlite or Postgres
• DatabaseType
  Type of database
• OckamError
  An enumeration of different error types emitted by this library.

Constants

• OCKAM_POSTGRES_DATABASE_NAME
  Database name environment variable
• OCKAM_POSTGRES_HOST
  Database host environment variable
• OCKAM_POSTGRES_PASSWORD
  Database password environment variable
• OCKAM_POSTGRES_PORT
  Database port environment variable
• OCKAM_POSTGRES_USER
  Database user environment variable

Traits

• AsyncTryClone
  Clone trait for async structs.
• FromSqlxError
  This trait provides some syntax for transforming sqlx errors into ockam errors
• Message
  A user defined message that can be serialised and deserialized.
• MigrationSet
  This trait runs migrations on a given database
• Processor
  Defines an interface for Ockam Workers that need to continuously perform background operations.
• RustMigration
  Individual rust migration
• ToVoid
  This trait provides some syntax to shorten queries execution returning ()
• Worker
  Defines the core interface shared by all Ockam Workers.

Functions

• allow
  Produces Ok(true) to avoid an ambiguous reading from using the unadorned value in auth code.
• create_temp_db_file
  Create a temporary database file that won’t be cleaned-up automatically
• deny
  Produces Ok(false) to avoid an ambiguous reading from using the unadorned value in auth code.
• with_application_dbs
  This function can be used to run some test code with the 3 different databases implementations of the application database
• with_dbs
  This function can be used to run some test code with the 3 different databases implementations

Type Aliases

• Encoded
  Alias of the type used for encoded data.
• Result

Attribute Macros

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

Derive Macros

• AsyncTryClone
  Implements the AsyncTryClone trait for a type.
• Message
  Implements the Message trait for a type.