Files
sashimono/README.md
Ravin Perera 737c3c0af0 Revamped Sashimono installation process. (#27)
- During development, binaries and data exist in build dir.
- In production, binaries in '/usr/bin/sashimono-agent' and data in '/etc/sashimono'.
- Added prerequisites script for easy machine preparation.
- Added cloud installation scripts.
- Added non-interactive installation scripts for fully automated setup of test vms.
- sagent must now be run as root (in development as well as in production)
2021-07-12 15:00:11 +05:30

2.6 KiB

Sashimono Agent

What's here?

In development

A C++ version of sashimono agent

Libraries

Setting up Sashimono Agent development environment

Tested on Ubuntu 18.04 and 20.04

  1. Run sudo ./prereq.sh
  2. Reboot the machine.
  3. Run ./dev-setup.sh

Build Sashimono Agent

  1. Run cmake . (You only have to do this once)
  2. Run make (Sashimono agent binary 'sagent' and dependencies will be placed in build directory)

Build Sashimono installer

Run make installer ('sashimono-installer.tar.gz' will be placed in build directory)

Run Sashimono

  1. cd examples/message-board && npm install (You only have to do this once)
  2. node message-board.js (Message board simulator will start listening at port 5000)
  3. ./build/sagent new (This will create the Sashimono config in build directory. You only have to do this once)
  4. sudo ./build/sagent run

Sashimono Client

  • Replace the sashimono-client.key file created inside dataDir in the first run by the key file found on this link. This is because we have hardcoded the pubkey in message board. This will generate the same pubkey we have hardcoded.
  • A sample bundle.zip bundle can be found here.

Code structure

Code is divided into subsystems via namespaces.

comm:: Handles generic web sockets communication functionality. Mainly acts as a wrapper for hpws.

conf:: Handles configuration. Loads and holds the central configuration object. Used by most of the subsystems.

crypto:: Handles cryptographic activities. Wraps libsodium and offers convenience functions.

hp:: Contains hotpocket instance management related helper functions.

hpfs:: Contains hpfs instance management related helper functions.

msg:: Extract message data from received raw messages.

salog:: Handles logging. Creates and prints the logs according to the configured log section in the json config.

sqlite:: Contains sqlite database management related helper functions.

util:: Contains shared data structures/helper functions used by multiple subsystems.