Sync up with master

This commit is contained in:
Bryan Ashby 2023-10-12 20:25:01 -06:00
commit 83636cb894
62 changed files with 511 additions and 167 deletions

9
.devcontainer/Dockerfile Normal file
View File

@ -0,0 +1,9 @@
FROM library/node:lts-bookworm
ARG DEBIAN_FRONTEND=noninteractive
RUN apt update \
&& apt install -y --no-install-recommends sudo telnet \
&& apt autoremove -y \
&& rm -rf /var/lib/apt/lists/* \
&& echo "node ALL=(ALL) NOPASSWD: ALL" >/etc/sudoers.d/node \
&& chmod 0440 /etc/sudoers.d/node

View File

@ -0,0 +1,24 @@
{
"name": "Basic Node.js",
"build": { "dockerfile": "Dockerfile" },
"remoteUser": "root",
"forwardPorts": [8888, 4000],
"postCreateCommand": "gem install jekyll bundler && /bin/rm -rf node_modules && npm install && cd docs && bundle install && cd ..",
"features": {
"ghcr.io/devcontainers/features/python:1": {
"installTools": true,
"version": "3.11"
},
"ghcr.io/devcontainers-contrib/features/curl-apt-get:1": {},
"ghcr.io/jungaretti/features/ripgrep:1": {},
"ghcr.io/warrenbuckley/codespace-features/sqlite:1": {},
"ghcr.io/devcontainers/features/ruby:1": {
"version": "3.1"
}
},
"customizations": {
"vscode": {
"extensions": ["ms-azuretools.vscode-docker","alexcvzz.vscode-sqlite","yzhang.markdown-all-in-one", "DavidAnson.vscode-markdownlint", "christian-kohler.npm-intellisense", "dbaeumer.vscode-eslint", "bierner.markdown-yaml-preamble"]
}
}
}

12
.dockerignore Normal file
View File

@ -0,0 +1,12 @@
node_modules
package-lock.json
yarn.lock
filebase
db
drop
file_base
logs
mail
docs/_site
docs/.sass-cache

10
.gitattributes vendored
View File

@ -6,3 +6,13 @@
*.TXT eol=crlf *.TXT eol=crlf
*.diz eol=crlf *.diz eol=crlf
*.DIZ eol=crlf *.DIZ eol=crlf
# Don't mess with shell script line endings
*.sh text eol=lf
# Same thing for optutil.js which functions as a shell script
optutil.js text eol=lf
# The devcontainer is also unix
.devcontainer/Dockerfile text eol=lf
.devcontainer/devcontainer.json text eol=lf

View File

@ -11,23 +11,23 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Set up QEMU - name: Set up QEMU
uses: docker/setup-qemu-action@v1 uses: docker/setup-qemu-action@v2
- name: Set up Docker Buildx - name: Set up Docker Buildx
id: buildx id: buildx
uses: docker/setup-buildx-action@v1 uses: docker/setup-buildx-action@v2
- name: Login to DockerHub - name: Login to DockerHub
uses: docker/login-action@v1 uses: docker/login-action@v2
with: with:
username: ${{ secrets.DOCKERHUB_USERNAME }} username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push - name: Build and push
uses: docker/build-push-action@v2 uses: docker/build-push-action@v3
with: with:
tags: enigmabbs/enigma-bbs:latest tags: enigmabbs/enigma-bbs:latest
file: docker/Dockerfile file: docker/Dockerfile

3
.gitignore vendored
View File

@ -11,4 +11,5 @@ mail/
node_modules/ node_modules/
docs/_site/ docs/_site/
docs/.sass-cache/ docs/.sass-cache/
.vscode/
docs/.jekyll-cache/

6
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,6 @@
{
"recommendations": [
"ms-vscode-remote.remote-containers",
"laktak.hjson"
]
}

26
.vscode/tasks.json vendored Normal file
View File

@ -0,0 +1,26 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Start Jekyll (ENiGMA½ documentation server)",
"command": "cd docs && bundle exec jekyll serve",
"isBackground": true,
"type": "shell"
},
{
"label": "(re)build Jekyll bundles",
"command": "cd docs && bundle install",
"type": "shell"
},
{
"label": "(re)build node modules",
"command": "/bin/rm -rf node_modules && npm install",
"type": "shell"
},
{
"label": "ENiGMA½ new configuration",
"command": "./oputil.js config new",
"type": "shell"
}
]
}

View File

@ -35,6 +35,10 @@ npm install # or simply 'yarn'
## 0.0.13-beta to 0.0.14-beta ## 0.0.13-beta to 0.0.14-beta
* Due to changes to supported algorithms in newer versions of openssl, the default list of supported algorithms for the ssh login server has changed. There are both removed ciphers as well as optional new kex algorithms available now. ***NOTE:*** Changes to supported algorithms are only needed to support keys generated with new versions of openssl, if you already have a ssl key in use you should not have to make any changes to your config.
* Removed ciphers: 'blowfish-cbc', 'arcfour256', 'arcfour128', and 'cast128-cbc'
* Added kex: 'curve25519-sha256', 'curve25519-sha256@libssh.org', 'curve25519-sha256', 'curve25519-sha256@libssh.org', 'ecdh-sha2-nistp256', 'ecdh-sha2-nistp384', 'ecdh-sha2-nistp521'
## 0.0.12-beta to 0.0.13-beta ## 0.0.12-beta to 0.0.13-beta
* To enable the new Waiting for Caller (WFC) support, please see [WFC](docs/modding/wfc.md). * To enable the new Waiting for Caller (WFC) support, please see [WFC](docs/modding/wfc.md).
* :exclamation: The SSH server's `ssh2` module has gone through a major upgrade. Existing users will need to comment out two SSH KEX algorithms from their `config.hjson` if present else clients such as NetRunner will not be able to connect over SSH. Comment out `diffie-hellman-group-exchange-sha256` and `diffie-hellman-group-exchange-sha1` * :exclamation: The SSH server's `ssh2` module has gone through a major upgrade. Existing users will need to comment out two SSH KEX algorithms from their `config.hjson` if present else clients such as NetRunner will not be able to connect over SSH. Comment out `diffie-hellman-group-exchange-sha256` and `diffie-hellman-group-exchange-sha1`

View File

@ -9,6 +9,8 @@ This document attempts to track **major** changes and additions in ENiGMA½. For
* Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established. * Finally, the system will search for `index.html` and `index.htm` in that order, if another suitable route cannot be established.
* CombatNet has shut down, so the module (`combatnet.js`) has been removed. * CombatNet has shut down, so the module (`combatnet.js`) has been removed.
* The Menu Flag `popParent` has been removed and `noHistory` has been updated to work as expected. In general things should "Just Work", but check your `menu.hjson` entries if you see menu stack issues. * The Menu Flag `popParent` has been removed and `noHistory` has been updated to work as expected. In general things should "Just Work", but check your `menu.hjson` entries if you see menu stack issues.
* Various New User Application (NUA) properties are now optional. If you would like to reduce the information users are required, remove optional fields from NUA artwork and collect less. These properties will be stored as "" (empty). Optional properties are as follows: Real name, Birth date, Sex, Location, Affiliations (Affils), Email, and Web address.
* Art handling has been changed to respect the art width contained in SAUCE when present in the case where the terminal width is greater than the art width. This fixes art files that assume wrapping at 80 columns on wide (mostly new utf8) terminals.
## 0.0.13-beta ## 0.0.13-beta
* **Note for contributors**: ENiGMA has switched to [Prettier](https://prettier.io) for formatting/style. Please see [CONTRIBUTING](CONTRIBUTING.md) and the Prettier website for more information. * **Note for contributors**: ENiGMA has switched to [Prettier](https://prettier.io) for formatting/style. Please see [CONTRIBUTING](CONTRIBUTING.md) and the Prettier website for more information.

View File

@ -187,7 +187,7 @@
} }
mci: { mci: {
VM1: { VM1: {
height: 15, height: 14
width: 50 width: 50
itemFormat: "|00|11{userName:<17.17}|03{affils:<21.21}|11{location:<19.19}|03{lastLoginTs}" itemFormat: "|00|11{userName:<17.17}|03{affils:<21.21}|11{location:<19.19}|03{lastLoginTs}"
focusItemFormat: "|00|19|15{userName:<17.17}{affils:<21.21}{location:<19.19}{lastLoginTs}" focusItemFormat: "|00|19|15{userName:<17.17}{affils:<21.21}{location:<19.19}{lastLoginTs}"
@ -343,7 +343,7 @@
} }
mci: { mci: {
VM1: { VM1: {
height: 14 height: 13
width: 70 width: 70
itemFormat: "|00|15{msgNum:>4} |03{subject:<28.27} |11{fromUserName:<20.20} |03{ts:<15.16} |15{newIndicator}" itemFormat: "|00|15{msgNum:>4} |03{subject:<28.27} |11{fromUserName:<20.20} |03{ts:<15.16} |15{newIndicator}"
focusItemFormat: "|00|19|15{msgNum:>4} {subject:<28.27} {fromUserName:<20.20} {ts:<15.16} {newIndicator}" focusItemFormat: "|00|19|15{msgNum:>4} {subject:<28.27} {fromUserName:<20.20} {ts:<15.16} {newIndicator}"
@ -416,7 +416,7 @@
} }
mci: { mci: {
VM1: { VM1: {
height: 14 height: 12
width: 70 width: 70
itemFormat: "|00|15{msgNum:>4} |03{subject:<28.27} |11{fromUserName:<20.20} |03{ts} |15{newIndicator}" itemFormat: "|00|15{msgNum:>4} |03{subject:<28.27} |11{fromUserName:<20.20} |03{ts} |15{newIndicator}"
focusItemFormat: "|00|19|15{msgNum:>4} {subject:<28.27} {fromUserName:<20.20} {ts} {newIndicator}" focusItemFormat: "|00|19|15{msgNum:>4} {subject:<28.27} {fromUserName:<20.20} {ts} {newIndicator}"
@ -618,7 +618,7 @@
} }
mci: { mci: {
VM1: { VM1: {
height: 16 height: 12
width: 71 width: 71
itemFormat: "|00|15 {msgNum:<4.4} |03{subject:<34.33} {fromUserName:<19.18} |03{ts:<12.12}" itemFormat: "|00|15 {msgNum:<4.4} |03{subject:<34.33} {fromUserName:<19.18} |03{ts:<12.12}"
focusItemFormat: "|00|19> |15{msgNum:<4.4} {subject:<34.33} {fromUserName:<19.18} {ts:<12.12}" focusItemFormat: "|00|19> |15{msgNum:<4.4} {subject:<34.33} {fromUserName:<19.18} {ts:<12.12}"
@ -783,7 +783,7 @@
} }
mci: { mci: {
VM1: { VM1: {
height: 14 height: 12
width: 70 width: 70
itemFormat: "|00|15 {msgNum:<5.5}|03{subject:<28.27} |15{fromUserName:<20.20} {ts}" itemFormat: "|00|15 {msgNum:<5.5}|03{subject:<28.27} |15{fromUserName:<20.20} {ts}"
focusItemFormat: "|00|19> |15{msgNum:<5.5}{subject:<28.27} {fromUserName:<20.20} {ts}" focusItemFormat: "|00|19> |15{msgNum:<5.5}{subject:<28.27} {fromUserName:<20.20} {ts}"
@ -1214,7 +1214,7 @@
2: { 2: {
mci: { mci: {
MT1: { MT1: {
height: 14 height: 13
width: 45 width: 45
} }

View File

@ -505,9 +505,9 @@ class Achievements {
getFormatObject(info) { getFormatObject(info) {
return { return {
userName: info.user.username, userName: info.user.username,
userRealName: info.user.properties[UserProps.RealName], userRealName: info.user.realName(false) || 'N/A',
userLocation: info.user.properties[UserProps.Location], userLocation: info.user.properties[UserProps.Location] || 'N/A',
userAffils: info.user.properties[UserProps.Affiliations], userAffils: info.user.properties[UserProps.Affiliations] || 'N/A',
nodeId: info.client.node, nodeId: info.client.node,
title: info.details.title, title: info.details.title,
//text : info.global ? info.details.globalText : info.details.text, //text : info.global ? info.details.globalText : info.details.text,

View File

@ -24,7 +24,7 @@ function ANSIEscapeParser(options) {
this.graphicRendition = {}; this.graphicRendition = {};
this.parseState = { this.parseState = {
re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsu])/g, // eslint-disable-line no-control-regex re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsutEFGST])/g, // eslint-disable-line no-control-regex
}; };
options = miscUtil.valueWithDefault(options, { options = miscUtil.valueWithDefault(options, {
@ -37,6 +37,12 @@ function ANSIEscapeParser(options) {
this.mciReplaceChar = miscUtil.valueWithDefault(options.mciReplaceChar, ''); this.mciReplaceChar = miscUtil.valueWithDefault(options.mciReplaceChar, '');
this.termHeight = miscUtil.valueWithDefault(options.termHeight, 25); this.termHeight = miscUtil.valueWithDefault(options.termHeight, 25);
this.termWidth = miscUtil.valueWithDefault(options.termWidth, 80); this.termWidth = miscUtil.valueWithDefault(options.termWidth, 80);
this.breakWidth = this.termWidth;
// toNumber takes care of null, undefined etc as well.
let artWidth = _.toNumber(options.artWidth);
if(!(_.isNaN(artWidth)) && artWidth > 0 && artWidth < this.breakWidth) {
this.breakWidth = options.artWidth;
}
this.trailingLF = miscUtil.valueWithDefault(options.trailingLF, 'default'); this.trailingLF = miscUtil.valueWithDefault(options.trailingLF, 'default');
this.row = Math.min(options?.startRow ?? 1, this.termHeight); this.row = Math.min(options?.startRow ?? 1, this.termHeight);
@ -90,8 +96,8 @@ function ANSIEscapeParser(options) {
switch (charCode) { switch (charCode) {
case CR: case CR:
self.emit('literal', text.slice(start, pos)); self.emit('literal', text.slice(start, pos + 1));
start = pos; start = pos + 1;
self.column = 1; self.column = 1;
@ -105,8 +111,8 @@ function ANSIEscapeParser(options) {
self.column = 1; self.column = 1;
} }
self.emit('literal', text.slice(start, pos)); self.emit('literal', text.slice(start, pos + 1));
start = pos; start = pos + 1;
self.row += 1; self.row += 1;
@ -114,13 +120,16 @@ function ANSIEscapeParser(options) {
break; break;
default: default:
if (self.column === self.termWidth) { if (self.column === self.breakWidth) {
self.emit('literal', text.slice(start, pos + 1)); self.emit('literal', text.slice(start, pos + 1));
start = pos + 1; start = pos + 1;
// If we hit breakWidth before termWidth then we need to force the terminal to go to the next line.
if(self.column < self.termWidth) {
self.emit('literal', '\r\n');
}
self.column = 1; self.column = 1;
self.row += 1; self.row += 1;
self.positionUpdated(); self.positionUpdated();
} else { } else {
self.column += 1; self.column += 1;
@ -135,7 +144,7 @@ function ANSIEscapeParser(options) {
// //
// Finalize this chunk // Finalize this chunk
// //
if (self.column > self.termWidth) { if (self.column > self.breakWidth) {
self.column = 1; self.column = 1;
self.row += 1; self.row += 1;
@ -222,7 +231,7 @@ function ANSIEscapeParser(options) {
self.parseState = { self.parseState = {
// ignore anything past EOF marker, if any // ignore anything past EOF marker, if any
buffer: input.split(String.fromCharCode(0x1a), 1)[0], buffer: input.split(String.fromCharCode(0x1a), 1)[0],
re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsu])/g, // eslint-disable-line no-control-regex re: /(?:\x1b\x5b)([?=;0-9]*?)([ABCDHJKfhlmnpsutEFGST])/g, // eslint-disable-line no-control-regex
stop: false, stop: false,
}; };
}; };

View File

@ -41,11 +41,21 @@ const SUPPORTED_ART_TYPES = {
}; };
function getFontNameFromSAUCE(sauce) { function getFontNameFromSAUCE(sauce) {
if (sauce.Character) { if (sauce && sauce.Character) {
return sauce.Character.fontName; return sauce.Character.fontName;
} }
} }
function getWidthFromSAUCE(sauce) {
if (sauce && sauce.Character) {
let sauceWidth = _.toNumber(sauce.Character.characterWidth);
if(!(_.isNaN(sauceWidth)) && sauceWidth > 0) {
return sauceWidth;
}
}
return null;
}
function sliceAtEOF(data, eofMarker) { function sliceAtEOF(data, eofMarker) {
let eof = data.length; let eof = data.length;
const stopPos = Math.max(data.length - 256, 0); // 256 = 2 * sizeof(SAUCE) const stopPos = Math.max(data.length - 256, 0); // 256 = 2 * sizeof(SAUCE)
@ -274,6 +284,7 @@ function display(client, art, options, cb) {
mciReplaceChar: options.mciReplaceChar, mciReplaceChar: options.mciReplaceChar,
termHeight: client.term.termHeight, termHeight: client.term.termHeight,
termWidth: client.term.termWidth, termWidth: client.term.termWidth,
artWidth: getWidthFromSAUCE(options.sauce),
trailingLF: options.trailingLF, trailingLF: options.trailingLF,
startRow: options.startRow, startRow: options.startRow,
}); });

View File

@ -87,7 +87,7 @@ function getActiveConnectionList(
// //
entry.text = ac.user?.username || 'N/A'; entry.text = ac.user?.username || 'N/A';
entry.userName = ac.user?.username || 'N/A'; entry.userName = ac.user?.username || 'N/A';
entry.realName = ac.user?.getProperty(UserProps.RealName) || 'N/A'; entry.realName = ac.user?.realName(false) || 'N/A';
entry.location = ac.user?.getProperty(UserProps.Location) || 'N/A'; entry.location = ac.user?.getProperty(UserProps.Location) || 'N/A';
entry.affils = entry.affiliation = entry.affils = entry.affiliation =
ac.user?.getProperty(UserProps.Affiliations) || 'N/A'; ac.user?.getProperty(UserProps.Affiliations) || 'N/A';

View File

@ -188,22 +188,15 @@ module.exports = () => {
// //
// 1 - Generate a Private Key (PK): // 1 - Generate a Private Key (PK):
// Currently ENiGMA 1/2 requires a PKCS#1 PEM formatted PK. // Currently ENiGMA 1/2 requires a PKCS#1 PEM formatted PK.
// To generate a secure PK, issue the following command: // For information on generating a key, see:
// // https://nuskooler.github.io/enigma-bbs/servers/loginservers/ssh.html#generate-a-ssh-private-key
// > openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 \
// -pkeyopt rsa_keygen_pubexp:65537 | openssl rsa \
// -out ./config/security/ssh_private_key.pem -aes128
//
// (The above is a more modern equivalent of the following):
// > openssl genrsa -aes128 -out ./config/security/ssh_private_key.pem 2048
// //
// 2 - Set 'privateKeyPass' to the password you used in step #1 // 2 - Set 'privateKeyPass' to the password you used in step #1
// //
// 3 - Finally, set 'enabled' to 'true' // 3 - Finally, set 'enabled' to 'true'
// //
// Additional reading: // Additional reading:
// - https://blog.sleeplessbeastie.eu/2017/12/28/how-to-generate-private-key/ // - https://nuskooler.github.io/enigma-bbs/servers/loginservers/ssh.html
// - https://gist.github.com/briansmith/2ee42439923d8e65a266994d0f70180b
// //
privateKeyPem: paths.join( privateKeyPem: paths.join(
__dirname, __dirname,
@ -222,14 +215,18 @@ module.exports = () => {
// //
algorithms: { algorithms: {
kex: [ kex: [
'curve25519-sha256',
'curve25519-sha256@libssh.org',
'ecdh-sha2-nistp256', 'ecdh-sha2-nistp256',
'ecdh-sha2-nistp384', 'ecdh-sha2-nistp384',
'ecdh-sha2-nistp521', 'ecdh-sha2-nistp521',
'diffie-hellman-group14-sha1', 'diffie-hellman-group14-sha1',
'diffie-hellman-group1-sha1', 'diffie-hellman-group1-sha1',
// Group exchange not currnetly supported 'curve25519-sha256',
// 'diffie-hellman-group-exchange-sha256', 'curve25519-sha256@libssh.org',
// 'diffie-hellman-group-exchange-sha1', 'ecdh-sha2-nistp256',
'ecdh-sha2-nistp384',
'ecdh-sha2-nistp521',
], ],
cipher: [ cipher: [
'aes128-ctr', 'aes128-ctr',
@ -242,12 +239,7 @@ module.exports = () => {
'aes256-cbc', 'aes256-cbc',
'aes192-cbc', 'aes192-cbc',
'aes128-cbc', 'aes128-cbc',
'blowfish-cbc',
'3des-cbc', '3des-cbc',
'arcfour256',
'arcfour128',
'cast128-cbc',
'arcfour',
], ],
hmac: [ hmac: [
'hmac-sha2-256', 'hmac-sha2-256',

View File

@ -57,8 +57,10 @@ module.exports = class Door {
run(exeInfo, cb) { run(exeInfo, cb) {
this.encoding = (exeInfo.encoding || 'cp437').toLowerCase(); this.encoding = (exeInfo.encoding || 'cp437').toLowerCase();
if ('socket' === this.io && !this.sockServer) { if ('socket' === this.io) {
if(!this.sockServer) {
return cb(Errors.UnexpectedState('Socket server is not running')); return cb(Errors.UnexpectedState('Socket server is not running'));
}
} else if ('stdio' !== this.io) { } else if ('stdio' !== this.io) {
return cb(Errors.Invalid(`"${this.io}" is not a valid io type!`)); return cb(Errors.Invalid(`"${this.io}" is not a valid io type!`));
} }

View File

@ -167,6 +167,7 @@ exports.FullScreenEditorModule =
var newFocusViewId; var newFocusViewId;
if (errMsgView) { if (errMsgView) {
if (err) { if (err) {
errMsgView.clearText();
errMsgView.setText(err.message); errMsgView.setText(err.message);
if (MciViewIds.header.subject === err.view.getId()) { if (MciViewIds.header.subject === err.view.getId()) {
@ -183,6 +184,13 @@ exports.FullScreenEditorModule =
return cb(null); return cb(null);
}, },
editModeEscPressed: function (formData, extraArgs, cb) { editModeEscPressed: function (formData, extraArgs, cb) {
const errMsgView = self.viewControllers.header.getView(
MciViewIds.header.errorMsg
);
if (errMsgView) {
errMsgView.clearText();
}
self.footerMode = self.footerMode =
'editor' === self.footerMode ? 'editorMenu' : 'editor'; 'editor' === self.footerMode ? 'editorMenu' : 'editor';
@ -982,11 +990,7 @@ exports.FullScreenEditorModule =
const area = getMessageAreaByTag(self.messageAreaTag); const area = getMessageAreaByTag(self.messageAreaTag);
if (fromView !== undefined) { if (fromView !== undefined) {
if (area && area.realNames) { if (area && area.realNames) {
fromView.setText( fromView.setText(self.client.user.realName());
self.client.user.properties[
UserProps.RealName
] || self.client.user.username
);
} else { } else {
fromView.setText(self.client.user.username); fromView.setText(self.client.user.username);
} }
@ -1054,7 +1058,7 @@ exports.FullScreenEditorModule =
posView.setText( posView.setText(
_.padStart(String(pos.row + 1), 2, '0') + _.padStart(String(pos.row + 1), 2, '0') +
',' + ',' +
_.padEnd(String(pos.col + 1), 2, '0') _.padStart(String(pos.col + 1), 2, '0')
); );
this.client.term.rawWrite(ansi.restorePos()); this.client.term.rawWrite(ansi.restorePos());
} }

View File

@ -135,7 +135,7 @@ module.exports = class Address {
static fromString(addrStr) { static fromString(addrStr) {
const m = FTN_ADDRESS_REGEXP.exec(addrStr); const m = FTN_ADDRESS_REGEXP.exec(addrStr);
if (m) { if (m && m[2] && m[3]) {
// start with a 2D // start with a 2D
let addr = { let addr = {
net: parseInt(m[2]), net: parseInt(m[2]),

View File

@ -763,6 +763,11 @@ module.exports = class Message {
} }
persist(cb) { persist(cb) {
const containsNonWhitespaceCharacterRegEx = /\S/;
if (!containsNonWhitespaceCharacterRegEx.test(this.message)) {
return cb(Errors.Invalid('Empty message'));
}
if (!this.isValid()) { if (!this.isValid()) {
return cb(Errors.Invalid('Cannot persist invalid message!')); return cb(Errors.Invalid('Cannot persist invalid message!'));
} }

View File

@ -14,6 +14,39 @@ exports.moduleInfo = {
author: 'NuSkooler', author: 'NuSkooler',
}; };
const MciViewIds = {
header: {
from: 1,
to: 2,
subject: 3,
errorMsg: 4,
modTimestamp: 5,
msgNum: 6,
msgTotal: 7,
customRangeStart: 10, // 10+ = customs
},
body: {
message: 1,
},
// :TODO: quote builder MCIs - remove all magic #'s
// :TODO: consolidate all footer MCI's - remove all magic #'s
ViewModeFooter: {
MsgNum: 6,
MsgTotal: 7,
// :TODO: Just use custom ranges
},
quoteBuilder: {
quotedMsg: 1,
// 2 NYI
quoteLines: 3,
},
};
exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule { exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule {
constructor(options) { constructor(options) {
super(options); super(options);
@ -42,8 +75,15 @@ exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule {
], ],
function complete(err) { function complete(err) {
if (err) { if (err) {
// :TODO:... sooooo now what? const errMsgView = self.viewControllers.header.getView(
} else { MciViewIds.header.errorMsg
);
if (errMsgView) {
errMsgView.setText(err.message);
}
return cb(err);
}
// note: not logging 'from' here as it's part of client.log.xxxx() // note: not logging 'from' here as it's part of client.log.xxxx()
self.client.log.info( self.client.log.info(
{ {
@ -53,7 +93,6 @@ exports.getModule = class AreaPostFSEModule extends FullScreenEditorModule {
}, },
`User "${self.client.user.username}" posted message to "${msg.toUserName}" (${msg.areaTag})` `User "${self.client.user.username}" posted message to "${msg.toUserName}" (${msg.areaTag})`
); );
}
return self.nextMenu(cb); return self.nextMenu(cb);
} }

View File

@ -21,10 +21,7 @@ exports.getModule = class MyMessagesModule extends MenuModule {
initSequence() { initSequence() {
const filter = { const filter = {
toUserName: [ toUserName: [this.client.user.username, this.client.user.realName()],
this.client.user.username,
this.client.user.getProperty(UserProps.RealName),
],
sort: 'modTimestamp', sort: 'modTimestamp',
resultType: 'messageList', resultType: 'messageList',
limit: 1024 * 16, // we want some sort of limit... limit: 1024 * 16, // we want some sort of limit...

View File

@ -13,6 +13,7 @@ const UserProps = require('./user_property.js');
// deps // deps
const _ = require('lodash'); const _ = require('lodash');
const moment = require('moment');
exports.moduleInfo = { exports.moduleInfo = {
name: 'NUA', name: 'NUA',
@ -95,15 +96,15 @@ exports.getModule = class NewUserAppModule extends MenuModule {
areaTag = areaTag || ''; areaTag = areaTag || '';
newUser.properties = { newUser.properties = {
[UserProps.RealName]: formData.value.realName, [UserProps.RealName]: formData.value.realName || '',
[UserProps.Birthdate]: getISOTimestampString( [UserProps.Birthdate]: getISOTimestampString(
formData.value.birthdate formData.value.birthdate || moment()
), ),
[UserProps.Sex]: formData.value.sex, [UserProps.Sex]: formData.value.sex || '',
[UserProps.Location]: formData.value.location, [UserProps.Location]: formData.value.location || '',
[UserProps.Affiliations]: formData.value.affils, [UserProps.Affiliations]: formData.value.affils || '',
[UserProps.EmailAddress]: formData.value.email, [UserProps.EmailAddress]: formData.value.email || '',
[UserProps.WebAddress]: formData.value.web, [UserProps.WebAddress]: formData.value.web || '',
[UserProps.AccountCreated]: getISOTimestampString(), [UserProps.AccountCreated]: getISOTimestampString(),
[UserProps.MessageConfTag]: confTag, [UserProps.MessageConfTag]: confTag,

View File

@ -21,8 +21,10 @@ exports.validateEmailAvail = validateEmailAvail;
exports.validateBirthdate = validateBirthdate; exports.validateBirthdate = validateBirthdate;
exports.validatePasswordSpec = validatePasswordSpec; exports.validatePasswordSpec = validatePasswordSpec;
const emptyFieldError = () => new Error('Field cannot be empty');
function validateNonEmpty(data, cb) { function validateNonEmpty(data, cb) {
return cb(data && data.length > 0 ? null : new Error('Field cannot be empty')); return cb(data && data.length > 0 ? null : emptyFieldError);
} }
function validateMessageSubject(data, cb) { function validateMessageSubject(data, cb) {
@ -91,7 +93,11 @@ function validateGeneralMailAddressedTo(data, cb) {
// :TODO: remove hard-coded FTN check here. We need a decent way to register global supported flavors with modules. // :TODO: remove hard-coded FTN check here. We need a decent way to register global supported flavors with modules.
const addressedToInfo = getAddressedToInfo(data); const addressedToInfo = getAddressedToInfo(data);
if (Message.AddressFlavor.FTN === addressedToInfo.flavor) { if (addressedToInfo.name.length === 0) {
return cb(emptyFieldError());
}
if (Message.AddressFlavor.Local !== addressedToInfo.flavor) {
return cb(null); return cb(null);
} }

View File

@ -179,6 +179,10 @@ TextView.prototype.setText = function (text, redraw) {
}; };
TextView.prototype.clearText = function () { TextView.prototype.clearText = function () {
if (this.text) {
this.setText(this.fillChar.repeat(this.text.length));
}
this.setText(''); this.setText('');
}; };

View File

@ -124,12 +124,29 @@ module.exports = class User {
return isMember; return isMember;
} }
realName(withUsernameFallback = true) {
const realName = this.getProperty(UserProps.RealName);
if (realName) {
return realName;
}
if (withUsernameFallback) {
return this.username;
}
}
getSanitizedName(type = 'username') { getSanitizedName(type = 'username') {
const name = const name = 'real' === type ? this.realName(true) : this.username;
'real' === type ? this.getProperty(UserProps.RealName) : this.username;
return sanatizeFilename(name) || `user${this.userId.toString()}`; return sanatizeFilename(name) || `user${this.userId.toString()}`;
} }
emailAddress() {
const email = this.getProperty(UserProps.EmailAddress);
if (email) {
const realName = this.realName(false);
return realName ? `${realName} <${email}>` : email;
}
}
isAvailable() { isAvailable() {
return (this.statusFlags & User.StatusFlags.NotAvailable) == 0; return (this.statusFlags & User.StatusFlags.NotAvailable) == 0;
} }

View File

@ -93,9 +93,7 @@ module.exports = class User2FA_OTPWebRegister {
} }
const message = { const message = {
to: `${ to: user.emailAddress(),
user.getProperty(UserProps.RealName) || user.username
} <${user.getProperty(UserProps.EmailAddress)}>`,
// from will be filled in // from will be filled in
subject: '2-Factor Authentication Registration', subject: '2-Factor Authentication Registration',
text: textTemplate, text: textTemplate,

View File

@ -115,15 +115,15 @@ exports.getModule = class UserConfigModule extends MenuModule {
formData = _.clone(formData); formData = _.clone(formData);
const newProperties = { const newProperties = {
[UserProps.RealName]: formData.value.realName, [UserProps.RealName]: formData.value.realName || '',
[UserProps.Birthdate]: getISOTimestampString( [UserProps.Birthdate]: getISOTimestampString(
formData.value.birthdate formData.value.birthdate || moment()
), ),
[UserProps.Sex]: formData.value.sex, [UserProps.Sex]: formData.value.sex || '',
[UserProps.Location]: formData.value.location, [UserProps.Location]: formData.value.location || '',
[UserProps.Affiliations]: formData.value.affils, [UserProps.Affiliations]: formData.value.affils || '',
[UserProps.EmailAddress]: formData.value.email, [UserProps.EmailAddress]: formData.value.email || '',
[UserProps.WebAddress]: formData.value.web, [UserProps.WebAddress]: formData.value.web || '',
[UserProps.TermHeight]: formData.value.termHeight.toString(), [UserProps.TermHeight]: formData.value.termHeight.toString(),
[UserProps.ThemeId]: [UserProps.ThemeId]:
self.availThemeInfo[formData.value.theme].themeId, self.availThemeInfo[formData.value.theme].themeId,
@ -233,11 +233,7 @@ exports.getModule = class UserConfigModule extends MenuModule {
function populateViews(callback) { function populateViews(callback) {
const user = self.client.user; const user = self.client.user;
self.setViewText( self.setViewText('menu', MciCodeIds.RealName, user.realName(false) || '');
'menu',
MciCodeIds.RealName,
user.properties[UserProps.RealName]
);
self.setViewText( self.setViewText(
'menu', 'menu',
MciCodeIds.BirthDate, MciCodeIds.BirthDate,

View File

@ -143,9 +143,7 @@ class WebPasswordReset {
} }
const message = { const message = {
to: `${user.properties[UserProps.RealName] || user.username} <${ to: user.emailAddress(),
user.properties[UserProps.EmailAddress]
}>`,
// from will be filled in // from will be filled in
subject: 'Forgot Password', subject: 'Forgot Password',
text: textTemplate, text: textTemplate,

View File

@ -506,9 +506,7 @@ exports.getModule = class WaitingForCallerModule extends MenuModule {
// Current // Current
currentUserName: this.client.user.username, currentUserName: this.client.user.username,
currentUserRealName: currentUserRealName: this.client.user.realName(false) || 'N/A',
this.client.user.getProperty(UserProps.RealName) ||
this.client.user.username,
availIndicator: availIndicator, availIndicator: availIndicator,
visIndicator: visIndicator, visIndicator: visIndicator,
lastLoginUserName: lastLoginStats.userName, lastLoginUserName: lastLoginStats.userName,

View File

@ -1,4 +1,4 @@
FROM node:14-buster-slim FROM node:18-buster-slim
LABEL maintainer="dave@force9.org" LABEL maintainer="dave@force9.org"
@ -21,8 +21,10 @@ RUN apt-get update \
lhasa \ lhasa \
unrar-free \ unrar-free \
p7zip-full \ p7zip-full \
dos2unix \
&& npm install -g npm@latest \
&& npm install -g pm2 \ && npm install -g pm2 \
&& cd /enigma-bbs && npm install --only=production \ && cd /enigma-bbs && npm install \
&& pm2 start main.js \ && pm2 start main.js \
&& mkdir -p /enigma-bbs-pre/art \ && mkdir -p /enigma-bbs-pre/art \
&& mkdir /enigma-bbs-pre/mods \ && mkdir /enigma-bbs-pre/mods \
@ -37,6 +39,7 @@ RUN apt-get update \
# sexyz # sexyz
COPY docker/bin/sexyz /usr/local/bin COPY docker/bin/sexyz /usr/local/bin
RUN dos2unix /enigma-bbs/docker/bin/docker-entrypoint.sh && apt-get remove dos2unix -y
RUN chmod +x /enigma-bbs/docker/bin/docker-entrypoint.sh RUN chmod +x /enigma-bbs/docker/bin/docker-entrypoint.sh
# enigma storage mounts # enigma storage mounts

View File

@ -30,3 +30,4 @@ end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
gem "webrick"

View File

@ -6,8 +6,8 @@ GEM
i18n (>= 1.6, < 2) i18n (>= 1.6, < 2)
minitest (>= 5.1) minitest (>= 5.1)
tzinfo (~> 2.0) tzinfo (~> 2.0)
addressable (2.8.0) addressable (2.8.5)
public_suffix (>= 2.0.2, < 5.0) public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0) colorator (1.1.0)
concurrent-ruby (1.2.2) concurrent-ruby (1.2.2)
cssminify2 (2.0.1) cssminify2 (2.0.1)
@ -19,14 +19,14 @@ GEM
ffi (1.15.5) ffi (1.15.5)
forwardable-extended (2.6.0) forwardable-extended (2.6.0)
gemoji (3.0.1) gemoji (3.0.1)
html-pipeline (2.14.0) html-pipeline (2.14.3)
activesupport (>= 2) activesupport (>= 2)
nokogiri (>= 1.4) nokogiri (>= 1.4)
htmlcompressor (0.4.0) htmlcompressor (0.4.0)
http_parser.rb (0.8.0) http_parser.rb (0.8.0)
i18n (1.14.1) i18n (1.14.1)
concurrent-ruby (~> 1.0) concurrent-ruby (~> 1.0)
jekyll (4.2.1) jekyll (4.2.2)
addressable (~> 2.4) addressable (~> 2.4)
colorator (~> 1.0) colorator (~> 1.0)
em-websocket (~> 0.5) em-websocket (~> 0.5)
@ -49,7 +49,7 @@ GEM
uglifier (~> 4.1) uglifier (~> 4.1)
jekyll-relative-links (0.6.1) jekyll-relative-links (0.6.1)
jekyll (>= 3.3, < 5.0) jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (2.1.0) jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0) sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.7.1) jekyll-seo-tag (2.7.1)
jekyll (>= 3.8, < 5.0) jekyll (>= 3.8, < 5.0)
@ -64,30 +64,32 @@ GEM
gemoji (~> 3.0) gemoji (~> 3.0)
html-pipeline (~> 2.2) html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0) jekyll (>= 3.0, < 5.0)
json (2.6.1) json (2.6.3)
json-minify (0.0.3) json-minify (0.0.3)
json (> 0) json (> 0)
kramdown (2.3.1) kramdown (2.4.0)
rexml rexml
kramdown-parser-gfm (1.1.0) kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0) kramdown (~> 2.0)
liquid (4.0.3) liquid (4.0.4)
listen (3.7.1) listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3) rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10) rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0) mercenary (0.4.0)
minitest (5.19.0) minitest (5.19.0)
nokogiri (1.14.3-x86_64-linux) nokogiri (1.15.4-aarch64-linux)
racc (~> 1.4)
nokogiri (1.15.4-x86_64-linux)
racc (~> 1.4) racc (~> 1.4)
pathutil (0.16.2) pathutil (0.16.2)
forwardable-extended (~> 2.6) forwardable-extended (~> 2.6)
public_suffix (4.0.6) public_suffix (5.0.3)
racc (1.6.2) racc (1.7.1)
rb-fsevent (0.11.0) rb-fsevent (0.11.2)
rb-inotify (0.10.1) rb-inotify (0.10.1)
ffi (~> 1.0) ffi (~> 1.0)
rexml (3.2.5) rexml (3.2.6)
rouge (3.28.0) rouge (3.30.0)
safe_yaml (1.0.5) safe_yaml (1.0.5)
sassc (2.4.0) sassc (2.4.0)
ffi (~> 1.9) ffi (~> 1.9)
@ -98,8 +100,10 @@ GEM
uglifier (4.2.0) uglifier (4.2.0)
execjs (>= 0.3.0, < 3) execjs (>= 0.3.0, < 3)
unicode-display_width (1.8.0) unicode-display_width (1.8.0)
webrick (1.8.1)
PLATFORMS PLATFORMS
aarch64-linux
x86_64-linux x86_64-linux
DEPENDENCIES DEPENDENCIES
@ -111,6 +115,7 @@ DEPENDENCIES
jekyll-theme-hacker (~> 0.2.0) jekyll-theme-hacker (~> 0.2.0)
jemoji (~> 0.12.0) jemoji (~> 0.12.0)
tzinfo-data tzinfo-data
webrick
BUNDLED WITH BUNDLED WITH
2.3.5 2.4.19

View File

@ -54,6 +54,7 @@ collections:
- installation/network.md - installation/network.md
- installation/testing.md - installation/testing.md
- installation/production.md - installation/production.md
- installation/development.md
- configuration/creating-config.md - configuration/creating-config.md
- configuration/sysop-setup.md - configuration/sysop-setup.md
- configuration/config-files.md - configuration/config-files.md
@ -130,4 +131,5 @@ collections:
- admin/oputil.md - admin/oputil.md
- admin/updating.md - admin/updating.md
- troubleshooting/monitoring-logs.md - troubleshooting/monitoring-logs.md
- troubleshooting/ssh-troubleshooting.md

View File

@ -3,7 +3,7 @@ layout: page
title: TIC Support title: TIC Support
--- ---
## TIC Support ## TIC Support
ENiGMA½ supports FidoNet-Style TIC file attachments by mapping TIC areas to local file areas. ENiGMA½ supports FidoNet-Style TIC file attachments by mapping external TIC area tags to local file areas.
Under a given node defined in the `ftn_bso` config section in `config.hjson` (see Under a given node defined in the `ftn_bso` config section in `config.hjson` (see
[BSO Import/Export](../messageareas/bso-import-export.md)), TIC configuration may be supplied: [BSO Import/Export](../messageareas/bso-import-export.md)), TIC configuration may be supplied:
@ -17,9 +17,9 @@ Under a given node defined in the `ftn_bso` config section in `config.hjson` (se
packetPassword: mypass packetPassword: mypass
encoding: cp437 encoding: cp437
archiveType: zip archiveType: zip
tic: { tic: { // <--- General TIC config for 46:*
password: TESTY-TEST password: TESTY-TEST
uploadBy: Agoranet TIC uploadBy: AgoraNet TIC
allowReplace: true allowReplace: true
} }
} }
@ -29,7 +29,15 @@ Under a given node defined in the `ftn_bso` config section in `config.hjson` (se
} }
``` ```
You then need to configure the mapping between TIC areas you want to carry, and the file base area and storage tag for them to be tossed to. Optionally you can also add hashtags to the tossed files to assist users in searching for files: Valid `tic` members:
| Item | Required | Description |
|--------|---------------|------------------|
| `password` | :-1: | TIC packet password, if required |
| `uploadedBy` | :-1: | Sets the "uploaded by" field for TIC attachments, for example "AgoraNet TIC" |
| `allowReplace` | :-1: | Set to `true` to allow TIC attachments to replace each other. This is especially handy for things like weekly node list attachments |
Next, we need to configure the mapping between TIC areas you want to carry, and the file base area (and, optionally, specific storage tag) for them to be tossed to. You can also add hashtags to the tossed files to assist users in searching for files:
```hjson ```hjson
ticAreas: { ticAreas: {
@ -41,10 +49,22 @@ ticAreas: {
} }
``` ```
Multiple TIC areas can be mapped to a single file base area.
> :information_source: Note that in the example above `agn_node` represents the **external** network area tag, usually represented in all caps. In this case, `AGN_NODE`.
Valid `ticAreas` members under a given node mapping are as follows:
| Item | Required | Description |
|--------|---------------|------------------|
| `areaTag` | :+1: | Specifies the local areaTag in which to place TIC attachments |
| `storageTag` | :-1: | Optionally, set a specific storageTag. If not set, the default for this area will be used. |
| `hashTags` | :-1: | One or more optional hash tags to assign TIC attachments in this area. |
💡 Multiple TIC areas can be mapped to a single file base area.
### Example Configuration ### Example Configuration
An example configuration linking file base areas, FTN BSO node configuration and TIC area configuration. Example configuration fragments mapping file base areas, FTN BSO node configuration and TIC area configuration.
```hjson ```hjson
fileBase: { fileBase: {
@ -79,11 +99,9 @@ scannerTossers: {
} }
} }
} }
}
}
ticAreas: {
ticAreas: { // here we map AgoraNet AGN_NODE -> local msgNetworks file area
agn_node: { agn_node: {
areaTag: msgNetworks areaTag: msgNetworks
storageTag: msg_network storageTag: msg_network
@ -94,7 +112,11 @@ ticAreas: {
storageTag: msg_network storageTag: msg_network
hashTags: agoranet,infopack hashTags: agoranet,infopack
} }
}
}
} }
``` ```
## See Also ## See Also

View File

@ -0,0 +1,38 @@
---
layout: page
title: Development Environment Setup
---
_Note:_ This is only useful for people who are looking to contribute to the ENiGMA½ source base itself. Those that are just setting up a new BBS system do not need this section.
The easiest way to get started with development on ENiGMA½ is via the pre-configured Visual Studio Code remote docker container environment. This setup will download and configure everything needed with minimal interaction. It also works cross-platform.
* Install [Visual Studio Code](https://code.visualstudio.com/download)
* Install [Docker](https://docs.docker.com/engine/install/)
* Clone the [ENiGMA½](https://github.com/NuSkooler/enigma-bbs) repository.
* Choose "Open Folder" from Visual Studio Code and open the location where you cloned the repository.
That's it! Visual Studio Code should prompt you for everything else that is needed, including some useful extensions for development.
## Tasks
Once it completes, there are a few tasks and run-configs that are useful. Open up the command pallete and search/choose "Tasks> Run Task". From there you can run the following tasks:
### Start Jekyll (ENiGMA½ documentation server)
This task will start the Jekyll server to perform local testing of changes to documentation. After running this task, open a browser to (http://localhost:4000/enigma-bbs/) to see the documentation.
### (re)build Jekyll bundles
When the image is created the Jekyll bundles are installed, so in general there shouldn't be much need to run this task. This is available however in case soemthing goes wrong or you are working on the Jekyll setup itself.
### (re)build node modules
Used to re-generate the node modules. Generally shouldn't be necessary unless something is broken or you are adding/changing versions of dependencies.
### ENiGMA½ new configuration
This task executes `oputil.js` in order to create a new BBS configuration (useful if you have just checked out the code and haven't setup any configuration yet.)
## Run / Debug config
There is also a default "Launch Program" config (hotkey access via F5 / Ctrl-Shift-D.) This will launch ENiGMA½. Once it has launched, access the system via telnet, port 8888 as usual.

View File

@ -71,5 +71,9 @@ Customising the Docker image is easy!
1. Clone the ENiGMA-BBS source. 1. Clone the ENiGMA-BBS source.
2. Build the image 2. Build the image
```bash ```bash
docker build -f ./docker/Dockerfile . docker build -t enigmabbs -f ./docker/Dockerfile .
```
3. Run the image
```bash
docker run -it -p 8888:8888 --name "ENiGMABBS" -v "$(pwd)/config:/enigma-bbs/config" -v "$(pwd)/db:/enigma-bbs/db" -v "$(pwd)/logs:/enigma-bbs/logs" -v "$(pwd)/filebase:/enigma-bbs/filebase" -v "$(pwd)/art:/enigma-bbs/art" -v "$(pwd)/mods:/enigma-bbs/mods" -v "$(pwd)/mail:/mail" enigmabbs
``` ```

View File

@ -3,9 +3,13 @@ layout: page
title: SSH Server title: SSH Server
--- ---
## SSH Login Server ## SSH Login Server
The ENiGMA½ SSH *login server* allows secure user logins over SSH (ssh://). The ENiGMA½ SSH *login server* allows secure user logins over SSH (ssh://).
*Note:* If you run into any troubles during SSH setup, please see [Troubleshooting SSH](../../troubleshooting/ssh-troubleshooting.md)
## Configuration ## Configuration
Entries available under `config.loginServers.ssh`: Entries available under `config.loginServers.ssh`:
| Item | Required | Description | | Item | Required | Description |
@ -20,10 +24,8 @@ Entries available under `config.loginServers.ssh`:
| `algorithms` | :-1: | Configuration block for SSH algorithms. Includes keys of `kex`, `cipher`, `hmac`, and `compress`. See the algorithms section in the [ssh2-streams](https://github.com/mscdex/ssh2-streams#ssh2stream-methods) documentation for details. For defaults set by ENiGMA½, see `core/config_default.js`. | `algorithms` | :-1: | Configuration block for SSH algorithms. Includes keys of `kex`, `cipher`, `hmac`, and `compress`. See the algorithms section in the [ssh2-streams](https://github.com/mscdex/ssh2-streams#ssh2stream-methods) documentation for details. For defaults set by ENiGMA½, see `core/config_default.js`.
| `traceConnections` | :-1: | Set to `true` to enable full trace-level information on SSH connections. | `traceConnections` | :-1: | Set to `true` to enable full trace-level information on SSH connections.
* *IMPORTANT* With the `privateKeyPass` option set, make sure that you verify that the config file is not readable by other users! * *IMPORTANT* With the `privateKeyPass` option set, make sure that you verify that the config file is not readable by other users!
### Example Configuration ### Example Configuration
```hjson ```hjson
@ -40,42 +42,93 @@ Entries available under `config.loginServers.ssh`:
``` ```
## Generate a SSH Private Key ## Generate a SSH Private Key
To utilize the SSH server, an SSH Private Key (PK) will need generated. OpenSSH or (with some versions) OpenSSL can be used for this task: To utilize the SSH server, an SSH Private Key (PK) will need generated. OpenSSH or (with some versions) OpenSSL can be used for this task:
### OpenSSH ### OpenSSH (Preferred)
```bash #### OpenSSH Install - Linux / Mac
ssh-keygen -m PEM -h -f config/ssh_private_key.pem
If it is not already available, install OpenSSH using the package manager of your choice (should be pre-installed on most distributions.)
#### Running OpenSSH - Linux / Mac
From the root directory of the Enigma BBS, run the following:
```shell
mkdir -p config/security
ssh-keygen -t rsa -m PEM -h -f config/security/ssh_private_key.pem
``` ```
#### Windows Install - OpenSSH
OpenSSH may already be installed, try running `ssh-keygen.exe`. If not, see this page: [Install OpenSSH for Windows](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui)
#### Running OpenSSH - Windows
After installation, go to the root directory of your enigma project and run:
```powershell
mkdir .\config\security -ErrorAction SilentlyContinue
ssh-keygen.exe -t rsa -m PEM -h -f .\config\security\ssh_private_key.pem
```
#### ssh-keygen options
Option descriptions: Option descriptions:
| Option | Description | | Option | Description |
|------|-------------| |------|-------------|
| `-t rsa` | Use the RSA algorithm needed for the `ssh2` library |
| `-m PEM` | Set the output format to `PEM`, compatible with the `ssh2` library | | `-m PEM` | Set the output format to `PEM`, compatible with the `ssh2` library |
| `-h` | Generate a host key | | `-h` | Generate a host key |
| `-f config/ssh_private_key.pem` | Filename for the private key. Used in the `privateKeyPem` option in the configuration | | `-f config/ssh_private_key.pem` | Filename for the private key. Used in the `privateKeyPem` option in the configuration |
When you execute the `ssh-keygen` command it will ask for a passphrase (and a confirmation.) This should then be used as the value for `privateKeyPass` in the configuration. When you execute the `ssh-keygen` command it will ask for a passphrase (and a confirmation.) This should then be used as the value for `privateKeyPass` in the configuration.
### OpenSSL ### OpenSSL
If you do not have OpenSSH installed or if you have trouble with the above OpenSSH commands, using some versions for OpenSSL (before version 3) the following commands may work as well: #### Open SSL Install - Linux / Mac
If not already installed, install via the `openssl` package on most package managers.
```bash #### Open SSL Install - Windows
openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -pkeyopt rsa_keygen_pubexp:65537 | openssl rsa -out ./config/ssh_private_key.pem -aes128
```powershell
winget install -e --id ShiningLight.OpenSSL
``` ```
Or for even older OpenSSL versions: #### Running OpenSSL
```bash *Note:* Using `ssh-keygen` from OpenSSL is recommended where possible. If you have trouble with the above OpenSSH commands, using some versions for OpenSSL (before version 3) the following commands may work as well:
#### Running OpenSSL - Linux / Mac
Run the following from the root directory of Enigma
```shell
mkdir -p config/security
openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -pkeyopt rsa_keygen_pubexp:65537 | openssl rsa -out ./config/security/ssh_private_key.pem -aes128
```
#### Running OpenSSL - Windows
Run the following from the root directory of Enigma (note: you may need to specify the full path to openssl.exe if it isn't in your system path, on my system it was `C:\Program Files\OpenSSL-Win64\bin\openssl.exe`):
```powershell
mkdir .\config\security -ErrorAction SilentlyContinue
openssl.exe genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -pkeyopt rsa_keygen_pubexp:65537 | openssl.exe rsa -out ./config/security/ssh_private_key.pem -aes128
```
#### Running Older OpenSSL
For older OpenSSL versions, the following command has been known to work:
```shell
openssl genrsa -aes128 -out ./config/ssh_private_key.pem 2048 openssl genrsa -aes128 -out ./config/ssh_private_key.pem 2048
``` ```
Note that you may need `-3des` for very old implementations or SSH clients! *Note:* that you may need `-3des` for very old implementations or SSH clients!
## Prompt ## Prompt

View File

@ -0,0 +1,45 @@
---
layout: page
title: Troubleshooting SSH
---
Stuck with errors trying to get your SSH setup configured? See below for some common problems. Or as always, reach out to us by creating an [Issue](https://github.com/NuSkooler/enigma-bbs/issues) or start a [Discussion](https://github.com/NuSkooler/enigma-bbs/discussions)
## No Such File or Directory
***Symptom:***
BBS not starting with an error similar to the following:
```shell
Error initializing: Error: ENOENT: no such file or directory, open '<path>/config/security/ssh_private_key.pem'
```
***Solution:***
Several things can cause this:
1. `ssh_private_key.pem` was installed to the wrong location. Make sure that it is in the `config/security` directory and has the name matching the error message. You can also change your `config.hjson` if you prefer to point to the location of the key file.
2. `ssh_private_key.pem` has the wrong file permissions. Verify that the file will be readable by the user that the BBS is running as. Because it is a cryptographic key however, we do recommend that access is restricted only to that user.
## Error With Netrunner
***Symptom:***
Some ssh clients connect, but Netrunner (and other older clients) get a connection failed message and the following is in the log:
```shell
"level":40,"error":"Handshake failed","code":2,"msg":"SSH connection error"
```
***Solution:***
The key was most likely not generated with the `-t rsa` option, and is using a newer algorithm that is not supported by Netrunner and similar clients. Regenerate the certificate with the `-t rsa` option.
***Symptom:***
Some ssh clients connect, but Netrunner (and other older clients) get a connection failed message and the following is in the log:
```shell
"level":40,"error":"Group exchange not implemented for server","msg":"SSH connection error"
```
***Solution:***
Remove the following encryption protocols from your `config.hjson`: `diffie-hellman-group-exchange-sha256` and `diffie-hellman-group-exchange-sha1`

View File

@ -69,7 +69,7 @@
} }
] ]
} }
actionKeys: @reference: common.escToPrev actionKeys: @reference:common.escToPrev
} }
1: { 1: {
mci: { mci: {

View File

@ -59,8 +59,8 @@
"sanitize-filename": "^1.6.3", "sanitize-filename": "^1.6.3",
"sqlite3": "5.1.6", "sqlite3": "5.1.6",
"sqlite3-trans": "1.3.0", "sqlite3-trans": "1.3.0",
"ssh2": "1.11.0", "ssh2": "1.14.0",
"systeminformation": "5.12.3", "systeminformation": "5.21.7",
"telnet-socket": "0.2.4", "telnet-socket": "0.2.4",
"temptmp": "^1.1.0", "temptmp": "^1.1.0",
"uuid": "8.3.2", "uuid": "8.3.2",

View File

@ -233,7 +233,7 @@ array-uniq@^1.0.1:
resolved "https://registry.yarnpkg.com/array-uniq/-/array-uniq-1.0.3.tgz#af6ac877a25cc7f74e058894753858dfdb24fdb6" resolved "https://registry.yarnpkg.com/array-uniq/-/array-uniq-1.0.3.tgz#af6ac877a25cc7f74e058894753858dfdb24fdb6"
integrity sha512-MNha4BWQ6JbwhFhj03YK552f7cb3AzoE8SzeljgChvL1dl3IcvggXVz1DilzySZkCja+CXuZbdW7yATchWn8/Q== integrity sha512-MNha4BWQ6JbwhFhj03YK552f7cb3AzoE8SzeljgChvL1dl3IcvggXVz1DilzySZkCja+CXuZbdW7yATchWn8/Q==
asn1@^0.2.4: asn1@^0.2.6:
version "0.2.6" version "0.2.6"
resolved "https://registry.yarnpkg.com/asn1/-/asn1-0.2.6.tgz#0d3a7bb6e64e02a90c0303b31f292868ea09a08d" resolved "https://registry.yarnpkg.com/asn1/-/asn1-0.2.6.tgz#0d3a7bb6e64e02a90c0303b31f292868ea09a08d"
integrity sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ== integrity sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ==
@ -455,7 +455,7 @@ console-control-strings@^1.0.0, console-control-strings@^1.1.0:
resolved "https://registry.yarnpkg.com/console-control-strings/-/console-control-strings-1.1.0.tgz#3d7cf4464db6446ea644bf4b39507f9851008e8e" resolved "https://registry.yarnpkg.com/console-control-strings/-/console-control-strings-1.1.0.tgz#3d7cf4464db6446ea644bf4b39507f9851008e8e"
integrity sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ== integrity sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==
cpu-features@~0.0.4: cpu-features@~0.0.8:
version "0.0.9" version "0.0.9"
resolved "https://registry.yarnpkg.com/cpu-features/-/cpu-features-0.0.9.tgz#5226b92f0f1c63122b0a3eb84cb8335a4de499fc" resolved "https://registry.yarnpkg.com/cpu-features/-/cpu-features-0.0.9.tgz#5226b92f0f1c63122b0a3eb84cb8335a4de499fc"
integrity sha512-AKjgn2rP2yJyfbepsmLfiYcmtNn/2eUvocUyM/09yB0YDiz39HteK/5/T4Onf0pmdYDMgkBoGvRLvEguzyL7wQ== integrity sha512-AKjgn2rP2yJyfbepsmLfiYcmtNn/2eUvocUyM/09yB0YDiz39HteK/5/T4Onf0pmdYDMgkBoGvRLvEguzyL7wQ==
@ -1468,7 +1468,7 @@ mv@~2:
ncp "~2.0.0" ncp "~2.0.0"
rimraf "~2.4.0" rimraf "~2.4.0"
nan@^2.14.0, nan@^2.16.0, nan@^2.17.0: nan@^2.14.0, nan@^2.17.0:
version "2.18.0" version "2.18.0"
resolved "https://registry.yarnpkg.com/nan/-/nan-2.18.0.tgz#26a6faae7ffbeb293a39660e88a76b82e30b7554" resolved "https://registry.yarnpkg.com/nan/-/nan-2.18.0.tgz#26a6faae7ffbeb293a39660e88a76b82e30b7554"
integrity sha512-W7tfG7vMOGtD30sHoZSSc/JVYiyDPEyQVso/Zz+/uQd0B0L46gtC+pHha5FFMRpil6fm/AoEcRWyOVi4+E/f8w== integrity sha512-W7tfG7vMOGtD30sHoZSSc/JVYiyDPEyQVso/Zz+/uQd0B0L46gtC+pHha5FFMRpil6fm/AoEcRWyOVi4+E/f8w==
@ -1986,16 +1986,16 @@ sqlite3@5.1.6:
optionalDependencies: optionalDependencies:
node-gyp "8.x" node-gyp "8.x"
ssh2@1.11.0: ssh2@1.14.0:
version "1.11.0" version "1.14.0"
resolved "https://registry.yarnpkg.com/ssh2/-/ssh2-1.11.0.tgz#ce60186216971e12f6deb553dcf82322498fe2e4" resolved "https://registry.yarnpkg.com/ssh2/-/ssh2-1.14.0.tgz#8f68440e1b768b66942c9e4e4620b2725b3555bb"
integrity sha512-nfg0wZWGSsfUe/IBJkXVll3PEZ//YH2guww+mP88gTpuSU4FtZN7zu9JoeTGOyCNx2dTDtT9fOpWwlzyj4uOOw== integrity sha512-AqzD1UCqit8tbOKoj6ztDDi1ffJZ2rV2SwlgrVVrHPkV5vWqGJOVp5pmtj18PunkPJAuKQsnInyKV+/Nb2bUnA==
dependencies: dependencies:
asn1 "^0.2.4" asn1 "^0.2.6"
bcrypt-pbkdf "^1.0.2" bcrypt-pbkdf "^1.0.2"
optionalDependencies: optionalDependencies:
cpu-features "~0.0.4" cpu-features "~0.0.8"
nan "^2.16.0" nan "^2.17.0"
ssri@^8.0.0, ssri@^8.0.1: ssri@^8.0.0, ssri@^8.0.1:
version "8.0.1" version "8.0.1"
@ -2044,10 +2044,10 @@ supports-color@^7.1.0:
dependencies: dependencies:
has-flag "^4.0.0" has-flag "^4.0.0"
systeminformation@5.12.3: systeminformation@5.21.7:
version "5.12.3" version "5.21.7"
resolved "https://registry.yarnpkg.com/systeminformation/-/systeminformation-5.12.3.tgz#1e6dc99070ace7d88b6a1dd465f4f3ce7d63901a" resolved "https://registry.yarnpkg.com/systeminformation/-/systeminformation-5.21.7.tgz#53ef75daaf5d756d015f4bb02e059126ccac74f2"
integrity sha512-aPyTDzK/VjEheGEODprxFTMahIWTHGyWXxTsh9EOHjeekVltrIWrle4dOZouOlOYgtKM1pDoHkrR+IssgYCK/A== integrity sha512-K3LjnajrazTLTD61+87DFg8IXFk5ljx6nSBqB8pQLtC1UPivAjDtTYGPZ8jaBFxcesPaCOkvLRtBq+RFscrsLw==
tar@^6.0.2, tar@^6.1.11, tar@^6.1.2: tar@^6.0.2, tar@^6.1.11, tar@^6.1.2:
version "6.2.0" version "6.2.0"