Command

Command line tools to build and orchestrate secure by design applications.

Ockam Command is our command line interface to build secure by design applications that can trust all data in motion. It makes it easy to orchestrate end-to-end encryption, mutual authentication, key management, credential management, and authorization policy enforcement – at a massive scale.

No more having to design error-prone ad-hoc ways to distribute sensitive credentials and roots of trust. Ockam's integrated approach takes away this complexity and gives you simple tools for:

End-to-end data authenticity, integrity, and privacy in any communication topology

• Create end-to-end encrypted, authenticated secure channels over any transport topology.

• Create secure channels over multi-hop, multi-protocol routes over TCP, UDP, WebSockets, BLE, etc.

• Provision encrypted relays for applications distributed across many edge, cloud and data-center private networks.

• Make any protocol secure by tunneling it through mutually authenticated and encrypted portals.

• Bring end-to-end encryption to enterprise messaging, pub/sub and event streams - Kafka, Kinesis, RabbitMQ, etc.

Identity-based, policy driven, application layer trust – granular authentication and authorization

• Generate cryptographically provable unique identities.

• Store private keys in safe vaults - hardware secure enclaves and cloud key management systems.

• Operate scalable credential authorities to issue lightweight, short-lived, revocable, attribute-based credentials.

• Onboard fleets of self-sovereign application identities using secure enrollment protocols.

• Rotate and revoke keys and credentials – at scale, across fleets.

• Define and enforce project-wide attribute-based access control policies. Choose ABAC, RBAC or ACLs.

• Integrate with enterprise identity providers and policy providers for seamless employee access.

Please click the diagram to see a bigger version.

A step by step introduction

Ockam Command provides the above collection of composable building blocks that are accessible through various sub-commands. In a step-by-step guide let's walk through various Ockam sub-commands to understand how you can use them to build end-to-end trustful communication for any application in any communication topology.

Install Ockam Command

If you haven't already, the first step is to install Ockam Command:

Homebrew

If you use Homebrew, you can install Ockam using brew.

# Tap and install Ockam Command
brew install build-trust/ockam/ockam

This will download a precompiled binary and add it to your path. If you don't use Homebrew, you can also install on Linux and macOS systems using curl. See instructions for other systems in the next tab.

Other Systems

Check that everything was installed correctly by enrolling with Ockam Orchestrator. This will create a Space and Project for you in Ockam Orchestrator.

ockam enroll

Next, let's dive in and learn how to use Nodes and Workers.