Skip to content

INSTALLATION.md

Latest commit

 

History

History
293 lines (210 loc) · 5.15 KB

INSTALLATION.md

File metadata and controls

293 lines (210 loc) · 5.15 KB

Mpcium Installation Guide

Prerequisites

Before starting, ensure you have:

  • Go 1.23+ installed: Install Go here
  • NATS server running
  • Consul server running

Clone and Install Mpcium

Clone the Repository

git clone https://github.com/fystack/mpcium.git
cd mpcium

Build the Project

With Make:

make

Or with Go:

go install ./cmd/mpcium
go install ./cmd/mpcium-cli

Available Commands

  • mpcium: Start an MPCium node
  • mpcium-cli: CLI utility for peer, identity, and initiator configuration

Running NATS and Consul (Development Only)

⚠️ This setup is insecure and should only be used for development. For production, use a secure cluster environment with TLS certificates.

Docker Compose Configuration

Create a docker-compose.yaml file:

version: "3"

services:
  nats-server:
    image: nats:latest
    container_name: nats-server
    command: -js --http_port 8222
    ports:
      - "4222:4222"
      - "8222:8222"
      - "6222:6222"
    tty: true
    restart: always

  consul:
    image: consul:1.15.4
    container_name: consul
    ports:
      - "8500:8500"
      - "8601:8600/udp"
    command: "agent -server -ui -node=server-1 -bootstrap-expect=1 -client=0.0.0.0"
    restart: always

Start the Services

docker compose up -d

Generate Peer Configuration

mpcium-cli generate-peers -n 3

Example output:

{
  "node0": "12345678-1234-1234-1234-123456789abc",
  "node1": "23456789-2345-2345-2345-23456789abcd",
  "node2": "34567890-3456-3456-3456-3456789abcde"
}

Cluster Configuration

1. Create and Update config.yaml

cp config.yaml.template config.yaml

Edit config.yaml:

nats:
  url: nats://127.0.0.1:4222
consul:
  address: localhost:8500

mpc_threshold: 2
environment: development
badger_password: "your_badger_password"
event_initiator_pubkey: "your_event_initiator_pubkey"

Generate a Strong Password (Recommended)

< /dev/urandom tr -dc 'A-Za-z0-9!@#$^&*()-_=+[]{}|;:,.<>?/~' | head -c 16; echo

Example:

badger_password: "F))ysJp?E]ol&I;^"

2. Register Peers to Consul

mpcium-cli register-peers

Event Initiator Setup

Generate the Initiator

mpcium-cli generate-initiator

💡 Use --encrypt in production.

Add Public Key to config.yaml

From event_initiator.identity.json:

{
  "public_key": "09be5d070816aadaa1b6638cad33e819a8aed7101626f6bf1e0b427412c3408a"
}

Update config.yaml:

event_initiator_pubkey: "09be5d070816aadaa1b6638cad33e819a8aed7101626f6bf1e0b427412c3408a"

Configure Node Identities

1. Create Node Folders

mkdir node{0..2}
for dir in node{0..2}; do cp config.yaml peers.json "$dir/"; done

2. Generate Identity for Each Node

Example for node0:

cd node0
mpcium-cli generate-identity --node node0

💡 For production, use encryption:

mpcium-cli generate-identity --node node0 --encrypt

Generate Strong Password for Encryption

< /dev/urandom tr -dc 'A-Za-z0-9!@#$^&*()-_=+[]{}|;:,.<>?/~' | head -c 16; echo

3. Distribute Identity Files to All Nodes

cp identity/node0_identity.json ../node1/identity/node0_identity.json
cp identity/node0_identity.json ../node2/identity/node0_identity.json

Repeat this for node1 and node2.

Folder Structure Example

├── node0
│   ├── config.yaml
│   ├── identity
│   │   ├── node0_identity.json
│   │   ├── node0_private.key
│   │   ├── node1_identity.json
│   │   └── node2_identity.json
│   └── peers.json
├── node1
│   ├── config.yaml
│   ├── identity
│   │   ├── node0_identity.json
│   │   ├── node1_identity.json
│   │   ├── node1_private.key
│   │   └── node2_identity.json
│   └── peers.json
├── node2
│   ├── config.yaml
│   ├── identity
│   │   ├── node0_identity.json
│   │   ├── node1_identity.json
│   │   ├── node2_identity.json
│   │   └── node2_private.key
│   └── peers.json

Start Mpcium Nodes

Start each node:

cd node0
mpcium start -n node0
cd node1
mpcium start -n node1
cd node2
mpcium start -n node2

💡 In production, avoid hardcoded passwords:

mpcium start -n node0 --prompt-credentials

All node ready

Production Deployment (High Security)

  1. Use production-grade NATS and Consul clusters.
  2. Enable TLS certificates on all endpoints.
  3. Encrypt all keys: 
    mpcium-cli generate-initiator --encrypt
mpcium-cli generate-identity --node node0 --encrypt
  4. Use --prompt-credentials to securely input Badger passwords (avoid hardcoding in config.yaml).

Apendix

Decrypt initiator private key with age

age --decrypt -o event_initiator.key event_initiator.key.age