Ockam Command 👋

Ockam Command, the easiest way to trust data-in-motion, within your applications.

# Install Ockam Command using Homebrew
> brew install build-trust/ockam/ockam

# Create three local Ockam nodes n1, n2 & n3
> for i in {1..3}; do ockam node create "n$i"; done

# Create a mutually authenticated, authorized, end-to-end encrypted secure channel
# and send an end-to-end encrypted message through it.
> ockam secure-channel create --from n1 --to /node/n2/node/n3/service/api \
    | ockam message send "hello ockam" --from n1 --to -/service/uppercase
HELLO OCKAM

In this example we created a mutually authenticated, authorized, and end-to-end encrypted secure channel over two TCP transport connection hops. The middle node n2 only sees encrypted data and is unable to tamper with it, without detection. The end nodes n1 and n3 mutually authenticate each other and can verify the source and integrity of exchanged messages.

Our new docs website (work in progress) has more examples. Please give them a try.
We'd love to hear your feedback.

Homebrew

To install this release using Homebrew:

$ brew install build-trust/ockam/ockam

Docker

To use the Docker OCI package:

docker pull ghcr.io/build-trust/ockam:0.69.0

Precompiled Binaries

# download sha256sums.txt
curl --proto '=https' --tlsv1.2 -sSfL -O \
  https://github.com/build-trust/ockam/releases/download/ockam_v0.69.0/sha256sums.txt

# download sha256sums.txt.sig
curl --proto '=https' --tlsv1.2 -sSfL -O \
  https://github.com/build-trust/ockam/releases/download/ockam_v0.69.0/sha256sums.txt.sig

# download our release public key
curl --proto '=https' --tlsv1.2 -sSfL -o ockam.pub \
  https://raw.githubusercontent.com/build-trust/ockam/develop/tools/docker/cosign.pub

# verify signatures
cosign verify-blob --key ockam.pub --signature sha256sums.txt.sig sha256sums.txt

# download ockam command binary for your architecture
curl --proto '=https' --tlsv1.2 -sSfL -O \
  https://github.com/build-trust/ockam/releases/download/ockam_v0.69.0/ockam.x86_64-unknown-linux-gnu

# verify that the sha256 hash of the downloaded binary is the same as
# the corresponding hash mentioned in sha256sums.txt
cat sha256sums.txt | grep ockam.x86_64-unknown-linux-gnu | sha256sum -c

# rename the download binary and give it permission to execure
mv ockam.x86_64-unknown-linux-gnu ockam
chmod u+x ockam

Terraform

To install the Ockam Terraform Provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    ockam = {
      source = "build-trust/ockam"
      version = "0.69.0"
    }
  }
}
provider ockam {}

Rust Crates

To use Ockam as a Rust library, run the following command within your project directory:

cargo add ockam@0.69.0

The following crates were published as part of this release:

ockam 0.69.0 (Documentation, CHANGELOG)
ockam_abac 0.3.0 (Documentation, CHANGELOG)
ockam_api 0.12.0 (Documentation, CHANGELOG)
ockam_channel 0.63.0 (Documentation, CHANGELOG)
ockam_command 0.69.0 (Documentation, CHANGELOG)
ockam_core 0.63.0 (Documentation, CHANGELOG)
ockam_examples 0.36.0 (Documentation, CHANGELOG)
ockam_executor 0.31.0 (Documentation, CHANGELOG)
ockam-ffi 0.55.0 (Documentation, CHANGELOG)
ockam_identity 0.57.0 (Documentation, CHANGELOG)
ockam_key_exchange_core 0.54.0 (Documentation, CHANGELOG)
ockam_key_exchange_x3dh 0.58.0 (Documentation, CHANGELOG)
ockam_key_exchange_xx 0.59.0 (Documentation, CHANGELOG)
ockam_macros 0.17.0 (Documentation, CHANGELOG)
ockam_multiaddr 0.3.0 (Documentation, CHANGELOG)
ockam_node 0.66.0 (Documentation, CHANGELOG)
ockam_transport_ble 0.24.0 (Documentation, CHANGELOG)
ockam_transport_core 0.36.0 (Documentation, CHANGELOG)
ockam_transport_tcp 0.64.0 (Documentation, CHANGELOG)
ockam_transport_udp 0.11.0 (Documentation, CHANGELOG)
ockam_transport_websocket 0.55.0 (Documentation, CHANGELOG)
ockam_vault 0.59.0 (Documentation, CHANGELOG)

build-trust/ockam ockam_v0.69.0 Ockam v0.69.0 on GitHub