full-stack privacy application with enciphered messaging, monero multisig and built-in i2p marketplace
Find a file
2023-05-17 11:05:31 -04:00
.cargo update audit.toml 2023-05-06 01:42:31 -04:00
.github/workflows add tests for db.rs 2023-05-17 10:18:22 -04:00
docs add gpg key 2023-05-12 20:38:37 -04:00
nevmes-auth update version 2023-05-12 20:39:49 -04:00
nevmes-contact update version 2023-05-12 20:39:49 -04:00
nevmes-core add tests for utils.rs 2023-05-17 11:05:31 -04:00
nevmes-gui update version 2023-05-12 20:39:49 -04:00
nevmes-message update version 2023-05-12 20:39:49 -04:00
scripts add rustfmt and fmtall.sh 2023-05-09 17:28:07 -04:00
src add rustfmt and fmtall.sh 2023-05-09 17:28:07 -04:00
.gitignore add i2p to installation manager 2023-05-08 02:21:52 -04:00
.rustfmt.toml add rustfmt and fmtall.sh 2023-05-09 17:28:07 -04:00
Cargo.lock update version 2023-05-12 20:39:49 -04:00
Cargo.toml update version 2023-05-12 20:39:49 -04:00
LICENSE add license 2023-05-01 22:08:53 -04:00
README.md add rustfmt and fmtall.sh 2023-05-09 17:28:07 -04:00

NEVMES

NEVidebla-MESago (invisible message)

cargo-build cargo-audit

gpg and i2p made simple for end-to-end encrypted, secure comms

About

  • send messages over the invisible internet
  • vanity base32 addresses (advanced)
  • automated mandatory gpg key encryption
  • xmr payment integration

Dev

  • stack - rust (egui, rocket), lmdb, i2p-zero, monero(rpc, daemon), gpg
  • install dependencies
    • ubuntu example: sudo apt update -y && sudo apt upgrade -y
    • sudo apt install -y libssl-dev build-essential libgpgme-dev
  • git clone https://github/com/creating2morrow/nevmes
  • cd nevmes && ./scripts/build_all_and_run.sh "-- -h"
  • gui built with rust egui

Installation Mananger

  • additional required software can be downloaded from the gui home or Binaries links below
  • hashes are in core lib.rs
  • download and run i2p
    • /i2p/i2prouter start
    • /i2p/i2prouter install (optional: setup to run on boot similar to tor daemon)
  • download i2p-zero, put the path in the connection manager or cli --i2p-zero-dir flag
  • download monero, update connection manager or cli
    • --monero-blockchain-dir, where to put lmdb for monero (e.g. path/to/ssd)
    • --monero-location, path to monero download

Contributing and Releasing

| branch |                 |tag and release|
  dev     -----------------|-------------------------------------------->
  v0.1.0  -----------tag v0.1.0 (delete branch)
  v0.2.0                   |-------------------------------------------->
  main    -------------------------------------------------------------->
  • code on dev branch
  • run ./scripts/fmtall.sh before committing
  • pull request to dev branch
  • todo => TODO(name): detailed work
  • docs on all pub fn and pub struct
  • merge dev to vX.X.X
  • merge vX.X.X to main
  • tag release v.X.X.X every friday (if stable changes)
  • release binaries from the cargo-build-release workflow with notes
  • create next v.X.X+1.X branch and delete old release branch
  • release bug fixes as appropriate to v.X.X.X+1 branch when ready

Workflows

name branch purpose
cargo-build main,dev ensure code compilation and build success
cargo-audit main,dev run security audit against RustSec database
cargo-build-release v0.* publish production ready binaries

API

  • remote/programmatic access
  • secured by wallet signing
  • jwt and jwp
  • see curl.md

Binaries

  • nevmes-auth - internal auth server
  • nevmes-contact - internal add contacts server
  • nevmes-gui - primary user interface
  • nevmes-message - internal message tx/read etc. server
  • nevmes - external primary server for contact share, payment, message rx etc.
  • monerod - (not included) monero-wallet-rpc needs this
    • can be overriden with remote node
    • use the --remote-node flag
  • monero-wallet-rpc - (not included) interface for xmr wallet ops
  • i2p-zero - (not included) tunnel creation
  • i2p - http proxy (not included, *i2p-zero http proxy not working)

most of the complex logic stays in nevmes-core, exported from lib.rs

Manual

the manual