Claytonia/cryptalk
Claytonia/cryptalk
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Compare commits

..

No commits in common. "master" and "1.2.3" have entirely different histories.
master ... 1.2.3

17 changed files with 4022 additions and 3755 deletions

1
.github/FUNDING.yml vendored
View file

@ -1,2 +1 @@
github: [hexagon] github: [hexagon]
ko_fi: hexagon_56k

6
.github/dependabot.yml vendored
View file

@ -1,6 +0,0 @@
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"

2
.github/workflows/node.js.yml vendored
View file

@ -27,4 +27,4 @@ jobs:
node-version: ${{ matrix.node-version }} node-version: ${{ matrix.node-version }}
cache: 'npm' cache: 'npm'
- run: npm ci - run: npm ci
- run: npm run build:ci - run: npm run build

7
Dockerfile
View file

@ -1,6 +1,7 @@
FROM keymetrics/pm2:16-alpine FROM node:16-alpine
COPY . /usr/src/app COPY . /usr/src/app
WORKDIR /usr/src/app WORKDIR /usr/src/app
RUN npm install --no-cache --production RUN npm install --no-cache
EXPOSE 8080 EXPOSE 8080
CMD [ "pm2-runtime", "start", "pm2.json" ] RUN chmod +x /usr/src/app/docker-entrypoint.sh
ENTRYPOINT ["/usr/src/app/docker-entrypoint.sh", "npm", "start"]

287
README.md
View file

@ -1,137 +1,150 @@
![cryptalk](https://i.imgur.com/1sH36n5.png) ![cryptalk](/screenshot.png)
![Node.js CI](https://github.com/Hexagon/cryptalk/workflows/Node.js%20CI/badge.svg?branch=master) ![Node.js CI](https://github.com/Hexagon/cryptalk/workflows/Node.js%20CI/badge.svg?branch=master)
[![npm version](https://badge.fury.io/js/cryptalk.svg)](https://badge.fury.io/js/cryptalk) [![npm version](https://badge.fury.io/js/cryptalk.svg)](https://badge.fury.io/js/cryptalk)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/753ef40cec1747c2b5025f834635375b)](https://www.codacy.com/gh/Hexagon/cryptalk/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Hexagon/cryptalk&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/753ef40cec1747c2b5025f834635375b)](https://www.codacy.com/gh/Hexagon/cryptalk/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Hexagon/cryptalk&utm_campaign=Badge_Grade)
# Cryptalk Cyptalk is a HTML5/Node.js based, client side (E2EE) encrypted instant chat
Cyptalk is a HTML5/Node.js based, client side (E2EE) encrypted instant chat
Features
## Features ========
* Client side AES-256-CBC encryption/decryption (the server is just a messenger) * Client side AES-256-CBC encryption/decryption (the server is just a messenger)
* 256 bit key derived from your passphrase using PBKDF2 * 256 bit key derived from your passphrase using PBKDF2
* Messages torched after a configurable delay, default is 600s. * Messages torched after a configurable delay, default is 600s.
* Simple setup using npm, Docker or Heroku * Simple setup using npm, Docker or Heroku
* Notification sounds (mutable) * Notification sounds (mutable)
* Native popup notifications * Native popup notifications
* Configurable page title * Configurable page title
* Nicknames, optional. * Nicknames, optional.
* Quick-links using http://server/#Room:Passphrase, optional and insecure * Quick-links using http://server/#Room:Passphrase, optional and insecure
## Installing
Docker setup
### Docker setup ========
To run latest cryptalk with docker, exposed on host port 80, simply run the following command to pull it from docker hub To run latest cryptalk with docker, exposed on host port 80, simply run the following command to pull it from docker hub
```bash ```bash
sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk
``` ```
### Heroku setup
Heroku setup
Click the button below ========
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/hexagon/cryptalk) Click the button below
### Docker setup without using docker hub [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/hexagon/cryptalk)
Clone this repo, enter the new directory.
Build image Docker setup without using docker hub
```bash ========
docker build . --tag="hexagon/cryptalk"
``` Clone this repo, enter the new directory.
Run container, enable start on boot, expose to port 80 at host Build image
```bash ```bash
sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk docker build . --tag="hexagon/cryptalk"
``` ```
Browse to ```http://<ip-of-server>/``` Run container, enable start on boot, expose to port 80 at host
```bash
Done! sudo docker run -d --restart=always -p 80:8080 hexagon/cryptalk
```
### npm setup
Browse to ```http://<ip-of-server>/```
Install node.js, exact procedure is dependant on platform and distribution.
Done!
Install the app from npm
```bash
npm install cryptalk -g
```` npm setup
========
Then issue the following to start the app
Install node.js, exact procedure is dependant on platform and distribution.
```bash
cryptalk Install the app from npm
``` ```bash
npm install cryptalk -g
Browse to ```http://localhost:8080``` ````
Done! Then issue the following to start the app
## Usage ```bash
cryptalk
``` ```
Available commands: Browse to ```http://localhost:8080```
Client: Done!
/key StrongPassphrase Sets encryption key
/nick NickName Sets an optional nick
/mute Audio on
/unmute Audio off Developer setup
/clear Clear on-screen buffer ========
/help This
/title Set your local page title Install node.js (development require >=12.0), exact procedure is dependant on platform and distribution.
/torch AfterSeconds Console messages are torched
after this amount of seconds Clone this repo
(default 600). ```bash
git clone https://github.com/Hexagon/cryptalk.git
Room: cd cryptalk
/join RoomId Join a room ```
/leave Leave the room
/count Count participants Pull dependencies from npm
```bash
Host: npm install
/connect Connect to host ```
/disconnect Disconnect from host
Start server
You can select any of the five last commands/messages with up/down key. ```bash
npn run start
Due to security reasons, /key command is not saved, and command ```
history is automatically cleared after one minute of inactivity.
Browse to ```http://localhost:8080```
It is highly recommended to use incognito mode while chatting,
to prevent browsers from keeping history or cache. To work on the JavaScript, edit the code in ```client/source/```. To test the changes, first run ```npm run build``` to lint, build and minify the code. Then restart the server.
``` Usage
========
## Development
```
Install node.js (development require >=12.0), exact procedure is dependant on platform and distribution.
Available commands:
Clone this repo
```bash Client:
git clone https://github.com/Hexagon/cryptalk.git /key StrongPassphrase Sets encryption key
cd cryptalk /nick NickName Sets an optional nick
``` /mute Audio on
/unmute Audio off
Pull dependencies from npm /clear Clear on-screen buffer
```bash /help This
npm install /title Set your local page title
``` /torch AfterSeconds Console messages are torched
after this amount of seconds
Start server (default 600).
```bash
npm run start Room:
``` /join RoomId Join a room
/leave Leave the room
Browse to ```http://localhost:8080``` /count Count participants
To work on the JavaScript, edit the code in ```client/source/```. To test the changes, first run ```npm run build``` to lint, build and minify the code. Then restart the server. Host:
/connect Connect to host
/disconnect Disconnect from host
You can select any of the five last commands/messages with up/down key.
Due to security reasons, /key command is not saved, and command
history is automatically cleared after one minute of inactivity.
It is highly recommended to use incognito mode while chatting,
to prevent browsers from keeping history or cache.
```

77
client/public/css/default.css
View file

@ -1,31 +1,32 @@
/*------------------------------------*\
GENERIC
\*------------------------------------*/
html { html {
-webkit-box-sizing: border-box; /* Safari/Chrome, other WebKit */ -webkit-box-sizing: border-box; /* Safari/Chrome, other WebKit */
-moz-box-sizing: border-box; /* Firefox, other Gecko */ -moz-box-sizing: border-box; /* Firefox, other Gecko */
box-sizing: border-box; /* Opera/IE 8+ */ box-sizing: border-box; /* Opera/IE 8+ */
} }
*, *, *:before, *:after {
*:before,
*:after {
box-sizing: inherit; box-sizing: inherit;
font-family: monospace, 'Courier New'; font-family: monospace, 'Courier New';
font-size: 12px; font-size: 12px;
} }
body, body, html {
html {
min-height: 100%; min-height: 100%;
min-width: 600px; min-width: 600px;
background-color: #181a1d; background-color: #181A1D;
overflow: hidden; overflow: hidden;
padding: 0px; padding: 0px;
margin: 0px; margin:0px;
color: #00dd00; color: #00DD00;
} }
.good { color: #99ff99; } .good { color: #99FF99; }
.bad { color: #ff7777; } .bad { color: #ff7777; }
.info { color: #99ffff; } .info { color: #99FFFF; }
.neutral { color: #eeeeee; } .neutral { color: #eeeeee; }
/*------------------------------------*\ /*------------------------------------*\
@ -37,8 +38,8 @@ html {
bottom: 40px; bottom: 40px;
position: absolute; position: absolute;
list-style-type: none; list-style-type: none;
padding: 0; padding:0;
margin: 0; margin:0;
} }
/* Messages */ /* Messages */
@ -49,7 +50,7 @@ html {
} }
#chat li .timestamp { #chat li .timestamp {
color: #a0a00a; color: #A0A00A;
} }
/* Message types */ /* Message types */
@ -57,27 +58,24 @@ html {
#chat i { #chat i {
font-style: normal; font-style: normal;
} }
#chat i.motd { #chat i.motd { color: #99FF99; display:inline-block; line-height: 12px !important; }
color: #99ff99;
display:inline-block;
line-height: 12px !important;
}
#chat i.info { color: #999999; } #chat i.info { color: #999999; }
#chat i.server { color: #99ffff; } #chat i.server { color: #99FFFF; }
#chat i.error { color: #ff7777; } #chat i.error { color: #ff7777; }
#chat i.message { color: #eeeeee; } #chat i.message { color: #eeeeee; }
#chat i.nick { color: #99ff99; } #chat i.nick { color: #99FF99; }
#chat i.fatal { color: #ff7777; } #chat i.fatal { color: #ff7777; }
/*------------------------------------*\ /*------------------------------------*\
INPUT & LOADER INPUT & LOADER
\*------------------------------------*/ \*------------------------------------*/
#input_wrapper { #input_wrapper {
right: 0; right:0;
bottom: 0; bottom:0;
left: 0; left:0;
position: absolute; position: absolute;
height: 30px;
height:30px;
} }
#input, #input,
@ -92,35 +90,26 @@ html {
padding: 5px 5px 5px 15px; padding: 5px 5px 5px 15px;
color: #ffffff; color: #FFFFFF;
background-color:#272a2e; background-color:#272A2E;
height:30px; height:30px;
border-top: 2px solid #153315; border-top: 2px solid #153315;
} }
#input { #input { z-index: 1; }
z-index: 1; #loader { z-index: 0; line-height: 20px; font-size: 14px; font-weight: 100; font-family: tahoma;}
}
#loader {
z-index: 0;
line-height: 20px;
font-size: 14px;
font-weight: 100;
font-family: tahoma;
}
.loading #loader {
z-index: 2;
}
/*------------------------------------*\
SPINNER
\*------------------------------------*/
.loading #loader { z-index: 2; }
.loading #loader span { .loading #loader span {
margin-left:-2px; margin-left:-2px;
-webkit-animation: rotation 1s infinite linear; -webkit-animation: rotation 1s infinite linear;
} }
@-webkit-keyframes rotation { @-webkit-keyframes rotation {
from { -webkit-transform: rotate(0deg); } from {-webkit-transform: rotate(0deg);}
to { -webkit-transform: rotate(359deg); } to {-webkit-transform: rotate(359deg);}
} }

2
client/public/js/cryptalk.min.js vendored
View file

File diff suppressed because one or more lines are too long

2
client/public/js/cryptalk.min.js.map
View file

File diff suppressed because one or more lines are too long

6
client/source/$.js
View file

@ -9,7 +9,8 @@ for(var k in proto) ElementArray.prototype[k] = proto[k];
// Create to actual dollar function // Create to actual dollar function
function Dollar (selector) { function Dollar (selector) {
let matches = new ElementArray(); var match,
matches = new ElementArray();
if (selector !== undefined) { if (selector !== undefined) {
if (selector === document) { if (selector === document) {
@ -17,8 +18,7 @@ function Dollar (selector) {
} else if (selector === window) { } else if (selector === window) {
matches.push(window); matches.push(window);
} else { } else {
let match = document.querySelectorAll(selector); if ((match = document.querySelectorAll(selector))) {
if (match) {
for( var i=0; i < match.length; i++) { for( var i=0; i < match.length; i++) {
matches.push(match[i]); matches.push(match[i]);
} }

24
client/source/console.js
View file

@ -128,6 +128,20 @@ export default function(mediator,settings,templates, sounds) {
components.input[0].removeAttribute('disabled'); components.input[0].removeAttribute('disabled');
components.inputWrapper[0].className = ''; components.inputWrapper[0].className = '';
components.input.focus(); components.input.focus();
},
_require: function (filepath, done) {
commands.lockInput();
commands.post('info', 'Requiring ' + filepath + '...');
require([filepath], function () {
commands.post('info', 'Successfully required ' + filepath + '.');
commands.unlockInput();
done();
}, function (e) {
commands.post('error', 'An error occurred while trying to load "' + filepath + '":\n' + e);
commands.unlockInput();
done();
});
} }
}, },
@ -142,8 +156,7 @@ export default function(mediator,settings,templates, sounds) {
// If the active element is not the input, focus on it and exit the function. // If the active element is not the input, focus on it and exit the function.
// Ignore this when ctrl and/or alt is pressed! // Ignore this when ctrl and/or alt is pressed!
if (!e.ctrlKey && !e.altKey && components.input[0] !== $.activeElement()) { if (!e.ctrlKey && !e.altKey && components.input[0] !== $.activeElement()) {
components.input.focus(); return components.input.focus();
return;
} }
// Return immediatly if the buffer is empty or if the hit key was not <enter> // Return immediatly if the buffer is empty or if the hit key was not <enter>
@ -163,8 +176,7 @@ export default function(mediator,settings,templates, sounds) {
payload, payload,
function(retvals, recipients) { function(retvals, recipients) {
if(!recipients) { if(!recipients) {
commands.post('error', $.template(templates.messages.unrecognized_command, { commandName: command })); return commands.post('error', $.template(templates.messages.unrecognized_command, { commandName: command }));
return;
} else { } else {
commands.clearInput(); commands.clearInput();
} }
@ -205,11 +217,13 @@ export default function(mediator,settings,templates, sounds) {
// Connect events // Connect events
for (var commandName in commands) { for (var commandName in commands) {
if (commandName !== 'post') { if (commandName !== '_require' && commandName !== 'post') {
mediator.on('console:' + commandName, commands[commandName]); mediator.on('console:' + commandName, commands[commandName]);
} }
} }
mediator.on('console:require', commands._require);
mediator.on('console:post', function (data) { mediator.on('console:post', function (data) {
commands.post(data.type, data.data, data.nick); commands.post(data.type, data.data, data.nick);
}); });

76
client/source/settings.js
View file

@ -1,34 +1,42 @@
export default { export default {
title: 'Claytonia Chat', title: 'Cryptalk - Online',
ttl: 600000, ttl: 600000,
motd: '<pre>\n\n' + motd: '<pre>\n\n' +
' Welcome to Claytonia Chat \n' + '▄████▄ ██▀███ ▓██ ██▓ ██▓███ ▄▄▄█████▓ ▄▄▄ ██▓ ██ ▄█▀ \n' +
' Tip of the day: /help \n' + '▒██▀ ▀█ ▓██ ▒ ██▒▒██ ██▒▓██░ ██▒▓ ██▒ ▓▒▒████▄ ▓██▒ ██▄█▒ \n' +
' Public Room: /join Claytonia \n' + '▒▓█ ▄ ▓██ ░▄█ ▒ ▒██ ██░▓██░ ██▓▒▒ ▓██░ ▒░▒██ ▀█▄ ▒██░ ▓███▄░ \n' +
' Public Key: /key Claytonia \n' + '▒▓▓▄ ▄██▒▒██▀▀█▄ ░ ▐██▓░▒██▄█▓▒ ▒░ ▓██▓ ░ ░██▄▄▄▄██ ▒██░ ▓██ █▄ \n' +
' Everyone in the room must have the same key to decrypt messages. \n' + '▒ ▓███▀ ░░██▓ ▒██▒ ░ ██▒▓░▒██▒ ░ ░ ▒██▒ ░ ▓█ ▓██▒░██████▒▒██▒ █▄ \n' +
'----------------------------------------------------------------------' + '░ ░▒ ▒ ░░ ▒▓ ░▒▓░ ██▒▒▒ ▒▓▒░ ░ ░ ▒ ░░ ▒▒ ▓▒█░░ ▒░▓ ░▒ ▒▒ ▓▒ \n' +
'</pre>', ' ░ ▒ ░▒ ░ ▒░▓██ ░▒░ ░▒ ░ ░ ▒ ▒▒ ░░ ░ ▒ ░░ ░▒ ▒░ \n' +
'░ ░░ ░ ▒ ▒ ░░ ░░ ░ ░ ▒ ░ ░ ░ ░░ ░ \n' +
nick: { '░ ░ ░ ░ ░ ░ ░ ░ ░░ ░ \n' +
maxLen: 20, '░ ░ ░ \n' +
minLen: 2, ' https://github.com/hexagon/cryptalk \n' +
}, ' \n' +
' Tip of the day: /help \n' +
key: { '----------------------------------------------------------------------' +
maxLen: 1024, '</pre>',
minLen: 8,
}, nick: {
maxLen: 20,
room: { minLen: 2,
minLen: 1, },
maxLen: 64
}, key: {
maxLen: 1024,
notifications: { minLen: 8,
maxOnePerMs: 3000 },
}
}; room: {
minLen: 1,
maxLen: 64
},
notifications: {
maxOnePerMs: 3000
}
};

17
cryptalk.service
View file

@ -1,17 +0,0 @@
[Unit]
Description=Cryptalk Node.js App
Documentation=https://github.com/Hexagon/cryptalk
After=network.target
[Service]
ExecStart=/usr/bin/npm run start
WorkingDirectory=/home/cryptochat/cryptalk
Restart=always
RestartSec=10
Environment=NODE_ENV=production
Environment=PATH=/usr/bin
User=cryptochat
Group=cryptochat
[Install]
WantedBy=multi-user.target

11
docker-entrypoint.sh Normal file
View file

@ -0,0 +1,11 @@
#!/bin/sh
set -e
# /usr/src/app/external-public kan be mounted as a volume on host to expose
# statics to be hosted by host nginx
if [ -d /usr/src/app/external-public ]; then
cp -R /usr/src/app/client/public/* /usr/src/app/external-public/
fi
exec "$@"

7223
package-lock.json generated
View file

File diff suppressed because it is too large Load diff

7
package.json
View file

@ -1,14 +1,13 @@
{ {
"name": "cryptalk", "name": "cryptalk",
"version": "1.2.9", "version": "1.2.3",
"description": "Encrypted HTML5/Node.JS instant chat", "description": "Encrypted HTML5/Node.JS instant chat",
"main": "server/server.js", "main": "server/server.js",
"preferGlobal": true, "preferGlobal": true,
"private": false, "private": false,
"scripts": { "scripts": {
"test": "echo \"No tests written yet\" && exit 0", "test": "echo \"No tests written yet\" && exit 0",
"build": "npm update && npm outdated && npm run test:lint && npx rollup -c rollup.config.js && npm run build:minify && npm run build:cleanup", "build": "npm run test:lint && npx rollup -c rollup.config.js && npm run build:minify && npm run build:cleanup",
"build:ci": "npm run test:lint && npx rollup -c rollup.config.js && npm run build:minify && npm run build:cleanup",
"build:minify": "uglifyjs client/public/js/cryptalk.js --source-map -o client/public/js/cryptalk.min.js", "build:minify": "uglifyjs client/public/js/cryptalk.js --source-map -o client/public/js/cryptalk.min.js",
"build:cleanup": "(rm client/public/js/cryptalk.js || del client\\public\\js\\cryptalk.js)", "build:cleanup": "(rm client/public/js/cryptalk.js || del client\\public\\js\\cryptalk.js)",
"test:lint": "eslint ./client/source/**/*.js ./server/*.js", "test:lint": "eslint ./client/source/**/*.js ./server/*.js",
@ -39,7 +38,7 @@
}, },
"bin": "./server/server.js", "bin": "./server/server.js",
"dependencies": { "dependencies": {
"serve": "^13.0.2", "serve": "^12.0.1",
"socket.io": "^4.3.1" "socket.io": "^4.3.1"
}, },
"os": [ "os": [

11
pm2.json
View file

@ -1,11 +0,0 @@
{
"name": "cryptalk",
"script": "server/server.js",
"instances": "1",
"env": {
"NODE_ENV": "development"
},
"env_production" : {
"NODE_ENV": "production"
}
}

18
rollup.config.js
View file

@ -2,13 +2,13 @@ import { nodeResolve } from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs'; import commonjs from '@rollup/plugin-commonjs';
module.exports = { module.exports = {
input: 'client/source/cryptalk.js', input: 'client/source/cryptalk.js',
output: { output: {
file: 'client/public/js/cryptalk.js', file: 'client/public/js/cryptalk.js',
format: 'iife' format: 'iife'
}, },
plugins: [ plugins: [
nodeResolve(), nodeResolve(),
commonjs() commonjs()
] ]
}; };