From 5cba18120b6ea9bc77edb66355f1594aeb32f006 Mon Sep 17 00:00:00 2001
From: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com>
Date: Sat, 2 Oct 2021 10:10:35 +0100
Subject: [PATCH] move haskell implementation to a folder (#108)
* move haskell implementation to a folder
* build v5 branch
* fixing CI
---
.github/workflows/build.yml | 3 +-
Dockerfile => haskell/Dockerfile | 0
haskell/README.md | 232 ++++++++++++++++++
{apps => haskell/apps}/simplex-chat/Demo.hs | 0
{apps => haskell/apps}/simplex-chat/Main.hs | 0
haskell/images/connection.gif | Bin 0 -> 2671490 bytes
haskell/images/files.gif | Bin 0 -> 1040373 bytes
haskell/images/groups.gif | Bin 0 -> 1535951 bytes
haskell/images/how-to-use-simplex.svg | 32 +++
haskell/images/logo.svg | 12 +
.../migrations}/20210612_initial.sql | 0
package.yaml => haskell/package.yaml | 0
{protocol => haskell/protocol}/types.ts | 0
{src => haskell/src}/Simplex/Chat.hs | 0
.../src}/Simplex/Chat/Controller.hs | 0
{src => haskell/src}/Simplex/Chat/Help.hs | 0
{src => haskell/src}/Simplex/Chat/Input.hs | 0
{src => haskell/src}/Simplex/Chat/Markdown.hs | 0
.../src}/Simplex/Chat/Notification.hs | 0
{src => haskell/src}/Simplex/Chat/Options.hs | 0
{src => haskell/src}/Simplex/Chat/Protocol.hs | 0
{src => haskell/src}/Simplex/Chat/Store.hs | 0
{src => haskell/src}/Simplex/Chat/Styled.hs | 0
{src => haskell/src}/Simplex/Chat/Terminal.hs | 0
{src => haskell/src}/Simplex/Chat/Types.hs | 0
{src => haskell/src}/Simplex/Chat/Util.hs | 0
{src => haskell/src}/Simplex/Chat/View.hs | 0
{src => haskell/src}/Simplex/Chat/protocol.md | 0
stack.yaml => haskell/stack.yaml | 0
{tests => haskell/tests}/ChatClient.hs | 0
{tests => haskell/tests}/ChatTests.hs | 0
{tests => haskell/tests}/MarkdownTests.hs | 0
{tests => haskell/tests}/ProtocolTests.hs | 0
{tests => haskell/tests}/Test.hs | 0
{tests => haskell/tests}/fixtures/test.jpg | Bin
{tests => haskell/tests}/fixtures/test.txt | 0
36 files changed, 278 insertions(+), 1 deletion(-)
rename Dockerfile => haskell/Dockerfile (100%)
create mode 100644 haskell/README.md
rename {apps => haskell/apps}/simplex-chat/Demo.hs (100%)
rename {apps => haskell/apps}/simplex-chat/Main.hs (100%)
create mode 100644 haskell/images/connection.gif
create mode 100644 haskell/images/files.gif
create mode 100644 haskell/images/groups.gif
create mode 100644 haskell/images/how-to-use-simplex.svg
create mode 100644 haskell/images/logo.svg
rename {migrations => haskell/migrations}/20210612_initial.sql (100%)
rename package.yaml => haskell/package.yaml (100%)
rename {protocol => haskell/protocol}/types.ts (100%)
rename {src => haskell/src}/Simplex/Chat.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Controller.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Help.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Input.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Markdown.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Notification.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Options.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Protocol.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Store.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Styled.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Terminal.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Types.hs (100%)
rename {src => haskell/src}/Simplex/Chat/Util.hs (100%)
rename {src => haskell/src}/Simplex/Chat/View.hs (100%)
rename {src => haskell/src}/Simplex/Chat/protocol.md (100%)
rename stack.yaml => haskell/stack.yaml (100%)
rename {tests => haskell/tests}/ChatClient.hs (100%)
rename {tests => haskell/tests}/ChatTests.hs (100%)
rename {tests => haskell/tests}/MarkdownTests.hs (100%)
rename {tests => haskell/tests}/ProtocolTests.hs (100%)
rename {tests => haskell/tests}/Test.hs (100%)
rename {tests => haskell/tests}/fixtures/test.jpg (100%)
rename {tests => haskell/tests}/fixtures/test.txt (100%)
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index e1ec517d7..723b1d4a3 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -4,7 +4,7 @@ on:
push:
branches:
- master
- - v4
+ - v5
tags:
- "v*"
pull_request:
@@ -87,6 +87,7 @@ jobs:
- name: Build & test
id: build_test
+ working-directory: ./haskell
run: |
stack build ${{ matrix.stack_args }}
echo "::set-output name=LOCAL_INSTALL_ROOT::$(stack path --local-install-root)"
diff --git a/Dockerfile b/haskell/Dockerfile
similarity index 100%
rename from Dockerfile
rename to haskell/Dockerfile
diff --git a/haskell/README.md b/haskell/README.md
new file mode 100644
index 000000000..b87f8590f
--- /dev/null
+++ b/haskell/README.md
@@ -0,0 +1,232 @@
+
+
+# SimpleX chat (legacy Haskell terminal prototype)
+
+## Private, secure, decentralized
+
+[](https://github.com/simplex-chat/simplex-chat/actions?query=workflow%3Abuild)
+[](https://github.com/simplex-chat/simplex-chat/releases)
+
+> **NEW in v0.4: [groups](#groups) and [sending files](#sending-files)!**
+
+The motivation for SimpleX chat is [presented here](./simplex.md).
+
+SimpleX chat prototype is a thin terminal UI on top of [SimpleXMQ](https://github.com/simplex-chat/simplexmq) message broker that uses [SMP protocols](https://github.com/simplex-chat/simplexmq/blob/master/protocol).
+
+See [simplex.chat](https://simplex.chat) website for chat demo and the explanations of the system and how SMP protocol works.
+
+
+
+## Table of contents
+
+- [Disclaimer](#disclaimer)
+- [Network topology](#network-topology)
+- [Terminal chat features](#terminal-chat-features)
+- [Installation](#installation)
+ - [Download chat client](#download-chat-client)
+ - [Build from source](#build-from-source)
+ - [Using Docker](#using-docker)
+ - [Using Haskell stack](#using-haskell-stack)
+- [Usage](#usage)
+ - [Running the chat client](#running-the-chat-client)
+ - [How to use SimpleX chat](#how-to-use-simplex-chat)
+ - [Groups](#groups)
+ - [Sending files](#sending-files)
+ - [Access chat history](#access-chat-history)
+- [Future roadmap](#future-roadmap)
+- [License](#license)
+
+## Disclaimer
+
+This is WIP implementation of SimpleX chat that implements a new network topology for asynchronous communication combining the advantages and avoiding the disadvantages of federated and P2P networks.
+
+If you expect a software being reliable most of the time and doing something useful, then this is probably not ready for you yet. We do use it for terminal chat though, and it seems to work most of the time - we would really appreciate if you try it and give us your feedback.
+
+**Please note:** The main differentiation of SimpleX network is the approach to internet message routing rather than encryption; for that reason no sufficient attention was paid to either TCP transport level encryption or to E2E encryption protocols - they are implemented in an ad hoc way based on RSA and AES algorithms. See [SMP protocol](https://github.com/simplex-chat/simplexmq/blob/master/protocol/simplex-messaging.md#appendix-a) on TCP transport encryption protocol (AEAD-GCM scheme, with an AES key negotiation based on RSA key hash known to the client in advance) and [this section](https://github.com/simplex-chat/simplexmq/blob/master/rfcs/2021-01-26-crypto.md#e2e-encryption) on E2E encryption protocol (an ad hoc hybrid scheme a la PGP). These protocols will change in a consumer ready version to something more robust.
+
+## Network topology
+
+SimpleX is a decentralized client-server network that uses redundant, disposable nodes to asynchronously pass the messages via message queues, providing receiver and sender anonymity.
+
+Unlike P2P networks, all messages are passed through one or several (for redundancy) servers, that do not even need to have persistence (in fact, the current [SMP server implementation](https://github.com/simplex-chat/simplexmq#smp-server) uses in-memory message storage, persisting only the queue records) - it provides better metadata protection than P2P designs, as no global participant ID is required, and avoids many [problems of P2P networks](https://github.com/simplex-chat/simplex-chat/blob/master/simplex.md#comparison-with-p2p-messaging-protocols).
+
+Unlike federated networks, the participating server nodes do NOT have records of the users, do NOT communicate with each other, do NOT store messages after they are delivered to the recipients, and there is no way to discover the full list of participating servers - it avoids the problem of metadata visibility that federated networks suffer from and better protects the network, as servers do not communicate with each other. Each server node provides unidirectional "dumb pipes" to the users, that do authorization without authentication, having no knowledge of the the users or their contacts. Each queue is assigned two RSA keys - one for receiver and one for sender - and each queue access is authorized with a signature created using a respective key's private counterpart.
+
+The routing of messages relies on the knowledge of client devices how user contacts and groups map at any given moment of time to these disposable queues on server nodes.
+
+## Terminal chat features
+
+- 1-to-1 chat with multiple people in the same terminal window.
+- Group messaging.
+- Sending files to contacts and groups.
+- Auto-populated recipient name - just type your messages to reply to the sender once the connection is established.
+- Demo SMP servers available and pre-configured in the app - or you can [deploy your own server](https://github.com/simplex-chat/simplexmq#using-smp-server-and-smp-agent).
+- No global identity or any names visible to the server(s), ensuring full privacy of your contacts and conversations.
+- E2E encryption, with RSA public key that has to be passed out-of-band (see [How to use SimpleX chat](#how-to-use-simplex-chat)).
+- Message signing and verification with automatically generated RSA keys.
+- Message integrity validation (via including the digests of the previous messages).
+- Authentication of each command/message by SMP servers with automatically generated RSA key pairs.
+- TCP transport encryption using SMP transport protocol.
+
+RSA keys are not used as identity, they are randomly generated for each contact.
+
+## Installation
+
+### Download chat client
+
+Download the chat binary for your system from the [latest stable release](https://github.com/simplex-chat/simplex-chat/releases) and make it executable as shown below.
+
+#### Linux and MacOS
+
+```sh
+chmod +x
+mv ~/.local/bin/simplex-chat
+```
+
+(or any other preferred location on PATH).
+
+On MacOS you also need to [allow Gatekeeper to run it](https://support.apple.com/en-us/HT202491).
+
+#### Windows
+
+```sh
+move %APPDATA%/local/bin/simplex-chat.exe
+```
+
+### Build from source
+
+#### Using Docker
+
+On Linux, you can build the chat executable using [docker build with custom output](https://docs.docker.com/engine/reference/commandline/build/#custom-build-outputs):
+
+```shell
+$ git clone git@github.com:simplex-chat/simplex-chat.git
+$ cd simplex-chat
+$ DOCKER_BUILDKIT=1 docker build --output ~/.local/bin .
+```
+
+> **Please note:** If you encounter ``version `GLIBC_2.28' not found`` error, rebuild it with `haskell:8.8.4-stretch` base image (change it in your local [Dockerfile](Dockerfile)).
+
+#### Using Haskell stack
+
+Install [Haskell stack](https://docs.haskellstack.org/en/stable/README/):
+
+```shell
+curl -sSL https://get.haskellstack.org/ | sh
+```
+
+and build the project:
+
+```shell
+$ git clone git@github.com:simplex-chat/simplex-chat.git
+$ cd simplex-chat
+$ stack install
+```
+
+## Usage
+
+### Running the chat client
+
+To start the chat client, run `simplex-chat` from the terminal.
+
+By default, app data directory is created in the home directory (`~/.simplex`, or `%APPDATA%/simplex` on Windows), and two SQLite database files `simplex.chat.db` and `simplex.agent.db` are initialized in it.
+
+To specify a different file path prefix for the database files use `-d` command line option:
+
+```shell
+$ simplex-chat -d alice
+```
+
+Running above, for example, would create `alice.chat.db` and `alice.agent.db` database files in current directory.
+
+Default SMP servers are hosted on Linode (London, UK and Fremont, CA) - they are [pre-configured in the app](https://github.com/simplex-chat/simplex-chat/blob/master/src/Simplex/Chat/Options.hs#L40). Base-64 encoded string after server host is the transport key digest.
+
+If you deployed your own SMP server(s) you can configure client via `-s` option:
+
+```shell
+$ simplex-chat -s smp.example.com:5223#KXNE1m2E1m0lm92WGKet9CL6+lO742Vy5G6nsrkvgs8=
+```
+
+The base-64 encoded string in server address is the digest of RSA transport handshake key that the server will generate on the first run and output its digest.
+
+You can still talk to people using default or any other server - it only affects the location of the message queue when you initiate the connection (and the reply queue can be on another server, as set by the other party's client).
+
+Run `simplex-chat -h` to see all available options.
+
+### How to use SimpleX chat
+
+Once you have started the chat, you will be prompted to specify your "display name" and an optional "full name" to create a local chat profile. Your display name is an alias for your contacts to refer to you by - it is not unique and does not serve as a global identity. In case different contacts chose the same display name, the chat client adds a numeric suffix to their local display names.
+
+This diagram shows how to connect and message a contact:
+
+
+
+