Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 4.07 KB

README.md

File metadata and controls

131 lines (99 loc) · 4.07 KB
Raw

cups

Building and running

Start9 Embassy

Go Here

Debian

This guide assumes you are running a debian-based operating system and are logged in as root.

  • Clone the repo
    • git clone https://github.com/Start9Labs/cups-messenger.git
    • This document assumes you have cloned to ~/cups-messenger
    • cd ~/cups-messenger
    • git submodule update --init
  • Install Tor
    • apt install tor
  • Set up Tor Hidden Service
    • vim /etc/tor/torrc
    • Add the following lines:
SOCKSPort 0.0.0.0:9050 # This makes your Tor proxy available to your network. If your server is not behind a NAT that you control, make sure to set a SOCKS policy, or bind to the host ip on the docker0 interface

HiddenServiceDir /var/lib/tor/cups_service
HiddenServicePort 80 127.0.0.1:80
HiddenServicePort 59001 127.0.0.1:59001
HiddenServiceVersion 3
  • Restart Tor
    • systemctl restart tor
  • Create a mount point for the container
    • mkdir -p /var/opt/cups/start9
  • Write config file
    • vim /var/opt/cups/start9/config.yaml
    • Add password: <your password> with the password you want to use
  • Build Cups UI
    • cd cups-messenger-ui
    • Build
      • npm i
      • npm run build-prod
    • Copy over result
      • cp -r www ../assets/www
    • Return to Cups
      • cd ..
  • Copy over assets
    • cp -r assets/* /var/opt/cups
  • Build cups server
    • Make sure you have the Rust toolchain
    • cargo build --release
    • NOTE: the docker image is designed for musl. If you are not on a musl platform, you must cross compile.
      • Here is a useful tool for cross compiling to musl.
      • You must also replace target/release with target/<your platform>/release everywhere in this guide, as well as in nonembassy.Dockerfile
    • (Optional) strip target/release/cups
  • Install Docker
    • apt install docker.io
  • Build the Docker Image
    • docker build . -f nonembassy.Dockerfile -t start9/cups
  • Create the Docker Container
docker create \
    --restart unless-stopped \
    --name cups \
    --mount type=bind,src=/var/opt/cups,dst=/root \
    --env TOR_ADDRESS=$(cat /var/lib/tor/cups_service/hostname | sed 's/\n*$//g') \
    --env TOR_KEY=$(tail -c 64 /var/lib/tor/cups_service/hs_ed25519_secret_key | base32 -w0 | sed 's/\n*$//g') \
    --net bridge \
    start9/cups
  • Start the Docker Container
    • docker start cups
  • Get IP address of the Docker Container
    • docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' cups
  • Update hidden service configuration with the container IP
    • vim /etc/tor/torrc
    • Change 127.0.0.1 in the HiddenServicePort config to the result of the previous step
  • Restart Tor
    • systemctl restart tor
  • Your cups tor address can be found by running cat /var/lib/tor/cups_service/hostname

API

Authorization

Cups uses Basic Auth

  • The username is always me.
  • The password is defined in ./start9/config.yaml

Send Message

Request

POST with body 0x00 <Tracking ID (UUID BE)> <ED25519 PubKey of Recipient (32 bytes)> <UTF-8 Encoded Message>

Name User

Request

POST with body 0x01 <ED25519 PubKey of User> <UTF-8 Encoded Name>

Get Contact Book

Request

GET with query ?type=users

Response

<User Info>* where <User Info> = <ED25519 PubKey of User> <Unreads Count (u64 BE)> <Length of Name (1 byte)> <UTF-8 Encoded Name>

Get Messages

Request

GET with query ?type=messages&pubkey=<RFC4648 Base32 encoded ED25519 PubKey of User>&limit=<Maximum number of messages to return>

Response

<Message>* in reverse chronological order where <Message> = <0x00 for Inbound / 0x01 for Outbound> <ID (i64 BE)> <Tracking ID (UUID BE)> <Unix Epoch (i64 BE)> <Length of Message (u64 BE)> <UTF-8 Encoded Message>

Get Version

Request

Unauthenticated GET with no query

Response

<Major Version (u64 BE)> <Minor Version (u64 BE)> <Patch Version (u64 BE)>