diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 0ff81520..f2e315ce 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
+ - name: Question
+ url: https://github.com/Ylianst/MeshCentral/discussions
+ about: Ask a question in discussions.
- name: Unofficial Discord Server
url: https://discord.gg/8wHC6ASWAc
about: Please ask here for support questions.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
deleted file mode 100644
index e0de813e..00000000
--- a/.github/ISSUE_TEMPLATE/question.md
+++ /dev/null
@@ -1,68 +0,0 @@
----
-name: Question
-about: Create a question for community help
-title: ''
-labels: question
-assignees: ''
-
----
-
-**Describe your issue**
-A clear and concise description of what your issue is.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Server Software (please complete the following information):**
- - OS: [e.g. Ubuntu]
- - Virtualization: [e.g. Docker]
- - Network: [e.g. LAN/WAN, reverse proxy, cloudflare, ssl offload, etc...]
- - Version: [e.g. 1.0.43]
- - Node: [e.g. 18.4.0]
-
-**Client Device (please complete the following information):**
- - Device: [e.g. Laptop]
- - OS: [e.g. Ubuntu]
- - Network: [e.g. Local to Meshcentral, Remote over WAN]
- - Browser: [e.g. Google Chrome]
- - MeshCentralRouter Version: [if applicable]
-
-**Remote Device (please complete the following information):**
- - Device: [e.g. Laptop]
- - OS: [e.g. Windows 10 21H2]
- - Network: [e.g. Local to Meshcentral, Remote over WAN]
- - Current Core Version (if known): [**HINT**: Go to a device then `console` Tab then type `info`]
-
-**Your config.json file**
-```
-{
- "$schema": "https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json",
- "__comment1__": "This is a simple configuration file, all values and sections that start with underscore (_) are ignored. Edit a section and remove the _ in front of the name. Refer to the user's guide for details.",
- "__comment2__": "See node_modules/meshcentral/sample-config-advanced.json for a more advanced example.",
- "settings": {
- "_cert": "myserver.mydomain.com",
- "_WANonly": true,
- "_LANonly": true,
- "_sessionKey": "MyReallySecretPassword1",
- "_port": 443,
- "_aliasPort": 443,
- "_redirPort": 80,
- "_redirAliasPort": 80
- },
- "domains": {
- "": {
- "_title": "MyServer",
- "_title2": "Servername",
- "_minify": true,
- "_newAccounts": true,
- "_userNameIsEmail": true
- }
- },
- "_letsencrypt": {
- "__comment__": "Requires NodeJS 8.x or better, Go to https://letsdebug.net/ first before trying Let's Encrypt.",
- "email": "myemail@mydomain.com",
- "names": "myserver.mydomain.com",
- "production": false
- }
-}
-```
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index c8b3dd93..d5a2c9f6 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -13,7 +13,7 @@ jobs:
steps:
- name: Checkout repository
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
@@ -26,7 +26,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
- uses: github/codeql-action/init@v1
+ uses: github/codeql-action/init@v2
# Override language selection by uncommenting this and choosing your languages
# with:
# languages: go, javascript, csharp, python, cpp, java
@@ -48,4 +48,4 @@ jobs:
# make release
- name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@v1
+ uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index f4bae68d..f2127064 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -14,8 +14,8 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-python@v2
+ - uses: actions/checkout@v4
+ - uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install --upgrade pip
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index bb6978c1..e4bafe94 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -1,49 +1,60 @@
name: Docker
on:
+ push:
+ branches:
+ - master
release:
types: [published]
+
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
+
jobs:
check-token:
runs-on: ubuntu-latest
outputs:
- token: ${{ steps.token.outputs.defined }}
+ token_defined: ${{ steps.token_check.outputs.token_defined }}
steps:
- - id: token
+ - name: Check token
+ id: token_check
env:
- MY_TOKEN: ${{ secrets.MY_TOKEN }}
+ MY_TOKEN: ${{ secrets.MY_TOKEN }}
if: "${{ env.MY_TOKEN != '' }}"
- run: echo "::set-output name=defined::true"
+ run: echo "token_defined=true" >> "$GITHUB_OUTPUT"
build:
name: Release
runs-on: ubuntu-latest
needs: [check-token]
- if: needs.check-token.outputs.token == 'true'
+ if: needs.check-token.outputs.token_defined == 'true'
steps:
- name: Checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
with:
fetch-depth: 0
+
- name: Set up QEMU
- uses: docker/setup-qemu-action@v2
+ uses: docker/setup-qemu-action@v3
+
- name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v2
+ uses: docker/setup-buildx-action@v3
+
- name: Log in to the Container registry
- uses: docker/login-action@v2
+ uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.MY_TOKEN }}
+
- name: Extract metadata (tags, labels) for Docker
id: meta
- uses: docker/metadata-action@v4
+ uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
- name: Build and push Docker image
- uses: docker/build-push-action@v3
+ uses: docker/build-push-action@v5
with:
context: .
file: docker/Dockerfile
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index eef13cd0..acf16409 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -3,6 +3,8 @@ on:
push:
branches:
- master
+ paths:
+ - 'package.json'
jobs:
build:
@@ -10,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Release
diff --git a/.gitignore b/.gitignore
index 31e27dc4..e2031237 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,12 +10,12 @@
[Aa]gents/meshcore.min.js
[Pp]ublic/translations/
[Vv]iews/translations/
+[Ee]mails/translations/
[Pp]ublic/*-min.htm
[Vv]iews/*-min.handlebars
meshcentral.db
meshcentral.db.json
mesherrors.txt
-package-lock.json
bob.json
.greenlockrc
diff --git a/LICENSE b/LICENSE
index cf8faf5a..85c3dcae 100644
--- a/LICENSE
+++ b/LICENSE
@@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.
- Copyright 2017-2021 Intel Corporation
+ Copyright 2017-2025 Intel Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
diff --git a/MeshCentralServer.njsproj b/MeshCentralServer.njsproj
index b4f4a7c6..f5b9d0de 100644
--- a/MeshCentralServer.njsproj
+++ b/MeshCentralServer.njsproj
@@ -241,7 +241,6 @@
-
@@ -441,7 +440,6 @@
-
@@ -596,12 +594,14 @@
+
+
@@ -718,6 +718,7 @@
+
@@ -764,6 +765,7 @@
+
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..57790a24
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,49 @@
+# Security Policy
+
+## Supported Versions
+
+Any version of MeshCentral 1.x.x is supported.
+
+| Version | Supported |
+| ------- | ------------------ |
+| 1.x.x | :white_check_mark: |
+| < 1.0 | :x: |
+
+## Reporting a Vulnerability
+
+Please report any concerns or security issue to Ylian Saint-Hilaire (ylianst@gmail.com). If needed, use my PGP key below.
+
+```
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: BCPG v1.56
+
+mQMuBF2gC4sRCAClFNvMCCVW3ego3UHBQ6LhSenJfaZYhvn8gaGuemSQxqTI6bla
+BTAv3aMtQnvqlSuadMMegb+FO6hnaQMlGvpVA1qpkSzgrPS5HrBD3H33J2Nj3i93
+ZpDPpxdI0ehCj6IJPnl0GxGbpKIN8YpJUFl44wv1lMRFI1lgyb+dCoO60irYdNQB
+PV85BI+DwPfOBFHunwR78nqMvpvsk9HaeHjEP7oXr952/7EazUowZsMlEfkYnw5S
++tLfpCoY3QWkektpJP40nMJSKQdV2NEuED99doA0X+7P1vsvFFFyMH69dnU2uSay
+XCHpkAbntBy0BGmtF1RnTcOMv2V/LPXnlMdvAQCbmLQzNra3r163tcdRY0jSs+pZ
+1L3w5tHNj2dzhfpa7wf/SIuds6QTr2LCN6miLoSVCRMMpT7d771b16GwQqWEXzN2
++h7dYqrssHPOa8FSUrPerz0+0eFcbMSm5/L/4KXWXoQthURv8aMP9E0iVoUYaaKB
+7U+5vFEZbpoOZyZmTAjXQMSNZCft0azA82Q+G85euyicWtMv48yNVzUhkdh+M2ud
+ohkXX2Aor1TqpBJoIeWke7j9D+Bo+lu61zPRx5ed9teUeLJCwqNEjlE+6gre5kxF
+PoreAtn59QYcBIpzQEWVMbNFlDAR4jMyqIoKCGfBPiRw2V+kunbzqiGQEglIFfOt
+6sTN/+CJh0ei976VDmE0Z1kMN+CNLgIjIw8fl02V9QgAnHcpqtVUxR4dbGOhVDq5
+lWv+K75QQlWyXC2k+KboXcaCvH0WZEBACYzO0CfrZ5hP9BSkbj5usSUVGGHwEFAJ
+t+/04KVY71fW281Ej5kGNaIKxeKsx6+hMo+UXb5ZM+6fANNNxs1cK95sTH6PjkyB
+tsKxLoa3CV2v9mSE5JiKKt74R9nXVo7PXf6DizwAU2l30Lb6y6y0OdXdCCPAG8Ij
+FrMgPu5MtjgsO5DnkZfUqDPWHhOgEPyOh3Ho+pvDhNYh5cm2eLQ8g5orzs2FHwbZ
+DpAHwCdqrlcpBlKJ4W/MZdf1fg2PjqaTWm7ZFiGr91P0F6kltTLWbVKTjLdS0T+D
+L7QnWWxpYW4gU2FpbnQtSGlsYWlyZSA8eWxpYW5zdEBnbWFpbC5jb20+iF4EExEI
+AAYFAl2gC4sACgkQg7j/r4DH+kD/3gD+MRedlM53VzOtNOpS6mqDAxj1aWP90HN0
+AqO6zuCTyGgBAJlunLFKH8IUetmQOhiohB8HVhdm/q4lKRDV7sHdplDyuMwEXaAL
+ixACAJSU/sCV87he4oZUKzg2/IGl3QoDSbTCOd04dE1IjPjjHbi8t9M7Qau55aM8
+ypFEsc7zMslL8Fc78EejrKmM3zsB/RU9XWFyrbQwRbaK6OHeEHC2E3AFaG0p09c6
+d0kZloHuWyEsm5a/3PpbIM1eP9IESJXWCc+bQQt6DxLKHLmkKMwB/icWMg8uMJlx
+aady8TEq7LH5oFVKsglnwuN1nIkecrf77TVkEqTjIxS6TiOup6zOnioFNKLYBAH0
+WUnJEYFvx4OIXgQYEQgABgUCXaALiwAKCRCDuP+vgMf6QGFTAQCUj2gGwsFlN0eR
+Wowv4eLcc3FwQ+lBElUctKg8vNFb0gD/ZWVWsWwKerNgNnf7RGD9mt8G2CKvdgGG
+oZ2hPP2gU9w=
+=roW4
+-----END PGP PUBLIC KEY BLOCK-----
+```
diff --git a/agents/MeshAgentOSXPackager.zip b/agents/MeshAgentOSXPackager.zip
index c4936a66..4248a4eb 100644
Binary files a/agents/MeshAgentOSXPackager.zip and b/agents/MeshAgentOSXPackager.zip differ
diff --git a/agents/MeshCentralRouter.exe b/agents/MeshCentralRouter.exe
index bdb2b890..828675dc 100644
Binary files a/agents/MeshCentralRouter.exe and b/agents/MeshCentralRouter.exe differ
diff --git a/agents/MeshCmd.exe b/agents/MeshCmd.exe
index 57c590aa..00b704aa 100644
Binary files a/agents/MeshCmd.exe and b/agents/MeshCmd.exe differ
diff --git a/agents/MeshCmd64.exe b/agents/MeshCmd64.exe
index fde90d0a..e4af314f 100644
Binary files a/agents/MeshCmd64.exe and b/agents/MeshCmd64.exe differ
diff --git a/agents/MeshCmdARM64.exe b/agents/MeshCmdARM64.exe
new file mode 100644
index 00000000..83f1079a
Binary files /dev/null and b/agents/MeshCmdARM64.exe differ
diff --git a/agents/MeshService.exe b/agents/MeshService.exe
index b6b4a387..e3aec7ab 100644
Binary files a/agents/MeshService.exe and b/agents/MeshService.exe differ
diff --git a/agents/MeshService64.exe b/agents/MeshService64.exe
index bb5ed095..540fed64 100644
Binary files a/agents/MeshService64.exe and b/agents/MeshService64.exe differ
diff --git a/agents/MeshServiceARM64.exe b/agents/MeshServiceARM64.exe
new file mode 100644
index 00000000..ee191f79
Binary files /dev/null and b/agents/MeshServiceARM64.exe differ
diff --git a/agents/agent-translations.json b/agents/agent-translations.json
index d10a44fa..554c68e5 100644
--- a/agents/agent-translations.json
+++ b/agents/agent-translations.json
@@ -52,7 +52,7 @@
"zenity": "Zkuste nainstalovat / aktualizovat Zenity a spustit znovu",
"status": [
"NENÍ INSTALOVÁN",
- "BĚH",
+ "SPUŠTĚNO",
"NEFUNGUJE"
],
"statusDescription": "Aktuální stav agenta",
@@ -651,5 +651,98 @@
],
"statusDescription": "Trenutni status agenta",
"description": "Kliknite na dugmad ispod da instalirate ili deinstalirate ovaj softver za daljinsko upravljanje. Kada je instaliran, ovaj softver radi u pozadini, što omogućava da ovim računarom upravlja i kontroliše udaljeni administrator."
+ },
+ "hu": {
+ "agent": "Agent",
+ "agentVersion": "Új verzió",
+ "group": "Eszköz csoport",
+ "url": "Kiszolgáló URL",
+ "meshName": "Csoport név",
+ "meshId": "Csoport azonosító",
+ "serverId": "Kiszolgáló azonosító",
+ "setup": "Beállítás",
+ "update": "Frissítés",
+ "install": "Telepítés",
+ "uninstall": "Eltávolítás",
+ "connect": "Kapcsolódás",
+ "disconnect": "Lekapcsolódás",
+ "cancel": "Mégse",
+ "close": "Bezár",
+ "pressok": "Press OK to disconnect",
+ "elevation": "A szoftver telepítéséhez/eltávolításához megnövelt jogosultságok szükségesek.",
+ "sudo": "Kérjük, próbálja meg újra a sudo használatával.",
+ "ctrlc": "A kilépéshez nyomja meg a Ctrl-C billentyűt.",
+ "commands": "A szöveges változatot a parancssorból futtathatja a következő parancs(okk)al",
+ "graphicalerror": "A telepítő grafikus verziója nem futtatható ezen a rendszeren.",
+ "zenity": "Próbálja meg telepíteni/frissíteni a Zenity-t, és indítsa újra",
+ "status": [
+ "NINCS TELEPÍTVE",
+ "FUT",
+ "NEM FUT"
+ ],
+ "statusDescription": "Jelenlegi agent állapota",
+ "description": "Kattintson a Telepítés vagy Eltávolítás gombokra a Távfelügyeleti alkalmazás telepítéséhez vagy eltávolításához. Telepítés után ez az alkalmazás a háttérben fut, lehetővé téve, hogy a számítógépet egy távoli rendszergazda kezelje."
+ },
+ "ca": {
+ "agent": "Agent",
+ "agentVersion": "Nova versió",
+ "group": "Grup de dispositius",
+ "url": "URL del servidor",
+ "meshName": "Nom del grup",
+ "meshId": "Identificador de grup",
+ "serverId": "Identificador del servidor",
+ "setup": "Configuració",
+ "update": "Actualització",
+ "install": "Instal·lar",
+ "uninstall": "Desinstal·la",
+ "connect": "Connecta't",
+ "disconnect": "Desconnecta",
+ "cancel": "Cancel · lar",
+ "close": "Tanca",
+ "pressok": "Premeu D'acord per desconnectar",
+ "elevation": "Es necessiten permisos elevats per instal·lar/desinstal·lar aquest programari.",
+ "sudo": "Si us plau, torna-ho a provar amb sudo.",
+ "ctrlc": "Premeu Ctrl-C per sortir.",
+ "commands": "Podeu executar la versió de text des de la línia d'ordres amb les següents ordres",
+ "graphicalerror": "La versió gràfica d'aquest instal·lador no pot executar-se en aquest sistema",
+ "zenity": "Proveu d'instal·lar/actualitzar Zenity i torneu a executar-lo",
+ "status": [
+ "NO ESTÀ INSTAL · LAT",
+ "CÓRRER",
+ "NO CORRE"
+ ],
+ "statusDescription": "Estat actual de l'agent",
+ "description": "Feu clic als botons següents per instal·lar o desinstal·lar aquest programari de gestió remota. Quan s'instal·la, aquest programari s'executa en segon pla i permet que aquest ordinador sigui gestionat i controlat per un administrador remot."
+ },
+ "uk": {
+ "agent": "Агент",
+ "agentVersion": "Нова Версія",
+ "group": "Група Пристроїв",
+ "url": "URL Сервера",
+ "meshName": "Ім'я Групи",
+ "meshId": "Ідентифікатор групи",
+ "serverId": "Ідентифікатор серверу",
+ "setup": "Налаштувати",
+ "update": "Оновлення",
+ "install": "Інсталювати",
+ "uninstall": "Видалити",
+ "connect": "Підключитися",
+ "disconnect": "Відключити",
+ "cancel": "Скасувати",
+ "close": "Закрити",
+ "pressok": "Натисніть OK, щоб від'єднатися",
+ "elevation": "Для інсталяції/деінсталяції цього програмного забезпечення потрібні підвищені дозволи.",
+ "sudo": "Будь ласка, спробуйте ще раз за допомогою sudo.",
+ "ctrlc": "Натисніть Ctrl-C, щоб вийти",
+ "commands": "Ви можете запустити текстову версію з командного рядка за допомогою таких команд",
+ "graphicalerror": "Графічна версія цього інсталятора не може працювати в цій системі",
+ "zenity": "Спробуйте встановити/оновити Zenity та запустіть наново",
+ "status": [
+ "НЕ ВСТАНОВЛЕНО",
+ "ВИКОНУЄТЬСЯ",
+ "НЕ ПРАЦЮЄ"
+ ],
+ "statusDescription": "Поточний Статус Агента",
+ "description": "Клікнути кнопки нижче, щоб інсталювати або видалити це програмне забезпечення для віддаленого керування. Після інсталювання ця програма працює у фоновому режимі, що дозволяє віддаленому адміністратору керувати цим комп'ютером."
}
}
\ No newline at end of file
diff --git a/agents/meshagent_android.apk b/agents/meshagent_android.apk
new file mode 100644
index 00000000..0b525a3b
Binary files /dev/null and b/agents/meshagent_android.apk differ
diff --git a/agents/meshcmd.js b/agents/meshcmd.js
index ac782e8c..1142c31a 100644
--- a/agents/meshcmd.js
+++ b/agents/meshcmd.js
@@ -588,7 +588,7 @@ function run(argv) {
}
amtMei.getProvisioningState(function (result) { if (result) { mestate.ProvisioningState = result; } });
amtMei.getProvisioningMode(function (result) { if (result) { mestate.ProvisioningMode = result; } });
- amtMei.getEHBCState(function (result) { mestate.ehbc = ((result === true) || (typeof result == 'object') && (result.EHBC === true)); });
+ amtMei.getEHBCState(function (result) { if (result) { mestate.ehbc = ((result === true) || (typeof result == 'object') && (result.EHBC === true)); } });
amtMei.getControlMode(function (result) { if (result) { mestate.controlmode = result; } });
amtMei.getMACAddresses(function (result) { if (result) { mestate.mac = result; } });
amtMei.getLanInterfaceSettings(0, function (result) { if (result) { mestate.net0 = result; } });
diff --git a/agents/meshcore.js b/agents/meshcore.js
index e536e574..5a7faaf1 100644
--- a/agents/meshcore.js
+++ b/agents/meshcore.js
@@ -295,8 +295,9 @@ if (process.platform == 'win32' && require('user-sessions').isRoot()) {
// Check the Agent Uninstall MetaData for correctness, as the installer may have written an incorrect value
try {
var writtenSize = 0, actualSize = Math.floor(require('fs').statSync(process.execPath).size / 1024);
- try { writtenSize = require('win-registry').QueryKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\MeshCentralAgent', 'EstimatedSize'); } catch (ex) { }
- if (writtenSize != actualSize) { try { require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\MeshCentralAgent', 'EstimatedSize', actualSize); } catch (ex) { } }
+ var serviceName = (_MSH().serviceName ? _MSH().serviceName : (require('_agentNodeId').serviceName() ? require('_agentNodeId').serviceName() : 'Mesh Agent'));
+ try { writtenSize = require('win-registry').QueryKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\' + serviceName, 'EstimatedSize'); } catch (ex) { }
+ if (writtenSize != actualSize) { try { require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\' + serviceName, 'EstimatedSize', actualSize); } catch (ex) { } }
} catch (ex) { }
// Check to see if we are the Installed Mesh Agent Service, if we are, make sure we can run in Safe Mode
@@ -310,6 +311,16 @@ if (process.platform == 'win32' && require('user-sessions').isRoot()) {
try { meshCheck = require('service-manager').manager.getService(svcname).isMe(); } catch (ex) { }
if (meshCheck && require('win-bcd').isSafeModeService && !require('win-bcd').isSafeModeService(svcname)) { require('win-bcd').enableSafeModeService(svcname); }
} catch (ex) { }
+
+ // Check the Agent Uninstall MetaData for DisplayVersion and update if not the same and only on windows
+ if (process.platform == 'win32') {
+ try {
+ var writtenDisplayVersion = 0, actualDisplayVersion = process.versions.commitDate.toString();
+ var serviceName = (_MSH().serviceName ? _MSH().serviceName : (require('_agentNodeId').serviceName() ? require('_agentNodeId').serviceName() : 'Mesh Agent'));
+ try { writtenDisplayVersion = require('win-registry').QueryKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\' + serviceName, 'DisplayVersion'); } catch (ex) { }
+ if (writtenDisplayVersion != actualDisplayVersion) { try { require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\' + serviceName, 'DisplayVersion', actualDisplayVersion); } catch (ex) { } }
+ } catch (ex) { }
+ }
}
if (process.platform != 'win32') {
@@ -622,7 +633,7 @@ if ((require('fs').existsSync(process.cwd() + 'batterystate.txt')) && (require('
else {
try {
// Setup normal battery monitoring
- if (require('identifiers').isBatteryPowered && require('identifiers').isBatteryPowered()) {
+ if (require('computer-identifiers').isBatteryPowered && require('computer-identifiers').isBatteryPowered()) {
require('MeshAgent')._battLevelChanged = function _battLevelChanged(val) {
_battLevelChanged.self._currentBatteryLevel = val;
_battLevelChanged.self.SendCommand({ action: 'battery', state: _battLevelChanged.self._currentPowerState, level: val });
@@ -654,35 +665,40 @@ var meshCoreObj = { action: 'coreinfo', value: (require('MeshAgent').coreHash ?
// Get the operating system description string
try { require('os').name().then(function (v) { meshCoreObj.osdesc = v; meshCoreObjChanged(); }); } catch (ex) { }
-
// Setup logged in user monitoring (THIS IS BROKEN IN WIN7)
+function onUserSessionChanged(user, locked) {
+ userSession.enumerateUsers().then(function (users) {
+ if (process.platform == 'linux') {
+ if (userSession._startTime == null) {
+ userSession._startTime = Date.now();
+ userSession._count = users.length;
+ }
+ else if (Date.now() - userSession._startTime < 10000 && users.length == userSession._count) {
+ userSession.removeAllListeners('changed');
+ return;
+ }
+ }
+
+ var u = [], a = users.Active;
+ if(meshCoreObj.lusers == null) { meshCoreObj.lusers = []; }
+ for (var i = 0; i < a.length; i++) {
+ var un = a[i].Domain ? (a[i].Domain + '\\' + a[i].Username) : (a[i].Username);
+ if (user && locked && (JSON.stringify(a[i]) === JSON.stringify(user))) { if (meshCoreObj.lusers.indexOf(un) == -1) { meshCoreObj.lusers.push(un); } }
+ else if (user && !locked && (JSON.stringify(a[i]) === JSON.stringify(user))) { meshCoreObj.lusers.splice(meshCoreObj.lusers.indexOf(un), 1); }
+ if (u.indexOf(un) == -1) { u.push(un); } // Only push users in the list once.
+ }
+ meshCoreObj.lusers = meshCoreObj.lusers;
+ meshCoreObj.users = u;
+ meshCoreObjChanged();
+ });
+}
+
try {
var userSession = require('user-sessions');
- userSession.on('changed', function onUserSessionChanged() {
- userSession.enumerateUsers().then(function (users) {
- if (process.platform == 'linux') {
- if (userSession._startTime == null) {
- userSession._startTime = Date.now();
- userSession._count = users.length;
- }
- else if (Date.now() - userSession._startTime < 10000 && users.length == userSession._count) {
- userSession.removeAllListeners('changed');
- return;
- }
- }
-
- var u = [], a = users.Active;
- for (var i = 0; i < a.length; i++) {
- var un = a[i].Domain ? (a[i].Domain + '\\' + a[i].Username) : (a[i].Username);
- if (u.indexOf(un) == -1) { u.push(un); } // Only push users in the list once.
- }
- meshCoreObj.users = u;
- meshCoreObjChanged();
- });
- });
+ userSession.on('changed', function () { onUserSessionChanged(null, false); });
userSession.emit('changed');
- //userSession.on('locked', function (user) { sendConsoleText('[' + (user.Domain ? user.Domain + '\\' : '') + user.Username + '] has LOCKED the desktop'); });
- //userSession.on('unlocked', function (user) { sendConsoleText('[' + (user.Domain ? user.Domain + '\\' : '') + user.Username + '] has UNLOCKED the desktop'); });
+ userSession.on('locked', function (user) { if(user != undefined && user != null) { onUserSessionChanged(user, true); } });
+ userSession.on('unlocked', function (user) { if(user != undefined && user != null) { onUserSessionChanged(user, false); } });
} catch (ex) { }
var meshServerConnectionState = 0;
@@ -1159,6 +1175,8 @@ function handleServerCommand(data) {
tunnel.soptions = data.soptions;
tunnel.consentTimeout = (tunnel.soptions && tunnel.soptions.consentTimeout) ? tunnel.soptions.consentTimeout : 30;
tunnel.consentAutoAccept = (tunnel.soptions && (tunnel.soptions.consentAutoAccept === true));
+ tunnel.consentAutoAcceptIfNoUser = (tunnel.soptions && (tunnel.soptions.consentAutoAcceptIfNoUser === true));
+ tunnel.oldStyle = (tunnel.soptions && tunnel.soptions.oldStyle) ? tunnel.soptions.oldStyle : false;
tunnel.tcpaddr = data.tcpaddr;
tunnel.tcpport = data.tcpport;
tunnel.udpaddr = data.udpaddr;
@@ -1215,8 +1233,11 @@ function handleServerCommand(data) {
ipr.message = data.msg;
ipr.username = data.username;
if (data.realname && (data.realname != '')) { ipr.username = data.realname; }
+ ipr.timeout = (typeof data.timeout === 'number' ? data.timeout : 120000);
global._clientmessage = ipr.then(function (img) {
- this.messagebox = require('win-dialog').create(this.title, this.message, this.username, { timeout: 120000, b64Image: img.split(',').pop(), background: color_options.background, foreground: color_options.foreground });
+ var options = { b64Image: img.split(',').pop(), background: color_options.background, foreground: color_options.foreground }
+ if (this.timeout != 0) { options.timeout = this.timeout; }
+ this.messagebox = require('win-dialog').create(this.title, this.message, this.username, options);
this.__childPromise.addMessage = this.messagebox.addMessage.bind(this.messagebox);
return (this.messagebox);
});
@@ -1247,6 +1268,9 @@ function handleServerCommand(data) {
// Requestion details information about a process
if (data.pid) {
var info = {}; // TODO: Replace with real data. Feel free not to give all values if not available.
+ try {
+ info = processManager.getProcessInfo(data.pid);
+ }catch(e){ }
/*
info.processUser = "User"; // String
info.processDomain = "Domain"; // String
@@ -1283,6 +1307,41 @@ function handleServerCommand(data) {
}
break;
}
+ case 'service': {
+ // return information about the service
+ try {
+ var service = require('service-manager').manager.getService(data.serviceName);
+ if (service != null) {
+ var reply = {
+ name: (service.name ? service.name : ''),
+ status: (service.status ? service.status : ''),
+ startType: (service.startType ? service.startType : ''),
+ failureActions: (service.failureActions ? service.failureActions : ''),
+ installedDate: (service.installedDate ? service.installedDate : ''),
+ installedBy: (service.installedBy ? service.installedBy : '') ,
+ user: (service.user ? service.user : '')
+ };
+ if(reply.installedBy.indexOf('S-1-5') != -1) {
+ var cmd = "(Get-WmiObject -Class win32_userAccount -Filter \"SID='"+service.installedBy+"'\").Caption";
+ var replydata = "";
+ var pws = require('child_process').execFile(process.env['windir'] + '\\System32\\WindowsPowerShell\\v1.0\\powershell.exe', ['powershell', '-noprofile', '-nologo', '-command', '-'], {});
+ pws.descriptorMetadata = 'UserSIDPowerShell';
+ pws.stdout.on('data', function (c) { replydata += c.toString(); });
+ pws.stderr.on('data', function (c) { replydata += c.toString(); });
+ pws.stdin.write(cmd + '\r\nexit\r\n');
+ pws.on('exit', function () {
+ if (replydata != "") reply.installedBy = replydata;
+ mesh.SendCommand({ action: 'msg', type: 'service', value: JSON.stringify(reply), sessionid: data.sessionid });
+ delete pws;
+ });
+ } else {
+ mesh.SendCommand({ action: 'msg', type: 'service', value: JSON.stringify(reply), sessionid: data.sessionid });
+ }
+ }
+ } catch (ex) {
+ mesh.SendCommand({ action: 'msg', type: 'service', error: ex, sessionid: data.sessionid })
+ }
+ }
case 'services': {
// Return the list of installed services
var services = null;
@@ -1338,11 +1397,13 @@ function handleServerCommand(data) {
child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
child.stderr.on('data', function () { });
child.waitExit();
+ mesh.SendCommand({ action: 'msg', type: 'deskBackground', sessionid: data.sessionid, data: (current != '' ? "" : require('MeshAgent')._wallpaper), });
} else {
var id = require('user-sessions').consoleUid();
var current = require('linux-gnome-helpers').getDesktopWallpaper(id);
if (current != '/dev/null') { require('MeshAgent')._wallpaper = current; }
require('linux-gnome-helpers').setDesktopWallpaper(id, current != '/dev/null' ? undefined : require('MeshAgent')._wallpaper);
+ mesh.SendCommand({ action: 'msg', type: 'deskBackground', sessionid: data.sessionid, data: (current != '/dev/null' ? "" : require('MeshAgent')._wallpaper), });
}
} catch (ex) {
sendConsoleText(ex);
@@ -1446,6 +1507,14 @@ function handleServerCommand(data) {
sendConsoleText('localappMsg: ' + data.appid + ', ' + JSON.stringify(data.value));
if (data.appid != null) { sendToRegisteredApp(data.appid, data.value); } else { broadcastToRegisteredApps(data.value); }
break;
+ case 'alertbox': {
+ // Display an old style alert box
+ if (data.title && data.msg) {
+ MeshServerLogEx(158, [data.title, data.msg], "Displaying alert box, title=" + data.title + ", message=" + data.msg, data);
+ try { require('message-box').create(data.title, data.msg, 9999, 1).then(function () { }).catch(function () { }); } catch (ex) { }
+ }
+ break;
+ }
default:
// Unknown action, ignore it.
break;
@@ -1469,7 +1538,7 @@ function handleServerCommand(data) {
}
case 'runcommands': {
if (mesh.cmdchild != null) { sendConsoleText("Run commands can't execute, already busy."); break; }
- sendConsoleText("Run commands (" + data.runAsUser + "): " + data.cmds);
+ if (!data.reply) sendConsoleText("Run commands (" + data.runAsUser + "): " + data.cmds);
// data.runAsUser: 0=Agent,1=UserOrAgent,2=UserOnly
var options = {};
@@ -1481,33 +1550,57 @@ function handleServerCommand(data) {
if (options.uid == null) break;
if (((require('user-sessions').minUid != null) && (options.uid < require('user-sessions').minUid()))) break; // This command can only run as user.
}
-
+ var replydata = "";
if (process.platform == 'win32') {
if (data.type == 1) {
// Windows command shell
mesh.cmdchild = require('child_process').execFile(process.env['windir'] + '\\system32\\cmd.exe', ['cmd'], options);
mesh.cmdchild.descriptorMetadata = 'UserCommandsShell';
- mesh.cmdchild.stdout.on('data', function (c) { sendConsoleText(c.toString()); });
- mesh.cmdchild.stderr.on('data', function (c) { sendConsoleText(c.toString()); });
+ mesh.cmdchild.stdout.on('data', function (c) { replydata += c.toString(); });
+ mesh.cmdchild.stderr.on('data', function (c) { replydata += c.toString(); });
mesh.cmdchild.stdin.write(data.cmds + '\r\nexit\r\n');
- mesh.cmdchild.on('exit', function () { sendConsoleText("Run commands completed."); delete mesh.cmdchild; });
+ mesh.cmdchild.on('exit', function () {
+ if (data.reply) {
+ mesh.SendCommand({ action: 'msg', type: 'runcommands', result: replydata, sessionid: data.sessionid, responseid: data.responseid });
+ } else {
+ sendConsoleText(replydata);
+ sendConsoleText("Run commands completed.");
+ }
+ delete mesh.cmdchild;
+ });
} else if (data.type == 2) {
// Windows Powershell
mesh.cmdchild = require('child_process').execFile(process.env['windir'] + '\\System32\\WindowsPowerShell\\v1.0\\powershell.exe', ['powershell', '-noprofile', '-nologo', '-command', '-'], options);
mesh.cmdchild.descriptorMetadata = 'UserCommandsPowerShell';
- mesh.cmdchild.stdout.on('data', function (c) { sendConsoleText(c.toString()); });
- mesh.cmdchild.stderr.on('data', function (c) { sendConsoleText(c.toString()); });
+ mesh.cmdchild.stdout.on('data', function (c) { replydata += c.toString(); });
+ mesh.cmdchild.stderr.on('data', function (c) { replydata += c.toString(); });
mesh.cmdchild.stdin.write(data.cmds + '\r\nexit\r\n');
- mesh.cmdchild.on('exit', function () { sendConsoleText("Run commands completed."); delete mesh.cmdchild; });
+ mesh.cmdchild.on('exit', function () {
+ if (data.reply) {
+ mesh.SendCommand({ action: 'msg', type: 'runcommands', result: replydata, sessionid: data.sessionid, responseid: data.responseid });
+ } else {
+ sendConsoleText(replydata);
+ sendConsoleText("Run commands completed.");
+ }
+ delete mesh.cmdchild;
+ });
}
} else if (data.type == 3) {
// Linux shell
mesh.cmdchild = require('child_process').execFile('/bin/sh', ['sh'], options);
mesh.cmdchild.descriptorMetadata = 'UserCommandsShell';
- mesh.cmdchild.stdout.on('data', function (c) { sendConsoleText(c.toString()); });
- mesh.cmdchild.stderr.on('data', function (c) { sendConsoleText(c.toString()); });
+ mesh.cmdchild.stdout.on('data', function (c) { replydata += c.toString(); });
+ mesh.cmdchild.stderr.on('data', function (c) { replydata += c.toString(); });
mesh.cmdchild.stdin.write(data.cmds.split('\r').join('') + '\nexit\n');
- mesh.cmdchild.on('exit', function () { sendConsoleText("Run commands completed."); delete mesh.cmdchild; });
+ mesh.cmdchild.on('exit', function () {
+ if (data.reply) {
+ mesh.SendCommand({ action: 'msg', type: 'runcommands', result: replydata, sessionid: data.sessionid, responseid: data.responseid });
+ } else {
+ sendConsoleText(replydata);
+ sendConsoleText("Run commands completed.");
+ }
+ delete mesh.cmdchild;
+ });
}
break;
}
@@ -1785,7 +1878,7 @@ function onFileWatcher(a, b) {
*/
// Replace all key name spaces with _ in an object recursively.
-// This is a workaround since require('identifiers').get() returns key names with spaces in them on Linux.
+// This is a workaround since require('computer-identifiers').get() returns key names with spaces in them on Linux.
function replaceSpacesWithUnderscoresRec(o) {
if (typeof o != 'object') return;
for (var i in o) { if (i.indexOf(' ') >= 0) { o[i.split(' ').join('_')] = o[i]; delete o[i]; } replaceSpacesWithUnderscoresRec(o[i]); }
@@ -1793,8 +1886,7 @@ function replaceSpacesWithUnderscoresRec(o) {
function getSystemInformation(func) {
try {
- var results = { hardware: require('identifiers').get() }; // Hardware info
-
+ var results = { hardware: require('computer-identifiers').get() }; // Hardware info
if (results.hardware && results.hardware.windows) {
// Remove extra entries and things that change quickly
var x = results.hardware.windows.osinfo;
@@ -1810,35 +1902,68 @@ function getSystemInformation(func) {
if (results.hardware.windows.osinfo) { delete results.hardware.windows.osinfo.Node; }
if (results.hardware.windows.partitions) { for (var i in results.hardware.windows.partitions) { delete results.hardware.windows.partitions[i].Node; } }
} catch (ex) { }
+ if (x.LastBootUpTime) { // detect windows uptime
+ var thedate = {
+ year: parseInt(x.LastBootUpTime.substring(0, 4)),
+ month: parseInt(x.LastBootUpTime.substring(4, 6)) - 1, // Months are 0-based in JavaScript (0 - January, 11 - December)
+ day: parseInt(x.LastBootUpTime.substring(6, 8)),
+ hours: parseInt(x.LastBootUpTime.substring(8, 10)),
+ minutes: parseInt(x.LastBootUpTime.substring(10, 12)),
+ seconds: parseInt(x.LastBootUpTime.substring(12, 14)),
+ };
+ var thelastbootuptime = new Date(thedate.year, thedate.month, thedate.day, thedate.hours, thedate.minutes, thedate.seconds);
+ meshCoreObj.lastbootuptime = thelastbootuptime.getTime(); // store the last boot up time in coreinfo for columns
+ meshCoreObjChanged();
+ var nowtime = new Date();
+ var differenceInMilliseconds = Math.abs(thelastbootuptime - nowtime);
+ if (differenceInMilliseconds < 300000) { // computer uptime less than 5 minutes
+ MeshServerLogEx(159, [thelastbootuptime.toString()], "Device Powered On", null);
+ }
+ }
}
+ if(results.hardware && results.hardware.linux) {
+ if(results.hardware.linux.LastBootUpTime) {
+ var thelastbootuptime = new Date(results.hardware.linux.LastBootUpTime);
+ meshCoreObj.lastbootuptime = thelastbootuptime.getTime(); // store the last boot up time in coreinfo for columns
+ meshCoreObjChanged();
+ var nowtime = new Date();
+ var differenceInMilliseconds = Math.abs(thelastbootuptime - nowtime);
+ if (differenceInMilliseconds < 300000) { // computer uptime less than 5 minutes
+ MeshServerLogEx(159, [thelastbootuptime.toString()], "Device Powered On", null);
+ }
+ }
+ }
+ if(results.hardware && results.hardware.darwin){
+ if(results.hardware.darwin.LastBootUpTime) {
+ var thelastbootuptime = new Date(results.hardware.darwin.LastBootUpTime * 1000); // must times by 1000 even tho timestamp is correct?
+ meshCoreObj.lastbootuptime = thelastbootuptime.getTime(); // store the last boot up time in coreinfo for columns
+ meshCoreObjChanged();
+ var nowtime = new Date();
+ var differenceInMilliseconds = Math.abs(thelastbootuptime - nowtime);
+ if (differenceInMilliseconds < 300000) { // computer uptime less than 5 minutes
+ MeshServerLogEx(159, [thelastbootuptime.toString()], "Device Powered On", null);
+ }
+ }
+ }
results.hardware.agentvers = process.versions;
+ results.hardware.network = { dns: require('os').dns() };
replaceSpacesWithUnderscoresRec(results);
var hasher = require('SHA384Stream').create();
- results.hash = hasher.syncHash(JSON.stringify(results)).toString('hex');
- func(results);
- /*
// On Windows platforms, get volume information - Needs more testing.
if (process.platform == 'win32')
{
results.pendingReboot = require('win-info').pendingReboot(); // Pending reboot
-
- if (require('identifiers').volumes_promise != null)
+ if (require('win-volumes').volumes_promise != null)
{
- var p = require('identifiers').volumes_promise();
+ var p = require('win-volumes').volumes_promise();
p.then(function (res)
{
- results.volumes = res;
+ results.hardware.windows.volumes = cleanGetBitLockerVolumeInfo(res);
results.hash = hasher.syncHash(JSON.stringify(results)).toString('hex');
func(results);
});
}
- else if (require('identifiers').volumes != null)
- {
- results.volumes = require('identifiers').volumes();
- results.hash = hasher.syncHash(JSON.stringify(results)).toString('hex');
- func(results);
- }
else
{
results.hash = hasher.syncHash(JSON.stringify(results)).toString('hex');
@@ -1850,7 +1975,7 @@ function getSystemInformation(func) {
results.hash = hasher.syncHash(JSON.stringify(results)).toString('hex');
func(results);
}
- */
+
} catch (ex) { func(null, ex); }
}
@@ -1860,11 +1985,10 @@ function getDirectoryInfo(reqpath) {
if (((reqpath == undefined) || (reqpath == '')) && (process.platform == 'win32')) {
// List all the drives in the root, or the root itself
var results = null;
- try { results = fs.readDrivesSync(); } catch (ex) { } // TODO: Anyway to get drive total size and free space? Could draw a progress bar.
+ try { results = fs.readDrivesSync(); } catch (ex) { }
if (results != null) {
for (var i = 0; i < results.length; ++i) {
- var drive = { n: results[i].name, t: 1 };
- if (results[i].type == 'REMOVABLE') { drive.dt = 'removable'; } // TODO: See if this is USB/CDROM or something else, we can draw icons.
+ var drive = { n: results[i].name, t: 1, dt: results[i].type, s: (results[i].size ? results[i].size : 0), f: (results[i].free ? results[i].free : 0) };
response.dir.push(drive);
}
}
@@ -2191,6 +2315,59 @@ function terminal_end()
}
+function terminal_consent_ask(ws) {
+ ws.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: "Waiting for user to grant access...", msgid: 1 }));
+ var consentMessage = currentTranslation['terminalConsent'].replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username);
+ var consentTitle = 'MeshCentral';
+ if (ws.httprequest.soptions != null) {
+ if (ws.httprequest.soptions.consentTitle != null) { consentTitle = ws.httprequest.soptions.consentTitle; }
+ if (ws.httprequest.soptions.consentMsgTerminal != null) { consentMessage = ws.httprequest.soptions.consentMsgTerminal.replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username); }
+ }
+ if (process.platform == 'win32') {
+ var enhanced = false;
+ if (ws.httprequest.oldStyle === false) {
+ try { require('win-userconsent'); enhanced = true; } catch (ex) { }
+ }
+ if (enhanced) {
+ var ipr = server_getUserImage(ws.httprequest.userid);
+ ipr.consentTitle = consentTitle;
+ ipr.consentMessage = consentMessage;
+ ipr.consentTimeout = ws.httprequest.consentTimeout;
+ ipr.consentAutoAccept = ws.httprequest.consentAutoAccept;
+ ipr.username = ws.httprequest.realname;
+ ipr.tsid = ws.tsid;
+ ipr.translations = { Allow: currentTranslation['allow'], Deny: currentTranslation['deny'], Auto: currentTranslation['autoAllowForFive'], Caption: consentMessage };
+ ws.httprequest.tpromise._consent = ipr.then(function (img) {
+ this.consent = require('win-userconsent').create(this.consentTitle, this.consentMessage, this.username, { b64Image: img.split(',').pop(), uid: this.tsid, timeout: this.consentTimeout * 1000, timeoutAutoAccept: this.consentAutoAccept, translations: this.translations, background: color_options.background, foreground: color_options.foreground });
+ this.__childPromise.close = this.consent.close.bind(this.consent);
+ return (this.consent);
+ });
+ } else {
+ ws.httprequest.tpromise._consent = require('message-box').create(consentTitle, consentMessage, ws.httprequest.consentTimeout);
+ }
+ } else {
+ ws.httprequest.tpromise._consent = require('message-box').create(consentTitle, consentMessage, ws.httprequest.consentTimeout);
+ }
+ ws.httprequest.tpromise._consent.retPromise = ws.httprequest.tpromise;
+ ws.httprequest.tpromise._consent.then(function (always) {
+ if (always && process.platform == 'win32') { server_set_consentTimer(this.retPromise.httprequest.userid); }
+ // Success
+ MeshServerLogEx(27, null, "Local user accepted remote terminal request (" + this.retPromise.httprequest.remoteaddr + ")", this.retPromise.that.httprequest);
+ this.retPromise.that.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: null, msgid: 0 }));
+ this.retPromise._consent = null;
+ this.retPromise._res();
+ }, function (e) {
+ if (this.retPromise.that) {
+ if(this.retPromise.that.httprequest){ // User Consent Denied
+ MeshServerLogEx(28, null, "Local user rejected remote terminal request (" + this.retPromise.that.httprequest.remoteaddr + ")", this.retPromise.that.httprequest);
+ } else { } // Connection was closed server side, maybe log some messages somewhere?
+ this.retPromise._consent = null;
+ this.retPromise.that.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: e.toString(), msgid: 2 }));
+ } else { } // no websocket, maybe log some messages somewhere?
+ this.retPromise._rej(e.toString());
+ });
+}
+
function terminal_promise_connection_rejected(e)
{
// FAILED to connect terminal
@@ -2243,7 +2420,7 @@ function terminal_promise_connection_resolved(term)
if (this.ws.httprequest.consent && (this.ws.httprequest.consent & 2))
{
// User Notifications is required
- var notifyMessage = currentTranslation['terminalNotify'].replace('{0}', this.ws.httprequest.username);
+ var notifyMessage = currentTranslation['terminalNotify'].replace('{0}', this.ws.httprequest.realname ? this.ws.httprequest.realname : this.ws.httprequest.username);
var notifyTitle = "MeshCentral";
if (this.ws.httprequest.soptions != null)
{
@@ -2472,7 +2649,7 @@ function tunnel_kvm_end()
this.httprequest.desktop.kvm.users.splice(i, 1);
this.httprequest.desktop.kvm.connectionBar.removeAllListeners('close');
this.httprequest.desktop.kvm.connectionBar.close();
- this.httprequest.desktop.kvm.connectionBar = require('notifybar-desktop')(this.httprequest.privacybartext.replace('{0}', this.httprequest.desktop.kvm.rusers.join(', ')).replace('{1}', this.httprequest.desktop.kvm.users.join(', ')), require('MeshAgent')._tsid, color_options);
+ this.httprequest.desktop.kvm.connectionBar = require('notifybar-desktop')(this.httprequest.privacybartext.replace('{0}', this.httprequest.desktop.kvm.rusers.join(', ')).replace('{1}', this.httprequest.desktop.kvm.users.join(', ')).replace(/'/g, "\\'\\"), require('MeshAgent')._tsid, color_options);
this.httprequest.desktop.kvm.connectionBar.httprequest = this.httprequest;
this.httprequest.desktop.kvm.connectionBar.on('close', function ()
{
@@ -2503,13 +2680,111 @@ function kvm_tunnel_consentpromise_closehandler()
if (this._consentpromise && this._consentpromise.close) { this._consentpromise.close(); }
}
+function kvm_consent_ok(ws) {
+ // User Consent Prompt is not required because no user is present
+ if (ws.httprequest.consent && (ws.httprequest.consent & 1)){
+ // User Notifications is required
+ MeshServerLogEx(35, null, "Started remote desktop with toast notification (" + ws.httprequest.remoteaddr + ")", ws.httprequest);
+ var notifyMessage = currentTranslation['desktopNotify'].replace('{0}', ws.httprequest.realname);
+ var notifyTitle = "MeshCentral";
+ if (ws.httprequest.soptions != null) {
+ if (ws.httprequest.soptions.notifyTitle != null) { notifyTitle = ws.httprequest.soptions.notifyTitle; }
+ if (ws.httprequest.soptions.notifyMsgDesktop != null) { notifyMessage = ws.httprequest.soptions.notifyMsgDesktop.replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username); }
+ }
+ try { require('toaster').Toast(notifyTitle, notifyMessage, ws.tsid); } catch (ex) { }
+ } else {
+ MeshServerLogEx(36, null, "Started remote desktop without notification (" + ws.httprequest.remoteaddr + ")", ws.httprequest);
+ }
+ if (ws.httprequest.consent && (ws.httprequest.consent & 0x40)) {
+ // Connection Bar is required
+ if (ws.httprequest.desktop.kvm.connectionBar) {
+ ws.httprequest.desktop.kvm.connectionBar.removeAllListeners('close');
+ ws.httprequest.desktop.kvm.connectionBar.close();
+ }
+ try {
+ ws.httprequest.desktop.kvm.connectionBar = require('notifybar-desktop')(ws.httprequest.privacybartext.replace('{0}', ws.httprequest.desktop.kvm.rusers.join(', ')).replace('{1}', ws.httprequest.desktop.kvm.users.join(', ')).replace(/'/g, "\\'\\"), require('MeshAgent')._tsid, color_options);
+ MeshServerLogEx(31, null, "Remote Desktop Connection Bar Activated/Updated (" + ws.httprequest.remoteaddr + ")", ws.httprequest);
+ } catch (ex) {
+ MeshServerLogEx(32, null, "Remote Desktop Connection Bar Failed or not Supported (" + ws.httprequest.remoteaddr + ")", ws.httprequest);
+ }
+ if (ws.httprequest.desktop.kvm.connectionBar) {
+ ws.httprequest.desktop.kvm.connectionBar.state = {
+ userid: ws.httprequest.userid,
+ xuserid: ws.httprequest.xuserid,
+ username: ws.httprequest.username,
+ sessionid: ws.httprequest.sessionid,
+ remoteaddr: ws.httprequest.remoteaddr,
+ guestname: ws.httprequest.guestname,
+ desktop: ws.httprequest.desktop
+ };
+ ws.httprequest.desktop.kvm.connectionBar.on('close', function () {
+ console.info1('Connection Bar Forcefully closed');
+ MeshServerLogEx(29, null, "Remote Desktop Connection forcefully closed by local user (" + this.state.remoteaddr + ")", this.state);
+ for (var i in this.state.desktop.kvm._pipedStreams) {
+ this.state.desktop.kvm._pipedStreams[i].end();
+ }
+ this.state.desktop.kvm.end();
+ });
+ }
+ }
+ ws.httprequest.desktop.kvm.pipe(ws, { dataTypeSkip: 1 });
+ if (ws.httprequest.autolock) {
+ destopLockHelper_pipe(ws.httprequest);
+ }
+}
+
+function kvm_consent_ask(ws){
+ // Send a console message back using the console channel, "\n" is supported.
+ ws.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: "Waiting for user to grant access...", msgid: 1 }));
+ var consentMessage = currentTranslation['desktopConsent'].replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username);
+ var consentTitle = 'MeshCentral';
+ if (ws.httprequest.soptions != null) {
+ if (ws.httprequest.soptions.consentTitle != null) { consentTitle = ws.httprequest.soptions.consentTitle; }
+ if (ws.httprequest.soptions.consentMsgDesktop != null) { consentMessage = ws.httprequest.soptions.consentMsgDesktop.replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username); }
+ }
+ var pr;
+ if (process.platform == 'win32') {
+ var enhanced = false;
+ if (ws.httprequest.oldStyle === false) {
+ try { require('win-userconsent'); enhanced = true; } catch (ex) { }
+ }
+ if (enhanced) {
+ var ipr = server_getUserImage(ws.httprequest.userid);
+ ipr.consentTitle = consentTitle;
+ ipr.consentMessage = consentMessage;
+ ipr.consentTimeout = ws.httprequest.consentTimeout;
+ ipr.consentAutoAccept = ws.httprequest.consentAutoAccept;
+ ipr.tsid = ws.tsid;
+ ipr.username = ws.httprequest.realname;
+ ipr.translation = { Allow: currentTranslation['allow'], Deny: currentTranslation['deny'], Auto: currentTranslation['autoAllowForFive'], Caption: consentMessage };
+ pr = ipr.then(function (img) {
+ this.consent = require('win-userconsent').create(this.consentTitle, this.consentMessage, this.username, { b64Image: img.split(',').pop(), uid: this.tsid, timeout: this.consentTimeout * 1000, timeoutAutoAccept: this.consentAutoAccept, translations: this.translation, background: color_options.background, foreground: color_options.foreground });
+ this.__childPromise.close = this.consent.close.bind(this.consent);
+ return (this.consent);
+ });
+ } else {
+ pr = require('message-box').create(consentTitle, consentMessage, ws.httprequest.consentTimeout, null, ws.tsid);
+ }
+ } else {
+ pr = require('message-box').create(consentTitle, consentMessage, ws.httprequest.consentTimeout, null, ws.tsid);
+ }
+ pr.ws = ws;
+ ws.pause();
+ ws._consentpromise = pr;
+ ws.prependOnceListener('end', kvm_tunnel_consentpromise_closehandler);
+ pr.then(kvm_consentpromise_resolved, kvm_consentpromise_rejected);
+}
+
function kvm_consentpromise_rejected(e)
{
- // User Consent Denied/Failed
- this.ws._consentpromise = null;
- MeshServerLogEx(34, null, "Failed to start remote desktop after local user rejected (" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
- this.ws.end(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: e.toString(), msgid: 2 }));
- this.ws = null;
+ if (this.ws) {
+ if(this.ws.httprequest){ // User Consent Denied
+ MeshServerLogEx(34, null, "Failed to start remote desktop after local user rejected (" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
+ } else { } // Connection was closed server side, maybe log some messages somewhere?
+ this.ws._consentpromise = null;
+ this.ws.end(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: e.toString(), msgid: 2 }));
+ this.ws = null;
+ } else { } // no websocket, maybe log some messages somewhere?
}
function kvm_consentpromise_resolved(always)
{
@@ -2541,7 +2816,7 @@ function kvm_consentpromise_resolved(always)
}
try
{
- this.ws.httprequest.desktop.kvm.connectionBar = require('notifybar-desktop')(this.ws.httprequest.privacybartext.replace('{0}', this.ws.httprequest.desktop.kvm.rusers.join(', ')).replace('{1}', this.ws.httprequest.desktop.kvm.users.join(', ')), require('MeshAgent')._tsid, color_options);
+ this.ws.httprequest.desktop.kvm.connectionBar = require('notifybar-desktop')(this.ws.httprequest.privacybartext.replace('{0}', this.ws.httprequest.desktop.kvm.rusers.join(', ')).replace('{1}', this.ws.httprequest.desktop.kvm.users.join(', ')).replace(/'/g, "\\'\\"), require('MeshAgent')._tsid, color_options);
MeshServerLogEx(31, null, "Remote Desktop Connection Bar Activated/Updated (" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
} catch (ex)
{
@@ -2550,27 +2825,24 @@ function kvm_consentpromise_resolved(always)
MeshServerLogEx(32, null, "Remote Desktop Connection Bar Failed or Not Supported (" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
}
}
- if (this.ws.httprequest.desktop.kvm.connectionBar)
+ try {
+ if (this.ws.httprequest.desktop.kvm.connectionBar) {
+ this.ws.httprequest.desktop.kvm.connectionBar.httprequest = this.ws.httprequest;
+ this.ws.httprequest.desktop.kvm.connectionBar.on('close', function () {
+ MeshServerLogEx(29, null, "Remote Desktop Connection forcefully closed by local user (" + this.httprequest.remoteaddr + ")", this.httprequest);
+ for (var i in this.httprequest.desktop.kvm._pipedStreams) {
+ this.httprequest.desktop.kvm._pipedStreams[i].end();
+ }
+ this.httprequest.desktop.kvm.end();
+ });
+ }
+ }
+ catch (ex)
{
- this.ws.httprequest.desktop.kvm.connectionBar.state =
+ if (process.platform != 'darwin')
{
- userid: this.ws.httprequest.userid,
- xuserid: this.ws.httprequest.xuserid,
- username: this.ws.httprequest.username,
- sessionid: this.ws.httprequest.sessionid,
- remoteaddr: this.ws.httprequest.remoteaddr,
- guestname: this.ws.httprequest.guestname,
- desktop: this.ws.httprequest.desktop
- };
- this.ws.httprequest.desktop.kvm.connectionBar.on('close', function ()
- {
- MeshServerLogEx(29, null, "Remote Desktop Connection forcefully closed by local user (" + this.state.remoteaddr + ")", state);
- for (var i in this.state.desktop.kvm._pipedStreams)
- {
- this.state.desktop.kvm._pipedStreams[i].end();
- }
- this.state.desktop.kvm.end();
- });
+ MeshServerLogEx(32, null, "Failed2(" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
+ }
}
}
this.ws.httprequest.desktop.kvm.pipe(this.ws, { dataTypeSkip: 1 });
@@ -2582,6 +2854,67 @@ function kvm_consentpromise_resolved(always)
this.ws = null;
}
+function files_consent_ok(ws){
+ // User Consent Prompt is not required
+ if (ws.httprequest.consent && (ws.httprequest.consent & 4)) {
+ // User Notifications is required
+ MeshServerLogEx(42, null, "Started remote files with toast notification (" + ws.httprequest.remoteaddr + ")", ws.httprequest);
+ var notifyMessage = currentTranslation['fileNotify'].replace('{0}', ws.httprequest.realname);
+ var notifyTitle = "MeshCentral";
+ if (ws.httprequest.soptions != null) {
+ if (ws.httprequest.soptions.notifyTitle != null) { notifyTitle = ws.httprequest.soptions.notifyTitle; }
+ if (ws.httprequest.soptions.notifyMsgFiles != null) { notifyMessage = ws.httprequest.soptions.notifyMsgFiles.replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username); }
+ }
+ try { require('toaster').Toast(notifyTitle, notifyMessage); } catch (ex) { }
+ } else {
+ MeshServerLogEx(43, null, "Started remote files without notification (" + ws.httprequest.remoteaddr + ")", ws.httprequest);
+ }
+ ws.resume();
+}
+
+function files_consent_ask(ws){
+ // Send a console message back using the console channel, "\n" is supported.
+ ws.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: "Waiting for user to grant access...", msgid: 1 }));
+ var consentMessage = currentTranslation['fileConsent'].replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username);
+ var consentTitle = 'MeshCentral';
+
+ if (ws.httprequest.soptions != null) {
+ if (ws.httprequest.soptions.consentTitle != null) { consentTitle = ws.httprequest.soptions.consentTitle; }
+ if (ws.httprequest.soptions.consentMsgFiles != null) { consentMessage = ws.httprequest.soptions.consentMsgFiles.replace('{0}', ws.httprequest.realname).replace('{1}', ws.httprequest.username); }
+ }
+ var pr;
+ if (process.platform == 'win32') {
+ var enhanced = false;
+ if (ws.httprequest.oldStyle === false) {
+ try { require('win-userconsent'); enhanced = true; } catch (ex) { }
+ }
+ if (enhanced) {
+ var ipr = server_getUserImage(ws.httprequest.userid);
+ ipr.consentTitle = consentTitle;
+ ipr.consentMessage = consentMessage;
+ ipr.consentTimeout = ws.httprequest.consentTimeout;
+ ipr.consentAutoAccept = ws.httprequest.consentAutoAccept;
+ ipr.username = ws.httprequest.realname;
+ ipr.tsid = ws.tsid;
+ ipr.translations = { Allow: currentTranslation['allow'], Deny: currentTranslation['deny'], Auto: currentTranslation['autoAllowForFive'], Caption: consentMessage };
+ pr = ipr.then(function (img) {
+ this.consent = require('win-userconsent').create(this.consentTitle, this.consentMessage, this.username, { b64Image: img.split(',').pop(), uid: this.tsid, timeout: this.consentTimeout * 1000, timeoutAutoAccept: this.consentAutoAccept, translations: this.translations, background: color_options.background, foreground: color_options.foreground });
+ this.__childPromise.close = this.consent.close.bind(this.consent);
+ return (this.consent);
+ });
+ } else {
+ pr = require('message-box').create(consentTitle, consentMessage, ws.httprequest.consentTimeout, null);
+ }
+ } else {
+ pr = require('message-box').create(consentTitle, consentMessage, ws.httprequest.consentTimeout, null);
+ }
+ pr.ws = ws;
+ ws.pause();
+ ws._consentpromise = pr;
+ ws.prependOnceListener('end', files_tunnel_endhandler);
+ pr.then(files_consentpromise_resolved, files_consentpromise_rejected);
+}
+
function files_consentpromise_resolved(always)
{
if (always && process.platform == 'win32') { server_set_consentTimer(this.ws.httprequest.userid); }
@@ -2607,11 +2940,14 @@ function files_consentpromise_resolved(always)
}
function files_consentpromise_rejected(e)
{
- // User Consent Denied/Failed
- this.ws._consentpromise = null;
- MeshServerLogEx(41, null, "Failed to start remote files after local user rejected (" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
- this.ws.end(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: e.toString(), msgid: 2 }));
- this.ws = null;
+ if (this.ws) {
+ if(this.ws.httprequest){ // User Consent Denied
+ MeshServerLogEx(41, null, "Failed to start remote files after local user rejected (" + this.ws.httprequest.remoteaddr + ")", this.ws.httprequest);
+ } else { } // Connection was closed server side, maybe log some messages somewhere?
+ this.ws._consentpromise = null;
+ this.ws.end(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: e.toString(), msgid: 2 }));
+ this.ws = null;
+ } else { } // no websocket, maybe log some messages somewhere?
}
function files_tunnel_endhandler()
{
@@ -2692,6 +3028,12 @@ function onTunnelData(data)
this.descriptorMetadata = "Remote Terminal";
+ // Look for a TSID
+ var tsid = null;
+ if ((this.httprequest.xoptions != null) && (typeof this.httprequest.xoptions.tsid == 'number')) { tsid = this.httprequest.xoptions.tsid; }
+ require('MeshAgent')._tsid = tsid;
+ this.tsid = tsid;
+
if (process.platform == 'win32')
{
if (!require('win-terminal').PowerShellCapable() && (this.httprequest.protocol == 6 || this.httprequest.protocol == 9)) {
@@ -2708,71 +3050,31 @@ function onTunnelData(data)
this.end = terminal_end;
// Perform User-Consent if needed.
- if (this.httprequest.consent && (this.httprequest.consent & 16))
- {
- this.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: "Waiting for user to grant access...", msgid: 1 }));
- var consentMessage = currentTranslation['terminalConsent'].replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username);
- var consentTitle = 'MeshCentral';
-
- if (this.httprequest.soptions != null)
- {
- if (this.httprequest.soptions.consentTitle != null) { consentTitle = this.httprequest.soptions.consentTitle; }
- if (this.httprequest.soptions.consentMsgTerminal != null) { consentMessage = this.httprequest.soptions.consentMsgTerminal.replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username); }
- }
- if (process.platform == 'win32')
- {
- var enhanced = false;
- try { require('win-userconsent'); enhanced = true; } catch (ex) { }
- if (enhanced)
- {
- var ipr = server_getUserImage(this.httprequest.userid);
- ipr.consentTitle = consentTitle;
- ipr.consentMessage = consentMessage;
- ipr.consentTimeout = this.httprequest.consentTimeout;
- ipr.consentAutoAccept = this.httprequest.consentAutoAccept;
- ipr.username = this.httprequest.realname;
- ipr.translations = { Allow: currentTranslation['allow'], Deny: currentTranslation['deny'], Auto: currentTranslation['autoAllowForFive'], Caption: consentMessage };
- this.httprequest.tpromise._consent = ipr.then(function (img)
- {
- this.consent = require('win-userconsent').create(this.consentTitle, this.consentMessage, this.username, { b64Image: img.split(',').pop(), timeout: this.consentTimeout * 1000, timeoutAutoAccept: this.consentAutoAccept, translations: this.translations, background: color_options.background, foreground: color_options.foreground });
- this.__childPromise.close = this.consent.close.bind(this.consent);
- return (this.consent);
- });
- } else
- {
- this.httprequest.tpromise._consent = require('message-box').create(consentTitle, consentMessage, this.httprequest.consentTimeout);
- }
- } else
- {
- this.httprequest.tpromise._consent = require('message-box').create(consentTitle, consentMessage, this.httprequest.consentTimeout);
- }
- this.httprequest.tpromise._consent.retPromise = this.httprequest.tpromise;
- this.httprequest.tpromise._consent.then(
- function (always)
- {
- if (always && process.platform == 'win32') { server_set_consentTimer(this.retPromise.httprequest.userid); }
-
- // Success
- MeshServerLogEx(27, null, "Local user accepted remote terminal request (" + this.retPromise.httprequest.remoteaddr + ")", this.retPromise.that.httprequest);
- this.retPromise.that.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: null, msgid: 0 }));
- this.retPromise._consent = null;
- this.retPromise._res();
- },
- function (e) {
- // Denied
- MeshServerLogEx(28, null, "Local user rejected remote terminal request (" + this.retPromise.that.httprequest.remoteaddr + ")", this.retPromise.that.httprequest);
- this.retPromise.that.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: e.toString(), msgid: 2 }));
- this.retPromise._consent = null;
- this.retPromise._rej(e.toString());
+ if (this.httprequest.consent && (this.httprequest.consent & 16)) {
+ // User asked for consent so now we check if we can auto accept if no user is present/loggedin
+ if (this.httprequest.consentAutoAcceptIfNoUser) {
+ var p = require('user-sessions').enumerateUsers();
+ p.sessionid = this.httprequest.sessionid;
+ p.ws = this;
+ p.then(function (u) {
+ var v = [];
+ for (var i in u) {
+ if (u[i].State == 'Active') { v.push({ tsid: i, type: u[i].StationName, user: u[i].Username, domain: u[i].Domain }); }
+ }
+ if (v.length == 0) { // No user is present, auto accept
+ this.ws.httprequest.tpromise._res();
+ } else {
+ // User is present so we still need consent
+ terminal_consent_ask(this.ws);
+ }
});
- }
- else
- {
+ } else {
+ terminal_consent_ask(this);
+ }
+ } else {
// User-Consent is not required, so just resolve this promise
this.httprequest.tpromise._res();
}
-
-
this.httprequest.tpromise.then(terminal_promise_consent_resolved, terminal_promise_consent_rejected);
}
else if (this.httprequest.protocol == 2)
@@ -2796,7 +3098,22 @@ function onTunnelData(data)
var tsid = null;
if ((this.httprequest.xoptions != null) && (typeof this.httprequest.xoptions.tsid == 'number')) { tsid = this.httprequest.xoptions.tsid; }
require('MeshAgent')._tsid = tsid;
+ this.tsid = tsid;
+ // If MacOS, Wake up device with caffeinate
+ if(process.platform == 'darwin'){
+ try {
+ var options = {};
+ try { options.uid = require('user-sessions').consoleUid(); } catch (ex) { }
+ options.type = require('child_process').SpawnTypes.TERM;
+ var replydata = "";
+ var cmdchild = require('child_process').execFile('/usr/bin/caffeinate', ['caffeinate', '-u', '-t', '10'], options);
+ cmdchild.descriptorMetadata = 'UserCommandsShell';
+ cmdchild.stdout.on('data', function (c) { replydata += c.toString(); });
+ cmdchild.stderr.on('data', function (c) { replydata + c.toString(); });
+ cmdchild.on('exit', function () { delete cmdchild; });
+ } catch(err) { }
+ }
// Remote desktop using native pipes
this.httprequest.desktop = { state: 0, kvm: mesh.getRemoteDesktopStream(tsid), tunnel: this };
this.httprequest.desktop.kvm.parent = this.httprequest.desktop;
@@ -2853,117 +3170,33 @@ function onTunnelData(data)
}
// Perform notification if needed. Toast messages may not be supported on all platforms.
- if (this.httprequest.consent && (this.httprequest.consent & 8))
- {
- // User Consent Prompt is required
- // Send a console message back using the console channel, "\n" is supported.
- this.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: "Waiting for user to grant access...", msgid: 1 }));
- var consentMessage = currentTranslation['desktopConsent'].replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username);
- var consentTitle = 'MeshCentral';
- if (this.httprequest.soptions != null)
- {
- if (this.httprequest.soptions.consentTitle != null) { consentTitle = this.httprequest.soptions.consentTitle; }
- if (this.httprequest.soptions.consentMsgDesktop != null) { consentMessage = this.httprequest.soptions.consentMsgDesktop.replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username); }
+ if (this.httprequest.consent && (this.httprequest.consent & 8)) {
+
+ // User asked for consent but now we check if can auto accept if no user is present
+ if (this.httprequest.consentAutoAcceptIfNoUser) {
+ // Get list of users to check if we any actual users logged in, and if users logged in, we still need consent
+ var p = require('user-sessions').enumerateUsers();
+ p.sessionid = this.httprequest.sessionid;
+ p.ws = this;
+ p.then(function (u) {
+ var v = [];
+ for (var i in u) {
+ if (u[i].State == 'Active') { v.push({ tsid: i, type: u[i].StationName, user: u[i].Username, domain: u[i].Domain }); }
+ }
+ if (v.length == 0) { // No user is present, auto accept
+ kvm_consent_ok(this.ws);
+ } else {
+ // User is present so we still need consent
+ kvm_consent_ask(this.ws);
+ }
+ });
+ } else {
+ // User Consent Prompt is required
+ kvm_consent_ask(this);
}
- var pr;
- if (process.platform == 'win32')
- {
- var enhanced = false;
- try { require('win-userconsent'); enhanced = true; } catch (ex) { }
- if (enhanced)
- {
- var ipr = server_getUserImage(this.httprequest.userid);
- ipr.consentTitle = consentTitle;
- ipr.consentMessage = consentMessage;
- ipr.consentTimeout = this.httprequest.consentTimeout;
- ipr.consentAutoAccept = this.httprequest.consentAutoAccept;
- ipr.tsid = tsid;
- ipr.username = this.httprequest.realname;
- ipr.translation = { Allow: currentTranslation['allow'], Deny: currentTranslation['deny'], Auto: currentTranslation['autoAllowForFive'], Caption: consentMessage };
- pr = ipr.then(function (img)
- {
- this.consent = require('win-userconsent').create(this.consentTitle, this.consentMessage, this.username, { b64Image: img.split(',').pop(), uid: this.tsid, timeout: this.consentTimeout * 1000, timeoutAutoAccept: this.consentAutoAccept, translations: this.translation, background: color_options.background, foreground: color_options.foreground });
- this.__childPromise.close = this.consent.close.bind(this.consent);
- return (this.consent);
- });
- }
- else
- {
- pr = require('message-box').create(consentTitle, consentMessage, this.httprequest.consentTimeout, null, tsid);
- }
- }
- else
- {
- pr = require('message-box').create(consentTitle, consentMessage, this.httprequest.consentTimeout, null, tsid);
- }
- pr.ws = this;
- this.pause();
- this._consentpromise = pr;
- this.prependOnceListener('end', kvm_tunnel_consentpromise_closehandler);
- pr.then(kvm_consentpromise_resolved, kvm_consentpromise_rejected);
- }
- else
- {
+ } else {
// User Consent Prompt is not required
- if (this.httprequest.consent && (this.httprequest.consent & 1))
- {
- // User Notifications is required
- MeshServerLogEx(35, null, "Started remote desktop with toast notification (" + this.httprequest.remoteaddr + ")", this.httprequest);
- var notifyMessage = currentTranslation['desktopNotify'].replace('{0}', this.httprequest.realname);
- var notifyTitle = "MeshCentral";
- if (this.httprequest.soptions != null) {
- if (this.httprequest.soptions.notifyTitle != null) { notifyTitle = this.httprequest.soptions.notifyTitle; }
- if (this.httprequest.soptions.notifyMsgDesktop != null) { notifyMessage = this.httprequest.soptions.notifyMsgDesktop.replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username); }
- }
- try { require('toaster').Toast(notifyTitle, notifyMessage, tsid); } catch (ex) { }
- } else
- {
- MeshServerLogEx(36, null, "Started remote desktop without notification (" + this.httprequest.remoteaddr + ")", this.httprequest);
- }
- if (this.httprequest.consent && (this.httprequest.consent & 0x40))
- {
- // Connection Bar is required
- if (this.httprequest.desktop.kvm.connectionBar)
- {
- this.httprequest.desktop.kvm.connectionBar.removeAllListeners('close');
- this.httprequest.desktop.kvm.connectionBar.close();
- }
- try
- {
- this.httprequest.desktop.kvm.connectionBar = require('notifybar-desktop')(this.httprequest.privacybartext.replace('{0}', this.httprequest.desktop.kvm.rusers.join(', ')).replace('{1}', this.httprequest.desktop.kvm.users.join(', ')), require('MeshAgent')._tsid, color_options);
- MeshServerLogEx(31, null, "Remote Desktop Connection Bar Activated/Updated (" + this.httprequest.remoteaddr + ")", this.httprequest);
- } catch (ex) {
- MeshServerLogEx(32, null, "Remote Desktop Connection Bar Failed or not Supported (" + this.httprequest.remoteaddr + ")", this.httprequest);
- }
- if (this.httprequest.desktop.kvm.connectionBar)
- {
- this.httprequest.desktop.kvm.connectionBar.state =
- {
- userid: this.httprequest.userid,
- xuserid: this.httprequest.xuserid,
- username: this.httprequest.username,
- sessionid: this.httprequest.sessionid,
- remoteaddr: this.httprequest.remoteaddr,
- guestname: this.httprequest.guestname,
- desktop: this.httprequest.desktop
- };
- this.httprequest.desktop.kvm.connectionBar.on('close', function ()
- {
- console.info1('Connection Bar Forcefully closed');
- MeshServerLogEx(29, null, "Remote Desktop Connection forcefully closed by local user (" + this.state.remoteaddr + ")", this.state);
- for (var i in this.state.desktop.kvm._pipedStreams)
- {
- this.state.desktop.kvm._pipedStreams[i].end();
- }
- this.state.desktop.kvm.end();
- });
- }
- }
- this.httprequest.desktop.kvm.pipe(this, { dataTypeSkip: 1 });
- if (this.httprequest.autolock)
- {
- destopLockHelper_pipe(this.httprequest);
- }
+ kvm_consent_ok(this);
}
this.removeAllListeners('data');
@@ -2985,6 +3218,12 @@ function onTunnelData(data)
this.descriptorMetadata = "Remote Files";
+ // Look for a TSID
+ var tsid = null;
+ if ((this.httprequest.xoptions != null) && (typeof this.httprequest.xoptions.tsid == 'number')) { tsid = this.httprequest.xoptions.tsid; }
+ require('MeshAgent')._tsid = tsid;
+ this.tsid = tsid;
+
// Add the files session to the count to update the server
if (this.httprequest.userid != null) {
var userid = getUserIdAndGuestNameFromHttpRequest(this.httprequest);
@@ -3007,69 +3246,31 @@ function onTunnelData(data)
// Perform notification if needed. Toast messages may not be supported on all platforms.
if (this.httprequest.consent && (this.httprequest.consent & 32))
{
- // User Consent Prompt is required
- // Send a console message back using the console channel, "\n" is supported.
- this.write(JSON.stringify({ ctrlChannel: '102938', type: 'console', msg: "Waiting for user to grant access...", msgid: 1 }));
- var consentMessage = currentTranslation['fileConsent'].replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username);
- var consentTitle = 'MeshCentral';
-
- if (this.httprequest.soptions != null)
- {
- if (this.httprequest.soptions.consentTitle != null) { consentTitle = this.httprequest.soptions.consentTitle; }
- if (this.httprequest.soptions.consentMsgFiles != null) { consentMessage = this.httprequest.soptions.consentMsgFiles.replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username); }
- }
- var pr;
- if (process.platform == 'win32')
- {
- var enhanced = false;
- try { require('win-userconsent'); enhanced = true; } catch (ex) { }
- if (enhanced)
- {
- var ipr = server_getUserImage(this.httprequest.userid);
- ipr.consentTitle = consentTitle;
- ipr.consentMessage = consentMessage;
- ipr.consentTimeout = this.httprequest.consentTimeout;
- ipr.consentAutoAccept = this.httprequest.consentAutoAccept;
- ipr.username = this.httprequest.realname;
- ipr.translations = { Allow: currentTranslation['allow'], Deny: currentTranslation['deny'], Auto: currentTranslation['autoAllowForFive'], Caption: consentMessage };
- pr = ipr.then(function (img)
- {
- this.consent = require('win-userconsent').create(this.consentTitle, this.consentMessage, this.username, { b64Image: img.split(',').pop(), timeout: this.consentTimeout * 1000, timeoutAutoAccept: this.consentAutoAccept, translations: this.translations, background: color_options.background, foreground: color_options.foreground });
- this.__childPromise.close = this.consent.close.bind(this.consent);
- return (this.consent);
- });
- } else
- {
- pr = require('message-box').create(consentTitle, consentMessage, this.httprequest.consentTimeout, null);
- }
- }
- else
- {
- pr = require('message-box').create(consentTitle, consentMessage, this.httprequest.consentTimeout, null);
- }
- pr.ws = this;
- this.pause();
- this._consentpromise = pr;
- this.prependOnceListener('end', files_tunnel_endhandler);
- pr.then(files_consentpromise_resolved, files_consentpromise_rejected);
- }
- else
- {
- // User Consent Prompt is not required
- if (this.httprequest.consent && (this.httprequest.consent & 4)) {
- // User Notifications is required
- MeshServerLogEx(42, null, "Started remote files with toast notification (" + this.httprequest.remoteaddr + ")", this.httprequest);
- var notifyMessage = currentTranslation['fileNotify'].replace('{0}', this.httprequest.realname);
- var notifyTitle = "MeshCentral";
- if (this.httprequest.soptions != null) {
- if (this.httprequest.soptions.notifyTitle != null) { notifyTitle = this.httprequest.soptions.notifyTitle; }
- if (this.httprequest.soptions.notifyMsgFiles != null) { notifyMessage = this.httprequest.soptions.notifyMsgFiles.replace('{0}', this.httprequest.realname).replace('{1}', this.httprequest.username); }
- }
- try { require('toaster').Toast(notifyTitle, notifyMessage); } catch (ex) { }
+ // User asked for consent so now we check if we can auto accept if no user is present/loggedin
+ if (this.httprequest.consentAutoAcceptIfNoUser) {
+ var p = require('user-sessions').enumerateUsers();
+ p.sessionid = this.httprequest.sessionid;
+ p.ws = this;
+ p.then(function (u) {
+ var v = [];
+ for (var i in u) {
+ if (u[i].State == 'Active') { v.push({ tsid: i, type: u[i].StationName, user: u[i].Username, domain: u[i].Domain }); }
+ }
+ if (v.length == 0) { // No user is present, auto accept
+ // User Consent Prompt is not required
+ files_consent_ok(this.ws);
+ } else {
+ // User is present so we still need consent
+ files_consent_ask(this.ws);
+ }
+ });
} else {
- MeshServerLogEx(43, null, "Started remote files without notification (" + this.httprequest.remoteaddr + ")", this.httprequest);
+ // User Consent Prompt is required
+ files_consent_ask(this);
}
- this.resume();
+ } else {
+ // User Consent Prompt is not required
+ files_consent_ok(this);
}
// Setup files
@@ -3149,6 +3350,13 @@ function onTunnelData(data)
}
break;
}
+ case 'open': {
+ // Open the local file/folder on the users desktop
+ if (cmd.path) {
+ MeshServerLogEx(20, [cmd.path], "Opening: " + cmd.path, cmd);
+ openFileOnDesktop(cmd.path);
+ }
+ }
case 'markcoredump': {
// If we are asking for the coredump file, set the right path.
var coreDumpPath = null;
@@ -3208,7 +3416,7 @@ function onTunnelData(data)
if (cmd.sub == 'startack') { sendNextBlock = ((typeof cmd.ack == 'number') ? cmd.ack : 8); } else if (cmd.sub == 'stop') { delete this.filedownload; } else if (cmd.sub == 'ack') { sendNextBlock = 1; }
}
// Send the next download block(s)
- while (sendNextBlock > 0) {
+ if (sendNextBlock > 0) {
sendNextBlock--;
var buf = Buffer.alloc(16384);
var len = fs.readSync(this.filedownload.f, buf, 4, 16380, null);
@@ -3317,6 +3525,24 @@ function onTunnelData(data)
this.zip.on('progress', require('events').moderated(function (name, p) { this.xws.write(Buffer.from(JSON.stringify({ action: 'dialogmessage', msg: 'zippingFile', file: ((process.platform == 'win32') ? (name.split('/').join('\\')) : name), progress: p }))); }, 1000));
this.zip.pipe(out);
break;
+ case 'unzip':
+ if (this.unzip != null) return; // Unzip operating is currently running, exit now.
+ this.unzip = require('zip-reader').read(cmd.input);
+ this.unzip._dest = cmd.dest;
+ this.unzip.xws = this;
+ this.unzip.then(function (zipped) {
+ this.xws.write(Buffer.from(JSON.stringify({ action: 'dialogmessage', msg: 'unzipping' })));
+ zipped.xws = this.xws;
+ zipped.extractAll(this._dest).then(function () { // finished extracting
+ zipped.xws.write(Buffer.from(JSON.stringify({ action: 'dialogmessage', msg: null })));
+ zipped.xws.write(Buffer.from(JSON.stringify({ action: 'refresh' })));
+ delete zipped.xws.unzip;
+ }, function (e) { // error extracting
+ zipped.xws.write(Buffer.from(JSON.stringify({ action: 'dialogmessage', msg: 'unziperror', error: e })));
+ delete zipped.xws.unzip;
+ });
+ }, function (e) { this.xws.write(Buffer.from(JSON.stringify({ action: 'dialogmessage', msg: 'unziperror', error: e }))); delete this.xws.unzip });
+ break;
case 'cancel':
// Cancel zip operation if present
try { this.zipcancel = true; this.zip.cancel(function () { }); } catch (ex) { }
@@ -3532,7 +3758,14 @@ function onTunnelControlData(data, ws) {
{ // Desktop
// Switch the user input from websocket to webrtc at this point.
ws.unpipe(ws.httprequest.desktop.kvm);
- try { ws.webrtc.rtcchannel.pipe(ws.httprequest.desktop.kvm, { dataTypeSkip: 1, end: false }); } catch (ex) { sendConsoleText('EX2'); } // 0 = Binary, 1 = Text.
+ if ((ws.httprequest.desktopviewonly != true) && ((ws.httprequest.rights == 0xFFFFFFFF) || (((ws.httprequest.rights & MESHRIGHT_REMOTECONTROL) != 0) && ((ws.httprequest.rights & MESHRIGHT_REMOTEVIEW) == 0)))) {
+ // If we have remote control rights, pipe the KVM input
+ try { ws.webrtc.rtcchannel.pipe(ws.httprequest.desktop.kvm, { dataTypeSkip: 1, end: false }); } catch (ex) { sendConsoleText('EX2'); } // 0 = Binary, 1 = Text.
+ } else {
+ // We need to only pipe non-mouse & non-keyboard inputs.
+ // sendConsoleText('Warning: No Remote Desktop Input Rights.');
+ // TODO!!!
+ }
ws.resume(); // Resume the websocket to keep receiving control data
}
ws.write('{\"ctrlChannel\":\"102938\",\"type\":\"webrtc2\"}'); // Indicates we will no longer get any data on websocket, switching to WebRTC at this point.
@@ -3591,6 +3824,64 @@ function consoleHttpResponse(response) {
response.close = function () { sendConsoleText('httprequest.response.close', this.sessionid); consoleHttpRequest = null; }
}
+// Open a local file on current user's desktop
+function openFileOnDesktop(file) {
+ var child = null;
+ try {
+ switch (process.platform) {
+ case 'win32':
+ var uid = require('user-sessions').consoleUid();
+ var user = require('user-sessions').getUsername(uid);
+ var domain = require('user-sessions').getDomain(uid);
+ var task = { name: 'MeshChatTask', user: user, domain: domain, execPath: (require('fs').statSync(file).isDirectory() ? process.env['windir'] + '\\explorer.exe' : file) };
+ if (require('fs').statSync(file).isDirectory()) task.arguments = [file];
+ try {
+ require('win-tasks').addTask(task);
+ require('win-tasks').getTask({ name: 'MeshChatTask' }).run();
+ require('win-tasks').deleteTask('MeshChatTask');
+ return (true);
+ }
+ catch (ex) {
+ var taskoptions = { env: { _target: (require('fs').statSync(file).isDirectory() ? process.env['windir'] + '\\explorer.exe' : file), _user: '"' + domain + '\\' + user + '"' }, _args: "" };
+ if (require('fs').statSync(file).isDirectory()) taskoptions.env._args = file;
+ for (var c1e in process.env) {
+ taskoptions.env[c1e] = process.env[c1e];
+ }
+ var child = require('child_process').execFile(process.env['windir'] + '\\System32\\WindowsPowerShell\\v1.0\\powershell.exe', ['powershell', '-noprofile', '-nologo', '-command', '-'], taskoptions);
+ child.stderr.on('data', function (c) { });
+ child.stdout.on('data', function (c) { });
+ child.stdin.write('SCHTASKS /CREATE /F /TN MeshChatTask /SC ONCE /ST 00:00 ');
+ if (user) { child.stdin.write('/RU $env:_user '); }
+ child.stdin.write('/TR "$env:_target $env:_args"\r\n');
+ child.stdin.write('$ts = New-Object -ComObject Schedule.service\r\n');
+ child.stdin.write('$ts.connect()\r\n');
+ child.stdin.write('$tsfolder = $ts.getfolder("\\")\r\n');
+ child.stdin.write('$task = $tsfolder.GetTask("MeshChatTask")\r\n');
+ child.stdin.write('$taskdef = $task.Definition\r\n');
+ child.stdin.write('$taskdef.Settings.StopIfGoingOnBatteries = $false\r\n');
+ child.stdin.write('$taskdef.Settings.DisallowStartIfOnBatteries = $false\r\n');
+ child.stdin.write('$taskdef.Actions.Item(1).Path = $env:_target\r\n');
+ child.stdin.write('$taskdef.Actions.Item(1).Arguments = $env:_args\r\n');
+ child.stdin.write('$tsfolder.RegisterTaskDefinition($task.Name, $taskdef, 4, $null, $null, $null)\r\n');
+ child.stdin.write('SCHTASKS /RUN /TN MeshChatTask\r\n');
+ child.stdin.write('SCHTASKS /DELETE /F /TN MeshChatTask\r\nexit\r\n');
+ child.waitExit();
+ }
+ break;
+ case 'linux':
+ child = require('child_process').execFile('/usr/bin/xdg-open', ['xdg-open', file], { uid: require('user-sessions').consoleUid() });
+ break;
+ case 'darwin':
+ child = require('child_process').execFile('/usr/bin/open', ['open', file]);
+ break;
+ default:
+ // Unknown platform, ignore this command.
+ break;
+ }
+ } catch (ex) { }
+ return child;
+}
+
// Open a web browser to a specified URL on current user's desktop
function openUserDesktopUrl(url) {
if ((url.toLowerCase().startsWith('http://') == false) && (url.toLowerCase().startsWith('https://') == false)) { return null; }
@@ -3656,14 +3947,15 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
var response = null;
switch (cmd) {
case 'help': { // Displays available commands
- var fin = '', f = '', availcommands = 'domain,translations,agentupdate,errorlog,msh,timerinfo,coreinfo,coredump,service,fdsnapshot,fdcount,startupoptions,alert,agentsize,versions,help,info,osinfo,args,print,type,dbkeys,dbget,dbset,dbcompact,eval,parseuri,httpget,wslist,plugin,wsconnect,wssend,wsclose,notify,ls,ps,kill,netinfo,location,power,wakeonlan,setdebug,smbios,rawsmbios,toast,lock,users,openurl,getscript,getclip,setclip,log,av,cpuinfo,sysinfo,apf,scanwifi,wallpaper,agentmsg,task';
+ var fin = '', f = '', availcommands = 'domain,translations,agentupdate,errorlog,msh,timerinfo,coreinfo,coreinfoupdate,coredump,service,fdsnapshot,fdcount,startupoptions,alert,agentsize,versions,help,info,osinfo,args,print,type,dbkeys,dbget,dbset,dbcompact,eval,parseuri,httpget,wslist,plugin,wsconnect,wssend,wsclose,notify,ls,ps,kill,netinfo,location,power,wakeonlan,setdebug,smbios,rawsmbios,toast,lock,users,openurl,getscript,getclip,setclip,log,av,cpuinfo,sysinfo,apf,scanwifi,wallpaper,agentmsg,task,uninstallagent,display,openfile';
if (require('os').dns != null) { availcommands += ',dnsinfo'; }
try { require('linux-dhcp'); availcommands += ',dhcp'; } catch (ex) { }
if (process.platform == 'win32') {
- availcommands += ',cs,wpfhwacceleration,uac,volumes';
+ availcommands += ',bitlocker,cs,wpfhwacceleration,uac,volumes,rdpport,deskbackground';
if (bcdOK()) { availcommands += ',safemode'; }
if (require('notifybar-desktop').DefaultPinned != null) { availcommands += ',privacybar'; }
try { require('win-utils'); availcommands += ',taskbar'; } catch (ex) { }
+ try { require('win-info'); availcommands += ',installedapps,qfe'; } catch (ex) { }
}
if (amt != null) { availcommands += ',amt,amtconfig,amtevents'; }
if (process.platform != 'freebsd') { availcommands += ',vm'; }
@@ -3820,6 +4112,14 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
case 'volumes':
response = JSON.stringify(require('win-volumes').getVolumes(), null, 1);
break;
+ case 'bitlocker':
+ if (process.platform == 'win32') {
+ if (require('win-volumes').volumes_promise != null) {
+ var p = require('win-volumes').volumes_promise();
+ p.then(function (res) { sendConsoleText(JSON.stringify(cleanGetBitLockerVolumeInfo(res), null, 1), this.session); });
+ }
+ }
+ break;
case 'dhcp': // This command is only supported on Linux, this is because Linux does not give us the DNS suffix for each network adapter independently so we have to ask the DHCP server.
{
try { require('linux-dhcp'); } catch (ex) { response = 'Unknown command "dhcp", type "help" for list of available commands.'; break; }
@@ -3925,7 +4225,67 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
}
break;
case 'msh':
- response = JSON.stringify(_MSH(), null, 2);
+ if (args['_'].length == 0) {
+ response = JSON.stringify(_MSH(), null, 2);
+ } else if (args['_'].length > 3) {
+ response = 'Proper usage: msh [get|set|delete]\r\nmsh get MeshServer\r\nmsh set abc "xyz"\r\nmsh delete abc';
+ } else {
+ var mshFileName = process.execPath.replace('.exe','') + '.msh';
+ switch (args['_'][0].toLocaleLowerCase()) {
+ case 'get':
+ if (typeof args['_'][1] != 'string' || args['_'].length > 2) {
+ response = 'Proper usage: msh get MeshServer';
+ } else if(_MSH()[args['_'][1]]) {
+ response = _MSH()[args['_'][1]];
+ } else {
+ response = "Unknown Value: " + args['_'][1];
+ }
+ break;
+ case 'set':
+ if (typeof args['_'][1] != 'string' || typeof args['_'][2] != 'string') {
+ response = 'Proper usage: msh set abc "xyz"';
+ } else {
+ var jsonToSave = _MSH();
+ jsonToSave[args['_'][1]] = args['_'][2];
+ var updatedContent = '';
+ for (var key in jsonToSave) {
+ if (jsonToSave.hasOwnProperty(key)) {
+ updatedContent += key + '=' + jsonToSave[key] + '\n';
+ }
+ }
+ try {
+ require('fs').writeFileSync(mshFileName, updatedContent);
+ response = "msh set " + args['_'][1] + " successful"
+ } catch (ex) {
+ response = "msh set " + args['_'][1] + " unsuccessful";
+ }
+ }
+ break;
+ case 'delete':
+ if (typeof args['_'][1] != 'string') {
+ response = 'Proper usage: msh delete abc';
+ } else {
+ var jsonToSave = _MSH();
+ delete jsonToSave[args['_'][1]];
+ var updatedContent = '';
+ for (var key in jsonToSave) {
+ if (jsonToSave.hasOwnProperty(key)) {
+ updatedContent += key + '=' + jsonToSave[key] + '\n';
+ }
+ }
+ try {
+ require('fs').writeFileSync(mshFileName, updatedContent);
+ response = "msh delete " + args['_'][1] + " successful"
+ } catch (ex) {
+ response = "msh delete " + args['_'][1] + " unsuccessful";
+ }
+ }
+ break;
+ default:
+ response = 'Proper usage: msh [get|set|delete]\r\nmsh get MeshServer\r\nmsh set abc "xyz"\r\nmsh delete abc';
+ break;
+ }
+ }
break;
case 'dnsinfo':
if (require('os').dns == null) {
@@ -3943,6 +4303,44 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
case 'timerinfo':
response = require('ChainViewer').getTimerInfo();
break;
+ case 'rdpport':
+ if (process.platform != 'win32') {
+ response = 'Unknown command "rdpport", type "help" for list of available commands.';
+ return;
+ }
+ if (args['_'].length == 0) {
+ response = 'Proper usage: rdpport [get|default|PORTNUMBER]';
+ } else {
+ switch (args['_'][0].toLocaleLowerCase()) {
+ case 'get':
+ var rdpport = require('win-registry').QueryKey(require('win-registry').HKEY.LocalMachine, 'System\\CurrentControlSet\\Control\\Terminal Server\\WinStations\\RDP-Tcp', 'PortNumber');
+ response = "Current RDP Port Set To: " + rdpport + '\r\n';
+ break;
+ case 'default':
+ try {
+ require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'System\\CurrentControlSet\\Control\\Terminal Server\\WinStations\\RDP-Tcp', 'PortNumber', 3389);
+ response = 'RDP Port Set To 3389, Please Dont Forget To Restart Your Computer To Fully Apply';
+ } catch (ex) {
+ response = 'Unable to Set RDP Port To: 3389';
+ }
+ break;
+ default:
+ if (isNaN(parseFloat(args['_'][0]))){
+ response = 'Proper usage: rdpport [get|default|PORTNUMBER]';
+ } else if(parseFloat(args['_'][0]) < 0 || args['_'][0] > 65535) {
+ response = 'RDP Port Must Be More Than 0 And Less Than 65535';
+ } else {
+ try {
+ require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'System\\CurrentControlSet\\Control\\Terminal Server\\WinStations\\RDP-Tcp', 'PortNumber', parseFloat(args['_'][0]));
+ response = 'RDP Port Set To ' + args['_'][0] + ', Please Dont Forget To Restart Your Computer To Fully Apply';
+ } catch (ex) {
+ response = 'Unable to Set RDP Port To: '+args['_'][0];
+ }
+ }
+ break;
+ }
+ }
+ break;
case 'find':
if (args['_'].length <= 1) {
response = "Proper usage:\r\n find root criteria [criteria2] [criteria n...]";
@@ -3962,12 +4360,13 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
break;
}
case 'coreinfoupdate': {
- sendPeriodicServerUpdate();
+ sendPeriodicServerUpdate(null, true);
+ response = "Core Info Update Requested"
break;
}
case 'agentmsg': {
if (args['_'].length == 0) {
- response = "Proper usage:\r\n agentmsg add \"[message]\" [iconIndex]\r\n agentmsg remove [index]\r\n agentmsg list"; // Display usage
+ response = "Proper usage:\r\n agentmsg add \"[message]\" [iconIndex]\r\n agentmsg remove [id]\r\n agentmsg list"; // Display usage
} else {
if ((args['_'][0] == 'add') && (args['_'].length > 1)) {
var msgID, iconIndex = 0;
@@ -4075,12 +4474,12 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
break;
case 'unzip':
if (args['_'].length == 0) {
- response = "Proper usage: unzip input, destination"; // Display usage
+ response = "Proper usage: unzip input,destination"; // Display usage
} else {
var p = args['_'].join(' ').split(',');
- if (p.length != 2) { response = "Proper usage: unzip input, destination"; break; } // Display usage
- var prom = require('zip-reader').read(p[0]);
- prom._dest = p[1];
+ if (p.length != 2) { response = "Proper usage: unzip input,destination"; break; } // Display usage
+ var prom = require('zip-reader').read(p[0].trim());
+ prom._dest = p[1].trim();
prom.self = this;
prom.sessionid = sessionid;
prom.then(function (zipped) {
@@ -4147,7 +4546,7 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
}
break;
case 'vm':
- response = 'Virtual Machine = ' + require('identifiers').isVM();
+ response = 'Virtual Machine = ' + require('computer-identifiers').isVM();
break;
case 'startupoptions':
response = JSON.stringify(require('MeshAgent').getStartupOptions());
@@ -4185,10 +4584,11 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
if (process.platform == 'win32') {
// Check the Agent Uninstall MetaData for correctness, as the installer may have written an incorrect value
var writtenSize = 0;
- try { writtenSize = require('win-registry').QueryKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\MeshCentralAgent', 'EstimatedSize'); } catch (ex) { response = ex; }
+ var serviceName = (_MSH().serviceName ? _MSH().serviceName : (require('_agentNodeId').serviceName() ? require('_agentNodeId').serviceName() : 'Mesh Agent'));
+ try { writtenSize = require('win-registry').QueryKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\' + serviceName, 'EstimatedSize'); } catch (ex) { response = ex; }
if (writtenSize != actualSize) {
response = "Size updated from: " + writtenSize + " to: " + actualSize;
- try { require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\MeshCentralAgent', 'EstimatedSize', actualSize); } catch (ex) { response = ex; }
+ try { require('win-registry').WriteKey(require('win-registry').HKEY.LocalMachine, 'Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\' + serviceName, 'EstimatedSize', actualSize); } catch (ex) { response = ex; }
} else
{ response = "Agent Size: " + actualSize + " kb"; }
} else
@@ -4450,6 +4850,11 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
else { if (openUserDesktopUrl(args['_'][0]) == null) { response = 'Failed.'; } else { response = 'Success.'; } }
break;
}
+ case 'openfile': {
+ if (args['_'].length != 1) { response = 'Proper usage: openfile (filepath)'; } // Display usage
+ else { if (openFileOnDesktop(args['_'][0]) == null) { response = 'Failed.'; } else { response = 'Success.'; } }
+ break;
+ }
case 'users': {
if (meshCoreObj.users == null) { response = 'Active users are unknown.'; } else { response = 'Active Users: ' + meshCoreObj.users.join(', ') + '.'; }
require('user-sessions').enumerateUsers().then(function (u) { for (var i in u) { sendConsoleText(u[i]); } });
@@ -4561,8 +4966,11 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
}
case 'sysinfo': { // Return system information
getSystemInformation(function (results, err) {
- if (results == null) { sendConsoleText(err, this.sessionid); } else {
+ if (results == null) {
+ sendConsoleText(err, this.sessionid);
+ } else {
sendConsoleText(JSON.stringify(results, null, 1), this.sessionid);
+ mesh.SendCommand({ action: 'sysinfo', sessionid: this.sessionid, data: results });
}
});
break;
@@ -4575,7 +4983,9 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
response += '\r\nServer Connection: ' + mesh.isControlChannelConnected + ', State: ' + meshServerConnectionState + '.';
var oldNodeId = db.Get('OldNodeId');
if (oldNodeId != null) { response += '\r\nOldNodeID: ' + oldNodeId + '.'; }
+ response += '\r\nNode ID: ' + Buffer.from(require('_agentNodeId')(), 'hex').toString('base64').replace(/\+/g, '@').replace(/\//g, '$');
if (process.platform == 'linux' || process.platform == 'freebsd') { response += '\r\nX11 support: ' + require('monitor-info').kvm_x11_support + '.'; }
+ response += '\r\nApplication Location: ' + process.cwd();
//response += '\r\Debug Console: ' + debugConsole + '.';
break;
}
@@ -4802,6 +5212,21 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
}
break;
}
+ case 'display': {
+ if (args['_'].length != 1) {
+ response = 'Proper usage: display (sleep | awake)';
+ } else {
+ var sleepawake = [args['_'][0]];
+ if(sleepawake=='sleep'){
+ require('power-monitor').sleepDisplay()
+ }else if(sleepawake=='awake'){
+ require('power-monitor').wakeDisplay()
+
+ }
+ response = 'Setting Display To ' + sleepawake;
+ }
+ break;
+ }
case 'sendall': { // Send a message to all consoles on this mesh
sendConsoleText(args['_'].join(' '));
break;
@@ -4966,6 +5391,19 @@ function processConsoleCommand(cmd, args, rights, sessionid) {
}
break;
}
+ case 'installedapps': {
+ if(process.platform == 'win32'){
+ require('win-info').installedApps().then(function (apps){ sendConsoleText(JSON.stringify(apps,null,1)); });
+ }
+ break;
+ }
+ case 'qfe': {
+ if(process.platform == 'win32'){
+ var qfe = require('win-info').qfe();
+ sendConsoleText(JSON.stringify(qfe,null,1));
+ }
+ break;
+ }
default: { // This is an unknown command, return an error message
response = "Unknown command \"" + cmd + "\", type \"help\" for list of available commands.";
break;
@@ -5230,12 +5668,12 @@ function windows_execve(name, agentfilename, sessionid) {
sendAgentMessage('Self Update failed because msvcrt.dll is missing', 3);
return;
}
-
+
var cmd = require('_GenericMarshal').CreateVariable(process.env['windir'] + '\\system32\\cmd.exe', { wide: true });
var args = require('_GenericMarshal').CreateVariable(3 * require('_GenericMarshal').PointerSize);
var arg1 = require('_GenericMarshal').CreateVariable('cmd.exe', { wide: true });
- var arg2 = require('_GenericMarshal').CreateVariable('/C wmic service "' + name + '" call stopservice & "' + process.cwd() + agentfilename + '.update.exe" -b64exec ' + 'dHJ5CnsKICAgIHZhciBzZXJ2aWNlTG9jYXRpb24gPSBwcm9jZXNzLmFyZ3YucG9wKCkudG9Mb3dlckNhc2UoKTsKICAgIHJlcXVpcmUoJ3Byb2Nlc3MtbWFuYWdlcicpLmVudW1lcmF0ZVByb2Nlc3NlcygpLnRoZW4oZnVuY3Rpb24gKHByb2MpCiAgICB7CiAgICAgICAgZm9yICh2YXIgcCBpbiBwcm9jKQogICAgICAgIHsKICAgICAgICAgICAgaWYgKHByb2NbcF0ucGF0aCAmJiAocHJvY1twXS5wYXRoLnRvTG93ZXJDYXNlKCkgPT0gc2VydmljZUxvY2F0aW9uKSkKICAgICAgICAgICAgewogICAgICAgICAgICAgICAgcHJvY2Vzcy5raWxsKHByb2NbcF0ucGlkKTsKICAgICAgICAgICAgfQogICAgICAgIH0KICAgICAgICBwcm9jZXNzLmV4aXQoKTsKICAgIH0pOwp9CmNhdGNoIChlKQp7CiAgICBwcm9jZXNzLmV4aXQoKTsKfQ==' +
- ' "' + process.execPath + '" & copy "' + process.cwd() + agentfilename + '.update.exe" "' + process.execPath + '" & wmic service "' + name + '" call startservice & erase "' + process.cwd() + agentfilename + '.update.exe"', { wide: true });
+ var arg2 = require('_GenericMarshal').CreateVariable('/C net stop "' + name + '" & "' + process.cwd() + agentfilename + '.update.exe" -b64exec ' + 'dHJ5CnsKICAgIHZhciBzZXJ2aWNlTG9jYXRpb24gPSBwcm9jZXNzLmFyZ3YucG9wKCkudG9Mb3dlckNhc2UoKTsKICAgIHJlcXVpcmUoJ3Byb2Nlc3MtbWFuYWdlcicpLmVudW1lcmF0ZVByb2Nlc3NlcygpLnRoZW4oZnVuY3Rpb24gKHByb2MpCiAgICB7CiAgICAgICAgZm9yICh2YXIgcCBpbiBwcm9jKQogICAgICAgIHsKICAgICAgICAgICAgaWYgKHByb2NbcF0ucGF0aCAmJiAocHJvY1twXS5wYXRoLnRvTG93ZXJDYXNlKCkgPT0gc2VydmljZUxvY2F0aW9uKSkKICAgICAgICAgICAgewogICAgICAgICAgICAgICAgcHJvY2Vzcy5raWxsKHByb2NbcF0ucGlkKTsKICAgICAgICAgICAgfQogICAgICAgIH0KICAgICAgICBwcm9jZXNzLmV4aXQoKTsKICAgIH0pOwp9CmNhdGNoIChlKQp7CiAgICBwcm9jZXNzLmV4aXQoKTsKfQ==' +
+ ' "' + process.execPath + '" & copy "' + process.cwd() + agentfilename + '.update.exe" "' + process.execPath + '" & net start "' + name + '" & erase "' + process.cwd() + agentfilename + '.update.exe"', { wide: true });
arg1.pointerBuffer().copy(args.toBuffer());
arg2.pointerBuffer().copy(args.toBuffer(), require('_GenericMarshal').PointerSize);
@@ -5425,6 +5863,7 @@ function handleServerConnection(state) {
// Update the server on with basic info, logged in users and more advanced stuff, like Intel ME and Network Settings
meInfoStr = null;
+ LastPeriodicServerUpdate = null;
sendPeriodicServerUpdate(null, true);
if (selfInfoUpdateTimer == null) {
selfInfoUpdateTimer = setInterval(sendPeriodicServerUpdate, 1200000); // 20 minutes
@@ -5466,6 +5905,7 @@ function sendNetworkUpdate(force) {
function sendPeriodicServerUpdate(flags, force) {
if (meshServerConnectionState == 0) return; // Not connected to server, do nothing.
if (!flags) { flags = 0xFFFFFFFF; }
+ if (!force) { force = false; }
// If we have a connected MEI, get Intel ME information
if ((flags & 1) && (amt != null) && (amt.state == 2)) {
@@ -5498,6 +5938,15 @@ function sendPeriodicServerUpdate(flags, force) {
});
} catch (ex) { }
}
+
+ // Get Defender for Windows Server
+ try {
+ var d = require('win-info').defender();
+ d.then(function(res){
+ meshCoreObj.defender = res;
+ meshCoreObjChanged();
+ });
+ } catch (ex) { }
}
// Send available data right now
@@ -5511,6 +5960,26 @@ function sendPeriodicServerUpdate(flags, force) {
}
}
+// Sort the names in an object
+function sortObject(obj) { return Object.keys(obj).sort().reduce(function(a, v) { a[v] = obj[v]; return a; }, {}); }
+
+// Fix the incoming data and cut down how much data we use
+function cleanGetBitLockerVolumeInfo(volumes) {
+ for (var i in volumes) {
+ const v = volumes[i];
+ if (typeof v.size == 'string') { v.size = parseInt(v.size); }
+ if (typeof v.sizeremaining == 'string') { v.sizeremaining = parseInt(v.sizeremaining); }
+ if (v.identifier == '') { delete v.identifier; }
+ if (v.name == '') { delete v.name; }
+ if (v.removable != true) { delete v.removable; }
+ if (v.cdrom != true) { delete v.cdrom; }
+ if (v.protectionStatus == 'On') { v.protectionStatus = true; } else { delete v.protectionStatus; }
+ if (v.volumeStatus == 'FullyDecrypted') { delete v.volumeStatus; }
+ if (v.recoveryPassword == '') { delete v.recoveryPassword; }
+ }
+ return sortObject(volumes);
+}
+
// Once we are done collecting all the data, send to server if needed
var LastPeriodicServerUpdate = null;
var PeriodicServerUpdateNagleTimer = null;
diff --git a/agents/modules_meshcmd/sysinfo.js b/agents/modules_meshcmd/sysinfo.js
index 02c355d9..611a7b1a 100644
--- a/agents/modules_meshcmd/sysinfo.js
+++ b/agents/modules_meshcmd/sysinfo.js
@@ -225,19 +225,14 @@ function macos_memUtilization()
function windows_thermals()
{
var ret = [];
- child = require('child_process').execFile(process.env['windir'] + '\\System32\\wbem\\wmic.exe', ['wmic', '/namespace:\\\\root\\wmi', 'PATH', 'MSAcpi_ThermalZoneTemperature', 'get', 'CurrentTemperature']);
- child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
- child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
- child.waitExit();
-
- if(child.stdout.str.trim!='')
- {
- var lines = child.stdout.str.trim().split('\r\n');
- for (var i = 1; i < lines.length; ++i)
- {
- if (lines[i].trim() != '') { ret.push(((parseFloat(lines[i]) / 10) - 273.15).toFixed(2)); }
+ try {
+ ret = require('win-wmi').query('ROOT\\WMI', 'SELECT CurrentTemperature,InstanceName FROM MSAcpi_ThermalZoneTemperature',['CurrentTemperature','InstanceName']);
+ if (ret[0]) {
+ for (var i = 0; i < ret.length; ++i) {
+ ret[i]['CurrentTemperature'] = ((parseFloat(ret[i]['CurrentTemperature']) / 10) - 273.15).toFixed(2);
+ }
}
- }
+ } catch (ex) { }
return (ret);
}
@@ -285,16 +280,10 @@ function macos_thermals()
return (ret);
}
-switch(process.platform)
-{
- case 'linux':
- module.exports = { cpuUtilization: linux_cpuUtilization, memUtilization: linux_memUtilization, thermals: linux_thermals };
- break;
- case 'win32':
- module.exports = { cpuUtilization: windows_cpuUtilization, memUtilization: windows_memUtilization, thermals: windows_thermals };
- break;
- case 'darwin':
- module.exports = { cpuUtilization: macos_cpuUtilization, memUtilization: macos_memUtilization, thermals: macos_thermals };
- break;
-}
+const platformConfig = {
+ linux: { cpuUtilization: linux_cpuUtilization, memUtilization: linux_memUtilization, thermals: linux_thermals },
+ win32: { cpuUtilization: windows_cpuUtilization, memUtilization: windows_memUtilization, thermals: windows_thermals },
+ darwin: { cpuUtilization: macos_cpuUtilization, memUtilization: macos_memUtilization, thermals: macos_thermals }
+};
+module.exports = platformConfig[process.platform];
diff --git a/agents/modules_meshcore/computer-identifiers.js b/agents/modules_meshcore/computer-identifiers.js
new file mode 100644
index 00000000..ce5e3520
--- /dev/null
+++ b/agents/modules_meshcore/computer-identifiers.js
@@ -0,0 +1,902 @@
+/*
+Copyright 2019-2021 Intel Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+function trimIdentifiers(val)
+{
+ for(var v in val)
+ {
+ if (!val[v] || val[v] == 'None' || val[v] == '') { delete val[v]; }
+ }
+}
+function trimResults(val)
+{
+ var i, x;
+ for (i = 0; i < val.length; ++i)
+ {
+ for (x in val[i])
+ {
+ if (x.startsWith('_'))
+ {
+ delete val[i][x];
+ }
+ else
+ {
+ if (val[i][x] == null || val[i][x] == 0)
+ {
+ delete val[i][x];
+ }
+ }
+ }
+ }
+}
+function brief(headers, obj)
+{
+ var i, x;
+ for (x = 0; x < obj.length; ++x)
+ {
+ for (i in obj[x])
+ {
+ if (!headers.includes(i))
+ {
+ delete obj[x][i];
+ }
+ }
+ }
+ return (obj);
+}
+
+function dataHandler(c)
+{
+ this.str += c.toString();
+}
+
+function linux_identifiers()
+{
+ var identifiers = {};
+ var ret = {};
+ var values = {};
+
+ if (!require('fs').existsSync('/sys/class/dmi/id')) {
+ if (require('fs').existsSync('/sys/firmware/devicetree/base/model')) {
+ if (require('fs').readFileSync('/sys/firmware/devicetree/base/model').toString().trim().startsWith('Raspberry')) {
+ identifiers['board_vendor'] = 'Raspberry Pi';
+ identifiers['board_name'] = require('fs').readFileSync('/sys/firmware/devicetree/base/model').toString().trim();
+ identifiers['board_serial'] = require('fs').readFileSync('/sys/firmware/devicetree/base/serial-number').toString().trim();
+ const memorySlots = [];
+ var child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stdin.write('vcgencmd get_mem arm && vcgencmd get_mem gpu\nexit\n');
+ child.waitExit();
+ try {
+ const lines = child.stdout.str.trim().split('\n');
+ if (lines.length == 2) {
+ memorySlots.push({ Locator: "ARM Memory", Size: lines[0].split('=')[1].trim() })
+ memorySlots.push({ Locator: "GPU Memory", Size: lines[1].split('=')[1].trim() })
+ ret.memory = { Memory_Device: memorySlots };
+ }
+ } catch (xx) { }
+ } else {
+ throw('Unknown board');
+ }
+ } else {
+ throw ('this platform does not have DMI statistics');
+ }
+ } else {
+ var entries = require('fs').readdirSync('/sys/class/dmi/id');
+ for (var i in entries) {
+ if (require('fs').statSync('/sys/class/dmi/id/' + entries[i]).isFile()) {
+ try {
+ ret[entries[i]] = require('fs').readFileSync('/sys/class/dmi/id/' + entries[i]).toString().trim();
+ } catch(z) { }
+ if (ret[entries[i]] == 'None') { delete ret[entries[i]]; }
+ }
+ }
+ entries = null;
+
+ identifiers['bios_date'] = ret['bios_date'];
+ identifiers['bios_vendor'] = ret['bios_vendor'];
+ identifiers['bios_version'] = ret['bios_version'];
+ identifiers['bios_serial'] = ret['product_serial'];
+ identifiers['board_name'] = ret['board_name'];
+ identifiers['board_serial'] = ret['board_serial'];
+ identifiers['board_vendor'] = ret['board_vendor'];
+ identifiers['board_version'] = ret['board_version'];
+ identifiers['product_uuid'] = ret['product_uuid'];
+ identifiers['product_name'] = ret['product_name'];
+ }
+
+ try {
+ identifiers['bios_mode'] = (require('fs').statSync('/sys/firmware/efi').isDirectory() ? 'UEFI': 'Legacy');
+ } catch (ex) { identifiers['bios_mode'] = 'Legacy'; }
+
+ var child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stdin.write('cat /proc/cpuinfo | grep -i "model name" | ' + "tr '\\n' ':' | awk -F: '{ print $2 }'\nexit\n");
+ child.waitExit();
+ identifiers['cpu_name'] = child.stdout.str.trim();
+ if (identifiers['cpu_name'] == "") { // CPU BLANK, check lscpu instead
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stdin.write('lscpu | grep -i "model name" | ' + "tr '\\n' ':' | awk -F: '{ print $2 }'\nexit\n");
+ child.waitExit();
+ identifiers['cpu_name'] = child.stdout.str.trim();
+ }
+ child = null;
+
+
+ // Fetch GPU info
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stdin.write("lspci | grep ' VGA ' | tr '\\n' '`' | awk '{ a=split($0,lines" + ',"`"); printf "["; for(i=1;i1 {printf "{\\"size\\":\\"%s\\",\\"used\\":\\"%s\\",\\"available\\":\\"%s\\",\\"mount_point\\":\\"%s\\",\\"type\\":\\"%s\\"},", $1, $2, $3, $4, $5}\' | sed \'$ s/,$//\' | awk \'BEGIN {printf "["} {printf "%s", $0} END {printf "]"}\'\nexit\n');
+ child.waitExit();
+ try { ret.volumes = JSON.parse(child.stdout.str.trim()); } catch (xx) { }
+ child = null;
+
+ values.identifiers = identifiers;
+ values.linux = ret;
+ trimIdentifiers(values.identifiers);
+
+ var dmidecode = require('lib-finder').findBinary('dmidecode');
+ if (dmidecode != null)
+ {
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stderr.str = ''; child.stderr.on('data', dataHandler);
+ child.stdin.write(dmidecode + " -t memory | tr '\\n' '`' | ");
+ child.stdin.write(" awk '{ ");
+ child.stdin.write(' printf("[");');
+ child.stdin.write(' comma="";');
+ child.stdin.write(' c=split($0, lines, "``");');
+ child.stdin.write(' for(i=1;i<=c;++i)');
+ child.stdin.write(' {');
+ child.stdin.write(' d=split(lines[i], val, "`");');
+ child.stdin.write(' split(val[1], tokens, ",");');
+ child.stdin.write(' split(tokens[2], dmitype, " ");');
+ child.stdin.write(' dmi = dmitype[3]+0; ');
+ child.stdin.write(' if(dmi == 5 || dmi == 6 || dmi == 16 || dmi == 17)');
+ child.stdin.write(' {');
+ child.stdin.write(' ccx="";');
+ child.stdin.write(' printf("%s{\\"%s\\": {", comma, val[2]);');
+ child.stdin.write(' for(j=3;j1)');
+ child.stdin.write(' {');
+ child.stdin.write(' sub(/^[ \\t]*/,"",tmp[2]);');
+ child.stdin.write(' gsub(/ /,"",tmp[1]);');
+ child.stdin.write(' printf("%s\\"%s\\": \\"%s\\"", ccx, tmp[1], tmp[2]);');
+ child.stdin.write(' ccx=",";');
+ child.stdin.write(' }');
+ child.stdin.write(' }');
+ child.stdin.write(' printf("}}");');
+ child.stdin.write(' comma=",";');
+ child.stdin.write(' }');
+ child.stdin.write(' }');
+ child.stdin.write(' printf("]");');
+ child.stdin.write("}'\nexit\n");
+ child.waitExit();
+
+ try
+ {
+ var j = JSON.parse(child.stdout.str);
+ var i, key, key2;
+ for (i = 0; i < j.length; ++i)
+ {
+ for (key in j[i])
+ {
+ delete j[i][key]['ArrayHandle'];
+ delete j[i][key]['ErrorInformationHandle'];
+ for (key2 in j[i][key])
+ {
+ if (j[i][key][key2] == 'Unknown' || j[i][key][key2] == 'Not Specified' || j[i][key][key2] == '')
+ {
+ delete j[i][key][key2];
+ }
+ }
+ }
+ }
+
+ if(j.length > 0){
+ var mem = {};
+ for (i = 0; i < j.length; ++i)
+ {
+ for (key in j[i])
+ {
+ if (mem[key] == null) { mem[key] = []; }
+ mem[key].push(j[i][key]);
+ }
+ }
+ values.linux.memory = mem;
+ }
+ }
+ catch (e)
+ { }
+ child = null;
+ }
+
+ var usbdevices = require('lib-finder').findBinary('usb-devices');
+ if (usbdevices != null)
+ {
+ var child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stderr.str = ''; child.stderr.on('data', dataHandler);
+ child.stdin.write(usbdevices + " | tr '\\n' '`' | ");
+ child.stdin.write(" awk '");
+ child.stdin.write('{');
+ child.stdin.write(' comma="";');
+ child.stdin.write(' printf("[");');
+ child.stdin.write(' len=split($0, group, "``");');
+ child.stdin.write(' for(i=1;i<=len;++i)');
+ child.stdin.write(' {');
+ child.stdin.write(' comma2="";');
+ child.stdin.write(' xlen=split(group[i], line, "`");');
+ child.stdin.write(' scount=0;');
+ child.stdin.write(' for(x=1;x0)');
+ child.stdin.write(' {');
+ child.stdin.write(' printf("%s{", comma); comma=",";');
+ child.stdin.write(' for(x=1;x> 24) & 0xFF, (v >> 16) & 0xFF, (v >> 8) & 0xFF, v & 0xFF); };
+ try {
+ values = require('win-wmi').query('ROOT\\CIMV2\\Security\\MicrosoftTpm', "SELECT * FROM Win32_Tpm", ['IsActivated_InitialValue','IsEnabled_InitialValue','IsOwned_InitialValue','ManufacturerId','ManufacturerVersion','SpecVersion']);
+ if(values[0]) {
+ ret.tpm = {
+ SpecVersion: values[0].SpecVersion.split(",")[0],
+ ManufacturerId: IntToStr(values[0].ManufacturerId).replace(/[^\x00-\x7F]/g, ""),
+ ManufacturerVersion: values[0].ManufacturerVersion,
+ IsActivated: values[0].IsActivated_InitialValue,
+ IsEnabled: values[0].IsEnabled_InitialValue,
+ IsOwned: values[0].IsOwned_InitialValue,
+ }
+ }
+ } catch (ex) { }
+
+ return (ret);
+}
+function macos_identifiers()
+{
+ var ret = { identifiers: {}, darwin: {} };
+ var child;
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('ioreg -d2 -c IOPlatformExpertDevice | grep board-id | awk -F= \'{ split($2, res, "\\""); print res[2]; }\'\nexit\n');
+ child.waitExit();
+ ret.identifiers.board_name = child.stdout.str.trim();
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('ioreg -d2 -c IOPlatformExpertDevice | grep IOPlatformSerialNumber | awk -F= \'{ split($2, res, "\\""); print res[2]; }\'\nexit\n');
+ child.waitExit();
+ ret.identifiers.board_serial = child.stdout.str.trim();
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('ioreg -d2 -c IOPlatformExpertDevice | grep manufacturer | awk -F= \'{ split($2, res, "\\""); print res[2]; }\'\nexit\n');
+ child.waitExit();
+ ret.identifiers.board_vendor = child.stdout.str.trim();
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('ioreg -d2 -c IOPlatformExpertDevice | grep version | awk -F= \'{ split($2, res, "\\""); print res[2]; }\'\nexit\n');
+ child.waitExit();
+ ret.identifiers.board_version = child.stdout.str.trim();
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('ioreg -d2 -c IOPlatformExpertDevice | grep IOPlatformUUID | awk -F= \'{ split($2, res, "\\""); print res[2]; }\'\nexit\n');
+ child.waitExit();
+ ret.identifiers.product_uuid = child.stdout.str.trim();
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('sysctl -n machdep.cpu.brand_string\nexit\n');
+ child.waitExit();
+ ret.identifiers.cpu_name = child.stdout.str.trim();
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('system_profiler SPMemoryDataType\nexit\n');
+ child.waitExit();
+ var lines = child.stdout.str.trim().split('\n');
+ if(lines.length > 0) {
+ const memorySlots = [];
+ if(lines[2].trim().includes('Memory Slots:')) { // OLD MACS WITH SLOTS
+ var memorySlots1 = child.stdout.str.split(/\n{2,}/).slice(3);
+ memorySlots1.forEach(function(slot,index) {
+ var lines = slot.split('\n');
+ if(lines.length == 1){ // start here
+ if(lines[0].trim()!=''){
+ var slotObj = { DeviceLocator: lines[0].trim().replace(/:$/, '') }; // Initialize name as an empty string
+ var nextline = memorySlots1[index+1].split('\n');
+ nextline.forEach(function(line) {
+ if (line.trim() !== '') {
+ var parts = line.split(':');
+ var key = parts[0].trim();
+ var value = parts[1].trim();
+ value = (key == 'Part Number' || key == 'Manufacturer') ? hexToAscii(parts[1].trim()) : parts[1].trim();
+ slotObj[key.replace(' ','')] = value; // Store attribute in the slot object
+ }
+ });
+ memorySlots.push(slotObj);
+ }
+ }
+ });
+ } else { // NEW MACS WITHOUT SLOTS
+ memorySlots.push({ DeviceLocator: "Onboard Memory", Size: lines[2].split(":")[1].trim(), PartNumber: lines[3].split(":")[1].trim(), Manufacturer: lines[4].split(":")[1].trim() })
+ }
+ ret.darwin.memory = memorySlots;
+ }
+
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('diskutil info -all\nexit\n');
+ child.waitExit();
+ var sections = child.stdout.str.split('**********\n');
+ if(sections.length > 0){
+ var devices = [];
+ for (var i = 0; i < sections.length; i++) {
+ var lines = sections[i].split('\n');
+ var deviceInfo = {};
+ var wholeYes = false;
+ var physicalYes = false;
+ var oldmac = false;
+ for (var j = 0; j < lines.length; j++) {
+ var keyValue = lines[j].split(':');
+ var key = keyValue[0].trim();
+ var value = keyValue[1] ? keyValue[1].trim() : '';
+ if (key === 'Virtual') oldmac = true;
+ if (key === 'Whole' && value === 'Yes') wholeYes = true;
+ if (key === 'Virtual' && value === 'No') physicalYes = true;
+ if(value && key === 'Device / Media Name'){
+ deviceInfo['Caption'] = value;
+ }
+ if(value && key === 'Disk Size'){
+ deviceInfo['Size'] = value.split(' ')[0] + ' ' + value.split(' ')[1];
+ }
+ }
+ if (wholeYes) {
+ if (oldmac) {
+ if (physicalYes) devices.push(deviceInfo);
+ } else {
+ devices.push(deviceInfo);
+ }
+ }
+ }
+ ret.identifiers.storage_devices = devices;
+ }
+
+ // Fetch storage volumes using df
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stdin.write('df -aHY | awk \'NR>1 {printf "{\\"size\\":\\"%s\\",\\"used\\":\\"%s\\",\\"available\\":\\"%s\\",\\"mount_point\\":\\"%s\\",\\"type\\":\\"%s\\"},", $3, $4, $5, $10, $2}\' | sed \'$ s/,$//\' | awk \'BEGIN {printf "["} {printf "%s", $0} END {printf "]"}\'\nexit\n');
+ child.waitExit();
+ try {
+ ret.darwin.volumes = JSON.parse(child.stdout.str.trim());
+ for (var index = 0; index < ret.darwin.volumes.length; index++) {
+ if (ret.darwin.volumes[index].type == 'auto_home'){
+ ret.darwin.volumes.splice(index,1);
+ }
+ }
+ if (ret.darwin.volumes.length == 0) { // not sonima OS so dont show type for now
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', dataHandler);
+ child.stdin.write('df -aH | awk \'NR>1 {printf "{\\"size\\":\\"%s\\",\\"used\\":\\"%s\\",\\"available\\":\\"%s\\",\\"mount_point\\":\\"%s\\"},", $2, $3, $4, $9}\' | sed \'$ s/,$//\' | awk \'BEGIN {printf "["} {printf "%s", $0} END {printf "]"}\'\nexit\n');
+ child.waitExit();
+ try {
+ ret.darwin.volumes = JSON.parse(child.stdout.str.trim());
+ for (var index = 0; index < ret.darwin.volumes.length; index++) {
+ if (ret.darwin.volumes[index].size == 'auto_home'){
+ ret.darwin.volumes.splice(index,1);
+ }
+ }
+ } catch (xx) { }
+ }
+ } catch (xx) { }
+ child = null;
+
+ // MacOS Last Boot Up Time
+ try {
+ child = require('child_process').execFile('/usr/sbin/sysctl', ['', 'kern.boottime']); // must include blank value at begining for some reason?
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stderr.on('data', function () { });
+ child.waitExit();
+ const timestampMatch = /\{ sec = (\d+), usec = \d+ \}/.exec(child.stdout.str.trim());
+ if (!ret.darwin) {
+ ret.darwin = { LastBootUpTime: parseInt(timestampMatch[1]) };
+ } else {
+ ret.darwin.LastBootUpTime = parseInt(timestampMatch[1]);
+ }
+ child = null;
+ } catch (ex) { }
+
+ trimIdentifiers(ret.identifiers);
+
+ child = null;
+ return (ret);
+}
+
+function hexToAscii(hexString) {
+ if(!hexString.startsWith('0x')) return hexString.trim();
+ hexString = hexString.startsWith('0x') ? hexString.slice(2) : hexString;
+ var str = '';
+ for (var i = 0; i < hexString.length; i += 2) {
+ var hexPair = hexString.substr(i, 2);
+ str += String.fromCharCode(parseInt(hexPair, 16));
+ }
+ str = str.replace(/[\u007F-\uFFFF]/g, ''); // Remove characters from 0x0080 to 0xFFFF
+ return str.trim();
+}
+
+function win_chassisType()
+{
+ // needs to be replaced with win-wmi but due to bug in win-wmi it doesnt handle arrays correctly
+ var child = require('child_process').execFile(process.env['windir'] + '\\System32\\WindowsPowerShell\\v1.0\\powershell.exe', ['powershell', '-noprofile', '-nologo', '-command', '-'], {});
+ if (child == null) { return ([]); }
+ child.descriptorMetadata = 'process-manager';
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write('Get-WmiObject Win32_SystemEnclosure | Select-Object -ExpandProperty ChassisTypes\r\n');
+ child.stdin.write('exit\r\n');
+ child.waitExit();
+ try {
+ return (parseInt(child.stdout.str));
+ } catch (e) {
+ return (2); // unknown
+ }
+}
+
+function win_systemType()
+{
+ try {
+ var tokens = require('win-wmi').query('ROOT\\CIMV2', 'SELECT PCSystemType FROM Win32_ComputerSystem', ['PCSystemType']);
+ if (tokens[0]) {
+ return (parseInt(tokens[0]['PCSystemType']));
+ } else {
+ return (parseInt(1)); // default is desktop
+ }
+ } catch (ex) {
+ return (parseInt(1)); // default is desktop
+ }
+
+}
+
+function win_formFactor(chassistype)
+{
+ var ret = 'DESKTOP';
+ switch (chassistype)
+ {
+ case 11: // Handheld
+ case 30: // Tablet
+ case 31: // Convertible
+ case 32: // Detachable
+ ret = 'TABLET';
+ break;
+ case 9: // Laptop
+ case 10: // Notebook
+ case 14: // Sub Notebook
+ ret = 'LAPTOP';
+ break;
+ default:
+ ret = win_systemType() == 2 ? 'MOBILE' : 'DESKTOP';
+ break;
+ }
+
+ return (ret);
+}
+
+switch(process.platform)
+{
+ case 'linux':
+ module.exports = { _ObjectID: 'identifiers', get: linux_identifiers };
+ break;
+ case 'win32':
+ module.exports = { _ObjectID: 'identifiers', get: windows_identifiers, chassisType: win_chassisType, formFactor: win_formFactor, systemType: win_systemType };
+ break;
+ case 'darwin':
+ module.exports = { _ObjectID: 'identifiers', get: macos_identifiers };
+ break;
+ default:
+ module.exports = { get: function () { throw ('Unsupported Platform'); } };
+ break;
+}
+module.exports.isDocker = function isDocker()
+{
+ if (process.platform != 'linux') { return (false); }
+
+ var child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write("cat /proc/self/cgroup | tr '\n' '`' | awk -F'`' '{ split($1, res, " + '"/"); if(res[2]=="docker"){print "1";} }\'\nexit\n');
+ child.waitExit();
+ return (child.stdout.str != '');
+};
+module.exports.isBatteryPowered = function isBatteryOperated()
+{
+ var ret = false;
+ switch(process.platform)
+ {
+ default:
+ break;
+ case 'linux':
+ var devices = require('fs').readdirSync('/sys/class/power_supply');
+ for (var i in devices)
+ {
+ if (require('fs').readFileSync('/sys/class/power_supply/' + devices[i] + '/type').toString().trim() == 'Battery')
+ {
+ ret = true;
+ break;
+ }
+ }
+ break;
+ case 'win32':
+ var GM = require('_GenericMarshal');
+ var stats = GM.CreateVariable(12);
+ var kernel32 = GM.CreateNativeProxy('Kernel32.dll');
+ kernel32.CreateMethod('GetSystemPowerStatus');
+ if (kernel32.GetSystemPowerStatus(stats).Val != 0)
+ {
+ if(stats.toBuffer()[1] != 128 && stats.toBuffer()[1] != 255)
+ {
+ ret = true;
+ }
+ else
+ {
+ // No Battery detected, so lets check if there is supposed to be one
+ var formFactor = win_formFactor(win_chassisType());
+ return (formFactor == 'LAPTOP' || formFactor == 'TABLET' || formFactor == 'MOBILE');
+ }
+ }
+ break;
+ case 'darwin':
+ var child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function(c){ this.str += c.toString(); });
+ child.stderr.str = ''; child.stderr.on('data', function(c){ this.str += c.toString(); });
+ child.stdin.write("pmset -g batt | tr '\\n' '`' | awk -F'`' '{ if(NF>2) { print \"true\"; }}'\nexit\n");
+ child.waitExit();
+ if(child.stdout.str.trim() != '') { ret = true; }
+ break;
+ }
+ return (ret);
+};
+module.exports.isVM = function isVM()
+{
+ var ret = false;
+ var id = this.get();
+ if (id.linux && id.linux.sys_vendor)
+ {
+ switch (id.linux.sys_vendor)
+ {
+ case 'VMware, Inc.':
+ case 'QEMU':
+ case 'Xen':
+ ret = true;
+ break;
+ default:
+ break;
+ }
+ }
+ if (id.identifiers.bios_vendor)
+ {
+ switch(id.identifiers.bios_vendor)
+ {
+ case 'VMware, Inc.':
+ case 'Xen':
+ case 'SeaBIOS':
+ case 'EFI Development Kit II / OVMF':
+ case 'Proxmox distribution of EDK II':
+ ret = true;
+ break;
+ default:
+ break;
+ }
+ }
+ if (id.identifiers.board_vendor && id.identifiers.board_vendor == 'VMware, Inc.') { ret = true; }
+ if (id.identifiers.board_name)
+ {
+ switch (id.identifiers.board_name)
+ {
+ case 'VirtualBox':
+ case 'Virtual Machine':
+ ret = true;
+ break;
+ default:
+ break;
+ }
+ }
+
+ if (process.platform == 'win32' && !ret)
+ {
+ for(var i in id.identifiers.gpu_name)
+ {
+ if(id.identifiers.gpu_name[i].startsWith('VMware '))
+ {
+ ret = true;
+ break;
+ }
+ }
+ }
+
+
+ if (!ret) { ret = this.isDocker(); }
+ return (ret);
+};
+
+// bios_date = BIOS->ReleaseDate
+// bios_vendor = BIOS->Manufacturer
+// bios_version = BIOS->SMBIOSBIOSVersion
+// board_name = BASEBOARD->Product = ioreg/board-id
+// board_serial = BASEBOARD->SerialNumber = ioreg/serial-number | ioreg/IOPlatformSerialNumber
+// board_vendor = BASEBOARD->Manufacturer = ioreg/manufacturer
+// board_version = BASEBOARD->Version
diff --git a/agents/modules_meshcore/coretranslations.json b/agents/modules_meshcore/coretranslations.json
index 8da6fcfb..567a08f8 100644
--- a/agents/modules_meshcore/coretranslations.json
+++ b/agents/modules_meshcore/coretranslations.json
@@ -135,12 +135,12 @@
"allow": "Permitir",
"deny": "Negar",
"autoAllowForFive": "Aceita automaticamente todas as conexões pelos próximos 5 minutos",
- "terminalConsent": "{0} solicitando acesso ao terminal remoto. Garantir acesso?",
- "desktopConsent": "{0} solicitando acesso à área de trabalho remota. Garantir acesso?",
- "fileConsent": "{0} solicitando acesso remoto ao arquivo. Garantir acesso?",
+ "terminalConsent": "{0} está a pedir acesso ao terminal remoto. Conceder acesso?",
+ "desktopConsent": "{0} está a pedir acesso à área de trabalho remota. Conceder acesso?",
+ "fileConsent": "{0} está a pedir acesso remoto aos ficheiros. Conceder acesso?",
"terminalNotify": "{0} iniciou uma sessão de terminal remoto.",
"desktopNotify": "{0} iniciou uma sessão de área de trabalho remota.",
- "fileNotify": "{0} iniciou uma sessão de arquivo remoto.",
+ "fileNotify": "{0} iniciou uma sessão de ficheiro remoto.",
"privacyBar": "Compartilhando área de trabalho com: {0}"
},
"ru": {
@@ -250,5 +250,41 @@
"desktopNotify": "{0} je započeo sesiju udaljene radne površine.",
"fileNotify": "{0} je započeo sesiju udaljenog fajla.",
"privacyBar": "Dijeljenje radne površine sa: {0}"
+ },
+ "hu": {
+ "allow": "Engedélyezés",
+ "deny": "Elutasítás",
+ "autoAllowForFive": "Csatlakozások automatikus elfogadása a következő 5 percben",
+ "terminalConsent": "{0} távoli parancssor,terminál hozzáférést kér. Engedélyezi a hozzáférést?",
+ "desktopConsent": "{0} távoli asztali hozzáférést kér. Engedélyezi a hozzáférést?",
+ "fileConsent": "{0} távoli fájlhozzáférést kér. Engedélyezi a hozzáférést?",
+ "terminalNotify": "{0} távoli parancssor munkamenetet indított.",
+ "desktopNotify": "{0} távoli asztali munkamenetet indított.",
+ "fileNotify": "{0} távoli fájlmunkamenetet indított.",
+ "privacyBar": "Asztal megosztás aktív: {0} felhasználóval"
+ },
+ "ca": {
+ "allow": "Permetre",
+ "deny": "Negar",
+ "autoAllowForFive": "Accepta automàticament totes les connexions durant els propers 5 minuts",
+ "terminalConsent": "{0} sol·licitant accés al terminal remot. Accés garantit?",
+ "desktopConsent": "{0} sol·licitant accés a l'escriptori remot. Accés garantit?",
+ "fileConsent": "{0} sol·licitant accés remot al fitxer. Accés garantit?",
+ "terminalNotify": "{0} va iniciar una sessió de terminal remota.",
+ "desktopNotify": "{0} va iniciar una sessió d'escriptori remot.",
+ "fileNotify": "{0} va iniciar una sessió de fitxer remota.",
+ "privacyBar": "Compartint escriptori amb: {0}"
+ },
+ "uk": {
+ "allow": "Дозволити",
+ "deny": "Відмовити",
+ "autoAllowForFive": "Автоматично приймати всі підключення впродовж наступних 5 хвилин",
+ "terminalConsent": "{0} запитує доступ до віддаленого терміналу. Надати доступ?",
+ "desktopConsent": "{0} запитує віддалений доступ до стільниці. Надати доступ?",
+ "fileConsent": "{0} запитує віддалений доступ до файлу. Надати доступ?",
+ "terminalNotify": "{0} почав сеанс віддаленого терміналу.",
+ "desktopNotify": "{0} розпочав сеанс віддаленої стільниці.",
+ "fileNotify": "{0} розпочав віддалений файловий сеанс.",
+ "privacyBar": "Поширити доступ до стільниці з: {0}"
}
}
\ No newline at end of file
diff --git a/agents/modules_meshcore/sysinfo.js b/agents/modules_meshcore/sysinfo.js
index 02c355d9..cc13574d 100644
--- a/agents/modules_meshcore/sysinfo.js
+++ b/agents/modules_meshcore/sysinfo.js
@@ -159,7 +159,7 @@ function linux_memUtilization()
case 'MemTotal:':
ret.total = parseInt(tokens[tokens.length - 2]);
break;
- case 'MemFree:':
+ case 'MemAvailable:':
ret.free = parseInt(tokens[tokens.length - 2]);
break;
}
@@ -209,9 +209,13 @@ function macos_memUtilization()
{
var usage = lines[0].split(':')[1];
var bdown = usage.split(',');
-
- mem.MemTotal = parseInt(bdown[0].trim().split(' ')[0]);
- mem.MemFree = parseInt(bdown[1].trim().split(' ')[0]);
+ if (bdown.length > 2){ // new style - PhysMem: 5750M used (1130M wired, 634M compressor), 1918M unused.
+ mem.MemFree = parseInt(bdown[2].trim().split(' ')[0]);
+ } else { // old style - PhysMem: 6683M used (1606M wired), 9699M unused.
+ mem.MemFree = parseInt(bdown[1].trim().split(' ')[0]);
+ }
+ mem.MemUsed = parseInt(bdown[0].trim().split(' ')[0]);
+ mem.MemTotal = (mem.MemFree + mem.MemUsed);
mem.percentFree = ((mem.MemFree / mem.MemTotal) * 100);//.toFixed(2);
mem.percentConsumed = (((mem.MemTotal - mem.MemFree) / mem.MemTotal) * 100);//.toFixed(2);
return (mem);
@@ -225,31 +229,48 @@ function macos_memUtilization()
function windows_thermals()
{
var ret = [];
- child = require('child_process').execFile(process.env['windir'] + '\\System32\\wbem\\wmic.exe', ['wmic', '/namespace:\\\\root\\wmi', 'PATH', 'MSAcpi_ThermalZoneTemperature', 'get', 'CurrentTemperature']);
- child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
- child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
- child.waitExit();
-
- if(child.stdout.str.trim!='')
- {
- var lines = child.stdout.str.trim().split('\r\n');
- for (var i = 1; i < lines.length; ++i)
- {
- if (lines[i].trim() != '') { ret.push(((parseFloat(lines[i]) / 10) - 273.15).toFixed(2)); }
+ try {
+ ret = require('win-wmi').query('ROOT\\WMI', 'SELECT CurrentTemperature,InstanceName FROM MSAcpi_ThermalZoneTemperature',['CurrentTemperature','InstanceName']);
+ if (ret[0]) {
+ for (var i = 0; i < ret.length; ++i) {
+ ret[i]['CurrentTemperature'] = ((parseFloat(ret[i]['CurrentTemperature']) / 10) - 273.15).toFixed(2);
+ }
}
- }
+ } catch (ex) { }
return (ret);
}
function linux_thermals()
{
+ var ret = [];
child = require('child_process').execFile('/bin/sh', ['sh']);
child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
- child.stdin.write("cat /sys/class/thermal/thermal_zone*/temp | awk '{ print $0 / 1000 }'\nexit\n");
+ child.stdin.write("for folder in /sys/class/thermal/thermal_zone*/; do [ -e \"$folder/temp\" ] && echo \"$(cat \"$folder/temp\"),$(cat \"$folder/type\")\"; done\nexit\n");
child.waitExit();
- var ret = child.stdout.str.trim().split('\n');
- if (ret.length == 1 && ret[0] == '') { ret = []; }
+ if(child.stdout.str.trim()!='')
+ {
+ var lines = child.stdout.str.trim().split('\n');
+ for (var i = 0; i < lines.length; ++i)
+ {
+ var line = lines[i].trim().split(',');
+ ret.push({CurrentTemperature: (parseFloat(line[0])/1000), InstanceName: line[1]});
+ }
+ }
+ child = require('child_process').execFile('/bin/sh', ['sh']);
+ child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
+ child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
+ child.stdin.write("for mon in /sys/class/hwmon/hwmon*; do for label in \"$mon\"/temp*_label; do if [ -f $label ]; then echo $(cat \"$label\")___$(cat \"${label%_*}_input\"); fi; done; done;\nexit\n");
+ child.waitExit();
+ if(child.stdout.str.trim()!='')
+ {
+ var lines = child.stdout.str.trim().split('\n');
+ for (var i = 0; i < lines.length; ++i)
+ {
+ var line = lines[i].trim().split('___');
+ ret.push({ CurrentTemperature: (parseFloat(line[1])/1000), InstanceName: line[0] });
+ }
+ }
return (ret);
}
@@ -261,7 +282,6 @@ function macos_thermals()
child.stderr.on('data', function () { });
child.stdin.write('powermetrics --help | grep SMC\nexit\n');
child.waitExit();
-
if (child.stdout.str.trim() != '')
{
child = require('child_process').execFile('/bin/sh', ['sh']);
@@ -273,14 +293,19 @@ function macos_thermals()
{
if (tokens[i].split(' die temperature: ').length > 1)
{
- ret.push(tokens[i].split(' ')[3]);
+ ret.push({CurrentTemperature: tokens[i].split(' ')[3], InstanceName: tokens[i].split(' ')[0]});
this.parent.kill();
}
}
});
- child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
- child.stdin.write('powermetrics -s smc\n');
- child.waitExit(5000);
+ child.stderr.on('data', function (c) {
+ if (c.toString().split('unable to get smc values').length > 1) { // error getting sensors so just kill
+ this.parent.kill();
+ return;
+ }
+ });
+ child.stdin.write('powermetrics -s smc -i 500 -n 1\n');
+ child.waitExit(2000);
}
return (ret);
}
diff --git a/agents/modules_meshcore/win-info.js b/agents/modules_meshcore/win-info.js
index 4b0e8f98..dd60eb12 100644
--- a/agents/modules_meshcore/win-info.js
+++ b/agents/modules_meshcore/win-info.js
@@ -18,28 +18,21 @@ var promise = require('promise');
function qfe()
{
- var child = require('child_process').execFile(process.env['windir'] + '\\System32\\wbem\\wmic.exe', ['wmic', 'qfe', 'list', 'full', '/FORMAT:CSV']);
- child.stdout.str = ''; child.stdout.on('data', function (c) { this.str += c.toString(); });
- child.stderr.str = ''; child.stderr.on('data', function (c) { this.str += c.toString(); });
- child.waitExit();
-
- var lines = child.stdout.str.trim().split('\r\n');
- var keys = lines[0].split(',');
- var i, key;
- var tokens;
- var result = [];
-
- for (i = 1; i < lines.length; ++i)
- {
- var obj = {};
- tokens = lines[i].split(',');
- for (key = 0; key < keys.length; ++key)
- {
- if (tokens[key]) { obj[keys[key]] = tokens[key]; }
+ try {
+ var tokens = require('win-wmi').query('ROOT\\CIMV2', 'SELECT * FROM Win32_QuickFixEngineering');
+ if (tokens[0]){
+ for (var index = 0; index < tokens.length; index++) {
+ for (var key in tokens[index]) {
+ if (key.startsWith('__')) delete tokens[index][key];
+ }
+ }
+ return (tokens);
+ } else {
+ return ([]);
}
- result.push(obj);
+ } catch (ex) {
+ return ([]);
}
- return (result);
}
function av()
{
@@ -53,9 +46,23 @@ function av()
child.stdin.write('[reflection.Assembly]::LoadWithPartialName("system.core")\r\n');
child.stdin.write('Get-WmiObject -Namespace "root/SecurityCenter2" -Class AntiVirusProduct | ');
child.stdin.write('ForEach-Object -Process { ');
+ child.stdin.write('$matches = [regex]::Matches($_.pathToSignedProductExe, "%(.*?)%"); ');
+ child.stdin.write('$modifiedPath = $_.pathToSignedProductExe; ');
+ child.stdin.write('foreach ($match in $matches) { ');
+ child.stdin.write('$modifiedPath = $modifiedPath -replace [regex]::Escape($match.Value), [System.Environment]::GetEnvironmentVariable($match.Groups[1].Value, "Process") ');
+ child.stdin.write('} ');
+ child.stdin.write('$flag = $true; ');
+ child.stdin.write('if ($modifiedPath -ne "windowsdefender://"){ ');
+ child.stdin.write('if (-not (Test-Path -Path $modifiedPath -PathType Leaf)) { ');
+ child.stdin.write('$flag = $false; ');
+ child.stdin.write('} ');
+ child.stdin.write('} ');
+ child.stdin.write('if ($flag -eq $true) { ')
child.stdin.write('$Bytes = [System.Text.Encoding]::UTF8.GetBytes($_.displayName); ');
child.stdin.write('$EncodedText =[Convert]::ToBase64String($Bytes); ');
- child.stdin.write('Write-Host ("{0},{1}" -f $_.productState,$EncodedText); }\r\n');
+ child.stdin.write('Write-Output ("{0},{1}" -f $_.productState,$EncodedText); ');
+ child.stdin.write('} ');
+ child.stdin.write('}\r\n ');
child.stdin.write('exit\r\n');
child.waitExit();
@@ -214,6 +221,14 @@ function installedApps()
catch(e)\
{\
}\
+ try\
+ {\
+ val.installdate = reg.QueryKey(reg.HKEY.LocalMachine, 'SOFTWARE\\\\Microsoft\\\\Windows\\\\CurrentVersion\\\\Uninstall\\\\' + items.subkeys[key], 'InstallDate');\
+ if (val.installdate == '') { delete val.installdate; }\
+ }\
+ catch(e)\
+ {\
+ }\
result.push(val);\
}\
console.log(JSON.stringify(result,'', 1));process.exit();";
@@ -225,12 +240,33 @@ function installedApps()
return (ret);
}
+function defender(){
+ var promise = require('promise');
+ var ret = new promise(function (a, r) { this._resolve = a; this._reject = r; });
+ ret.child = require('child_process').execFile(process.env['windir'] + '\\System32\\WindowsPowerShell\\v1.0\\powershell.exe', ['powershell', '-noprofile', '-nologo', '-command', '-'], {});
+ ret.child.promise = ret;
+ ret.child.stdout.str = ''; ret.child.stdout.on('data', function (c) { this.str += c.toString(); });
+ ret.child.stderr.str = ''; ret.child.stderr.on('data', function (c) { this.str += c.toString(); });
+ ret.child.stdin.write('Get-MpComputerStatus | Select-Object RealTimeProtectionEnabled,IsTamperProtected | ConvertTo-JSON\r\n');
+ ret.child.stdin.write('exit\r\n');
+ ret.child.on('exit', function (c) {
+ if (this.stdout.str == '') { this.promise._resolve({}); return; }
+ try {
+ var abc = JSON.parse(this.stdout.str.trim());
+ this.promise._resolve({ RealTimeProtection: abc.RealTimeProtectionEnabled, TamperProtected: abc.IsTamperProtected });
+ } catch (ex) {
+ this.promise._resolve({}); return;
+ }
+ });
+ return (ret);
+}
+
if (process.platform == 'win32')
{
- module.exports = { qfe: qfe, av: av, defrag: defrag, pendingReboot: pendingReboot, installedApps: installedApps };
+ module.exports = { qfe: qfe, av: av, defrag: defrag, pendingReboot: pendingReboot, installedApps: installedApps, defender: defender };
}
else
{
var not_supported = function () { throw (process.platform + ' not supported'); };
- module.exports = { qfe: not_supported, av: not_supported, defrag: not_supported, pendingReboot: not_supported, installedApps: not_supported };
+ module.exports = { qfe: not_supported, av: not_supported, defrag: not_supported, pendingReboot: not_supported, installedApps: not_supported, defender: not_supported };
}
\ No newline at end of file
diff --git a/agents/modules_meshcore/win-volumes.js b/agents/modules_meshcore/win-volumes.js
index e0e11276..59e87c1a 100644
--- a/agents/modules_meshcore/win-volumes.js
+++ b/agents/modules_meshcore/win-volumes.js
@@ -39,17 +39,90 @@ function getVolumes()
{
ret[v[i].DeviceID] = trimObject(v[i]);
}
-
- v = require('win-wmi').query('ROOT\\CIMV2\\Security\\MicrosoftVolumeEncryption', 'SELECT * FROM Win32_EncryptableVolume');
- for (i in v)
- {
- var tmp = trimObject(v[i]);
- for (var k in tmp)
+ try {
+ v = require('win-wmi').query('ROOT\\CIMV2\\Security\\MicrosoftVolumeEncryption', 'SELECT * FROM Win32_EncryptableVolume');
+ for (i in v)
{
- ret[tmp.DeviceID][k] = tmp[k];
+ var tmp = trimObject(v[i]);
+ for (var k in tmp)
+ {
+ ret[tmp.DeviceID][k] = tmp[k];
+ }
}
- }
+ } catch (ex) { }
return (ret);
}
-module.exports = { getVolumes: function () { try { return (getVolumes()); } catch (x) { return ({}); } } };
\ No newline at end of file
+function windows_volumes()
+{
+ var promise = require('promise');
+ var p1 = new promise(function (res, rej) { this._res = res; this._rej = rej; });
+ var ret = {};
+ var values = require('win-wmi').query('ROOT\\CIMV2', 'SELECT * FROM Win32_LogicalDisk', ['DeviceID', 'VolumeName', 'FileSystem', 'Size', 'FreeSpace', 'DriveType']);
+ if(values[0]){
+ for (var i = 0; i < values.length; ++i) {
+ var drive = values[i]['DeviceID'].slice(0,-1);
+ ret[drive] = {
+ name: (values[i]['VolumeName'] ? values[i]['VolumeName'] : ""),
+ type: (values[i]['FileSystem'] ? values[i]['FileSystem'] : "Unknown"),
+ size: (values[i]['Size'] ? values[i]['Size'] : 0),
+ sizeremaining: (values[i]['FreeSpace'] ? values[i]['FreeSpace'] : 0),
+ removable: (values[i]['DriveType'] == 2),
+ cdrom: (values[i]['DriveType'] == 5)
+ };
+ }
+ }
+ try {
+ values = require('win-wmi').query('ROOT\\CIMV2\\Security\\MicrosoftVolumeEncryption', 'SELECT * FROM Win32_EncryptableVolume', ['DriveLetter','ConversionStatus','ProtectionStatus']);
+ if(values[0]){
+ for (var i = 0; i < values.length; ++i) {
+ var drive = values[i]['DriveLetter'].slice(0,-1);
+ var statuses = {
+ 0: 'FullyDecrypted',
+ 1: 'FullyEncrypted',
+ 2: 'EncryptionInProgress',
+ 3: 'DecryptionInProgress',
+ 4: 'EncryptionPaused',
+ 5: 'DecryptionPaused'
+ };
+ ret[drive].volumeStatus = statuses.hasOwnProperty(values[i].ConversionStatus) ? statuses[values[i].ConversionStatus] : 'FullyDecrypted';
+ ret[drive].protectionStatus = (values[i].ProtectionStatus == 0 ? 'Off' : (values[i].ProtectionStatus == 1 ? 'On' : 'Unknown'));
+ try {
+ var foundIDMarkedLine = false, foundMarkedLine = false, identifier = '', password = '';
+ var keychild = require('child_process').execFile(process.env['windir'] + '\\system32\\cmd.exe', ['/c', 'manage-bde -protectors -get ' + drive + ': -Type recoverypassword'], {});
+ keychild.stdout.str = ''; keychild.stdout.on('data', function (c) { this.str += c.toString(); });
+ keychild.waitExit();
+ var lines = keychild.stdout.str.trim().split('\r\n');
+ for (var x = 0; x < lines.length; x++) { // Loop each line
+ var abc = lines[x].trim();
+ var englishidpass = (abc !== '' && abc.includes('Numerical Password:')); // English ID
+ var germanidpass = (abc !== '' && abc.includes('Numerisches Kennwort:')); // German ID
+ var frenchidpass = (abc !== '' && abc.includes('Mot de passe num')); // French ID
+ var englishpass = (abc !== '' && abc.includes('Password:') && !abc.includes('Numerical Password:')); // English Password
+ var germanpass = (abc !== '' && abc.includes('Kennwort:') && !abc.includes('Numerisches Kennwort:')); // German Password
+ var frenchpass = (abc !== '' && abc.includes('Mot de passe :') && !abc.includes('Mot de passe num')); // French Password
+ if (englishidpass || germanidpass || frenchidpass|| englishpass || germanpass || frenchpass) {
+ var nextline = lines[x + 1].trim();
+ if (x + 1 < lines.length && (nextline !== '' && (nextline.startsWith('ID:') || nextline.startsWith('ID :')) )) {
+ identifier = nextline.replace('ID:','').replace('ID :', '').trim();
+ foundIDMarkedLine = true;
+ }else if (x + 1 < lines.length && nextline !== '') {
+ password = nextline;
+ foundMarkedLine = true;
+ }
+ }
+ }
+ ret[drive].identifier = (foundIDMarkedLine ? identifier : ''); // Set Bitlocker Identifier
+ ret[drive].recoveryPassword = (foundMarkedLine ? password : ''); // Set Bitlocker Password
+ } catch(ex) { } // just carry on as we cant get bitlocker key
+ }
+ }
+ p1._res(ret);
+ } catch (ex) { p1._res(ret); } // just return volumes as cant get encryption/bitlocker
+ return (p1);
+}
+
+module.exports = {
+ getVolumes: function () { try { return (getVolumes()); } catch (x) { return ({}); } },
+ volumes_promise: windows_volumes
+};
\ No newline at end of file
diff --git a/agents/recoverycore.js b/agents/recoverycore.js
index 169b170c..5d9f13bc 100644
--- a/agents/recoverycore.js
+++ b/agents/recoverycore.js
@@ -485,8 +485,8 @@ function windows_execve(name, agentfilename, sessionid) {
var cmd = require('_GenericMarshal').CreateVariable(process.env['windir'] + '\\system32\\cmd.exe', { wide: true });
var args = require('_GenericMarshal').CreateVariable(3 * require('_GenericMarshal').PointerSize);
var arg1 = require('_GenericMarshal').CreateVariable('cmd.exe', { wide: true });
- var arg2 = require('_GenericMarshal').CreateVariable('/C wmic service "' + name + '" call stopservice & "' + cwd + agentfilename + '.update.exe" -b64exec ' + 'dHJ5CnsKICAgIHZhciBzZXJ2aWNlTG9jYXRpb24gPSBwcm9jZXNzLmFyZ3YucG9wKCkudG9Mb3dlckNhc2UoKTsKICAgIHJlcXVpcmUoJ3Byb2Nlc3MtbWFuYWdlcicpLmVudW1lcmF0ZVByb2Nlc3NlcygpLnRoZW4oZnVuY3Rpb24gKHByb2MpCiAgICB7CiAgICAgICAgZm9yICh2YXIgcCBpbiBwcm9jKQogICAgICAgIHsKICAgICAgICAgICAgaWYgKHByb2NbcF0ucGF0aCAmJiAocHJvY1twXS5wYXRoLnRvTG93ZXJDYXNlKCkgPT0gc2VydmljZUxvY2F0aW9uKSkKICAgICAgICAgICAgewogICAgICAgICAgICAgICAgcHJvY2Vzcy5raWxsKHByb2NbcF0ucGlkKTsKICAgICAgICAgICAgfQogICAgICAgIH0KICAgICAgICBwcm9jZXNzLmV4aXQoKTsKICAgIH0pOwp9CmNhdGNoIChlKQp7CiAgICBwcm9jZXNzLmV4aXQoKTsKfQ==' +
- ' "' + process.execPath + '" & copy "' + cwd + agentfilename + '.update.exe" "' + process.execPath + '" & wmic service "' + name + '" call startservice & erase "' + cwd + agentfilename + '.update.exe"', { wide: true });
+ var arg2 = require('_GenericMarshal').CreateVariable('/C net stop "' + name + '" & "' + cwd + agentfilename + '.update.exe" -b64exec ' + 'dHJ5CnsKICAgIHZhciBzZXJ2aWNlTG9jYXRpb24gPSBwcm9jZXNzLmFyZ3YucG9wKCkudG9Mb3dlckNhc2UoKTsKICAgIHJlcXVpcmUoJ3Byb2Nlc3MtbWFuYWdlcicpLmVudW1lcmF0ZVByb2Nlc3NlcygpLnRoZW4oZnVuY3Rpb24gKHByb2MpCiAgICB7CiAgICAgICAgZm9yICh2YXIgcCBpbiBwcm9jKQogICAgICAgIHsKICAgICAgICAgICAgaWYgKHByb2NbcF0ucGF0aCAmJiAocHJvY1twXS5wYXRoLnRvTG93ZXJDYXNlKCkgPT0gc2VydmljZUxvY2F0aW9uKSkKICAgICAgICAgICAgewogICAgICAgICAgICAgICAgcHJvY2Vzcy5raWxsKHByb2NbcF0ucGlkKTsKICAgICAgICAgICAgfQogICAgICAgIH0KICAgICAgICBwcm9jZXNzLmV4aXQoKTsKICAgIH0pOwp9CmNhdGNoIChlKQp7CiAgICBwcm9jZXNzLmV4aXQoKTsKfQ==' +
+ ' "' + process.execPath + '" & copy "' + cwd + agentfilename + '.update.exe" "' + process.execPath + '" & net start "' + name + '" & erase "' + cwd + agentfilename + '.update.exe"', { wide: true });
if (name == null)
{
diff --git a/amtmanager.js b/amtmanager.js
index b01cb267..10e19647 100644
--- a/amtmanager.js
+++ b/amtmanager.js
@@ -707,7 +707,15 @@ module.exports.CreateAmtManager = function (parent) {
dev.aquired.controlMode = responses['IPS_HostBasedSetupService'].response.CurrentControlMode; // 1 = CCM, 2 = ACM
if (typeof stack.wsman.comm.amtVersion == 'string') { // Set the Intel AMT version using the HTTP header if present
var verSplit = stack.wsman.comm.amtVersion.split('.');
- if (verSplit.length >= 3) { dev.aquired.version = verSplit[0] + '.' + verSplit[1] + '.' + verSplit[2]; dev.aquired.majorver = parseInt(verSplit[0]); dev.aquired.minorver = parseInt(verSplit[1]); }
+ if (verSplit.length >= 2) {
+ dev.aquired.version = verSplit[0] + '.' + verSplit[1];
+ dev.aquired.majorver = parseInt(verSplit[0]);
+ dev.aquired.minorver = parseInt(verSplit[1]);
+ if (verSplit.length >= 3) {
+ dev.aquired.version = verSplit[0] + '.' + verSplit[1] + '.' + verSplit[2];
+ dev.aquired.maintenancever = parseInt(verSplit[2]);
+ }
+ }
}
dev.aquired.realm = stack.wsman.comm.digestRealm;
dev.aquired.user = dev.intelamt.user = stack.wsman.comm.user;
@@ -750,7 +758,8 @@ module.exports.CreateAmtManager = function (parent) {
// Start power polling if not connected to LMS
var ppfunc = function powerPoleFunction() { fetchPowerState(powerPoleFunction.dev); }
ppfunc.dev = dev;
- dev.polltimer = new setTimeout(ppfunc, 290000); // Poll for power state every 4 minutes 50 seconds.
+ if(dev.polltimer){ clearInterval(dev.polltimer); delete dev.polltimer; }
+ dev.polltimer = new setInterval(ppfunc, 290000); // Poll for power state every 4 minutes 50 seconds.
fetchPowerState(dev);
} else {
// For LMS connections, close now.
@@ -930,8 +939,8 @@ module.exports.CreateAmtManager = function (parent) {
if (response.Body.OSPowerSavingState == 2) { meshPowerState = 1; } // Fully powered (S0);
else if (response.Body.OSPowerSavingState == 3) { meshPowerState = 2; } // Modern standby (We are going to call this S1);
- // Set OS power state
- if (meshPowerState >= 0) { parent.SetConnectivityState(dev.meshid, dev.nodeid, Date.now(), 4, meshPowerState, null, { name: dev.name }); }
+ // Set OS power state - connType: 0 = CIRA, 1 = CIRA-Relay, 2 = CIRA-LMS, 3 = LAN
+ if (meshPowerState >= 0) { parent.SetConnectivityState(dev.meshid, dev.nodeid, Date.now(), (dev.connType == 3 ? 4 : 2), meshPowerState, null, { name: dev.name }); }
});
} else {
// Convert the power state
@@ -940,13 +949,13 @@ module.exports.CreateAmtManager = function (parent) {
var meshPowerState = -1, powerConversionTable = [-1, -1, 1, 2, 3, 6, 6, 5, 6];
if (powerstate < powerConversionTable.length) { meshPowerState = powerConversionTable[powerstate]; } else { powerstate = 6; }
- // Set power state
- if (meshPowerState >= 0) { parent.SetConnectivityState(dev.meshid, dev.nodeid, Date.now(), 4, meshPowerState, null, { name: dev.name }); }
+ // Set power state - connType: 0 = CIRA, 1 = CIRA-Relay, 2 = CIRA-LMS, 3 = LAN
+ if (meshPowerState >= 0) { parent.SetConnectivityState(dev.meshid, dev.nodeid, Date.now(), (dev.connType == 3 ? 4 : 2), meshPowerState, null, { name: dev.name }); }
}
});
}
- // Perform a power action: 2 = Power up, 5 = Power cycle, 8 = Power down, 10 = Reset, 11 = Power on to BIOS, 12 = Reset to BIOS, 13 = Power on to BIOS with SOL, 14 = Reset to BIOS with SOL
+ // Perform a power action: 2 = Power up, 5 = Power cycle, 8 = Power down, 10 = Reset, 11 = Power on to BIOS, 12 = Reset to BIOS, 13 = Power on to BIOS with SOL, 14 = Reset to BIOS with SOL, 15 = Power on to PXE, 16 = Reset to PXE
function performPowerAction(nodeid, action) {
console.log('performPowerAction', nodeid, action);
var devices = obj.amtDevices[nodeid];
@@ -961,7 +970,7 @@ module.exports.CreateAmtManager = function (parent) {
// Action: 2 = Power up, 5 = Power cycle, 8 = Power down, 10 = Reset
try { dev.amtstack.RequestPowerStateChange(action, performPowerActionResponse); } catch (ex) { }
} else {
- // 11 = Power on to BIOS, 12 = Reset to BIOS, 13 = Power on to BIOS with SOL, 14 = Reset to BIOS with SOL
+ // 11 = Power on to BIOS, 12 = Reset to BIOS, 13 = Power on to BIOS with SOL, 14 = Reset to BIOS with SOL, 15 = Power on to PXE, 16 = Reset to PXE
dev.amtstack.BatchEnum(null, ['*AMT_BootSettingData'], performAdvancedPowerActionResponse);
}
}
@@ -994,8 +1003,8 @@ module.exports.CreateAmtManager = function (parent) {
// Ready boot parameters
bootSettingData['BIOSSetup'] = ((action >= 11) && (action <= 14));
bootSettingData['UseSOL'] = ((action >= 13) && (action <= 14));
- if ((action == 11) || (action == 13)) { dev.powerAction = 2; } // Power on
- if ((action == 12) || (action == 14)) { dev.powerAction = 10; } // Reset
+ if ((action == 11) || (action == 13) || (action == 15)) { dev.powerAction = 2; } // Power on
+ if ((action == 12) || (action == 14) || (action == 16)) { dev.powerAction = 10; } // Reset
// Set boot parameters
dev.amtstack.Put('AMT_BootSettingData', bootSettingData, function (stack, name, response, status, tag) {
@@ -1006,7 +1015,8 @@ module.exports.CreateAmtManager = function (parent) {
const dev = stack.dev;
if ((obj.amtDevices[dev.nodeid] == null) || (status != 200)) return; // Device no longer exists or error
// Set boot order
- dev.amtstack.CIM_BootConfigSetting_ChangeBootOrder(null, function (stack, name, response, status) {
+ var bootDevice = (action === 15 || action === 16) ? 'http://schemas.xmlsoap.org/ws/2004/08/addressinghttp://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_BootSourceSettingIntel(r) AMT: Force PXE Boot' : null;
+ dev.amtstack.CIM_BootConfigSetting_ChangeBootOrder(bootDevice, function (stack, name, response, status) {
const dev = stack.dev;
if ((obj.amtDevices[dev.nodeid] == null) || (status != 200)) return; // Device no longer exists or error
// Perform power action
@@ -1059,7 +1069,7 @@ module.exports.CreateAmtManager = function (parent) {
if (status != 200) { dev.consoleMsg("Failed to get security information (" + status + ")."); delete dev.ocrfile; return; }
// Check if this Intel AMT device supports OCR
- if (responses['AMT_PublicKeyCertificate'].responses['ForceUEFIHTTPSBoot'] !== true) {
+ if (responses['AMT_BootCapabilities'].response['ForceUEFIHTTPSBoot'] !== true) {
dev.consoleMsg("This Intel AMT device does not support UEFI HTTPS boot (" + status + ")."); delete dev.ocrfile; return;
}
@@ -1089,11 +1099,14 @@ module.exports.CreateAmtManager = function (parent) {
// Generate the one-time URL.
var cookie = obj.parent.encodeCookie({ a: 'f', f: dev.ocrfile }, obj.parent.loginCookieEncryptionKey)
- var url = 'https://' + parent.webserver.certificates.AmtMpsName + ':' + ((parent.args.mpsaliasport != null) ? parent.args.mpsaliasport : parent.args.mpsport) + '/c/' + cookie + '.iso';
+ var url = 'https://' + parent.webserver.certificates.AmtMpsName + ':' + ((parent.args.mpsaliasport != null) ? parent.args.mpsaliasport : parent.args.mpsport) + '/c/' + cookie + '.efi';
delete dev.ocrfile;
// Generate the boot data for OCR with URL
var r = response.Body;
+ r['BIOSPause'] = false;
+ r['BIOSSetup'] = false;
+ r['EnforceSecureBoot'] = false;
r['UefiBootParametersArray'] = Buffer.from(makeUefiBootParam(1, url) + makeUefiBootParam(20, 1, 1) + makeUefiBootParam(30, 0, 2), 'binary').toString('base64');
r['UefiBootNumberOfParams'] = 3;
r['BootMediaIndex'] = 0; // Do not use boot media index for One Click Recovery (OCR)
@@ -1114,8 +1127,7 @@ module.exports.CreateAmtManager = function (parent) {
dev.amtstack.SetBootConfigRole(1, function (stack, name, response, status) {
if (isAmtDeviceValid(dev) == false) return; // Device no longer exists, ignore this request.
if (status != 200) { dev.consoleMsg("Failed to set boot config role (" + status + ")."); return; }
- var bootSource = 'Force OCR UEFI HTTPS Boot';
- dev.amtstack.CIM_BootConfigSetting_ChangeBootOrder((bootSource == null) ? bootSource : 'http://schemas.xmlsoap.org/ws/2004/08/addressinghttp://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_BootSourceSettingIntel(r) AMT: ' + bootSource + '', function (stack, name, response, status) {
+ dev.amtstack.CIM_BootConfigSetting_ChangeBootOrder('http://schemas.xmlsoap.org/ws/2004/08/addressinghttp://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_BootSourceSettingIntel(r) AMT: Force OCR UEFI HTTPS Boot', function (stack, name, response, status) {
if (isAmtDeviceValid(dev) == false) return; // Device no longer exists, ignore this request.
if (status != 200) { dev.consoleMsg("Failed to set boot config (" + status + ")."); return; }
dev.amtstack.RequestPowerStateChange(10, function (stack, name, response, status) { // 10 = Reset, 2 = Power Up
@@ -2620,7 +2632,14 @@ module.exports.CreateAmtManager = function (parent) {
if (domain && domain.amtmanager && (domain.amtmanager.tlsacmactivation == true)) { TlsAcmActivation = true; }
// Check Intel AMT version
- if (typeof dev.intelamt.ver == 'string') { var verSplit = dev.intelamt.ver.split('.'); if (verSplit.length >= 3) { dev.aquired.majorver = parseInt(verSplit[0]); dev.aquired.minorver = parseInt(verSplit[1]); } }
+ if (typeof dev.intelamt.ver == 'string') {
+ var verSplit = dev.intelamt.ver.split('.');
+ if (verSplit.length >= 2) {
+ dev.aquired.majorver = parseInt(verSplit[0]);
+ dev.aquired.minorver = parseInt(verSplit[1]);
+ if (verSplit.length >= 3) { dev.aquired.maintenancever = parseInt(verSplit[2]); }
+ }
+ }
// If this is Intel AMT 14 or better and allowed, we are going to attempt a host-based end-to-end TLS activation.
if (TlsAcmActivation && (dev.aquired.majorver >= 14)) {
@@ -2676,7 +2695,15 @@ module.exports.CreateAmtManager = function (parent) {
dev.aquired.controlMode = 1; // 1 = CCM, 2 = ACM
if (typeof dev.amtstack.wsman.comm.amtVersion == 'string') {
var verSplit = dev.amtstack.wsman.comm.amtVersion.split('.');
- if (verSplit.length >= 3) { dev.aquired.version = verSplit[0] + '.' + verSplit[1] + '.' + verSplit[2]; dev.aquired.majorver = parseInt(verSplit[0]); dev.aquired.minorver = parseInt(verSplit[1]); }
+ if (verSplit.length >= 2) {
+ dev.aquired.version = verSplit[0] + '.' + verSplit[1];
+ dev.aquired.majorver = parseInt(verSplit[0]);
+ dev.aquired.minorver = parseInt(verSplit[1]);
+ if (verSplit.length >= 3) {
+ dev.aquired.version = verSplit[0] + '.' + verSplit[1] + '.' + verSplit[2];
+ dev.aquired.maintenancever = parseInt(verSplit[2]);
+ }
+ }
}
if ((typeof dev.mpsConnection.tag.meiState.OsHostname == 'string') && (typeof dev.mpsConnection.tag.meiState.OsDnsSuffix == 'string')) {
dev.aquired.host = dev.mpsConnection.tag.meiState.OsHostname + '.' + dev.mpsConnection.tag.meiState.OsDnsSuffix;
@@ -2811,8 +2838,10 @@ module.exports.CreateAmtManager = function (parent) {
var vs = getInstance(amtlogicalelements, 'AMT')['VersionString'];
if (vs != null) {
dev.aquired.version = vs;
- dev.aquired.versionmajor = parseInt(dev.aquired.version.split('.')[0]);
- dev.aquired.versionminor = parseInt(dev.aquired.version.split('.')[1]);
+ version = dev.aquired.version.split('.')
+ dev.aquired.versionmajor = parseInt(version[0]);
+ dev.aquired.versionminor = parseInt(version[1]);
+ if (version.length > 2) { dev.aquired.versionmaintenance = parseInt(version[2]); }
}
}
}
@@ -2820,10 +2849,14 @@ module.exports.CreateAmtManager = function (parent) {
// Fetch the Intel AMT version from HTTP stack
if ((dev.amtversionstr == null) && (stack.wsman.comm.amtVersion != null)) {
var s = stack.wsman.comm.amtVersion.split('.');
- if (s.length >= 3) {
- dev.aquired.version = s[0] + '.' + s[1] + '.' + s[2];
+ if (s.length >= 2) {
+ dev.aquired.version = s[0] + '.' + s[1] + '.';
dev.aquired.versionmajor = parseInt(s[0]);
dev.aquired.versionminor = parseInt(s[1]);
+ if (s.length >= 3) {
+ dev.aquired.version = s[0] + '.' + s[1] + '.' + s[2];
+ dev.aquired.versionmaintenance = parseInt(s[2]);
+ }
}
}
diff --git a/amtprovisioningserver.js b/amtprovisioningserver.js
index 84a07df9..d31b7b83 100644
--- a/amtprovisioningserver.js
+++ b/amtprovisioningserver.js
@@ -201,8 +201,10 @@ module.exports.CreateAmtProvisioningServer = function (parent, config) {
var vs = getInstance(amtlogicalelements, 'AMT')['VersionString'];
if (vs != null) {
dev.aquired.version = vs;
- dev.aquired.versionmajor = parseInt(dev.aquired.version.split('.')[0]);
- dev.aquired.versionminor = parseInt(dev.aquired.version.split('.')[1]);
+ const versionSplit = parseInt(dev.aquired.version.split('.'));
+ dev.aquired.versionmajor = parseInt(versionSplit[0]);
+ dev.aquired.versionminor = parseInt(versionSplit[1]);
+ if (versionSplit.length >= 3) { dev.aquired.versionmaintenance = parseInt(versionSplit[2]); }
}
}
}
@@ -210,10 +212,14 @@ module.exports.CreateAmtProvisioningServer = function (parent, config) {
// Fetch the Intel AMT version from HTTP stack
if ((dev.amtversionstr == null) && (stack.wsman.comm.amtVersion != null)) {
var s = stack.wsman.comm.amtVersion.split('.');
- if (s.length >= 3) {
- dev.aquired.version = s[0] + '.' + s[1] + '.' + s[2];
+ if (s.length >= 2) {
+ dev.aquired.version = s[0] + '.' + s[1];
dev.aquired.versionmajor = parseInt(s[0]);
dev.aquired.versionminor = parseInt(s[1]);
+ if (s.length >= 3) {
+ dev.aquired.version = s[0] + '.' + s[1] + '.' + s[2];
+ dev.aquired.versionmaintenance = parseInt(s[2]);
+ }
}
}
diff --git a/apprelays.js b/apprelays.js
index 6ebfc7ac..cd6bc5fa 100644
--- a/apprelays.js
+++ b/apprelays.js
@@ -1,4 +1,4 @@
-/**
+/**
* @description MeshCentral MSTSC & SSH relay
* @author Ylian Saint-Hilaire & Bryan Roe
* @copyright Intel Corporation 2018-2022
@@ -458,7 +458,7 @@ module.exports.CreateWebRelay = function (parent, db, args, domain, mtype) {
const protocol = (args.tlsoffload) ? 'ws' : 'wss';
var domainadd = '';
if ((domain.dns == null) && (domain.id != '')) { domainadd = domain.id + '/' }
- const url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=14&auth=' + cookie; // Protocol 14 is Web-TCP
+ var url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=14&auth=' + cookie; // Protocol 14 is Web-TCP
if (domain.id != '') { url += '&domainid=' + domain.id; } // Since we are using "localhost", we are going to signal what domain we are on using a URL argument.
parent.parent.parent.debug('relay', 'TCP: Connection websocket to ' + url);
obj.wsClient = new WebSocket(url, options);
@@ -717,9 +717,10 @@ module.exports.CreateWebRelay = function (parent, db, args, domain, mtype) {
}
}
}
- else if (blockHeaders.indexOf(i) == -1) { obj.res.set(i, header[i]); } // Set the headers if not blocked
+ else if (blockHeaders.indexOf(i) == -1) { obj.res.set(i.trim(), header[i]); } // Set the headers if not blocked
}
- obj.res.set('Content-Security-Policy', "default-src 'self' 'unsafe-inline' 'unsafe-eval' data: blob:;"); // Set an "allow all" policy, see if the can restrict this in the future
+ // Dont set any Content-Security-Policy at all because some applications like Node-Red, access external websites from there javascript which would be forbidden by the below CSP
+ //obj.res.set('Content-Security-Policy', "default-src 'self' 'unsafe-inline' 'unsafe-eval' data: blob:;"); // Set an "allow all" policy, see if the can restrict this in the future
//obj.res.set('Content-Security-Policy', "default-src * 'unsafe-inline' 'unsafe-eval'; script-src * 'unsafe-inline' 'unsafe-eval'; connect-src * 'unsafe-inline'; img-src * data: blob: 'unsafe-inline'; frame-src *; style-src * 'unsafe-inline';"); // Set an "allow all" policy, see if the can restrict this in the future
obj.res.set('Cache-Control', 'no-store'); // Tell the browser not to cache the responses since since the relay port can be used for many relays
}
@@ -842,22 +843,21 @@ module.exports.CreateMstscRelay = function (parent, db, ws, req, args, domain) {
obj.relaySocket.resume();
}
} else {
- if (typeof data == 'string') {
- // Forward any ping/pong commands to the browser
- var cmd = null;
- try { cmd = JSON.parse(data); } catch (ex) { }
+ try { // Forward any ping/pong commands to the browser
+ var cmd = JSON.parse(data);
if ((cmd != null) && (cmd.ctrlChannel == '102938')) {
if (cmd.type == 'ping') { send(['ping']); }
else if (cmd.type == 'pong') { send(['pong']); }
}
return;
+ } catch (ex) { // You are not JSON data so just send over relaySocket
+ obj.wsClient._socket.pause();
+ try {
+ obj.relaySocket.write(data, function () {
+ if (obj.wsClient && obj.wsClient._socket) { try { obj.wsClient._socket.resume(); } catch (ex) { console.log(ex); } }
+ });
+ } catch (ex) { console.log(ex); obj.close(); }
}
- obj.wsClient._socket.pause();
- try {
- obj.relaySocket.write(data, function () {
- if (obj.wsClient && obj.wsClient._socket) { try { obj.wsClient._socket.resume(); } catch (ex) { console.log(ex); } }
- });
- } catch (ex) { console.log(ex); obj.close(); }
}
});
obj.wsClient.on('close', function () { parent.parent.debug('relay', 'RDP: Relay websocket closed'); obj.close(); });
@@ -984,6 +984,7 @@ module.exports.CreateMstscRelay = function (parent, db, ws, req, args, domain) {
if ((node == null) || (visible == false) || ((rights & MESHRIGHT_REMOTECONTROL) == 0)) { obj.close(); return; }
if ((rights != MESHRIGHT_ADMIN) && ((rights & MESHRIGHT_REMOTEVIEWONLY) != 0)) { obj.viewonly = true; }
if ((rights != MESHRIGHT_ADMIN) && ((rights & MESHRIGHT_DESKLIMITEDINPUT) != 0)) { obj.limitedinput = true; }
+ node = parent.common.unEscapeLinksFieldName(node); // unEscape node data for rdp/ssh credentials
obj.mtype = node.mtype; // Store the device group type
obj.meshid = node.meshid; // Store the MeshID
@@ -1046,7 +1047,11 @@ module.exports.CreateMstscRelay = function (parent, db, ws, req, args, domain) {
if ((k == 14) || (k == 28)) { ok = true; } // Enter and backspace
if (ok == false) return;
}
- if (rdpClient && (obj.viewonly != true)) { rdpClient.sendKeyEventScancode(msg[1], msg[2]); } break;
+ var extended = false;
+ var extendedkeys = [57419,57421,57416,57424,57426,57427,57417,57425,57372,57397,57415,57423,57373,57400,57399];
+ // left,right,up,down,insert,delete,pageup,pagedown,numpadenter,numpaddivide,home,end,controlright,altright,printscreen
+ if (extendedkeys.includes(msg[1])) extended=true;
+ if (rdpClient && (obj.viewonly != true)) { rdpClient.sendKeyEventScancode(msg[1], msg[2], extended); } break;
}
case 'unicode': { if (rdpClient && (obj.viewonly != true)) { rdpClient.sendKeyEventUnicode(msg[1], msg[2]); } break; }
case 'utype': {
@@ -1210,7 +1215,7 @@ module.exports.CreateSshRelay = function (parent, db, ws, req, args, domain) {
const protocol = (args.tlsoffload) ? 'ws' : 'wss';
var domainadd = '';
if ((domain.dns == null) && (domain.id != '')) { domainadd = domain.id + '/' }
- const url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=11&auth=' + obj.xcookie; // Protocol 11 is Web-SSH
+ var url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=11&auth=' + obj.xcookie; // Protocol 11 is Web-SSH
if (domain.id != '') { url += '&domainid=' + domain.id; } // Since we are using "localhost", we are going to signal what domain we are on using a URL argument.
parent.parent.debug('relay', 'SSH: Connection websocket to ' + url);
obj.wsClient = new WebSocket(url, options);
@@ -1277,16 +1282,14 @@ module.exports.CreateSshRelay = function (parent, db, ws, req, args, domain) {
ws._socket.resume();
}
} else {
- if (typeof data == 'string') {
- // Forward any ping/pong commands to the browser
+ try { // Forward any ping/pong commands to the browser
var cmd = null;
- try { cmd = JSON.parse(data); } catch (ex) { }
+ cmd = JSON.parse(data);
if ((cmd != null) && (cmd.ctrlChannel == '102938') && ((cmd.type == 'ping') || (cmd.type == 'pong'))) { obj.ws.send(data); }
return;
+ } catch(ex) { // Relay WS --> SSH instead
+ if ((data.length > 0) && (obj.ser != null)) { try { obj.ser.updateBuffer(data); } catch (ex) { console.log(ex); } }
}
-
- // Relay WS --> SSH
- if ((data.length > 0) && (obj.ser != null)) { try { obj.ser.updateBuffer(data); } catch (ex) { console.log(ex); } }
}
});
obj.wsClient.on('close', function () { parent.parent.debug('relay', 'SSH: Relay websocket closed'); obj.close(); });
@@ -1314,7 +1317,7 @@ module.exports.CreateSshRelay = function (parent, db, ws, req, args, domain) {
// Check if we have SSH credentials for this device
parent.parent.db.Get(obj.cookie.nodeid, function (err, nodes) {
if ((err != null) || (nodes == null) || (nodes.length != 1)) return;
- const node = nodes[0];
+ const node = parent.common.unEscapeLinksFieldName(nodes[0]); // unEscape node data for rdp/ssh credentials
if ((domain.allowsavingdevicecredentials === false) || (node.ssh == null) || (typeof node.ssh != 'object') || (node.ssh[obj.userid] == null) || (typeof node.ssh[obj.userid].u != 'string') || ((typeof node.ssh[obj.userid].p != 'string') && (typeof node.ssh[obj.userid].k != 'string'))) {
// Send a request for SSH authentication
try { ws.send(JSON.stringify({ action: 'sshauth' })) } catch (ex) { }
@@ -1362,7 +1365,7 @@ module.exports.CreateSshRelay = function (parent, db, ws, req, args, domain) {
obj.termSize = msg;
parent.parent.db.Get(obj.cookie.nodeid, function (err, nodes) {
if ((err != null) || (nodes == null) || (nodes.length != 1)) return;
- const node = nodes[0];
+ const node = parent.common.unEscapeLinksFieldName(nodes[0]); // unEscape node data for rdp/ssh credentials
if (node.ssh != null) {
obj.username = node.ssh.u;
obj.privateKey = node.ssh.k;
@@ -1404,7 +1407,7 @@ module.exports.CreateSshRelay = function (parent, db, ws, req, args, domain) {
parent.parent.db.Get(obj.cookie.nodeid, function (err, nodes) {
if (obj.cookie == null) return; // obj has been cleaned up, just exit.
if ((err != null) || (nodes == null) || (nodes.length != 1)) { parent.parent.debug('relay', 'SSH: Invalid device'); obj.close(); }
- const node = nodes[0];
+ const node = parent.common.unEscapeLinksFieldName(nodes[0]); // unEscape node data for rdp/ssh credentials
obj.nodeid = node._id; // Store the NodeID
obj.meshid = node.meshid; // Store the MeshID
obj.mtype = node.mtype; // Store the device group type
@@ -1549,7 +1552,7 @@ module.exports.CreateSshTerminalRelay = function (parent, db, ws, req, domain, u
const protocol = (args.tlsoffload) ? 'ws' : 'wss';
var domainadd = '';
if ((domain.dns == null) && (domain.id != '')) { domainadd = domain.id + '/' }
- const url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=11&auth=' + authCookie // Protocol 11 is Web-SSH
+ var url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=11&auth=' + authCookie // Protocol 11 is Web-SSH
if (domain.id != '') { url += '&domainid=' + domain.id; } // Since we are using "localhost", we are going to signal what domain we are on using a URL argument.
parent.parent.debug('relay', 'SSH: Connection websocket to ' + url);
obj.wsClient = new WebSocket(url, options);
@@ -1617,16 +1620,14 @@ module.exports.CreateSshTerminalRelay = function (parent, db, ws, req, domain, u
ws._socket.resume();
}
} else {
- if (typeof data == 'string') {
- // Forward any ping/pong commands to the browser
+ try { // Forward any ping/pong commands to the browser
var cmd = null;
- try { cmd = JSON.parse(data); } catch (ex) { }
+ cmd = JSON.parse(data);
if ((cmd != null) && (cmd.ctrlChannel == '102938') && ((cmd.type == 'ping') || (cmd.type == 'pong'))) { try { obj.ws.send(data); } catch (ex) { console.log(ex); } }
return;
+ } catch (ex) { // Relay WS --> SSH
+ if ((data.length > 0) && (obj.ser != null)) { try { obj.ser.updateBuffer(data); } catch (ex) { console.log(ex); } }
}
-
- // Relay WS --> SSH
- if ((data.length > 0) && (obj.ser != null)) { try { obj.ser.updateBuffer(data); } catch (ex) { console.log(ex); } }
}
});
obj.wsClient.on('close', function () {
@@ -1739,6 +1740,7 @@ module.exports.CreateSshTerminalRelay = function (parent, db, ws, req, domain, u
if ((user == null) || (req.query.nodeid == null)) { obj.close(); return; } // Invalid nodeid
parent.GetNodeWithRights(domain, user, req.query.nodeid, function (node, rights, visible) {
if (obj.ws == null) return; // obj has been cleaned up, just exit.
+ node = parent.common.unEscapeLinksFieldName(node); // unEscape node data for rdp/ssh credentials
// Check permissions
if ((rights & 8) == 0) { obj.close(); return; } // No MESHRIGHT_REMOTECONTROL rights
@@ -1903,7 +1905,7 @@ module.exports.CreateSshFilesRelay = function (parent, db, ws, req, domain, user
const protocol = (args.tlsoffload) ? 'ws' : 'wss';
var domainadd = '';
if ((domain.dns == null) && (domain.id != '')) { domainadd = domain.id + '/' }
- const url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=13&auth=' + authCookie // Protocol 13 is Web-SSH-Files
+ var url = protocol + '://localhost:' + args.port + '/' + domainadd + (((obj.mtype == 3) && (obj.relaynodeid == null)) ? 'local' : 'mesh') + 'relay.ashx?p=13&auth=' + authCookie // Protocol 13 is Web-SSH-Files
if (domain.id != '') { url += '&domainid=' + domain.id; } // Since we are using "localhost", we are going to signal what domain we are on using a URL argument.
parent.parent.debug('relay', 'SSH: Connection websocket to ' + url);
obj.wsClient = new WebSocket(url, options);
@@ -1965,16 +1967,15 @@ module.exports.CreateSshFilesRelay = function (parent, db, ws, req, domain, user
ws._socket.resume();
}
} else {
- if (typeof data == 'string') {
+ try {
// Forward any ping/pong commands to the browser
var cmd = null;
- try { cmd = JSON.parse(data); } catch (ex) { }
+ cmd = JSON.parse(data);
if ((cmd != null) && (cmd.ctrlChannel == '102938') && ((cmd.type == 'ping') || (cmd.type == 'pong'))) { obj.ws.send(data); }
return;
+ } catch (ex) { // Relay WS --> SSH
+ if ((data.length > 0) && (obj.ser != null)) { try { obj.ser.updateBuffer(data); } catch (ex) { console.log(ex); } }
}
-
- // Relay WS --> SSH
- if ((data.length > 0) && (obj.ser != null)) { try { obj.ser.updateBuffer(data); } catch (ex) { console.log(ex); } }
}
});
obj.wsClient.on('close', function () {
@@ -2269,6 +2270,7 @@ module.exports.CreateSshFilesRelay = function (parent, db, ws, req, domain, user
if ((user == null) || (req.query.nodeid == null)) { obj.close(); return; } // Invalid nodeid
parent.GetNodeWithRights(domain, user, req.query.nodeid, function (node, rights, visible) {
if (obj.ws == null) return; // obj has been cleaned up, just exit.
+ node = parent.common.unEscapeLinksFieldName(node); // unEscape node data for rdp/ssh credentials
// Check permissions
if ((rights & 8) == 0) { obj.close(); return; } // No MESHRIGHT_REMOTECONTROL rights
diff --git a/authenticode.js b/authenticode.js
index 821cf7ae..5f0bd441 100644
--- a/authenticode.js
+++ b/authenticode.js
@@ -298,7 +298,7 @@ function createAuthenticodeHandler(path) {
for (var i = 0; i < obj.header.coff.numberOfSections; i++) {
var section = {};
buf = readFileSlice(obj.header.SectionHeadersPtr + (i * 40), 40);
- if (buf[0] != 46) { obj.close(); return false; }; // Name of the section must start with a dot. If not, something is wrong.
+ if ((buf[0] != 46) && (buf[0] != 95)) { obj.close(); return false; }; // Name of the section must start with a dot or underscore. If not, something is wrong.
var sectionName = buf.slice(0, 8).toString().trim('\0');
var j = sectionName.indexOf('\0');
if (j >= 0) { sectionName = sectionName.substring(0, j); } // Trim any trailing zeroes
@@ -1566,7 +1566,11 @@ function createAuthenticodeHandler(path) {
options.protocol = timeServerUrl.protocol;
options.hostname = timeServerUrl.hostname;
options.path = timeServerUrl.pathname;
- options.port = ((timeServerUrl.port == '') ? 80 : parseInt(timeServerUrl.port));
+ let http = require("http")
+ if (options.protocol === "https:"){
+ http = require("https")
+ }
+ options.port = ((timeServerUrl.port == '') ? (options.protocol === "https:" ? 443 : 80) : parseInt(timeServerUrl.port));
if (options.proxy == null) {
// No proxy needed
@@ -1584,7 +1588,7 @@ function createAuthenticodeHandler(path) {
// Set up the request
var responseAccumulator = '';
- var req = require('http').request(options, function (res) {
+ var req = http.request(options, function (res) {
res.setEncoding('utf8');
res.on('data', function (chunk) { responseAccumulator += chunk; });
res.on('end', function () { func(null, responseAccumulator); });
@@ -1605,12 +1609,12 @@ function createAuthenticodeHandler(path) {
proxyOptions.protocol = proxyUrl.protocol;
proxyOptions.hostname = proxyUrl.hostname;
proxyOptions.path = options.hostname + ':' + options.port;
- proxyOptions.port = ((proxyUrl.port == '') ? 80 : parseInt(proxyUrl.port));
+ proxyOptions.port = ((proxyUrl.port == '') ? (options.protocol === "https:" ? 443 : 80) : parseInt(proxyUrl.port));
}
// Set up the proxy request
var responseAccumulator = '';
- var req = require('http').request(proxyOptions);
+ var req = http.request(proxyOptions);
req.on('error', function (err) { func('' + err); });
req.on('connect', function (res, socket, head) {
// Make a request over the HTTP tunnel
diff --git a/certoperations.js b/certoperations.js
index 44aae919..50c92f2a 100644
--- a/certoperations.js
+++ b/certoperations.js
@@ -262,7 +262,10 @@ module.exports.CertificateOperations = function (parent) {
acmconfig.cn = certCommonName.value;
}
}
-
+ if(r.certs[0].md){
+ acmconfig.hashAlgorithm = r.certs[0].md.algorithm;
+ }
+
delete acmconfig.cert;
delete acmconfig.certpass;
acmconfig.certs = orderedCerts;
@@ -633,9 +636,16 @@ module.exports.CertificateOperations = function (parent) {
};
// Return the SHA384 hash of the certificate public key
- obj.getPublicKeyHashBinary = function (cert) {
- var publickey = obj.pki.certificateFromPem(cert).publicKey;
- return obj.pki.getPublicKeyFingerprint(publickey, { encoding: 'binary', md: obj.forge.md.sha384.create() });
+ obj.getPublicKeyHashBinary = function (pem) {
+ const { X509Certificate } = require('crypto');
+ if (X509Certificate == null) {
+ // This version of NodeJS ( 1) && (v <= 2000)) {
+ if ((v >= 1) && (v <= 2000)) {
if (v < minRemoveInactiveDevice) { minRemoveInactiveDevice = v; }
removeInactiveDevicesPerDomain[i] = v;
minRemoveInactiveDevicesPerDomain[i] = v;
@@ -148,7 +188,7 @@ module.exports.CreateDB = function (parent, func) {
for (var i in parent.webserver.meshes) {
if (typeof parent.webserver.meshes[i].expireDevs == 'number') {
var v = parent.webserver.meshes[i].expireDevs;
- if ((v > 1) && (v <= 2000)) {
+ if ((v >= 1) && (v <= 2000)) {
if (v < minRemoveInactiveDevice) { minRemoveInactiveDevice = v; }
if ((minRemoveInactiveDevicesPerDomain[parent.webserver.meshes[i].domain] == null) || (minRemoveInactiveDevicesPerDomain[parent.webserver.meshes[i].domain] > v)) {
minRemoveInactiveDevicesPerDomain[parent.webserver.meshes[i].domain] = v;
@@ -245,18 +285,18 @@ module.exports.CreateDB = function (parent, func) {
obj.removeDomain = function (domainName, func) {
var pendingCalls;
// Remove all events, power events and SMBIOS data from the main collection. They are all in seperate collections now.
- if (obj.databaseType == 7) {
+ if (obj.databaseType == DB_ACEBASE) {
// AceBase
pendingCalls = 3;
obj.file.query('meshcentral').filter('domain', '==', domainName).remove().then(function () { if (--pendingCalls == 0) { func(); } });
obj.file.query('events').filter('domain', '==', domainName).remove().then(function () { if (--pendingCalls == 0) { func(); } });
obj.file.query('power').filter('domain', '==', domainName).remove().then(function () { if (--pendingCalls == 0) { func(); } });
- } else if ((obj.databaseType == 4) || (obj.databaseType == 5) || (obj.databaseType == 6)) {
+ } else if ((obj.databaseType == DB_MARIADB) || (obj.databaseType == DB_MYSQL) || (obj.databaseType == DB_POSTGRESQL)) {
// MariaDB, MySQL or PostgreSQL
pendingCalls = 2;
sqlDbQuery('DELETE FROM main WHERE domain = $1', [domainName], function () { if (--pendingCalls == 0) { func(); } });
sqlDbQuery('DELETE FROM events WHERE domain = $1', [domainName], function () { if (--pendingCalls == 0) { func(); } });
- } else if (obj.databaseType == 3) {
+ } else if (obj.databaseType == DB_MONGODB) {
// MongoDB
pendingCalls = 3;
obj.file.deleteMany({ domain: domainName }, { multi: true }, function () { if (--pendingCalls == 0) { func(); } });
@@ -276,17 +316,17 @@ module.exports.CreateDB = function (parent, func) {
// TODO: Remove all meshes that dont have any links
// Remove all events, power events and SMBIOS data from the main collection. They are all in seperate collections now.
- if ((obj.databaseType == 4) || (obj.databaseType == 5) || (obj.databaseType == 6)) {
+ if ((obj.databaseType == DB_MARIADB) || (obj.databaseType == DB_MYSQL) || (obj.databaseType == DB_POSTGRESQL)) {
// MariaDB, MySQL or PostgreSQL
obj.RemoveAllOfType('event', function () { });
obj.RemoveAllOfType('power', function () { });
obj.RemoveAllOfType('smbios', function () { });
- } else if (obj.databaseType == 3) {
+ } else if (obj.databaseType == DB_MONGODB) {
// MongoDB
obj.file.deleteMany({ type: 'event' }, { multi: true });
obj.file.deleteMany({ type: 'power' }, { multi: true });
obj.file.deleteMany({ type: 'smbios' }, { multi: true });
- } else if ((obj.databaseType == 1) || (obj.databaseType == 2)) {
+ } else if ((obj.databaseType == DB_NEDB) || (obj.databaseType == DB_MONGOJS)) {
// NeDB or MongoJS
obj.file.remove({ type: 'event' }, { multi: true });
obj.file.remove({ type: 'power' }, { multi: true });
@@ -387,19 +427,19 @@ module.exports.CreateDB = function (parent, func) {
if (meshChange) { obj.Set(docs[i]); }
}
}
- if (obj.databaseType == 8) {
+ if (obj.databaseType == DB_SQLITE) {
// SQLite
- } else if (obj.databaseType == 7) {
+ } else if (obj.databaseType == DB_ACEBASE) {
// AceBase
- } else if (obj.databaseType == 6) {
+ } else if (obj.databaseType == DB_POSTGRESQL) {
// Postgres
sqlDbQuery('DELETE FROM Main WHERE ((extra != NULL) AND (extra LIKE (\'mesh/%\')) AND (extra != ANY ($1)))', [meshlist], function (err, response) { });
- } else if ((obj.databaseType == 4) || (obj.databaseType == 5)) {
+ } else if ((obj.databaseType == DB_MARIADB) || (obj.databaseType == DB_MYSQL)) {
// MariaDB
sqlDbQuery('DELETE FROM Main WHERE (extra LIKE ("mesh/%") AND (extra NOT IN ?)', [meshlist], function (err, response) { });
- } else if (obj.databaseType == 3) {
+ } else if (obj.databaseType == DB_MONGODB) {
// MongoDB
obj.file.deleteMany({ meshid: { $exists: true, $nin: meshlist } }, { multi: true });
} else {
@@ -417,14 +457,66 @@ module.exports.CreateDB = function (parent, func) {
};
// Get encryption key
- obj.getEncryptDataKey = function (password) {
+ obj.getEncryptDataKey = function (password, salt, iterations) {
if (typeof password != 'string') return null;
- return parent.crypto.createHash('sha384').update(password).digest("raw").slice(0, 32);
+ let key;
+ try {
+ key = parent.crypto.pbkdf2Sync(password, salt, iterations, 32, 'sha384');
+ } catch (ex) {
+ // If this previous call fails, it's probably because older pbkdf2 did not specify the hashing function, just use the default.
+ key = parent.crypto.pbkdf2Sync(password, salt, iterations, 32);
+ }
+ return key
}
// Encrypt data
obj.encryptData = function (password, plaintext) {
- var key = obj.getEncryptDataKey(password);
+ let encryptionVersion = 0x01;
+ let iterations = 100000
+ const iv = parent.crypto.randomBytes(16);
+ var key = obj.getEncryptDataKey(password, iv, iterations);
+ if (key == null) return null;
+ const aes = parent.crypto.createCipheriv('aes-256-gcm', key, iv);
+ var ciphertext = aes.update(plaintext);
+ let versionbuf = Buffer.allocUnsafe(2);
+ versionbuf.writeUInt16BE(encryptionVersion);
+ let iterbuf = Buffer.allocUnsafe(4);
+ iterbuf.writeUInt32BE(iterations);
+ let encryptedBuf = aes.final();
+ ciphertext = Buffer.concat([versionbuf, iterbuf, aes.getAuthTag(), iv, ciphertext, encryptedBuf]);
+ return ciphertext.toString('base64');
+ }
+
+ // Decrypt data
+ obj.decryptData = function (password, ciphertext) {
+ // Adding an encryption version lets us avoid try catching in the future
+ let ciphertextBytes = Buffer.from(ciphertext, 'base64');
+ let encryptionVersion = ciphertextBytes.readUInt16BE(0);
+ try {
+ switch (encryptionVersion) {
+ case 0x01:
+ let iterations = ciphertextBytes.readUInt32BE(2);
+ let authTag = ciphertextBytes.slice(6, 22);
+ const iv = ciphertextBytes.slice(22, 38);
+ const data = ciphertextBytes.slice(38);
+ let key = obj.getEncryptDataKey(password, iv, iterations);
+ if (key == null) return null;
+ const aes = parent.crypto.createDecipheriv('aes-256-gcm', key, iv);
+ aes.setAuthTag(authTag);
+ let plaintextBytes = Buffer.from(aes.update(data));
+ plaintextBytes = Buffer.concat([plaintextBytes, aes.final()]);
+ return plaintextBytes;
+ default:
+ return obj.oldDecryptData(password, ciphertextBytes);
+ }
+ } catch (ex) { return obj.oldDecryptData(password, ciphertextBytes); }
+ }
+
+ // Encrypt data
+ // The older encryption system uses CBC without integraty checking.
+ // This method is kept only for testing
+ obj.oldEncryptData = function (password, plaintext) {
+ let key = parent.crypto.createHash('sha384').update(password).digest('raw').slice(0, 32);
if (key == null) return null;
const iv = parent.crypto.randomBytes(16);
const aes = parent.crypto.createCipheriv('aes-256-cbc', key, iv);
@@ -433,16 +525,17 @@ module.exports.CreateDB = function (parent, func) {
return ciphertext.toString('base64');
}
- // Decrypt data
- obj.decryptData = function (password, ciphertext) {
+ // Decrypt data
+ // The older encryption system uses CBC without integraty checking.
+ // This method is kept only to convert the old encryption to the new one.
+ obj.oldDecryptData = function (password, ciphertextBytes) {
+ if (typeof password != 'string') return null;
try {
- var key = obj.getEncryptDataKey(password);
- if (key == null) return null;
- const ciphertextBytes = Buffer.from(ciphertext, 'base64');
const iv = ciphertextBytes.slice(0, 16);
const data = ciphertextBytes.slice(16);
+ let key = parent.crypto.createHash('sha384').update(password).digest('raw').slice(0, 32);
const aes = parent.crypto.createDecipheriv('aes-256-cbc', key, iv);
- var plaintextBytes = Buffer.from(aes.update(data));
+ let plaintextBytes = Buffer.from(aes.update(data));
plaintextBytes = Buffer.concat([plaintextBytes, aes.final()]);
return plaintextBytes;
} catch (ex) { return null; }
@@ -451,33 +544,33 @@ module.exports.CreateDB = function (parent, func) {
// Get the number of records in the database for various types, this is the slow NeDB way.
// WARNING: This is a terrible query for database performance. Only do this when needed. This query will look at almost every document in the database.
obj.getStats = function (func) {
- if (obj.databaseType == 7) {
+ if (obj.databaseType == DB_ACEBASE) {
// AceBase
// TODO
- } else if (obj.databaseType == 6) {
+ } else if (obj.databaseType == DB_POSTGRESQL) {
// PostgreSQL
// TODO
- } else if (obj.databaseType == 5) {
+ } else if (obj.databaseType == DB_MYSQL) {
// MySQL
// TODO
- } else if (obj.databaseType == 4) {
+ } else if (obj.databaseType == DB_MARIADB) {
// MariaDB
// TODO
- } else if (obj.databaseType == 3) {
+ } else if (obj.databaseType == DB_MONGODB) {
// MongoDB
obj.file.aggregate([{ "$group": { _id: "$type", count: { $sum: 1 } } }]).toArray(function (err, docs) {
var counters = {}, totalCount = 0;
if (err == null) { for (var i in docs) { if (docs[i]._id != null) { counters[docs[i]._id] = docs[i].count; totalCount += docs[i].count; } } }
func(counters);
});
- } else if (obj.databaseType == 2) {
+ } else if (obj.databaseType == DB_MONGOJS) {
// MongoJS
obj.file.aggregate([{ "$group": { _id: "$type", count: { $sum: 1 } } }], function (err, docs) {
var counters = {}, totalCount = 0;
if (err == null) { for (var i in docs) { if (docs[i]._id != null) { counters[docs[i]._id] = docs[i].count; totalCount += docs[i].count; } } }
func(counters);
});
- } else if (obj.databaseType == 1) {
+ } else if (obj.databaseType == DB_NEDB) {
// NeDB version
obj.file.count({ type: 'node' }, function (err, nodeCount) {
obj.file.count({ type: 'mesh' }, function (err, meshCount) {
@@ -517,8 +610,8 @@ module.exports.CreateDB = function (parent, func) {
if (err == null) { for (var i in docs) { count++; obj.Set(docs[i]); } }
obj.GetAllType('mesh', function (err, docs) {
if (err == null) { for (var i in docs) { count++; obj.Set(docs[i]); } }
- if (obj.databaseType == 1) { // If we are using NeDB, compact the database.
- obj.file.persistence.compactDatafile();
+ if (obj.databaseType == DB_NEDB) { // If we are using NeDB, compact the database.
+ obj.file.compactDatafile();
obj.file.on('compaction.done', function () { func(count); }); // It's important to wait for compaction to finish before exit, otherwise NeDB may corrupt.
} else {
func(count); // For all other databases, normal exit.
@@ -668,13 +761,31 @@ module.exports.CreateDB = function (parent, func) {
if (parent.args.sqlite3) {
// SQLite3 database setup
- obj.databaseType = 8;
+ obj.databaseType = DB_SQLITE;
const sqlite3 = require('sqlite3');
- obj.file = new sqlite3.Database(parent.path.join(parent.datapath, 'meshcentral.sqlite'), sqlite3.OPEN_READWRITE, function (err) {
+ let configParams = parent.config.settings.sqlite3;
+ if (typeof configParams == 'string') {databaseName = configParams} else {databaseName = configParams.name ? configParams.name : 'meshcentral';};
+ obj.sqliteConfig.startupVacuum = configParams.startupvacuum ? configParams.startupvacuum : false;
+ obj.sqliteConfig.autoVacuum = configParams.autovacuum ? configParams.autovacuum.toLowerCase() : 'incremental';
+ obj.sqliteConfig.incrementalVacuum = configParams.incrementalvacuum ? configParams.incrementalvacuum : 100;
+ obj.sqliteConfig.journalMode = configParams.journalmode ? configParams.journalmode.toLowerCase() : 'delete';
+ //allowed modes, 'none' excluded because not usefull for this app, maybe also remove 'memory'?
+ if (!(['delete', 'truncate', 'persist', 'memory', 'wal'].includes(obj.sqliteConfig.journalMode))) { obj.sqliteConfig.journalMode = 'delete'};
+ obj.sqliteConfig.journalSize = configParams.journalsize ? configParams.journalsize : 409600;
+ //wal can use the more performant 'normal' mode, see https://www.sqlite.org/pragma.html#pragma_synchronous
+ obj.sqliteConfig.synchronous = (obj.sqliteConfig.journalMode == 'wal') ? 'normal' : 'full';
+ if (obj.sqliteConfig.journalMode == 'wal') {obj.sqliteConfig.maintenance += 'PRAGMA wal_checkpoint(PASSIVE);'};
+ if (obj.sqliteConfig.autoVacuum == 'incremental') {obj.sqliteConfig.maintenance += 'PRAGMA incremental_vacuum(' + obj.sqliteConfig.incrementalVacuum + ');'};
+ obj.sqliteConfig.maintenance += 'PRAGMA optimize;';
+
+ parent.debug('db', 'SQlite config options: ' + JSON.stringify(obj.sqliteConfig, null, 4));
+ if (obj.sqliteConfig.journalMode == 'memory') { console.log('[WARNING] journal_mode=memory: this can lead to database corruption if there is a crash during a transaction. See https://www.sqlite.org/pragma.html#pragma_journal_mode') };
+ //.cached not usefull
+ obj.file = new sqlite3.Database(path.join(parent.datapath, databaseName + '.sqlite'), sqlite3.OPEN_READWRITE, function (err) {
if (err && (err.code == 'SQLITE_CANTOPEN')) {
// Database needs to be created
- obj.file = new sqlite3.Database(parent.path.join(parent.datapath, 'meshcentral.sqlite'), function (err) {
- if (err) { console.log("SQLite Error: " + err); exit(1); return; }
+ obj.file = new sqlite3.Database(path.join(parent.datapath, databaseName + '.sqlite'), function (err) {
+ if (err) { console.log("SQLite Error: " + err); process.exit(1); }
obj.file.exec(`
CREATE TABLE main (id VARCHAR(256) PRIMARY KEY NOT NULL, type CHAR(32), domain CHAR(64), extra CHAR(255), extraex CHAR(255), doc JSON);
CREATE TABLE events(id INTEGER PRIMARY KEY, time TIMESTAMP, domain CHAR(64), action CHAR(255), nodeid CHAR(255), userid CHAR(255), doc JSON);
@@ -696,20 +807,24 @@ module.exports.CreateDB = function (parent, func) {
CREATE INDEX ndxsmbiostime ON smbios (time);
CREATE INDEX ndxsmbiosexpire ON smbios (expire);
`, function (err) {
- // Completed setup of SQLite3
+ // Completed DB creation of SQLite3
+ sqliteSetOptions(func);
+ //setupFunctions could be put in the sqliteSetupOptions, but left after it for clarity
setupFunctions(func);
}
);
});
return;
- } else if (err) { console.log("SQLite Error: " + err); exit(1); return; }
+ } else if (err) { console.log("SQLite Error: " + err); process.exit(0); }
- // Completed setup of SQLite3
+ //for existing db's
+ sqliteSetOptions();
+ //setupFunctions could be put in the sqliteSetupOptions, but left after it for clarity
setupFunctions(func);
});
} else if (parent.args.acebase) {
// AceBase database setup
- obj.databaseType = 7;
+ obj.databaseType = DB_ACEBASE;
const { AceBase } = require('acebase');
// For information on AceBase sponsor: https://github.com/appy-one/acebase/discussions/100
obj.file = new AceBase('meshcentral', { sponsor: ((typeof parent.args.acebase == 'object') && (parent.args.acebase.sponsor)), logLevel: 'error', storage: { path: parent.datapath } });
@@ -733,27 +848,39 @@ module.exports.CreateDB = function (parent, func) {
});
} else if (parent.args.mariadb || parent.args.mysql) {
var connectinArgs = (parent.args.mariadb) ? parent.args.mariadb : parent.args.mysql;
- var dbname = (connectinArgs.database != null) ? connectinArgs.database : 'meshcentral';
+ if (typeof connectinArgs == 'string') {
+ const parts = connectinArgs.split(/[:@/]+/);
+ var connectionObject = {
+ "user": parts[1],
+ "password": parts[2],
+ "host": parts[3],
+ "port": parts[4],
+ "database": parts[5]
+ };
+ var dbname = (connectionObject.database != null) ? connectionObject.database : 'meshcentral';
+ } else {
+ var dbname = (connectinArgs.database != null) ? connectinArgs.database : 'meshcentral';
- // Including the db name in the connection obj will cause a connection faliure if it does not exist
- var connectionObject = Clone(connectinArgs);
- delete connectionObject.database;
+ // Including the db name in the connection obj will cause a connection faliure if it does not exist
+ var connectionObject = Clone(connectinArgs);
+ delete connectionObject.database;
- try {
- if (connectinArgs.ssl) {
- if (connectinArgs.ssl.dontcheckserveridentity == true) { connectionObject.ssl.checkServerIdentity = function (name, cert) { return undefined; } };
- if (connectinArgs.ssl.cacertpath) { connectionObject.ssl.ca = [require('fs').readFileSync(connectinArgs.ssl.cacertpath, 'utf8')]; }
- if (connectinArgs.ssl.clientcertpath) { connectionObject.ssl.cert = [require('fs').readFileSync(connectinArgs.ssl.clientcertpath, 'utf8')]; }
- if (connectinArgs.ssl.clientkeypath) { connectionObject.ssl.key = [require('fs').readFileSync(connectinArgs.ssl.clientkeypath, 'utf8')]; }
+ try {
+ if (connectinArgs.ssl) {
+ if (connectinArgs.ssl.dontcheckserveridentity == true) { connectionObject.ssl.checkServerIdentity = function (name, cert) { return undefined; } };
+ if (connectinArgs.ssl.cacertpath) { connectionObject.ssl.ca = [require('fs').readFileSync(connectinArgs.ssl.cacertpath, 'utf8')]; }
+ if (connectinArgs.ssl.clientcertpath) { connectionObject.ssl.cert = [require('fs').readFileSync(connectinArgs.ssl.clientcertpath, 'utf8')]; }
+ if (connectinArgs.ssl.clientkeypath) { connectionObject.ssl.key = [require('fs').readFileSync(connectinArgs.ssl.clientkeypath, 'utf8')]; }
+ }
+ } catch (ex) {
+ console.log('Error loading SQL Connector certificate: ' + ex);
+ process.exit();
}
- } catch (ex) {
- console.log('Error loading SQL Connector certificate: ' + ex);
- process.exit();
}
if (parent.args.mariadb) {
// Use MariaDB
- obj.databaseType = 4;
+ obj.databaseType = DB_MARIADB;
var tempDatastore = require('mariadb').createPool(connectionObject);
tempDatastore.getConnection().then(function (conn) {
conn.query('CREATE DATABASE IF NOT EXISTS ' + dbname).then(function (result) {
@@ -767,49 +894,70 @@ module.exports.CreateDB = function (parent, func) {
createTablesIfNotExist(dbname);
} else if (parent.args.mysql) {
// Use MySQL
- obj.databaseType = 5;
- var tempDatastore = require('mysql').createPool(connectionObject);
+ obj.databaseType = DB_MYSQL;
+ var tempDatastore = require('mysql2').createPool(connectionObject);
tempDatastore.query('CREATE DATABASE IF NOT EXISTS ' + dbname, function (error) {
if (error != null) {
console.log('Auto-create database failed: ' + error);
}
connectionObject.database = dbname;
- Datastore = require('mysql').createPool(connectionObject);
+ Datastore = require('mysql2').createPool(connectionObject);
createTablesIfNotExist(dbname);
});
setTimeout(function () { tempDatastore.end(); }, 2000);
}
} else if (parent.args.postgres) {
// Postgres SQL
- var connectinArgs = parent.args.postgres;
- var dbname = (connectinArgs.database != null) ? connectinArgs.database : 'meshcentral';
- delete connectinArgs.database;
- obj.databaseType = 6;
- const pgtools = require('pgtools');
- pgtools.createdb(connectinArgs, dbname, function (err, res) {
- const { Pool, Client } = require('pg');
- connectinArgs.database = dbname;
- Datastore = new Client(connectinArgs);
- Datastore.connect();
- if (err == null) {
- // Create the tables and indexes
- postgreSqlCreateTables(func);
- } else {
- // Database already existed, perform a test query to see if the main table is present
- sqlDbQuery('SELECT doc FROM main WHERE id = $1', ['DatabaseIdentifier'], function (err, docs) {
- if (err == null) { setupFunctions(func); } else { postgreSqlCreateTables(func); } // If not present, create the tables and indexes
+ let connectinArgs = parent.args.postgres;
+ connectinArgs.database = (databaseName = (connectinArgs.database != null) ? connectinArgs.database : 'meshcentral');
+
+ let DatastoreTest;
+ obj.databaseType = DB_POSTGRESQL;
+ const { Client } = require('pg');
+ Datastore = new Client(connectinArgs);
+ //Connect to and check pg db first to check if own db exists. Otherwise errors out on 'database does not exist'
+ connectinArgs.database = 'postgres';
+ DatastoreTest = new Client(connectinArgs);
+ DatastoreTest.connect();
+
+ DatastoreTest.query('SELECT 1 FROM pg_catalog.pg_database WHERE datname = $1', [databaseName], function (err, res) { // check database exists first before creating
+ if (res.rowCount != 0) { // database exists now check tables exists
+ DatastoreTest.end();
+ Datastore.connect();
+ Datastore.query('SELECT doc FROM main WHERE id = $1', ['DatabaseIdentifier'], function (err, res) {
+ if (err == null) {
+ (res.rowCount ==0) ? postgreSqlCreateTables(func) : setupFunctions(func)
+ } else
+ if (err.code == '42P01') { //42P01 = undefined table, https://www.postgresql.org/docs/current/errcodes-appendix.html
+ postgreSqlCreateTables(func);
+ } else {
+ console.log('Postgresql database exists, other error: ', err.message); process.exit(0);
+ };
+ });
+ } else { // If not present, create the tables and indexes
+ //not needed, just use a create db statement: const pgtools = require('pgtools');
+ DatastoreTest.query('CREATE DATABASE '+ databaseName + ';', [], function (err, res) {
+ if (err == null) {
+ // Create the tables and indexes
+ DatastoreTest.end();
+ Datastore.connect();
+ postgreSqlCreateTables(func);
+ } else {
+ console.log('Postgresql database create error: ', err.message);
+ process.exit(0);
+ }
});
}
});
} else if (parent.args.mongodb) {
// Use MongoDB
- obj.databaseType = 3;
+ obj.databaseType = DB_MONGODB;
// If running an older NodeJS version, TextEncoder/TextDecoder is required
if (global.TextEncoder == null) { global.TextEncoder = require('util').TextEncoder; }
if (global.TextDecoder == null) { global.TextDecoder = require('util').TextDecoder; }
- require('mongodb').MongoClient.connect(parent.args.mongodb, { useNewUrlParser: true, useUnifiedTopology: true }, function (err, client) {
+ require('mongodb').MongoClient.connect(parent.args.mongodb, { useNewUrlParser: true, useUnifiedTopology: true, enableUtf8Validation: false }, function (err, client) {
if (err != null) { console.log("Unable to connect to database: " + err); process.exit(); return; }
Datastore = client;
parent.debug('db', 'Connected to MongoDB database...');
@@ -827,7 +975,7 @@ module.exports.CreateDB = function (parent, func) {
} else {
if ((info.versionArray[0] < 3) || ((info.versionArray[0] == 3) && (info.versionArray[1] < 6))) {
// We are running with mongoDB older than 3.6, this is not good.
- parent.addServerWarning("Current version of MongoDB (" + info.version + ") is too old, please upgrade to MongoDB 3.6 or better.");
+ parent.addServerWarning("Current version of MongoDB (" + info.version + ") is too old, please upgrade to MongoDB 3.6 or better.", true);
}
}
});
@@ -986,7 +1134,7 @@ module.exports.CreateDB = function (parent, func) {
});
} else if (parent.args.xmongodb) {
// Use MongoJS, this is the old system.
- obj.databaseType = 2;
+ obj.databaseType = DB_MONGOJS;
Datastore = require('mongojs');
var db = Datastore(parent.args.xmongodb);
var dbcollection = 'meshcentral';
@@ -1090,9 +1238,12 @@ module.exports.CreateDB = function (parent, func) {
setupFunctions(func); // Completed setup of MongoJS
} else {
// Use NeDB (The default)
- obj.databaseType = 1;
- try { Datastore = require('@yetzt/nedb'); } catch (ex) { } // This is the NeDB with fixed security dependencies.
- if (Datastore == null) { Datastore = require('nedb'); } // So not to break any existing installations, if the old NeDB is present, use it.
+ obj.databaseType = DB_NEDB;
+ try { Datastore = require('@seald-io/nedb'); } catch (ex) { } // This is the NeDB with Node 23 support.
+ if (Datastore == null) {
+ try { Datastore = require('@yetzt/nedb'); } catch (ex) { } // This is the NeDB with fixed security dependencies.
+ if (Datastore == null) { Datastore = require('nedb'); } // So not to break any existing installations, if the old NeDB is present, use it.
+ }
var datastoreOptions = { filename: parent.getConfigFilePath('meshcentral.db'), autoload: true };
// If a DB encryption key is provided, perform database encryption
@@ -1119,7 +1270,7 @@ module.exports.CreateDB = function (parent, func) {
// Start NeDB main collection and setup indexes
obj.file = new Datastore(datastoreOptions);
- obj.file.persistence.setAutocompactionInterval(86400000); // Compact once a day
+ obj.file.setAutocompactionInterval(86400000); // Compact once a day
obj.file.ensureIndex({ fieldName: 'type' });
obj.file.ensureIndex({ fieldName: 'domain' });
obj.file.ensureIndex({ fieldName: 'meshid', sparse: true });
@@ -1128,7 +1279,7 @@ module.exports.CreateDB = function (parent, func) {
// Setup the events collection and setup indexes
obj.eventsfile = new Datastore({ filename: parent.getConfigFilePath('meshcentral-events.db'), autoload: true, corruptAlertThreshold: 1 });
- obj.eventsfile.persistence.setAutocompactionInterval(86400000); // Compact once a day
+ obj.eventsfile.setAutocompactionInterval(86400000); // Compact once a day
obj.eventsfile.ensureIndex({ fieldName: 'ids' }); // TODO: Not sure if this is a good index, this is a array field.
obj.eventsfile.ensureIndex({ fieldName: 'nodeid', sparse: true });
obj.eventsfile.ensureIndex({ fieldName: 'time', expireAfterSeconds: expireEventsSeconds });
@@ -1136,18 +1287,18 @@ module.exports.CreateDB = function (parent, func) {
// Setup the power collection and setup indexes
obj.powerfile = new Datastore({ filename: parent.getConfigFilePath('meshcentral-power.db'), autoload: true, corruptAlertThreshold: 1 });
- obj.powerfile.persistence.setAutocompactionInterval(86400000); // Compact once a day
+ obj.powerfile.setAutocompactionInterval(86400000); // Compact once a day
obj.powerfile.ensureIndex({ fieldName: 'nodeid' });
obj.powerfile.ensureIndex({ fieldName: 'time', expireAfterSeconds: expirePowerEventsSeconds });
obj.powerfile.remove({ time: { '$lt': new Date(Date.now() - (expirePowerEventsSeconds * 1000)) } }, { multi: true }); // Force delete older events
// Setup the SMBIOS collection, for NeDB we don't setup SMBIOS since NeDB will corrupt the database. Remove any existing ones.
//obj.smbiosfile = new Datastore({ filename: parent.getConfigFilePath('meshcentral-smbios.db'), autoload: true, corruptAlertThreshold: 1 });
- parent.fs.unlink(parent.getConfigFilePath('meshcentral-smbios.db'), function () { });
+ fs.unlink(parent.getConfigFilePath('meshcentral-smbios.db'), function () { });
// Setup the server stats collection and setup indexes
obj.serverstatsfile = new Datastore({ filename: parent.getConfigFilePath('meshcentral-stats.db'), autoload: true, corruptAlertThreshold: 1 });
- obj.serverstatsfile.persistence.setAutocompactionInterval(86400000); // Compact once a day
+ obj.serverstatsfile.setAutocompactionInterval(86400000); // Compact once a day
obj.serverstatsfile.ensureIndex({ fieldName: 'time', expireAfterSeconds: expireServerStatsSeconds });
obj.serverstatsfile.ensureIndex({ fieldName: 'expire', expireAfterSeconds: 0 }); // Auto-expire events
obj.serverstatsfile.remove({ time: { '$lt': new Date(Date.now() - (expireServerStatsSeconds * 1000)) } }, { multi: true }); // Force delete older events
@@ -1155,12 +1306,51 @@ module.exports.CreateDB = function (parent, func) {
// Setup plugin info collection
if (obj.pluginsActive) {
obj.pluginsfile = new Datastore({ filename: parent.getConfigFilePath('meshcentral-plugins.db'), autoload: true });
- obj.pluginsfile.persistence.setAutocompactionInterval(86400000); // Compact once a day
+ obj.pluginsfile.setAutocompactionInterval(86400000); // Compact once a day
}
setupFunctions(func); // Completed setup of NeDB
}
+ function sqliteSetOptions(func) {
+ //get current auto_vacuum mode for comparison
+ obj.file.get('PRAGMA auto_vacuum;', function(err, current){
+ let pragma = 'PRAGMA journal_mode=' + obj.sqliteConfig.journalMode + ';' +
+ 'PRAGMA synchronous='+ obj.sqliteConfig.synchronous + ';' +
+ 'PRAGMA journal_size_limit=' + obj.sqliteConfig.journalSize + ';' +
+ 'PRAGMA auto_vacuum=' + obj.sqliteConfig.autoVacuum + ';' +
+ 'PRAGMA incremental_vacuum=' + obj.sqliteConfig.incrementalVacuum + ';' +
+ 'PRAGMA optimize=0x10002;';
+ //check new autovacuum mode, if changing from or to 'none', a VACUUM needs to be done to activate it. See https://www.sqlite.org/pragma.html#pragma_auto_vacuum
+ if ( obj.sqliteConfig.startupVacuum
+ || (current.auto_vacuum == 0 && obj.sqliteConfig.autoVacuum !='none')
+ || (current.auto_vacuum != 0 && obj.sqliteConfig.autoVacuum =='none'))
+ {
+ pragma += 'VACUUM;';
+ };
+ parent.debug ('db', 'Config statement: ' + pragma);
+
+ obj.file.exec( pragma,
+ function (err) {
+ if (err) { parent.debug('db', 'Config pragma error: ' + (err.message)) };
+ sqliteGetPragmas(['journal_mode', 'journal_size_limit', 'freelist_count', 'auto_vacuum', 'page_size', 'wal_autocheckpoint', 'synchronous'], function (pragma, pragmaValue) {
+ parent.debug('db', 'PRAGMA: ' + pragma + '=' + pragmaValue);
+ });
+ });
+ });
+ //setupFunctions(func);
+ }
+
+ function sqliteGetPragmas (pragmas, func){
+ //pragmas can only be gotting one by one
+ pragmas.forEach (function (pragma) {
+ obj.file.get('PRAGMA ' + pragma + ';', function(err, res){
+ if (pragma == 'auto_vacuum') { res[pragma] = SQLITE_AUTOVACUUM[res[pragma]] };
+ if (pragma == 'synchronous') { res[pragma] = SQLITE_SYNCHRONOUS[res[pragma]] };
+ if (func) { func (pragma, res[pragma]); }
+ });
+ });
+ }
// Create the PostgreSQL tables
function postgreSqlCreateTables(func) {
// Database was created, create the tables
@@ -1202,7 +1392,7 @@ module.exports.CreateDB = function (parent, func) {
// Query the database
function sqlDbQuery(query, args, func, debug) {
- if (obj.databaseType == 8) { // SQLite
+ if (obj.databaseType == DB_SQLITE) { // SQLite
if (args == null) { args = []; }
obj.file.all(query, args, function (err, docs) {
if (err != null) { console.log(query, args, err, docs); }
@@ -1217,7 +1407,7 @@ module.exports.CreateDB = function (parent, func) {
}
if (func) { func(err, docs); }
});
- } else if (obj.databaseType == 4) { // MariaDB
+ } else if (obj.databaseType == DB_MARIADB) { // MariaDB
Datastore.getConnection()
.then(function (conn) {
conn.query(query, args)
@@ -1236,7 +1426,7 @@ module.exports.CreateDB = function (parent, func) {
})
.catch(function (err) { conn.release(); if (func) try { func(err); } catch (ex) { console.log('SQLERR2', ex); } });
}).catch(function (err) { if (func) { try { func(err); } catch (ex) { console.log('SQLERR3', ex); } } });
- } else if (obj.databaseType == 5) { // MySQL
+ } else if (obj.databaseType == DB_MYSQL) { // MySQL
Datastore.query(query, args, function (error, results, fields) {
if (error != null) {
if (func) try { func(error); } catch (ex) { console.log('SQLERR4', ex); }
@@ -1244,7 +1434,11 @@ module.exports.CreateDB = function (parent, func) {
var docs = [];
for (var i in results) {
if (results[i].doc) {
- docs.push(JSON.parse(results[i].doc));
+ if (typeof results[i].doc == 'string') {
+ docs.push(JSON.parse(results[i].doc));
+ } else {
+ docs.push(results[i].doc);
+ }
} else if ((results.length == 1) && (results[i]['COUNT(doc)'] != null)) {
// This is a SELECT COUNT() operation
docs = results[i]['COUNT(doc)'];
@@ -1253,10 +1447,9 @@ module.exports.CreateDB = function (parent, func) {
if (func) { try { func(null, docs); } catch (ex) { console.log('SQLERR5', ex); } }
}
});
- } else if (obj.databaseType == 6) { // Postgres SQL
+ } else if (obj.databaseType == DB_POSTGRESQL) { // Postgres SQL
Datastore.query(query, args, function (error, results) {
if (error != null) {
- console.log(query, args, error);
if (func) try { func(error); } catch (ex) { console.log('SQLERR4', ex); }
} else {
var docs = [];
@@ -1283,7 +1476,7 @@ module.exports.CreateDB = function (parent, func) {
// Exec on the database
function sqlDbExec(query, args, func) {
- if (obj.databaseType == 4) { // MariaDB
+ if (obj.databaseType == DB_MARIADB) { // MariaDB
Datastore.getConnection()
.then(function (conn) {
conn.query(query, args)
@@ -1293,7 +1486,7 @@ module.exports.CreateDB = function (parent, func) {
})
.catch(function (err) { conn.release(); if (func) try { func(err); } catch (ex) { console.log(ex); } });
}).catch(function (err) { if (func) { try { func(err); } catch (ex) { console.log(ex); } } });
- } else if ((obj.databaseType == 5) || (obj.databaseType == 6)) { // MySQL or Postgres SQL
+ } else if ((obj.databaseType == DB_MYSQL) || (obj.databaseType == DB_POSTGRESQL)) { // MySQL or Postgres SQL
Datastore.query(query, args, function (error, results, fields) {
if (func) try { func(error, results ? results[0] : null); } catch (ex) { console.log(ex); }
});
@@ -1302,7 +1495,7 @@ module.exports.CreateDB = function (parent, func) {
// Execute a batch of commands on the database
function sqlDbBatchExec(queries, func) {
- if (obj.databaseType == 4) { // MariaDB
+ if (obj.databaseType == DB_MARIADB) { // MariaDB
Datastore.getConnection()
.then(function (conn) {
var Promises = [];
@@ -1312,7 +1505,16 @@ module.exports.CreateDB = function (parent, func) {
.catch(function (err) { conn.release(); if (func) { try { func(err); } catch (ex) { console.log(ex); } } });
})
.catch(function (err) { if (func) { try { func(err); } catch (ex) { console.log(ex); } } });
- } else if ((obj.databaseType == 5) || (obj.databaseType == 6)) { // MySQL
+ } else if (obj.databaseType == DB_MYSQL) { // MySQL
+ Datastore.getConnection(function(err, connection) {
+ if (err) { if (func) { try { func(err); } catch (ex) { console.log(ex); } } return; }
+ var Promises = [];
+ for (var i in queries) { if (typeof queries[i] == 'string') { Promises.push(connection.promise().query(queries[i])); } else { Promises.push(connection.promise().query(queries[i][0], queries[i][1])); } }
+ Promise.all(Promises)
+ .then(function (error, results, fields) { connection.release(); if (func) { try { func(error, results); } catch (ex) { console.log(ex); } } })
+ .catch(function (error, results, fields) { connection.release(); if (func) { try { func(error); } catch (ex) { console.log(ex); } } });
+ });
+ } else if (obj.databaseType == DB_POSTGRESQL) { // Postgres
var Promises = [];
for (var i in queries) { if (typeof queries[i] == 'string') { Promises.push(Datastore.query(queries[i])); } else { Promises.push(Datastore.query(queries[i][0], queries[i][1])); } }
Promise.all(Promises)
@@ -1322,7 +1524,7 @@ module.exports.CreateDB = function (parent, func) {
}
function setupFunctions(func) {
- if (obj.databaseType == 8) {
+ if (obj.databaseType == DB_SQLITE) {
// Database actions on the main collection. SQLite3: https://www.linode.com/docs/guides/getting-started-with-nodejs-sqlite/
obj.Set = function (value, func) {
obj.dbCounters.fileSet++;
@@ -1450,9 +1652,9 @@ module.exports.CreateDB = function (parent, func) {
obj.SetUser = function (user) { if (user == null) return; if (user.subscriptions != null) { var u = Clone(user); if (u.subscriptions) { delete u.subscriptions; } obj.Set(u); } else { obj.Set(user); } };
obj.dispose = function () { for (var x in obj) { if (obj[x].close) { obj[x].close(); } delete obj[x]; } };
obj.getLocalAmtNodes = function (func) {
- sqlDbQuery('SELECT doc FROM main WHERE (type = \'node\') AND (extraex IS NOT NULL)', null, function (err, docs) {
+ sqlDbQuery('SELECT doc FROM main WHERE (type = \'node\') AND (extraex IS NULL)', null, function (err, docs) {
if (docs != null) { for (var i in docs) { if (docs[i].links != null) { docs[i] = common.unEscapeLinksFieldName(docs[i]); } } }
- var r = []; if (err == null) { for (var i in docs) { if (docs[i].host != null) { r.push(docs[i]); } } } func(err, r);
+ var r = []; if (err == null) { for (var i in docs) { if (docs[i].host != null && docs[i].intelamt != null) { r.push(docs[i]); } } } func(err, r);
});
};
obj.getAmtUuidMeshNode = function (domainid, mtype, uuid, func) {
@@ -1470,36 +1672,102 @@ module.exports.CreateDB = function (parent, func) {
obj.StoreEvent = function (event, func) {
obj.dbCounters.eventsSet++;
sqlDbQuery('INSERT INTO events VALUES (NULL, $1, $2, $3, $4, $5, $6) RETURNING id', [event.time, ((typeof event.domain == 'string') ? event.domain : null), event.action, event.nodeid ? event.nodeid : null, event.userid ? event.userid : null, JSON.stringify(event)], function (err, docs) {
- if ((err == null) && (docs[0].id)) { for (var i in event.ids) { if (event.ids[i] != '*') { sqlDbQuery('INSERT INTO eventids VALUES ($1, $2)', [docs[0].id, event.ids[i]]); } } }
+ if(func){ func(); }
+ if ((err == null) && (docs[0].id)) {
+ for (var i in event.ids) {
+ if (event.ids[i] != '*') {
+ obj.pendingTransfer++;
+ sqlDbQuery('INSERT INTO eventids VALUES ($1, $2)', [docs[0].id, event.ids[i]], function(){ if(func){ func(); } });
+ }
+ }
+ }
});
};
- obj.GetEvents = function (ids, domain, func) {
+ obj.GetEvents = function (ids, domain, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1) ORDER BY time DESC', [domain], func);
+ query = query + "WHERE (domain = $1";
+ if (filter != null) {
+ query = query + " AND action = $2";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC";
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND (target IN (' + dbMergeSqlArray(ids) + '))) GROUP BY id ORDER BY time DESC', [domain], func);
+ query = query + 'JOIN eventids ON id = fkid WHERE (domain = $1 AND (target IN (' + dbMergeSqlArray(ids) + '))';
+ if (filter != null) {
+ query = query + " AND action = $2";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC ";
}
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetEventsWithLimit = function (ids, domain, limit, func) {
+ obj.GetEventsWithLimit = function (ids, domain, limit, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1) ORDER BY time DESC LIMIT $2', [domain, limit], func);
+ query = query + "WHERE (domain = $1";
+ if (filter != null) {
+ query = query + " AND action = $2) ORDER BY time DESC LIMIT $3";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $2";
+ }
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND (target IN (' + dbMergeSqlArray(ids) + '))) GROUP BY id ORDER BY time DESC LIMIT $2', [domain, limit], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = $1 AND (target IN (" + dbMergeSqlArray(ids) + "))";
+ if (filter != null) {
+ query = query + " AND action = $2) GROUP BY id ORDER BY time DESC LIMIT $3";
+ dataarray.push(filter);
+ } else {
+ query = query + ") GROUP BY id ORDER BY time DESC LIMIT $2";
+ }
}
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetUserEvents = function (ids, domain, userid, func) {
+ obj.GetUserEvents = function (ids, domain, userid, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain, userid];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1 AND userid = $2) ORDER BY time DESC', [domain, userid], func);
+ query = query + "WHERE (domain = $1 AND userid = $2";
+ if (filter != null) {
+ query = query + " AND action = $3";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC";
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target IN (' + dbMergeSqlArray(ids) + '))) GROUP BY id ORDER BY time DESC', [domain, userid], func);
+ query = query + 'JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target IN (' + dbMergeSqlArray(ids) + '))';
+ if (filter != null) {
+ query = query + " AND action = $3";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC";
}
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, func) {
+ obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain, userid];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1 AND userid = $2) ORDER BY time DESC LIMIT $3', [domain, userid, limit], func);
+ query = query + "WHERE (domain = $1 AND userid = $2";
+ if (filter != null) {
+ query = query + " AND action = $3) ORDER BY time DESC LIMIT $4";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $3";
+ }
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target IN (' + dbMergeSqlArray(ids) + '))) GROUP BY id ORDER BY time DESC LIMIT $3', [domain, userid, limit], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target IN (" + dbMergeSqlArray(ids) + "))";
+ if (filter != null) {
+ query = query + " AND action = $3) GROUP BY id ORDER BY time DESC LIMIT $4";
+ dataarray.push(filter);
+ } else {
+ query = query + ") GROUP BY id ORDER BY time DESC LIMIT $3";
+ }
}
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
};
obj.GetEventsTimeRange = function (ids, domain, msgids, start, end, func) {
if (ids.indexOf('*') >= 0) {
@@ -1509,8 +1777,30 @@ module.exports.CreateDB = function (parent, func) {
}
};
//obj.GetUserLoginEvents = function (domain, userid, func) { } // TODO
- obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, func) { sqlDbQuery('SELECT doc FROM events WHERE (nodeid = $1) AND (domain = $2) ORDER BY time DESC LIMIT $3', [nodeid, domain, limit], func); };
- obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, func) { sqlDbQuery('SELECT doc FROM events WHERE (nodeid = $1) AND (domain = $2) AND ((userid = $3) OR (userid IS NULL)) ORDER BY time DESC LIMIT $4', [nodeid, domain, userid, limit], func); };
+ obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, filter, func) {
+ var query = "SELECT doc FROM events WHERE (nodeid = $1 AND domain = $2";
+ var dataarray = [nodeid, domain];
+ if (filter != null) {
+ query = query + " AND action = $3) ORDER BY time DESC LIMIT $4";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $3";
+ }
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
+ };
+ obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, filter, func) {
+ var query = "SELECT doc FROM events WHERE (nodeid = $1) AND (domain = $2) AND ((userid = $3) OR (userid IS NULL)) ";
+ var dataarray = [nodeid, domain, userid];
+ if (filter != null) {
+ query = query + "AND (action = $4) ORDER BY time DESC LIMIT $5";
+ dataarray.push(filter);
+ } else {
+ query = query + "ORDER BY time DESC LIMIT $4";
+ }
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
+ };
obj.RemoveAllEvents = function (domain) { sqlDbQuery('DELETE FROM events', null, function (err, docs) { }); };
obj.RemoveAllNodeEvents = function (domain, nodeid) { if ((domain == null) || (nodeid == null)) return; sqlDbQuery('DELETE FROM events WHERE domain = $1 AND nodeid = $2', [domain, nodeid], function (err, docs) { }); };
obj.RemoveAllUserEvents = function (domain, userid) { if ((domain == null) || (userid == null)) return; sqlDbQuery('DELETE FROM events WHERE domain = $1 AND userid = $2', [domain, userid], function (err, docs) { }); };
@@ -1553,14 +1843,14 @@ module.exports.CreateDB = function (parent, func) {
// Plugin operations
if (obj.pluginsActive) {
- obj.addPlugin = function (plugin, func) { sqlDbQuery('INSERT INTO plugin VALUES (NULL, $1)', [JSON.stringify(value)], func); }; // Add a plugin
- obj.getPlugins = function (func) { sqlDbQuery('SELECT doc FROM plugin', null, func); }; // Get all plugins
- obj.getPlugin = function (id, func) { sqlDbQuery('SELECT doc FROM plugin WHERE id = $1', [id], func); }; // Get plugin
+ obj.addPlugin = function (plugin, func) { sqlDbQuery('INSERT INTO plugin VALUES (NULL, $1)', [JSON.stringify(plugin)], func); }; // Add a plugin
+ obj.getPlugins = function (func) { sqlDbQuery('SELECT JSON_INSERT(doc, "$._id", id) as doc FROM plugin', null, func); }; // Get all plugins
+ obj.getPlugin = function (id, func) { sqlDbQuery('SELECT JSON_INSERT(doc, "$._id", id) as doc FROM plugin WHERE id = $1', [id], func); }; // Get plugin
obj.deletePlugin = function (id, func) { sqlDbQuery('DELETE FROM plugin WHERE id = $1', [id], func); }; // Delete plugin
- obj.setPluginStatus = function (id, status, func) { obj.getPlugin(id, function (err, docs) { if ((err == null) && (docs.length == 1)) { docs[0].status = status; obj.updatePlugin(id, docs[0], func); } }); };
- obj.updatePlugin = function (id, args, func) { delete args._id; sqlDbQuery('INSERT INTO plugin VALUES ($1, $2) ON CONFLICT (id) DO UPDATE SET doc = $2', [id, JSON.stringify(args)], func); };
+ obj.setPluginStatus = function (id, status, func) { sqlDbQuery('UPDATE plugin SET doc=JSON_SET(doc,"$.status",$1) WHERE id=$2', [status,id], func); };
+ obj.updatePlugin = function (id, args, func) { delete args._id; sqlDbQuery('UPDATE plugin SET doc=json_patch(doc,$1) WHERE id=$2', [JSON.stringify(args),id], func); };
}
- } else if (obj.databaseType == 7) {
+ } else if (obj.databaseType == DB_ACEBASE) {
// Database actions on the main collection. AceBase: https://github.com/appy-one/acebase
obj.Set = function (data, func) {
data = common.escapeLinksFieldNameEx(data);
@@ -1648,42 +1938,78 @@ module.exports.CreateDB = function (parent, func) {
obj.dbCounters.eventsSet++;
obj.file.ref('events').push(event).then(function (userRef) { if (func) { func(); } });
};
- obj.GetEvents = function (ids, domain, func) {
+ obj.GetEvents = function (ids, domain, filter, func) {
// This request is slow since we have not found a .filter() that will take two arrays and match a single item.
- obj.file.query('events').filter('domain', '==', domain).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type'] }, function (snapshots) {
- const docs = [];
- for (var i in snapshots) {
- const doc = snapshots[i].val();
- if ((doc.ids == null) || (!Array.isArray(doc.ids))) continue;
- var found = false;
- for (var j in doc.ids) { if (ids.indexOf(doc.ids[j]) >= 0) { found = true; } } // Check if one of the items in both arrays matches
- if (found) { delete doc.ids; if (typeof doc.account == 'object') { doc.account = common.aceUnEscapeFieldNames(doc.account); } docs.push(doc); }
- }
- func(null, docs);
- });
+ if (filter != null) {
+ obj.file.query('events').filter('domain', '==', domain).filter('action', '==', filter).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type'] }, function (snapshots) {
+ const docs = [];
+ for (var i in snapshots) {
+ const doc = snapshots[i].val();
+ if ((doc.ids == null) || (!Array.isArray(doc.ids))) continue;
+ var found = false;
+ for (var j in doc.ids) { if (ids.indexOf(doc.ids[j]) >= 0) { found = true; } } // Check if one of the items in both arrays matches
+ if (found) { delete doc.ids; if (typeof doc.account == 'object') { doc.account = common.aceUnEscapeFieldNames(doc.account); } docs.push(doc); }
+ }
+ func(null, docs);
+ });
+ } else {
+ obj.file.query('events').filter('domain', '==', domain).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type'] }, function (snapshots) {
+ const docs = [];
+ for (var i in snapshots) {
+ const doc = snapshots[i].val();
+ if ((doc.ids == null) || (!Array.isArray(doc.ids))) continue;
+ var found = false;
+ for (var j in doc.ids) { if (ids.indexOf(doc.ids[j]) >= 0) { found = true; } } // Check if one of the items in both arrays matches
+ if (found) { delete doc.ids; if (typeof doc.account == 'object') { doc.account = common.aceUnEscapeFieldNames(doc.account); } docs.push(doc); }
+ }
+ func(null, docs);
+ });
+ }
};
- obj.GetEventsWithLimit = function (ids, domain, limit, func) {
+ obj.GetEventsWithLimit = function (ids, domain, limit, filter, func) {
// This request is slow since we have not found a .filter() that will take two arrays and match a single item.
// TODO: Request a new AceBase feature for a 'array:contains-one-of' filter:
// obj.file.indexes.create('events', 'ids', { type: 'array' });
// db.query('events').filter('ids', 'array:contains-one-of', ids)
- obj.file.query('events').filter('domain', '==', domain).take(limit).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type'] }, function (snapshots) {
- const docs = [];
- for (var i in snapshots) {
- const doc = snapshots[i].val();
- if ((doc.ids == null) || (!Array.isArray(doc.ids))) continue;
- var found = false;
- for (var j in doc.ids) { if (ids.indexOf(doc.ids[j]) >= 0) { found = true; } } // Check if one of the items in both arrays matches
- if (found) { delete doc.ids; if (typeof doc.account == 'object') { doc.account = common.aceUnEscapeFieldNames(doc.account); } docs.push(doc); }
- }
- func(null, docs);
- });
+ if (filter != null) {
+ obj.file.query('events').filter('domain', '==', domain).filter('action', '==', filter).take(limit).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type'] }, function (snapshots) {
+ const docs = [];
+ for (var i in snapshots) {
+ const doc = snapshots[i].val();
+ if ((doc.ids == null) || (!Array.isArray(doc.ids))) continue;
+ var found = false;
+ for (var j in doc.ids) { if (ids.indexOf(doc.ids[j]) >= 0) { found = true; } } // Check if one of the items in both arrays matches
+ if (found) { delete doc.ids; if (typeof doc.account == 'object') { doc.account = common.aceUnEscapeFieldNames(doc.account); } docs.push(doc); }
+ }
+ func(null, docs);
+ });
+ } else {
+ obj.file.query('events').filter('domain', '==', domain).take(limit).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type'] }, function (snapshots) {
+ const docs = [];
+ for (var i in snapshots) {
+ const doc = snapshots[i].val();
+ if ((doc.ids == null) || (!Array.isArray(doc.ids))) continue;
+ var found = false;
+ for (var j in doc.ids) { if (ids.indexOf(doc.ids[j]) >= 0) { found = true; } } // Check if one of the items in both arrays matches
+ if (found) { delete doc.ids; if (typeof doc.account == 'object') { doc.account = common.aceUnEscapeFieldNames(doc.account); } docs.push(doc); }
+ }
+ func(null, docs);
+ });
+ }
};
- obj.GetUserEvents = function (ids, domain, userid, func) {
- obj.file.query('events').filter('domain', '==', domain).filter('userid', 'in', userid).filter('ids', 'in', ids).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type', 'ids'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ obj.GetUserEvents = function (ids, domain, userid, filter, func) {
+ if (filter != null) {
+ obj.file.query('events').filter('domain', '==', domain).filter('userid', 'in', userid).filter('ids', 'in', ids).filter('action', '==', filter).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type', 'ids'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ } else {
+ obj.file.query('events').filter('domain', '==', domain).filter('userid', 'in', userid).filter('ids', 'in', ids).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type', 'ids'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ }
};
- obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, func) {
- obj.file.query('events').take(limit).filter('domain', '==', domain).filter('userid', 'in', userid).filter('ids', 'in', ids).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type', 'ids'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, filter, func) {
+ if (filter != null) {
+ obj.file.query('events').take(limit).filter('domain', '==', domain).filter('userid', 'in', userid).filter('ids', 'in', ids).filter('action', '==', filter).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type', 'ids'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ } else {
+ obj.file.query('events').take(limit).filter('domain', '==', domain).filter('userid', 'in', userid).filter('ids', 'in', ids).sort('time', false).get({ exclude: ['_id', 'domain', 'node', 'type', 'ids'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ }
};
obj.GetEventsTimeRange = function (ids, domain, msgids, start, end, func) {
obj.file.query('events').filter('domain', '==', domain).filter('ids', 'in', ids).filter('msgid', 'in', msgids).filter('time', 'between', [start, end]).sort('time', false).get({ exclude: ['type', '_id', 'domain', 'node'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
@@ -1691,10 +2017,19 @@ module.exports.CreateDB = function (parent, func) {
obj.GetUserLoginEvents = function (domain, userid, func) {
obj.file.query('events').filter('domain', '==', domain).filter('action', 'in', ['authfail', 'login']).filter('userid', '==', userid).filter('msgArgs', 'exists').sort('time', false).get({ include: ['action', 'time', 'msgid', 'msgArgs', 'tokenName'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
};
- obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, func) {
- obj.file.query('events').take(limit).filter('domain', '==', domain).filter('nodeid', '==', nodeid).sort('time', false).get({ exclude: ['type', 'etype', '_id', 'domain', 'ids', 'node', 'nodeid'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, filter, func) {
+ if (filter != null) {
+ obj.file.query('events').take(limit).filter('domain', '==', domain).filter('nodeid', '==', nodeid).filter('action', '==', filter).sort('time', false).get({ exclude: ['type', 'etype', '_id', 'domain', 'ids', 'node', 'nodeid'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ } else {
+ obj.file.query('events').take(limit).filter('domain', '==', domain).filter('nodeid', '==', nodeid).sort('time', false).get({ exclude: ['type', 'etype', '_id', 'domain', 'ids', 'node', 'nodeid'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ }
};
- obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, func) {
+ obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, filter, func) {
+ if (filter != null) {
+ obj.file.query('events').take(limit).filter('domain', '==', domain).filter('nodeid', '==', nodeid).filter('userid', '==', userid).filter('action', '==', filter).sort('time', false).get({ exclude: ['type', 'etype', '_id', 'domain', 'ids', 'node', 'nodeid'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ } else {
+ obj.file.query('events').take(limit).filter('domain', '==', domain).filter('nodeid', '==', nodeid).filter('userid', '==', userid).sort('time', false).get({ exclude: ['type', 'etype', '_id', 'domain', 'ids', 'node', 'nodeid'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
+ }
obj.file.query('events').take(limit).filter('domain', '==', domain).filter('nodeid', '==', nodeid).filter('userid', '==', userid).sort('time', false).get({ exclude: ['type', 'etype', '_id', 'domain', 'ids', 'node', 'nodeid'] }, function (snapshots) { const docs = []; for (var i in snapshots) { docs.push(snapshots[i].val()); } func(null, docs); });
};
obj.RemoveAllEvents = function (domain) {
@@ -1807,7 +2142,7 @@ module.exports.CreateDB = function (parent, func) {
obj.setPluginStatus = function (id, status, func) { obj.file.ref('plugin').child(encodeURIComponent(id)).update({ status: status }).then(function (ref) { if (func) { func(); } }) };
obj.updatePlugin = function (id, args, func) { delete args._id; obj.file.ref('plugin').child(encodeURIComponent(id)).set(args).then(function (ref) { if (func) { func(); } }) };
}
- } else if (obj.databaseType == 6) {
+ } else if (obj.databaseType == DB_POSTGRESQL) {
// Database actions on the main collection (Postgres)
obj.Set = function (value, func) {
obj.dbCounters.fileSet++;
@@ -1873,7 +2208,7 @@ module.exports.CreateDB = function (parent, func) {
obj.DeleteDomain = function (domain, func) { sqlDbQuery('DELETE FROM main WHERE domain = $1', [domain], func); };
obj.SetUser = function (user) { if (user == null) return; if (user.subscriptions != null) { var u = Clone(user); if (u.subscriptions) { delete u.subscriptions; } obj.Set(u); } else { obj.Set(user); } };
obj.dispose = function () { for (var x in obj) { if (obj[x].close) { obj[x].close(); } delete obj[x]; } };
- obj.getLocalAmtNodes = function (func) { sqlDbQuery('SELECT doc FROM main WHERE (type = \'node\') AND (extraex IS NOT NULL)', null, function (err, docs) { var r = []; if (err == null) { for (var i in docs) { if (docs[i].host != null) { r.push(docs[i]); } } } func(err, r); }); };
+ obj.getLocalAmtNodes = function (func) { sqlDbQuery('SELECT doc FROM main WHERE (type = \'node\') AND (extraex IS NULL)', null, function (err, docs) { var r = []; if (err == null) { for (var i in docs) { if (docs[i].host != null && docs[i].intelamt != null) { r.push(docs[i]); } } } func(err, r); }); };
obj.getAmtUuidMeshNode = function (domainid, mtype, uuid, func) { sqlDbQuery('SELECT doc FROM main WHERE domain = $1 AND extraex = $2', [domainid, 'uuid/' + uuid], func); };
obj.isMaxType = function (max, type, domainid, func) { if (max == null) { func(false); } else { sqlDbExec('SELECT COUNT(id) FROM main WHERE domain = $1 AND type = $2', [domainid, type], function (err, response) { func((response['COUNT(id)'] == null) || (response['COUNT(id)'] > max), response['COUNT(id)']) }); } }
@@ -1882,36 +2217,109 @@ module.exports.CreateDB = function (parent, func) {
obj.StoreEvent = function (event, func) {
obj.dbCounters.eventsSet++;
sqlDbQuery('INSERT INTO events VALUES (DEFAULT, $1, $2, $3, $4, $5, $6) RETURNING id', [event.time, ((typeof event.domain == 'string') ? event.domain : null), event.action, event.nodeid ? event.nodeid : null, event.userid ? event.userid : null, event], function (err, docs) {
- if (docs.id) { for (var i in event.ids) { if (event.ids[i] != '*') { sqlDbQuery('INSERT INTO eventids VALUES ($1, $2)', [docs.id, event.ids[i]]); } } }
+ if(func){ func(); }
+ if (docs.id) {
+ for (var i in event.ids) {
+ if (event.ids[i] != '*') {
+ obj.pendingTransfer++;
+ sqlDbQuery('INSERT INTO eventids VALUES ($1, $2)', [docs.id, event.ids[i]], function(){ if(func){ func(); } });
+ }
+ }
+ }
});
};
- obj.GetEvents = function (ids, domain, func) {
+ obj.GetEvents = function (ids, domain, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1) ORDER BY time DESC', [domain], func);
+ query = query + "WHERE (domain = $1";
+ if (filter != null) {
+ query = query + " AND action = $2";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC";
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND (target = ANY ($2))) GROUP BY id ORDER BY time DESC', [domain, ids], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = $1 AND (target = ANY ($2))";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = $3";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC";
}
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetEventsWithLimit = function (ids, domain, limit, func) {
+ obj.GetEventsWithLimit = function (ids, domain, limit, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1) ORDER BY time DESC LIMIT $2', [domain, limit], func);
+ query = query + "WHERE (domain = $1";
+ if (filter != null) {
+ query = query + " AND action = $2) ORDER BY time DESC LIMIT $3";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $2";
+ }
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND (target = ANY ($2))) GROUP BY id ORDER BY time DESC LIMIT $3', [domain, ids, limit], func);
+ if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = $1 AND (target = ANY ($2))";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = $3) ORDER BY time DESC LIMIT $4";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $3";
+ }
}
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetUserEvents = function (ids, domain, userid, func) {
+ obj.GetUserEvents = function (ids, domain, userid, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain, userid];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1 AND userid = $2) ORDER BY time DESC', [domain, userid], func);
+ query = query + "WHERE (domain = $1 AND userid = $2";
+ if (filter != null) {
+ query = query + " AND action = $3";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC";
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target = ANY ($3))) GROUP BY id ORDER BY time DESC', [domain, userid, ids], func);
+ if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target = ANY ($3))";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = $4";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC";
}
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, func) {
+ obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain, userid];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = $1 AND userid = $2) ORDER BY time DESC LIMIT $3', [domain, userid, limit], func);
+ query = query + "WHERE (domain = $1 AND userid = $2";
+ if (filter != null) {
+ query = query + " AND action = $3) ORDER BY time DESC LIMIT $4 ";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $3";
+ }
} else {
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target = ANY ($3))) GROUP BY id ORDER BY time DESC LIMIT $4', [domain, userid, ids, limit], func);
+ if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = $1 AND userid = $2 AND (target = ANY ($3))";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = $4) GROUP BY id ORDER BY time DESC LIMIT $5";
+ dataarray.push(filter);
+ } else {
+ query = query + ") GROUP BY id ORDER BY time DESC LIMIT $4";
+ }
}
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
};
obj.GetEventsTimeRange = function (ids, domain, msgids, start, end, func) {
if (ids.indexOf('*') >= 0) {
@@ -1921,8 +2329,30 @@ module.exports.CreateDB = function (parent, func) {
}
};
//obj.GetUserLoginEvents = function (domain, userid, func) { } // TODO
- obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, func) { sqlDbQuery('SELECT doc FROM events WHERE (nodeid = $1) AND (domain = $2) ORDER BY time DESC LIMIT $3', [nodeid, domain, limit], func); };
- obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, func) { sqlDbQuery('SELECT doc FROM events WHERE (nodeid = $1) AND (domain = $2) AND ((userid = $3) OR (userid IS NULL)) ORDER BY time DESC LIMIT $4', [nodeid, domain, userid, limit], func); };
+ obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, filter, func) {
+ var query = "SELECT doc FROM events WHERE (nodeid = $1 AND domain = $2";
+ var dataarray = [nodeid, domain];
+ if (filter != null) {
+ query = query + " AND action = $3) ORDER BY time DESC LIMIT $4";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $3";
+ }
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
+ };
+ obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, filter, func) {
+ var query = "SELECT doc FROM events WHERE (nodeid = $1 AND domain = $2 AND ((userid = $3) OR (userid IS NULL))";
+ var dataarray = [nodeid, domain, userid];
+ if (filter != null) {
+ query = query + " AND action = $4) ORDER BY time DESC LIMIT $5";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT $4";
+ }
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
+ };
obj.RemoveAllEvents = function (domain) { sqlDbQuery('DELETE FROM events', null, function (err, docs) { }); };
obj.RemoveAllNodeEvents = function (domain, nodeid) { if ((domain == null) || (nodeid == null)) return; sqlDbQuery('DELETE FROM events WHERE domain = $1 AND nodeid = $2', [domain, nodeid], function (err, docs) { }); };
obj.RemoveAllUserEvents = function (domain, userid) { if ((domain == null) || (userid == null)) return; sqlDbQuery('DELETE FROM events WHERE domain = $1 AND userid = $2', [domain, userid], function (err, docs) { }); };
@@ -1965,14 +2395,14 @@ module.exports.CreateDB = function (parent, func) {
// Plugin operations
if (obj.pluginsActive) {
- obj.addPlugin = function (plugin, func) { sqlDbQuery('INSERT INTO plugin VALUES (DEFAULT, $2)', [value], func); }; // Add a plugin
- obj.getPlugins = function (func) { sqlDbQuery('SELECT doc FROM plugin', null, func); }; // Get all plugins
- obj.getPlugin = function (id, func) { sqlDbQuery('SELECT doc FROM plugin WHERE id = $1', [id], func); }; // Get plugin
+ obj.addPlugin = function (plugin, func) { sqlDbQuery('INSERT INTO plugin VALUES (DEFAULT, $1)', [plugin], func); }; // Add a plugin
+ obj.getPlugins = function (func) { sqlDbQuery("SELECT doc::jsonb || ('{\"_id\":' || plugin.id || '}')::jsonb as doc FROM plugin", null, func); }; // Get all plugins
+ obj.getPlugin = function (id, func) { sqlDbQuery("SELECT doc::jsonb || ('{\"_id\":' || plugin.id || '}')::jsonb as doc FROM plugin WHERE id = $1", [id], func); }; // Get plugin
obj.deletePlugin = function (id, func) { sqlDbQuery('DELETE FROM plugin WHERE id = $1', [id], func); }; // Delete plugin
- obj.setPluginStatus = function (id, status, func) { obj.getPlugin(id, function (err, docs) { if ((err == null) && (docs.length == 1)) { docs[0].status = status; obj.updatePlugin(id, docs[0], func); } }); };
- obj.updatePlugin = function (id, args, func) { delete args._id; sqlDbQuery('INSERT INTO plugin VALUES ($1, $2) ON CONFLICT (id) DO UPDATE SET doc = $2', [id, args], func); };
+ obj.setPluginStatus = function (id, status, func) { sqlDbQuery("UPDATE plugin SET doc= jsonb_set(doc::jsonb,'{status}',$1) WHERE id=$2", [status,id], func); };
+ obj.updatePlugin = function (id, args, func) { delete args._id; sqlDbQuery('UPDATE plugin SET doc= doc::jsonb || ($1) WHERE id=$2', [args,id], func); };
}
- } else if ((obj.databaseType == 4) || (obj.databaseType == 5)) {
+ } else if ((obj.databaseType == DB_MARIADB) || (obj.databaseType == DB_MYSQL)) {
// Database actions on the main collection (MariaDB or MySQL)
obj.Set = function (value, func) {
obj.dbCounters.fileSet++;
@@ -2038,7 +2468,7 @@ module.exports.CreateDB = function (parent, func) {
obj.DeleteDomain = function (domain, func) { sqlDbQuery('DELETE FROM main WHERE domain = ?', [domain], func); };
obj.SetUser = function (user) { if (user == null) return; if (user.subscriptions != null) { var u = Clone(user); if (u.subscriptions) { delete u.subscriptions; } obj.Set(u); } else { obj.Set(user); } };
obj.dispose = function () { for (var x in obj) { if (obj[x].close) { obj[x].close(); } delete obj[x]; } };
- obj.getLocalAmtNodes = function (func) { sqlDbQuery('SELECT doc FROM main WHERE (type = "node") AND (extraex IS NOT NULL)', null, function (err, docs) { var r = []; if (err == null) { for (var i in docs) { if (docs[i].host != null) { r.push(docs[i]); } } } func(err, r); }); };
+ obj.getLocalAmtNodes = function (func) { sqlDbQuery('SELECT doc FROM main WHERE (type = "node") AND (extraex IS NULL)', null, function (err, docs) { var r = []; if (err == null) { for (var i in docs) { if (docs[i].host != null && docs[i].intelamt != null) { r.push(docs[i]); } } } func(err, r); }); };
obj.getAmtUuidMeshNode = function (domainid, mtype, uuid, func) { sqlDbQuery('SELECT doc FROM main WHERE domain = ? AND extraex = ?', [domainid, 'uuid/' + uuid], func); };
obj.isMaxType = function (max, type, domainid, func) { if (max == null) { func(false); } else { sqlDbExec('SELECT COUNT(id) FROM main WHERE domain = ? AND type = ?', [domainid, type], function (err, response) { func((response['COUNT(id)'] == null) || (response['COUNT(id)'] > max), response['COUNT(id)']) }); } }
@@ -2050,37 +2480,95 @@ module.exports.CreateDB = function (parent, func) {
for (var i in event.ids) { if (event.ids[i] != '*') { batchQuery.push(['INSERT INTO eventids VALUE (LAST_INSERT_ID(), ?)', [event.ids[i]]]); } }
sqlDbBatchExec(batchQuery, function (err, docs) { if (func != null) { func(err, docs); } });
};
- obj.GetEvents = function (ids, domain, func) {
+ obj.GetEvents = function (ids, domain, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = ?) ORDER BY time DESC', [domain], func);
+ query = query + "WHERE (domain = ?";
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC";
} else {
if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = ? AND target IN (?)) GROUP BY id ORDER BY time DESC', [domain, ids], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = ? AND target IN (?)";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC";
}
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetEventsWithLimit = function (ids, domain, limit, func) {
+ obj.GetEventsWithLimit = function (ids, domain, limit, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = ?) ORDER BY time DESC LIMIT ?', [domain, limit], func);
+ query = query + "WHERE (domain = ?";
+ if (filter != null) {
+ query = query + " AND action = ? ";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC LIMIT ?";
} else {
if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = ? AND target IN (?)) GROUP BY id ORDER BY time DESC LIMIT ?', [domain, ids, limit], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = ? AND target IN (?)";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC LIMIT ?";
}
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetUserEvents = function (ids, domain, userid, func) {
+ obj.GetUserEvents = function (ids, domain, userid, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain, userid];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = ? AND userid = ?) ORDER BY time DESC', [domain, userid], func);
+ query = query + "WHERE (domain = ? AND userid = ?";
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC";
} else {
if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = ? AND userid = ? AND target IN (?)) GROUP BY id ORDER BY time DESC', [domain, userid, ids], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = ? AND userid = ? AND target IN (?)";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC";
}
+ sqlDbQuery(query, dataarray, func);
};
- obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, func) {
+ obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, filter, func) {
+ var query = "SELECT doc FROM events ";
+ var dataarray = [domain, userid];
if (ids.indexOf('*') >= 0) {
- sqlDbQuery('SELECT doc FROM events WHERE (domain = ? AND userid = ?) ORDER BY time DESC LIMIT ?', [domain, userid, limit], func);
+ query = query + "WHERE (domain = ? AND userid = ?";
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") ORDER BY time DESC LIMIT ?";
} else {
if (ids.length == 0) { ids = ''; } // MySQL can't handle a query with IN() on an empty array, we have to use an empty string instead.
- sqlDbQuery('SELECT doc FROM events JOIN eventids ON id = fkid WHERE (domain = ? AND userid = ? AND target IN (?)) GROUP BY id ORDER BY time DESC LIMIT ?', [domain, userid, ids, limit], func);
+ query = query + "JOIN eventids ON id = fkid WHERE (domain = ? AND userid = ? AND target IN (?)";
+ dataarray.push(ids);
+ if (filter != null) {
+ query = query + " AND action = ?";
+ dataarray.push(filter);
+ }
+ query = query + ") GROUP BY id ORDER BY time DESC LIMIT ?";
}
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
};
obj.GetEventsTimeRange = function (ids, domain, msgids, start, end, func) {
if (ids.indexOf('*') >= 0) {
@@ -2091,8 +2579,30 @@ module.exports.CreateDB = function (parent, func) {
}
};
//obj.GetUserLoginEvents = function (domain, userid, func) { } // TODO
- obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, func) { sqlDbQuery('SELECT doc FROM events WHERE (nodeid = ?) AND (domain = ?) ORDER BY time DESC LIMIT ?', [nodeid, domain, limit], func); };
- obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, func) { sqlDbQuery('SELECT doc FROM events WHERE (nodeid = ?) AND (domain = ?) AND ((userid = ?) OR (userid IS NULL)) ORDER BY time DESC LIMIT ?', [nodeid, domain, userid, limit], func); };
+ obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, filter, func) {
+ var query = "SELECT doc FROM events WHERE (nodeid = ? AND domain = ?";
+ var dataarray = [nodeid, domain];
+ if (filter != null) {
+ query = query + " AND action = ?) ORDER BY time DESC LIMIT ?";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT ?";
+ }
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
+ };
+ obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, filter, func) {
+ var query = "SELECT doc FROM events WHERE (nodeid = ? AND domain = ? AND ((userid = ?) OR (userid IS NULL))";
+ var dataarray = [nodeid, domain, userid];
+ if (filter != null) {
+ query = query + " AND action = ?) ORDER BY time DESC LIMIT ?";
+ dataarray.push(filter);
+ } else {
+ query = query + ") ORDER BY time DESC LIMIT ?";
+ }
+ dataarray.push(limit);
+ sqlDbQuery(query, dataarray, func);
+ };
obj.RemoveAllEvents = function (domain) { sqlDbQuery('DELETE FROM events', null, function (err, docs) { }); };
obj.RemoveAllNodeEvents = function (domain, nodeid) { if ((domain == null) || (nodeid == null)) return; sqlDbQuery('DELETE FROM events WHERE domain = ? AND nodeid = ?', [domain, nodeid], function (err, docs) { }); };
obj.RemoveAllUserEvents = function (domain, userid) { if ((domain == null) || (userid == null)) return; sqlDbQuery('DELETE FROM events WHERE domain = ? AND userid = ?', [domain, userid], function (err, docs) { }); };
@@ -2135,14 +2645,14 @@ module.exports.CreateDB = function (parent, func) {
// Plugin operations
if (obj.pluginsActive) {
- obj.addPlugin = function (plugin, func) { sqlDbQuery('INSERT INTO plugin VALUE (?, ?)', [null, JSON.stringify(value)], func); }; // Add a plugin
- obj.getPlugins = function (func) { sqlDbQuery('SELECT doc FROM plugin', null, func); }; // Get all plugins
- obj.getPlugin = function (id, func) { sqlDbQuery('SELECT doc FROM plugin WHERE id = ?', [id], func); }; // Get plugin
+ obj.addPlugin = function (plugin, func) { sqlDbQuery('INSERT INTO plugin VALUE (?, ?)', [null, JSON.stringify(plugin)], func); }; // Add a plugin
+ obj.getPlugins = function (func) { sqlDbQuery('SELECT JSON_INSERT(doc, "$._id", id) as doc FROM plugin', null, func); }; // Get all plugins
+ obj.getPlugin = function (id, func) { sqlDbQuery('SELECT JSON_INSERT(doc, "$._id", id) as doc FROM plugin WHERE id = ?', [id], func); }; // Get plugin
obj.deletePlugin = function (id, func) { sqlDbQuery('DELETE FROM plugin WHERE id = ?', [id], func); }; // Delete plugin
- obj.setPluginStatus = function (id, status, func) { obj.getPlugin(id, function (err, docs) { if ((err == null) && (docs.length == 1)) { docs[0].status = status; obj.updatePlugin(id, docs[0], func); } }); };
- obj.updatePlugin = function (id, args, func) { delete args._id; sqlDbQuery('REPLACE INTO plugin VALUE (?, ?)', [id, JSON.stringify(args)], func); };
+ obj.setPluginStatus = function (id, status, func) { sqlDbQuery('UPDATE meshcentral.plugin SET doc=JSON_SET(doc,"$.status",?) WHERE id=?', [status,id], func); };
+ obj.updatePlugin = function (id, args, func) { delete args._id; sqlDbQuery('UPDATE meshcentral.plugin SET doc=JSON_MERGE_PATCH(doc,?) WHERE id=?', [JSON.stringify(args),id], func); };
}
- } else if (obj.databaseType == 3) {
+ } else if (obj.databaseType == DB_MONGODB) {
// Database actions on the main collection (MongoDB)
// Bulk operations
@@ -2327,14 +2837,38 @@ module.exports.CreateDB = function (parent, func) {
obj.StoreEvent = function (event, func) { obj.dbCounters.eventsSet++; obj.eventsfile.insertOne(event, func); };
}
- obj.GetEvents = function (ids, domain, func) { obj.eventsfile.find({ domain: domain, ids: { $in: ids } }).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).toArray(func); };
- obj.GetEventsWithLimit = function (ids, domain, limit, func) { obj.eventsfile.find({ domain: domain, ids: { $in: ids } }).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).toArray(func); };
- obj.GetUserEvents = function (ids, domain, userid, func) { obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] }).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).toArray(func); };
- obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, func) { obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] }).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).toArray(func); };
+ obj.GetEvents = function (ids, domain, filter, func) {
+ var finddata = { domain: domain, ids: { $in: ids } };
+ if (filter != null) finddata.action = filter;
+ obj.eventsfile.find(finddata).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).toArray(func);
+ };
+ obj.GetEventsWithLimit = function (ids, domain, limit, filter, func) {
+ var finddata = { domain: domain, ids: { $in: ids } };
+ if (filter != null) finddata.action = filter;
+ obj.eventsfile.find(finddata).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).toArray(func);
+ };
+ obj.GetUserEvents = function (ids, domain, userid, filter, func) {
+ var finddata = { domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] };
+ if (filter != null) finddata.action = filter;
+ obj.eventsfile.find(finddata).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).toArray(func);
+ };
+ obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, filter, func) {
+ var finddata = { domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] };
+ if (filter != null) finddata.action = filter;
+ obj.eventsfile.find(finddata).project({ type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).toArray(func);
+ };
obj.GetEventsTimeRange = function (ids, domain, msgids, start, end, func) { obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }], msgid: { $in: msgids }, time: { $gte: start, $lte: end } }).project({ type: 0, _id: 0, domain: 0, node: 0 }).sort({ time: 1 }).toArray(func); };
obj.GetUserLoginEvents = function (domain, userid, func) { obj.eventsfile.find({ domain: domain, action: { $in: ['authfail', 'login'] }, userid: userid, msgArgs: { $exists: true } }).project({ action: 1, time: 1, msgid: 1, msgArgs: 1, tokenName: 1 }).sort({ time: -1 }).toArray(func); };
- obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, func) { obj.eventsfile.find({ domain: domain, nodeid: nodeid }).project({ type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).toArray(func); };
- obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, func) { obj.eventsfile.find({ domain: domain, nodeid: nodeid, userid: { $in: [userid, null] } }).project({ type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).toArray(func); };
+ obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, filter, func) {
+ var finddata = { domain: domain, nodeid: nodeid };
+ if (filter != null) finddata.action = filter;
+ obj.eventsfile.find(finddata).project({ type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).toArray(func);
+ };
+ obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, filter, func) {
+ var finddata = { domain: domain, nodeid: nodeid, userid: { $in: [userid, null] } };
+ if (filter != null) finddata.action = filter;
+ obj.eventsfile.find(finddata).project({ type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).toArray(func);
+ };
obj.RemoveAllEvents = function (domain) { obj.eventsfile.deleteMany({ domain: domain }, { multi: true }); };
obj.RemoveAllNodeEvents = function (domain, nodeid) { if ((domain == null) || (nodeid == null)) return; obj.eventsfile.deleteMany({ domain: domain, nodeid: nodeid }, { multi: true }); };
obj.RemoveAllUserEvents = function (domain, userid) { if ((domain == null) || (userid == null)) return; obj.eventsfile.deleteMany({ domain: domain, userid: userid }, { multi: true }); };
@@ -2499,38 +3033,74 @@ module.exports.CreateDB = function (parent, func) {
// Database actions on the events collection
obj.GetAllEvents = function (func) { obj.eventsfile.find({}, func); };
obj.StoreEvent = function (event, func) { obj.eventsfile.insert(event, func); };
- obj.GetEvents = function (ids, domain, func) { if (obj.databaseType == 1) { obj.eventsfile.find({ domain: domain, ids: { $in: ids } }, { _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).exec(func); } else { obj.eventsfile.find({ domain: domain, ids: { $in: ids } }, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }, func); } };
- obj.GetEventsWithLimit = function (ids, domain, limit, func) { if (obj.databaseType == 1) { obj.eventsfile.find({ domain: domain, ids: { $in: ids } }, { _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).exec(func); } else { obj.eventsfile.find({ domain: domain, ids: { $in: ids } }, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit, func); } };
- obj.GetUserEvents = function (ids, domain, userid, func) {
- if (obj.databaseType == 1) {
- obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] }, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).exec(func);
+ obj.GetEvents = function (ids, domain, filter, func) {
+ var finddata = { domain: domain, ids: { $in: ids } };
+ if (filter != null) finddata.action = filter;
+ if (obj.databaseType == DB_NEDB) {
+ obj.eventsfile.find(finddata, { _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).exec(func);
} else {
- obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] }, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }, func);
+ obj.eventsfile.find(finddata, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }, func);
}
};
- obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, func) {
- if (obj.databaseType == 1) {
- obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] }, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).exec(func);
+ obj.GetEventsWithLimit = function (ids, domain, limit, filter, func) {
+ var finddata = { domain: domain, ids: { $in: ids } };
+ if (filter != null) finddata.action = filter;
+ if (obj.databaseType == DB_NEDB) {
+ obj.eventsfile.find(finddata, { _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).exec(func);
} else {
- obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] }, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit, func);
+ obj.eventsfile.find(finddata, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit, func);
+ }
+ };
+ obj.GetUserEvents = function (ids, domain, userid, filter, func) {
+ var finddata = { domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] };
+ if (filter != null) finddata.action = filter;
+ if (obj.databaseType == DB_NEDB) {
+ obj.eventsfile.find(finddata, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).exec(func);
+ } else {
+ obj.eventsfile.find(finddata, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }, func);
+ }
+ };
+ obj.GetUserEventsWithLimit = function (ids, domain, userid, limit, filter, func) {
+ var finddata = { domain: domain, $or: [{ ids: { $in: ids } }, { userid: userid }] };
+ if (filter != null) finddata.action = filter;
+ if (obj.databaseType == DB_NEDB) {
+ obj.eventsfile.find(finddata, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit).exec(func);
+ } else {
+ obj.eventsfile.find(finddata, { type: 0, _id: 0, domain: 0, ids: 0, node: 0 }).sort({ time: -1 }).limit(limit, func);
}
};
obj.GetEventsTimeRange = function (ids, domain, msgids, start, end, func) {
- if (obj.databaseType == 1) {
+ if (obj.databaseType == DB_NEDB) {
obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }], msgid: { $in: msgids }, time: { $gte: start, $lte: end } }, { type: 0, _id: 0, domain: 0, node: 0 }).sort({ time: 1 }).exec(func);
} else {
obj.eventsfile.find({ domain: domain, $or: [{ ids: { $in: ids } }], msgid: { $in: msgids }, time: { $gte: start, $lte: end } }, { type: 0, _id: 0, domain: 0, node: 0 }).sort({ time: 1 }, func);
}
};
obj.GetUserLoginEvents = function (domain, userid, func) {
- if (obj.databaseType == 1) {
+ if (obj.databaseType == DB_NEDB) {
obj.eventsfile.find({ domain: domain, action: { $in: ['authfail', 'login'] }, userid: userid, msgArgs: { $exists: true } }, { action: 1, time: 1, msgid: 1, msgArgs: 1, tokenName: 1 }).sort({ time: -1 }).exec(func);
} else {
obj.eventsfile.find({ domain: domain, action: { $in: ['authfail', 'login'] }, userid: userid, msgArgs: { $exists: true } }, { action: 1, time: 1, msgid: 1, msgArgs: 1, tokenName: 1 }).sort({ time: -1 }, func);
}
};
- obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, func) { if (obj.databaseType == 1) { obj.eventsfile.find({ domain: domain, nodeid: nodeid }, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).exec(func); } else { obj.eventsfile.find({ domain: domain, nodeid: nodeid }, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit, func); } };
- obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, func) { if (obj.databaseType == 1) { obj.eventsfile.find({ domain: domain, nodeid: nodeid, userid: { $in: [userid, null] } }, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).exec(func); } else { obj.eventsfile.find({ domain: domain, nodeid: nodeid }, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit, func); } };
+ obj.GetNodeEventsWithLimit = function (nodeid, domain, limit, filter, func) {
+ var finddata = { domain: domain, nodeid: nodeid };
+ if (filter != null) finddata.action = filter;
+ if (obj.databaseType == DB_NEDB) {
+ obj.eventsfile.find(finddata, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).exec(func);
+ } else {
+ obj.eventsfile.find(finddata, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit, func);
+ }
+ };
+ obj.GetNodeEventsSelfWithLimit = function (nodeid, domain, userid, limit, filter, func) {
+ var finddata = { domain: domain, nodeid: nodeid, userid: { $in: [userid, null] } };
+ if (filter != null) finddata.action = filter;
+ if (obj.databaseType == DB_NEDB) {
+ obj.eventsfile.find(finddata, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit).exec(func);
+ } else {
+ obj.eventsfile.find(finddata, { type: 0, etype: 0, _id: 0, domain: 0, ids: 0, node: 0, nodeid: 0 }).sort({ time: -1 }).limit(limit, func);
+ }
+ };
obj.RemoveAllEvents = function (domain) { obj.eventsfile.remove({ domain: domain }, { multi: true }); };
obj.RemoveAllNodeEvents = function (domain, nodeid) { if ((domain == null) || (nodeid == null)) return; obj.eventsfile.remove({ domain: domain, nodeid: nodeid }, { multi: true }); };
obj.RemoveAllUserEvents = function (domain, userid) { if ((domain == null) || (userid == null)) return; obj.eventsfile.remove({ domain: domain, userid: userid }, { multi: true }); };
@@ -2539,7 +3109,7 @@ module.exports.CreateDB = function (parent, func) {
// Database actions on the power collection
obj.getAllPower = function (func) { obj.powerfile.find({}, func); };
obj.storePowerEvent = function (event, multiServer, func) { if (multiServer != null) { event.server = multiServer.serverid; } obj.powerfile.insert(event, func); };
- obj.getPowerTimeline = function (nodeid, func) { if (obj.databaseType == 1) { obj.powerfile.find({ nodeid: { $in: ['*', nodeid] } }, { _id: 0, nodeid: 0, s: 0 }).sort({ time: 1 }).exec(func); } else { obj.powerfile.find({ nodeid: { $in: ['*', nodeid] } }, { _id: 0, nodeid: 0, s: 0 }).sort({ time: 1 }, func); } };
+ obj.getPowerTimeline = function (nodeid, func) { if (obj.databaseType == DB_NEDB) { obj.powerfile.find({ nodeid: { $in: ['*', nodeid] } }, { _id: 0, nodeid: 0, s: 0 }).sort({ time: 1 }).exec(func); } else { obj.powerfile.find({ nodeid: { $in: ['*', nodeid] } }, { _id: 0, nodeid: 0, s: 0 }).sort({ time: 1 }, func); } };
obj.removeAllPowerEvents = function () { obj.powerfile.remove({}, { multi: true }); };
obj.removeAllPowerEventsForNode = function (nodeid) { if (nodeid == null) return; obj.powerfile.remove({ nodeid: nodeid }, { multi: true }); };
@@ -2617,58 +3187,94 @@ module.exports.CreateDB = function (parent, func) {
// Return a human readable string with current backup configuration
obj.getBackupConfig = function () {
var r = '', backupPath = parent.backuppath;
- if (parent.config.settings.autobackup && parent.config.settings.autobackup.backuppath) { backupPath = parent.config.settings.autobackup.backuppath; }
- var dbname = 'meshcentral';
+ let dbname = 'meshcentral';
if (parent.args.mongodbname) { dbname = parent.args.mongodbname; }
else if ((typeof parent.args.mariadb == 'object') && (typeof parent.args.mariadb.database == 'string')) { dbname = parent.args.mariadb.database; }
else if ((typeof parent.args.mysql == 'object') && (typeof parent.args.mysql.database == 'string')) { dbname = parent.args.mysql.database; }
+ else if (typeof parent.config.settings.sqlite3 == 'string') {dbname = parent.config.settings.sqlite3 + '.sqlite'};
const currentDate = new Date();
const fileSuffix = currentDate.getFullYear() + '-' + padNumber(currentDate.getMonth() + 1, 2) + '-' + padNumber(currentDate.getDate(), 2) + '-' + padNumber(currentDate.getHours(), 2) + '-' + padNumber(currentDate.getMinutes(), 2);
- const newAutoBackupFile = 'meshcentral-autobackup-' + fileSuffix;
- const newAutoBackupPath = parent.path.join(backupPath, newAutoBackupFile);
+ obj.newAutoBackupFile = parent.config.settings.autobackup.backupname + fileSuffix;
r += 'DB Name: ' + dbname + '\r\n';
- r += 'DB Type: ' + ['None', 'NeDB', 'MongoJS', 'MongoDB', 'MariaDB', 'MySQL', 'AceBase'][obj.databaseType] + '\r\n';
+ r += 'DB Type: ' + DB_LIST[obj.databaseType] + '\r\n';
r += 'BackupPath: ' + backupPath + '\r\n';
- r += 'newAutoBackupFile: ' + newAutoBackupFile + '\r\n';
- r += 'newAutoBackupPath: ' + newAutoBackupPath + '\r\n';
+ r += 'BackupFile: ' + obj.newAutoBackupFile + '.zip\r\n';
if (parent.config.settings.autobackup == null) {
r += 'No Settings/AutoBackup\r\n';
} else {
+ if (parent.config.settings.autobackup.backuphour != null && parent.config.settings.autobackup.backuphour != -1) {
+ r += 'Backup between: ' + parent.config.settings.autobackup.backuphour + 'H-' + (parent.config.settings.autobackup.backuphour + 1) + 'H\r\n';
+ }
if (parent.config.settings.autobackup.backupintervalhours != null) {
- if (typeof parent.config.settings.autobackup.backupintervalhours != 'number') { r += 'Bad backupintervalhours type\r\n'; }
- else { r += 'Backup Interval (Hours): ' + parent.config.settings.autobackup.backupintervalhours + '\r\n'; }
+ r += 'Backup Interval (Hours): ' + parent.config.settings.autobackup.backupintervalhours + '\r\n';
}
if (parent.config.settings.autobackup.keeplastdaysbackup != null) {
- if (typeof parent.config.settings.autobackup.keeplastdaysbackup != 'number') { r += 'Bad keeplastdaysbackup type\r\n'; }
- else { r += 'Keep Last Backups (Days): ' + parent.config.settings.autobackup.keeplastdaysbackup + '\r\n'; }
+ r += 'Keep Last Backups (Days): ' + parent.config.settings.autobackup.keeplastdaysbackup + '\r\n';
}
if (parent.config.settings.autobackup.zippassword != null) {
- if (typeof parent.config.settings.autobackup.zippassword != 'string') { r += 'Bad zippassword type\r\n'; }
- else { r += 'ZIP Password Set\r\n'; }
+ r += 'ZIP Password: ';
+ if (typeof parent.config.settings.autobackup.zippassword != 'string') { r += 'Bad zippassword type, Backups will not be encrypted\r\n'; }
+ else if (parent.config.settings.autobackup.zippassword == "") { r += 'Blank zippassword, Backups will fail\r\n'; }
+ else { r += 'Set\r\n'; }
}
if (parent.config.settings.autobackup.mongodumppath != null) {
+ r += 'MongoDump Path: ';
if (typeof parent.config.settings.autobackup.mongodumppath != 'string') { r += 'Bad mongodumppath type\r\n'; }
- else { r += 'MongoDump Path: ' + parent.config.settings.autobackup.mongodumppath + '\r\n'; }
+ else { r += parent.config.settings.autobackup.mongodumppath + '\r\n'; }
}
if (parent.config.settings.autobackup.mysqldumppath != null) {
+ r += 'MySqlDump Path: ';
if (typeof parent.config.settings.autobackup.mysqldumppath != 'string') { r += 'Bad mysqldump type\r\n'; }
- else { r += 'MySqlDump Path: ' + parent.config.settings.autobackup.mysqldumppath + '\r\n'; }
+ else { r += parent.config.settings.autobackup.mysqldumppath + '\r\n'; }
}
+ if (parent.config.settings.autobackup.backupotherfolders) {
+ r += 'Backup other folders: ';
+ r += parent.filespath + ', ' + parent.recordpath + '\r\n';
+ }
+ if (parent.config.settings.autobackup.backupwebfolders) {
+ r += 'Backup webfolders: ';
+ if (parent.webViewsOverridePath) {r += parent.webViewsOverridePath };
+ if (parent.webPublicOverridePath) {r += ', '+ parent.webPublicOverridePath};
+ if (parent.webEmailsOverridePath) {r += ',' + parent.webEmailsOverridePath};
+ r+= '\r\n';
+ }
+ if (parent.config.settings.autobackup.backupignorefilesglob != []) {
+ r += 'Backup IgnoreFilesGlob: ';
+ { r += parent.config.settings.autobackup.backupignorefilesglob + '\r\n'; }
+ }
+ if (parent.config.settings.autobackup.backupskipfoldersglob != []) {
+ r += 'Backup SkipFoldersGlob: ';
+ { r += parent.config.settings.autobackup.backupskipfoldersglob + '\r\n'; }
+ }
+
+ if (typeof parent.config.settings.autobackup.s3 == 'object') {
+ r += 'S3 Backups: Enabled\r\n';
+ }
+ if (typeof parent.config.settings.autobackup.webdav == 'object') {
+ r += 'WebDAV Backups: Enabled\r\n';
+ r += 'WebDAV backup path: ' + ((typeof parent.config.settings.autobackup.webdav.foldername == 'string') ? parent.config.settings.autobackup.webdav.foldername : 'MeshCentral-Backups') + '\r\n';
+ r += 'WebDAV maximum files: '+ ((typeof parent.config.settings.autobackup.webdav.maxfiles == 'number') ? parent.config.settings.autobackup.webdav.maxfiles : 'no limit') + '\r\n';
+ }
+ if (typeof parent.config.settings.autobackup.googledrive == 'object') {
+ r += 'Google Drive Backups: Enabled\r\n';
+ }
+
+
}
return r;
}
function buildSqlDumpCommand() {
- var props = (obj.databaseType == 4) ? parent.args.mariadb : parent.args.mysql;
+ var props = (obj.databaseType == DB_MARIADB) ? parent.args.mariadb : parent.args.mysql;
var mysqldumpPath = 'mysqldump';
if (parent.config.settings.autobackup && parent.config.settings.autobackup.mysqldumppath) {
- mysqldumpPath = parent.config.settings.autobackup.mysqldumppath;
+ mysqldumpPath = path.normalize(parent.config.settings.autobackup.mysqldumppath);
}
var cmd = '\"' + mysqldumpPath + '\" --user=\'' + props.user + '\'';
@@ -2681,11 +3287,11 @@ module.exports.CreateDB = function (parent, func) {
// SSL options different on mariadb/mysql
var sslOptions = '';
- if (obj.databaseType == 4) {
+ if (obj.databaseType == DB_MARIADB) {
if (props.ssl) {
sslOptions = ' --ssl';
if (props.ssl.cacertpath) sslOptions = ' --ssl-ca=' + props.ssl.cacertpath;
- if (props.ssl.dontcheckserveridentity != true) sslOptions += ' --ssl-verify-server-cert';
+ if (props.ssl.dontcheckserveridentity != true) {sslOptions += ' --ssl-verify-server-cert'} else {sslOptions += ' --ssl-verify-server-cert=false'};
if (props.ssl.clientcertpath) sslOptions += ' --ssl-cert=' + props.ssl.clientcertpath;
if (props.ssl.clientkeypath) sslOptions += ' --ssl-key=' + props.ssl.clientkeypath;
}
@@ -2712,7 +3318,7 @@ module.exports.CreateDB = function (parent, func) {
var mongoDumpPath = 'mongodump';
if (parent.config.settings.autobackup && parent.config.settings.autobackup.mongodumppath) {
- mongoDumpPath = parent.config.settings.autobackup.mongodumppath;
+ mongoDumpPath = path.normalize(parent.config.settings.autobackup.mongodumppath);
}
var cmd = '"' + mongoDumpPath + '"';
@@ -2722,57 +3328,88 @@ module.exports.CreateDB = function (parent, func) {
}
// Check that the server is capable of performing a backup
+ // Tries configured custom location with fallback to default location
+ // Now runs after autobackup config init in meshcentral.js so config options are checked
obj.checkBackupCapability = function (func) {
- if ((parent.config.settings.autobackup == null) || (parent.config.settings.autobackup == false)) { func(); }
- if ((obj.databaseType == 2) || (obj.databaseType == 3)) {
- // Check that we have access to MongoDump
- var backupPath = parent.backuppath;
- if (parent.config.settings.autobackup && parent.config.settings.autobackup.backuppath) { backupPath = parent.config.settings.autobackup.backuppath; }
- try { parent.fs.mkdirSync(backupPath); } catch (ex) { }
- if (parent.fs.existsSync(backupPath) == false) { func(1, "Backup folder \"" + backupPath + "\" does not exist, database auto-backup will not be performed."); return; }
+ if ((parent.config.settings.autobackup == null) || (parent.config.settings.autobackup == false)) { return; };
+ //block backup until validated. Gets put back if all checks are ok.
+ let backupInterval = parent.config.settings.autobackup.backupintervalhours;
+ parent.config.settings.autobackup.backupintervalhours = -1;
+ let backupPath = parent.backuppath;
+ if (backupPath.startsWith(parent.datapath)) {
+ func(1, "Backup path can't be set within meshcentral-data folder. No backups will be made.");
+ return;
+ }
+ // Check create/write backupdir
+ try { fs.mkdirSync(backupPath); }
+ catch (e) {
+ // EEXIST error = dir already exists
+ if (e.code != 'EEXIST' ) {
+ //Unable to create backuppath
+ console.error(e.message);
+ func(1, 'Unable to create ' + backupPath + '. No backups will be made. Error: ' + e.message);
+ return;
+ }
+ }
+ const testFile = path.join(backupPath, (parent.config.settings.autobackup.backupname + ".test"));
+
+ try { fs.writeFileSync( testFile, "DeleteMe"); }
+ catch (e) {
+ //Unable to create file
+ console.error (e.message);
+ func(1, "Backuppath (" + backupPath + ") can't be written to. No backups will be made. Error: " + e.message);
+ return;
+ }
+ try { fs.unlinkSync(testFile); parent.debug('backup', 'Backuppath ' + backupPath + ' accesscheck successful');}
+ catch (e) {
+ console.error (e.message);
+ func(1, "Backuppathtestfile (" + testFile + ") can't be deleted, check filerights. Error: " + e.message);
+ // Assume write rights, no delete rights. Continue with warning.
+ //return;
+ }
+
+ // Check database dumptools
+ if ((obj.databaseType == DB_MONGOJS) || (obj.databaseType == DB_MONGODB)) {
+ // Check that we have access to MongoDump
var cmd = buildMongoDumpCommand();
cmd += (parent.platform == 'win32') ? ' --archive=\"nul\"' : ' --archive=\"/dev/null\"';
const child_process = require('child_process');
child_process.exec(cmd, { cwd: backupPath }, function (error, stdout, stderr) {
- try {
- if ((error != null) && (error != '')) {
- if (parent.platform == 'win32') {
- func(1, "Unable to find mongodump.exe, MongoDB database auto-backup will not be performed.");
- } else {
- func(1, "Unable to find mongodump, MongoDB database auto-backup will not be performed.");
- }
- } else {
- func();
- }
- } catch (ex) { console.log(ex); }
+ if ((error != null) && (error != '')) {
+ func(1, "Unable to find mongodump tool, backup will not be performed. Command tried: " + cmd);
+ return;
+ } else {parent.config.settings.autobackup.backupintervalhours = backupInterval;}
});
- } else if ((obj.databaseType == 4) || (obj.databaseType == 5)) {
+ } else if ((obj.databaseType == DB_MARIADB) || (obj.databaseType == DB_MYSQL)) {
// Check that we have access to mysqldump
- var backupPath = parent.backuppath;
- if (parent.config.settings.autobackup && parent.config.settings.autobackup.backuppath) { backupPath = parent.config.settings.autobackup.backuppath; }
- try { parent.fs.mkdirSync(backupPath); } catch (e) { }
- if (parent.fs.existsSync(backupPath) == false) { func(1, "Backup folder \"" + backupPath + "\" does not exist, database auto-backup will not be performed."); return; }
-
var cmd = buildSqlDumpCommand();
cmd += ' > ' + ((parent.platform == 'win32') ? '\"nul\"' : '\"/dev/null\"');
const child_process = require('child_process');
- child_process.exec(cmd, { cwd: backupPath }, function(error, stdout, stdin) {
- try {
- if ((error != null) && (error != '')) {
- if (parent.platform == 'win32') {
- func(1, "Unable to find mysqldump.exe, MySQL/MariaDB database auto-backup will not be performed.");
- } else {
- func(1, "Unable to find mysqldump, MySQL/MariaDB database auto-backup will not be performed.");
- }
- } else {
- func();
- }
- } catch (ex) { console.log(ex); }
+ child_process.exec(cmd, { cwd: backupPath, timeout: 1000*30 }, function(error, stdout, stdin) {
+ if ((error != null) && (error != '')) {
+ func(1, "Unable to find mysqldump tool, backup will not be performed. Command tried: " + cmd);
+ return;
+ } else {parent.config.settings.autobackup.backupintervalhours = backupInterval;}
+
});
+ } else if (obj.databaseType == DB_POSTGRESQL) {
+ // Check that we have access to pg_dump
+ parent.config.settings.autobackup.pgdumppath = path.normalize(parent.config.settings.autobackup.pgdumppath ? parent.config.settings.autobackup.pgdumppath : 'pg_dump');
+ let cmd = '"' + parent.config.settings.autobackup.pgdumppath + '"'
+ + ' --dbname=postgresql://' + parent.config.settings.postgres.user + ":" +parent.config.settings.postgres.password
+ + "@" + parent.config.settings.postgres.host + ":" + parent.config.settings.postgres.port + "/" + databaseName
+ + ' > ' + ((parent.platform == 'win32') ? '\"nul\"' : '\"/dev/null\"');
+ const child_process = require('child_process');
+ child_process.exec(cmd, { cwd: backupPath }, function(error, stdout, stdin) {
+ if ((error != null) && (error != '')) {
+ func(1, "Unable to find pg_dump tool, backup will not be performed. Command tried: " + cmd);
+ return;
+ } else {parent.config.settings.autobackup.backupintervalhours = backupInterval;}
+ });
} else {
- func();
- }
+ //all ok, enable backup
+ parent.config.settings.autobackup.backupintervalhours = backupInterval;}
}
// MongoDB pending bulk read operation, perform fast bulk document reads.
@@ -2885,157 +3522,268 @@ module.exports.CreateDB = function (parent, func) {
}
// Perform a server backup
- obj.performingBackup = false;
obj.performBackup = function (func) {
+ parent.debug('backup','Entering performBackup');
try {
- if (obj.performingBackup) return 1;
+ if (obj.performingBackup) return 'Backup alreay in progress.';
+ if (parent.config.settings.autobackup.backupintervalhours == -1) { if (func) { func('Backup disabled.'); return 'Backup disabled.' }};
obj.performingBackup = true;
- //console.log('Performing backup...');
+ let backupPath = parent.backuppath;
+ let dataPath = parent.datapath;
- var backupPath = parent.backuppath;
- if (parent.config.settings.autobackup && parent.config.settings.autobackup.backuppath) { backupPath = parent.config.settings.autobackup.backuppath; }
- try { parent.fs.mkdirSync(backupPath); } catch (e) { }
- const dbname = (parent.args.mongodbname) ? (parent.args.mongodbname) : 'meshcentral';
- const dburl = parent.args.mongodb;
const currentDate = new Date();
const fileSuffix = currentDate.getFullYear() + '-' + padNumber(currentDate.getMonth() + 1, 2) + '-' + padNumber(currentDate.getDate(), 2) + '-' + padNumber(currentDate.getHours(), 2) + '-' + padNumber(currentDate.getMinutes(), 2);
- const newAutoBackupFile = 'meshcentral-autobackup-' + fileSuffix;
- const newAutoBackupPath = parent.path.join(backupPath, newAutoBackupFile);
+ obj.newAutoBackupFile = path.join(backupPath, parent.config.settings.autobackup.backupname + fileSuffix + '.zip');
+ parent.debug('backup','newAutoBackupFile=' + obj.newAutoBackupFile);
- if ((obj.databaseType == 2) || (obj.databaseType == 3)) {
- // Perform a MongoDump backup
- const newBackupFile = 'mongodump-' + fileSuffix;
- var newBackupPath = parent.path.join(backupPath, newBackupFile);
+ if ((obj.databaseType == DB_MONGOJS) || (obj.databaseType == DB_MONGODB)) {
+ // Perform a MongoDump
+ const dbname = (parent.args.mongodbname) ? (parent.args.mongodbname) : 'meshcentral';
+ const dburl = parent.args.mongodb;
+
+ obj.newDBDumpFile = path.join(backupPath, (dbname + '-mongodump-' + fileSuffix + '.archive'));
var cmd = buildMongoDumpCommand();
- cmd += (dburl) ? ' --archive=\"' + newBackupPath + '.archive\"' :
- ' --db=\"' + dbname + '\" --archive=\"' + newBackupPath + '.archive\"';
-
+ cmd += (dburl) ? ' --archive=\"' + obj.newDBDumpFile + '\"' :
+ ' --db=\"' + dbname + '\" --archive=\"' + obj.newDBDumpFile + '\"';
+ parent.debug('backup','Mongodump cmd: ' + cmd);
const child_process = require('child_process');
- var backupProcess = child_process.exec(cmd, { cwd: backupPath }, function (error, stdout, stderr) {
- try {
- var mongoDumpSuccess = true;
- backupProcess = null;
- if ((error != null) && (error != '')) { mongoDumpSuccess = false; console.log('ERROR: Unable to perform MongoDB backup: ' + error + '\r\n'); }
+ const dumpProcess = child_process.exec(
+ cmd,
+ { cwd: parent.parentpath },
+ (error)=> {if (error) {obj.backupStatus |= BACKUPFAIL_DBDUMP; console.error('ERROR: Unable to perform MongoDB backup: ' + error + '\r\n'); obj.createBackupfile(func);}}
+ );
+
+ dumpProcess.on('exit', (code) => {
+ if (code != 0) {console.log(`Mongodump child process exited with code ${code}`); obj.backupStatus |= BACKUPFAIL_DBDUMP;}
+ obj.createBackupfile(func);
+ });
- // Perform archive compression
- var archiver = require('archiver');
- var output = parent.fs.createWriteStream(newAutoBackupPath + '.zip');
- var archive = null;
- if (parent.config.settings.autobackup && (typeof parent.config.settings.autobackup.zippassword == 'string')) {
- try { archiver.registerFormat('zip-encrypted', require('archiver-zip-encrypted')); } catch (ex) { }
- archive = archiver.create('zip-encrypted', { zlib: { level: 9 }, encryptionMethod: 'aes256', password: parent.config.settings.autobackup.zippassword });
- } else {
- archive = archiver('zip', { zlib: { level: 9 } });
- }
- output.on('close', function () {
- obj.performingBackup = false;
- if (func) { if (mongoDumpSuccess) { func('Auto-backup completed.'); } else { func('Auto-backup completed without mongodb database: ' + error); } }
- obj.performCloudBackup(newAutoBackupPath + '.zip', func);
- setTimeout(function () { try { parent.fs.unlink(newBackupPath + '.archive', function () { }); } catch (ex) { console.log(ex); } }, 5000);
- });
- output.on('end', function () { });
- output.on('error', function (err) { console.log('Backup error: ' + err); if (func) { func('Backup error: ' + err); } });
- archive.on('warning', function (err) { console.log('Backup warning: ' + err); if (func) { func('Backup warning: ' + err); } });
- archive.on('error', function (err) { console.log('Backup error: ' + err); if (func) { func('Backup error: ' + err); } });
- archive.pipe(output);
- if (mongoDumpSuccess == true) { archive.file(newBackupPath + '.archive', { name: newBackupFile + '.archive' }); }
- archive.directory(parent.datapath, 'meshcentral-data');
- archive.finalize();
- } catch (ex) { console.log(ex); }
- });
- } else if ((obj.databaseType == 4) || (obj.databaseType == 5)) {
+ } else if ((obj.databaseType == DB_MARIADB) || (obj.databaseType == DB_MYSQL)) {
// Perform a MySqlDump backup
const newBackupFile = 'mysqldump-' + fileSuffix;
- var newBackupPath = parent.path.join(backupPath, newBackupFile);
+ obj.newDBDumpFile = path.join(backupPath, newBackupFile + '.sql');
var cmd = buildSqlDumpCommand();
- cmd += ' --result-file=\"' + newBackupPath + '.sql\"';
- const child_process = require('child_process');
- var backupProcess = child_process.exec(cmd, { cwd: backupPath }, function (error, stdout, stderr) {
- try {
- var sqlDumpSuccess = true;
- backupProcess = null;
- if ((error != null) && (error != '')) { sqlDumpSuccess = false; console.log('ERROR: Unable to perform MySQL/MariaDB backup: ' + error + '\r\n'); }
+ cmd += ' --result-file=\"' + obj.newDBDumpFile + '\"';
+ parent.debug('backup','Maria/MySQLdump cmd: ' + cmd);
- var archiver = require('archiver');
- var output = parent.fs.createWriteStream(newAutoBackupPath + '.zip');
- var archive = null;
- if (parent.config.settings.autobackup && (typeof parent.config.settings.autobackup.zippassword == 'string')) {
- try { archiver.registerFormat('zip-encrypted', require('archiver-zip-encrypted')); } catch (ex) { }
- archive = archiver.create('zip-encrypted', { zlib: { level: 9 }, encryptionMethod: 'aes256', password: parent.config.settings.autobackup.zippassword });
- } else {
- archive = archiver('zip', { zlib: { level: 9 } });
- }
- output.on('close', function () {
- obj.performingBackup = false;
- if (func) { if (sqlDumpSuccess) { func('Auto-backup completed.'); } else { func('Auto-backup completed without MySQL/MariaDB database: ' + error); } }
- obj.performCloudBackup(newAutoBackupPath + '.zip', func);
- setTimeout(function () { try { parent.fs.unlink(newBackupPath + '.sql', function () { }); } catch (ex) { console.log(ex); } }, 5000);
- });
- output.on('end', function () { });
- output.on('error', function (err) { console.log('Backup error: ' + err); if (func) { func('Backup error: ' + err); } });
- archive.on('warning', function (err) { console.log('Backup warning: ' + err); if (func) { func('Backup warning: ' + err); } });
- archive.on('error', function (err) { console.log('Backup error: ' + err); if (func) { func('Backup error: ' + err); } });
- archive.pipe(output);
- if (sqlDumpSuccess == true) { archive.file(newBackupPath + '.sql', { name: newBackupFile + '.sql' }); }
- archive.directory(parent.datapath, 'meshcentral-data');
- archive.finalize();
- } catch (ex) { console.log(ex); }
+ const child_process = require('child_process');
+ const dumpProcess = child_process.exec(
+ cmd,
+ { cwd: parent.parentpath },
+ (error)=> {if (error) {obj.backupStatus |= BACKUPFAIL_DBDUMP; console.error('ERROR: Unable to perform MySQL backup: ' + error + '\r\n'); obj.createBackupfile(func);}}
+ );
+ dumpProcess.on('exit', (code) => {
+ if (code != 0) {console.error(`MySQLdump child process exited with code ${code}`); obj.backupStatus |= BACKUPFAIL_DBDUMP;}
+ obj.createBackupfile(func);
+ });
+
+ } else if (obj.databaseType == DB_SQLITE) {
+ //.db3 suffix to escape escape backupfile glob to exclude the sqlite db files
+ obj.newDBDumpFile = path.join(backupPath, databaseName + '-sqlitedump-' + fileSuffix + '.db3');
+ // do a VACUUM INTO in favor of the backup API to compress the export, see https://www.sqlite.org/backup.html
+ parent.debug('backup','SQLitedump: VACUUM INTO ' + obj.newDBDumpFile);
+ obj.file.exec('VACUUM INTO \'' + obj.newDBDumpFile + '\'', function (err) {
+ if (err) { console.error('SQLite backup error: ' + err); obj.backupStatus |=BACKUPFAIL_DBDUMP;};
+ //always finish/clean up
+ obj.createBackupfile(func);
+ });
+ } else if (obj.databaseType == DB_POSTGRESQL) {
+ // Perform a PostgresDump backup
+ const newBackupFile = databaseName + '-pgdump-' + fileSuffix + '.sql';
+ obj.newDBDumpFile = path.join(backupPath, newBackupFile);
+ let cmd = '"' + parent.config.settings.autobackup.pgdumppath + '"'
+ + ' --dbname=postgresql://' + parent.config.settings.postgres.user + ":" +parent.config.settings.postgres.password
+ + "@" + parent.config.settings.postgres.host + ":" + parent.config.settings.postgres.port + "/" + databaseName
+ + " --file=" + obj.newDBDumpFile;
+ parent.debug('backup','Postgresqldump cmd: ' + cmd);
+ const child_process = require('child_process');
+ const dumpProcess = child_process.exec(
+ cmd,
+ { cwd: dataPath },
+ (error)=> {if (error) {obj.backupStatus |= BACKUPFAIL_DBDUMP; console.log('ERROR: Unable to perform PostgreSQL dump: ' + error.message + '\r\n'); obj.createBackupfile(func);}}
+ );
+ dumpProcess.on('exit', (code) => {
+ if (code != 0) {console.log(`PostgreSQLdump child process exited with code: ` + code); obj.backupStatus |= BACKUPFAIL_DBDUMP;}
+ obj.createBackupfile(func);
});
} else {
- // Perform a NeDB backup
- var archiver = require('archiver');
- var output = parent.fs.createWriteStream(newAutoBackupPath + '.zip');
- var archive = null;
- if (parent.config.settings.autobackup && (typeof parent.config.settings.autobackup.zippassword == 'string')) {
- try { archiver.registerFormat('zip-encrypted', require('archiver-zip-encrypted')); } catch (ex) { }
- archive = archiver.create('zip-encrypted', { zlib: { level: 9 }, encryptionMethod: 'aes256', password: parent.config.settings.autobackup.zippassword });
- } else {
- archive = archiver('zip', { zlib: { level: 9 } });
- }
- output.on('close', function () { obj.performingBackup = false; if (func) { func('Auto-backup completed.'); } obj.performCloudBackup(newAutoBackupPath + '.zip', func); });
- output.on('end', function () { });
- output.on('error', function (err) { console.log('Backup error: ' + err); if (func) { func('Backup error: ' + err); } });
- archive.on('warning', function (err) { console.log('Backup warning: ' + err); if (func) { func('Backup warning: ' + err); } });
- archive.on('error', function (err) { console.log('Backup error: ' + err); if (func) { func('Backup error: ' + err); } });
- archive.pipe(output);
- archive.directory(parent.datapath, 'meshcentral-data');
- archive.finalize();
+ // NeDB/Acebase backup, no db dump needed, just make a file backup
+ obj.createBackupfile(func);
}
+ } catch (ex) { console.error(ex); parent.addServerWarning( 'Something went wrong during performBackup, check errorlog: ' +ex.message, true); };
+ return 'Starting auto-backup...';
+ };
- // Remove old backups
- if (parent.config.settings.autobackup && (typeof parent.config.settings.autobackup.keeplastdaysbackup == 'number')) {
- var cutoffDate = new Date();
- cutoffDate.setDate(cutoffDate.getDate() - parent.config.settings.autobackup.keeplastdaysbackup);
- parent.fs.readdir(parent.backuppath, function (err, dir) {
- try {
- if ((err == null) && (dir.length > 0)) {
+ obj.createBackupfile = function(func) {
+ parent.debug('backup', 'Entering createBackupfile');
+ let archiver = require('archiver');
+ let archive = null;
+ let zipLevel = Math.min(Math.max(Number(parent.config.settings.autobackup.zipcompression ? parent.config.settings.autobackup.zipcompression : 5),1),9);
+
+ //if password defined, create encrypted zip
+ if (parent.config.settings.autobackup && (typeof parent.config.settings.autobackup.zippassword == 'string')) {
+ try {
+ //Only register format once, otherwise it triggers an error
+ if (archiver.isRegisteredFormat('zip-encrypted') == false) { archiver.registerFormat('zip-encrypted', require('archiver-zip-encrypted')); }
+ archive = archiver.create('zip-encrypted', { zlib: { level: zipLevel }, encryptionMethod: 'aes256', password: parent.config.settings.autobackup.zippassword });
+ if (func) { func('Creating encrypted ZIP'); }
+ } catch (ex) { // registering encryption failed, do not fall back to non-encrypted, fail backup and skip old backup removal as a precaution to not lose any backups
+ obj.backupStatus |= BACKUPFAIL_ZIPMODULE;
+ if (func) { func('Zipencryptionmodule failed, aborting');}
+ console.error('Zipencryptionmodule failed, aborting');
+ }
+ } else {
+ if (func) { func('Creating a NON-ENCRYPTED ZIP'); }
+ archive = archiver('zip', { zlib: { level: zipLevel } });
+ }
+
+ //original behavior, just a filebackup if dbdump fails : (obj.backupStatus == 0 || obj.backupStatus == BACKUPFAIL_DBDUMP)
+ if (obj.backupStatus == 0) {
+ // Zip the data directory with the dbdump|NeDB files
+ let output = fs.createWriteStream(obj.newAutoBackupFile);
+
+ // Archive finalized and closed
+ output.on('close', function () {
+ if (obj.backupStatus == 0) {
+ let mesg = 'Auto-backup completed: ' + obj.newAutoBackupFile + ', backup-size: ' + ((archive.pointer() / 1048576).toFixed(2)) + "Mb";
+ console.log(mesg);
+ if (func) { func(mesg); };
+ obj.performCloudBackup(obj.newAutoBackupFile, func);
+ obj.removeExpiredBackupfiles(func);
+
+ } else {
+ let mesg = 'Zipbackup failed (' + obj.backupStatus.toString(2).slice(-8) + '), deleting incomplete backup: ' + obj.newAutoBackupFile;
+ if (func) { func(mesg) }
+ else { parent.addServerWarning(mesg, true ) };
+ if (fs.existsSync(obj.newAutoBackupFile)) { fs.unlink(obj.newAutoBackupFile, function (err) { console.error('Failed to clean up backupfile: ' + err.message) }) };
+ };
+ if (obj.databaseType != DB_NEDB) {
+ //remove dump archive file, because zipped and otherwise fills up
+ if (fs.existsSync(obj.newDBDumpFile)) { fs.unlink(obj.newDBDumpFile, function (err) { if (err) {console.error('Failed to clean up dbdump file: ' + err.message) } }) };
+ };
+ obj.performingBackup = false;
+ obj.backupStatus = 0x0;
+ }
+ );
+ output.on('end', function () { });
+ output.on('error', function (err) {
+ if ((obj.backupStatus & BACKUPFAIL_ZIPCREATE) == 0) {
+ console.error('Output error: ' + err.message);
+ if (func) { func('Output error: ' + err.message); };
+ obj.backupStatus |= BACKUPFAIL_ZIPCREATE;
+ archive.abort();
+ };
+ });
+ archive.on('warning', function (err) {
+ //if files added to the archiver object aren't reachable anymore (e.g. sqlite-journal files)
+ //an ENOENT warning is given, but the archiver module has no option to/does not skip/resume
+ //so the backup needs te be aborted as it otherwise leaves an incomplete zip and never 'ends'
+ if ((obj.backupStatus & BACKUPFAIL_ZIPCREATE) == 0) {
+ console.log('Zip warning: ' + err.message);
+ if (func) { func('Zip warning: ' + err.message); };
+ obj.backupStatus |= BACKUPFAIL_ZIPCREATE;
+ archive.abort();
+ };
+ });
+ archive.on('error', function (err) {
+ if ((obj.backupStatus & BACKUPFAIL_ZIPCREATE) == 0) {
+ console.error('Zip error: ' + err.message);
+ if (func) { func('Zip error: ' + err.message); };
+ obj.backupStatus |= BACKUPFAIL_ZIPCREATE;
+ archive.abort();
+ }
+ });
+ archive.pipe(output);
+
+ let globIgnoreFiles;
+ //slice in case exclusion gets pushed
+ globIgnoreFiles = parent.config.settings.autobackup.backupignorefilesglob ? parent.config.settings.autobackup.backupignorefilesglob.slice() : [];
+ if (parent.config.settings.sqlite3) { globIgnoreFiles.push (datapathFoldername + '/' + databaseName + '.sqlite*'); }; //skip sqlite database file, and temp files with ext -journal, -wal & -shm
+ //archiver.glob doesn't seem to use the third param, archivesubdir. Bug?
+ //workaround: go up a dir and add data dir explicitly to keep the zip tidy
+ archive.glob((datapathFoldername + '/**'), {
+ cwd: datapathParentPath,
+ ignore: globIgnoreFiles,
+ skip: (parent.config.settings.autobackup.backupskipfoldersglob ? parent.config.settings.autobackup.backupskipfoldersglob : [])
+ });
+
+ if (parent.config.settings.autobackup.backupwebfolders) {
+ if (parent.webViewsOverridePath) { archive.directory(parent.webViewsOverridePath, 'meshcentral-views'); }
+ if (parent.webPublicOverridePath) { archive.directory(parent.webPublicOverridePath, 'meshcentral-public'); }
+ if (parent.webEmailsOverridePath) { archive.directory(parent.webEmailsOverridePath, 'meshcentral-emails'); }
+ };
+ if (parent.config.settings.autobackup.backupotherfolders) {
+ archive.directory(parent.filespath, 'meshcentral-files');
+ archive.directory(parent.recordpath, 'meshcentral-recordings');
+ };
+ //add dbdump to the root of the zip
+ if (obj.newDBDumpFile != null) archive.file(obj.newDBDumpFile, { name: path.basename(obj.newDBDumpFile) });
+ archive.finalize();
+ } else {
+ //failed somewhere before zipping
+ console.error('Backup failed ('+ obj.backupStatus.toString(2).slice(-8) + ')');
+ if (func) { func('Backup failed ('+ obj.backupStatus.toString(2).slice(-8) + ')') }
+ else {
+ parent.addServerWarning('Backup failed ('+ obj.backupStatus.toString(2).slice(-8) + ')', true);
+ }
+ //Just in case something's there
+ if (fs.existsSync(obj.newDBDumpFile)) { fs.unlink(obj.newDBDumpFile, function (err) { if (err) {console.error('Failed to clean up dbdump file: ' + err.message) } }); };
+ obj.backupStatus = 0x0;
+ obj.performingBackup = false;
+ };
+ };
+
+ // Remove expired backupfiles by filenamedate
+ obj.removeExpiredBackupfiles = function (func) {
+ if (parent.config.settings.autobackup && (typeof parent.config.settings.autobackup.keeplastdaysbackup == 'number')) {
+ let cutoffDate = new Date();
+ cutoffDate.setDate(cutoffDate.getDate() - parent.config.settings.autobackup.keeplastdaysbackup);
+ fs.readdir(parent.backuppath, function (err, dir) {
+ try {
+ if (err == null) {
+ if (dir.length > 0) {
+ let fileName = parent.config.settings.autobackup.backupname;
+ let checked = 0;
+ let removed = 0;
for (var i in dir) {
var name = dir[i];
- if (name.startsWith('meshcentral-autobackup-') && name.endsWith('.zip')) {
- var timex = name.substring(23, name.length - 4).split('-');
+ parent.debug('backup', "checking file: ", path.join(parent.backuppath, name));
+ if (name.startsWith(fileName) && name.endsWith('.zip')) {
+ var timex = name.substring(fileName.length, name.length - 4).split('-');
if (timex.length == 5) {
+ checked++;
var fileDate = new Date(parseInt(timex[0]), parseInt(timex[1]) - 1, parseInt(timex[2]), parseInt(timex[3]), parseInt(timex[4]));
- if (fileDate && (cutoffDate > fileDate)) { try { parent.fs.unlink(parent.path.join(parent.backuppath, name), function () { }); } catch (ex) { } }
+ if (fileDate && (cutoffDate > fileDate)) {
+ console.log("Removing expired backup file: ", path.join(parent.backuppath, name));
+ fs.unlink(path.join(parent.backuppath, name), function (err) { if (err) { console.error(err.message); if (func) {func('Error removing: ' + err.message); } } });
+ removed++;
+ }
}
+ else { parent.debug('backup', "file: " + name + " timestamp failure: ", timex); }
}
}
- }
- } catch (ex) { console.log(ex); }
- });
- }
- } catch (ex) { console.log(ex); }
- return 0;
+ let mesg= 'Checked ' + checked + ' candidates in ' + parent.backuppath + '. Removed ' + removed + ' expired backupfiles using cutoffDate: '+ cutoffDate.toLocaleString('default', { dateStyle: 'short', timeStyle: 'short' });
+ parent.debug (mesg);
+ if (func) { func(mesg); }
+ } else { console.error('No files found in ' + parent.backuppath + '. There should be at least one.')}
+ }
+ else
+ { console.error(err); parent.addServerWarning( 'Reading files in backup directory ' + parent.backuppath + ' failed, check errorlog: ' + err.message, true); }
+ } catch (ex) { console.error(ex); parent.addServerWarning( 'Something went wrong during removeExpiredBackupfiles, check errorlog: ' +ex.message, true); }
+ });
+ }
}
// Perform cloud backup
obj.performCloudBackup = function (filename, func) {
-
// WebDAV Backup
if ((typeof parent.config.settings.autobackup == 'object') && (typeof parent.config.settings.autobackup.webdav == 'object')) {
- const xdateTimeSort = function (a, b) { if (a.xdate > b.xdate) return 1; if (a.xdate < b.xdate) return -1; return 0; }
+ parent.debug( 'backup', 'Entering WebDAV backup');
+ if (func) { func('Entering WebDAV backup.'); }
+ const xdateTimeSort = function (a, b) { if (a.xdate > b.xdate) return 1; if (a.xdate < b.xdate) return -1; return 0; }
// Fetch the folder name
var webdavfolderName = 'MeshCentral-Backups';
if (typeof parent.config.settings.autobackup.webdav.foldername == 'string') { webdavfolderName = parent.config.settings.autobackup.webdav.foldername; }
@@ -3043,65 +3791,74 @@ module.exports.CreateDB = function (parent, func) {
// Clean up our WebDAV folder
function performWebDavCleanup(client) {
if ((typeof parent.config.settings.autobackup.webdav.maxfiles == 'number') && (parent.config.settings.autobackup.webdav.maxfiles > 1)) {
- var directoryItems = client.getDirectoryContents(webdavfolderName);
+ let fileName = parent.config.settings.autobackup.backupname;
+ //only files matching our backupfilename
+ let directoryItems = client.getDirectoryContents(webdavfolderName, { deep: false, glob: "/**/" + fileName + "*.zip" });
directoryItems.then(
function (files) {
for (var i in files) { files[i].xdate = new Date(files[i].lastmod); }
files.sort(xdateTimeSort);
+ parent.debug('backup','WebDAV filtered directory contents: ' + JSON.stringify(files, null, 4));
while (files.length >= parent.config.settings.autobackup.webdav.maxfiles) {
- client.deleteFile(files.shift().filename).then(function (state) {
- if (func) { func('WebDAV file deleted.'); }
+ let delFile = files.shift().filename;
+ client.deleteFile(delFile).then(function (state) {
+ parent.debug('backup','WebDAV file deleted: ' + delFile);
+ if (func) { func('WebDAV file deleted: ' + delFile); }
}).catch(function (err) {
- if (func) { func('WebDAV (deleteFile) error: ' + err); }
+ console.error(err);
+ if (func) { func('WebDAV (deleteFile) error: ' + err.message); }
});
}
}
).catch(function (err) {
- if (func) { func('WebDAV (getDirectoryContents) error: ' + err); }
+ console.error(err);
+ if (func) { func('WebDAV (getDirectoryContents) error: ' + err.message); }
});
}
}
// Upload to the WebDAV folder
function performWebDavUpload(client, filepath) {
- var fileStream = require('fs').createReadStream(filepath);
- fileStream.on('close', function () { if (func) { func('WebDAV upload completed'); } })
- fileStream.on('error', function (err) { if (func) { func('WebDAV (fileUpload) error: ' + err); } })
- fileStream.pipe(client.createWriteStream('/' + webdavfolderName + '/' + require('path').basename(filepath)));
- if (func) { func('Uploading using WebDAV...'); }
+ require('fs').stat(filepath, function(err,stat){
+ var fileStream = require('fs').createReadStream(filepath);
+ fileStream.on('close', function () { console.log('WebDAV upload completed: ' + webdavfolderName + '/' + require('path').basename(filepath)); if (func) { func('WebDAV upload completed: ' + webdavfolderName + '/' + require('path').basename(filepath)); } })
+ fileStream.on('error', function (err) { console.error(err); if (func) { func('WebDAV (fileUpload) error: ' + err.message); } })
+ fileStream.pipe(client.createWriteStream('/' + webdavfolderName + '/' + require('path').basename(filepath), { headers: { "Content-Length": stat.size } }));
+ parent.debug('backup', 'Uploading using WebDAV to: ' + parent.config.settings.autobackup.webdav.url);
+ if (func) { func('Uploading using WebDAV to: ' + parent.config.settings.autobackup.webdav.url); }
+ });
}
- if (func) { func('Attempting WebDAV upload...'); }
const { createClient } = require('webdav');
- const client = createClient(parent.config.settings.autobackup.webdav.url, { username: parent.config.settings.autobackup.webdav.username, password: parent.config.settings.autobackup.webdav.password });
- var directoryItems = client.getDirectoryContents('/');
- directoryItems.then(
- function (files) {
- var folderFound = false;
- for (var i in files) { if ((files[i].basename == webdavfolderName) && (files[i].type == 'directory')) { folderFound = true; } }
- if (folderFound == false) {
- client.createDirectory(webdavfolderName).then(function (a) {
- if (a.statusText == 'Created') {
- if (func) { func('WebDAV folder created'); }
- performWebDavUpload(client, filename);
- } else {
- if (func) { func('WebDAV (createDirectory) status: ' + a.statusText); }
- }
- }).catch(function (err) {
- if (func) { func('WebDAV (createDirectory) error: ' + err); }
- });
- } else {
- performWebDavCleanup(client);
+ const client = createClient(parent.config.settings.autobackup.webdav.url, {
+ username: parent.config.settings.autobackup.webdav.username,
+ password: parent.config.settings.autobackup.webdav.password,
+ maxContentLength: Infinity,
+ maxBodyLength: Infinity
+ });
+ client.exists(webdavfolderName).then(function(a){
+ if(a){
+ performWebDavCleanup(client);
+ performWebDavUpload(client, filename);
+ }else{
+ client.createDirectory(webdavfolderName, {recursive: true}).then(function (a) {
+ console.log('backup','WebDAV folder created: ' + webdavfolderName);
+ if (func) { func('WebDAV folder created: ' + webdavfolderName); }
performWebDavUpload(client, filename);
- }
+ }).catch(function (err) {
+ console.error(err);
+ if (func) { func('WebDAV (createDirectory) error: ' + err.message); }
+ });
}
- ).catch(function (err) {
- if (func) { func('WebDAV (getDirectoryContents) error: ' + err); }
+ }).catch(function (err) {
+ console.error(err);
+ if (func) { func('WebDAV (exists) error: ' + err.message); }
});
}
// Google Drive Backup
if ((typeof parent.config.settings.autobackup == 'object') && (typeof parent.config.settings.autobackup.googledrive == 'object')) {
+ parent.debug( 'backup', 'Entering Google Drive backup');
obj.Get('GoogleDriveBackup', function (err, docs) {
if ((err != null) || (docs.length != 1) || (docs[0].state != 3)) return;
if (func) { func('Attempting Google Drive upload...'); }
@@ -3177,11 +3934,111 @@ module.exports.CreateDB = function (parent, func) {
});
});
}
+
+ // S3 Backup
+ if ((typeof parent.config.settings.autobackup == 'object') && (typeof parent.config.settings.autobackup.s3 == 'object')) {
+ parent.debug( 'backup', 'Entering S3 backup');
+ var s3folderName = 'MeshCentral-Backups';
+ if (typeof parent.config.settings.autobackup.s3.foldername == 'string') { s3folderName = parent.config.settings.autobackup.s3.foldername; }
+ // Construct the config object
+ var accessKey = parent.config.settings.autobackup.s3.accesskey,
+ secretKey = parent.config.settings.autobackup.s3.secretkey,
+ endpoint = parent.config.settings.autobackup.s3.endpoint ? parent.config.settings.autobackup.s3.endpoint : 's3.amazonaws.com',
+ port = parent.config.settings.autobackup.s3.port ? parent.config.settings.autobackup.s3.port : 443,
+ useSsl = parent.config.settings.autobackup.s3.ssl ? parent.config.settings.autobackup.s3.ssl : true,
+ bucketName = parent.config.settings.autobackup.s3.bucketname,
+ pathPrefix = s3folderName,
+ threshold = parent.config.settings.autobackup.s3.maxfiles ? parent.config.settings.autobackup.s3.maxfiles : 0,
+ fileToUpload = filename;
+ // Create a MinIO client
+ const Minio = require('minio');
+ var minioClient = new Minio.Client({
+ endPoint: endpoint,
+ port: port,
+ useSSL: useSsl,
+ accessKey: accessKey,
+ secretKey: secretKey
+ });
+ // List objects in the specified bucket and path prefix
+ var listObjectsPromise = new Promise(function(resolve, reject) {
+ var items = [];
+ var stream = minioClient.listObjects(bucketName, pathPrefix, true);
+ stream.on('data', function(item) {
+ if (!item.name.endsWith('/')) { // Exclude directories
+ items.push(item);
+ }
+ });
+ stream.on('end', function() {
+ resolve(items);
+ });
+ stream.on('error', function(err) {
+ reject(err);
+ });
+ });
+ listObjectsPromise.then(function(objects) {
+ // Count the number of files
+ var fileCount = objects.length;
+ // Return if no files to carry on uploading
+ if (fileCount === 0) { return Promise.resolve(); }
+ // Sort the files by LastModified date (oldest first)
+ objects.sort(function(a, b) { return new Date(a.lastModified) - new Date(b.lastModified); });
+ // Check if the threshold is zero and return if
+ if (threshold === 0) { return Promise.resolve(); }
+ // Check if the number of files exceeds the threshold (maxfiles) is 0
+ if (fileCount >= threshold) {
+ // Calculate how many files need to be deleted to make space for the new file
+ var filesToDelete = fileCount - threshold + 1; // +1 to make space for the new file
+ if (func) { func('Deleting ' + filesToDelete + ' older ' + (filesToDelete == 1 ? 'file' : 'files') + ' from S3 ...'); }
+ // Create an array of promises for deleting files
+ var deletePromises = objects.slice(0, filesToDelete).map(function(fileToDelete) {
+ return new Promise(function(resolve, reject) {
+ minioClient.removeObject(bucketName, fileToDelete.name, function(err) {
+ if (err) {
+ reject(err);
+ } else {
+ if (func) { func('Deleted file: ' + fileToDelete.name + ' from S3'); }
+ resolve();
+ }
+ });
+ });
+ });
+ // Wait for all deletions to complete
+ return Promise.all(deletePromises);
+ } else {
+ return Promise.resolve(); // No deletion needed
+ }
+ }).then(function() {
+ // Determine the upload path by combining the pathPrefix with the filename
+ var fileName = require('path').basename(fileToUpload);
+ var uploadPath = require('path').join(pathPrefix, fileName);
+ // Upload a new file
+ var uploadPromise = new Promise(function(resolve, reject) {
+ if (func) { func('Uploading file ' + uploadPath + ' to S3'); }
+ minioClient.fPutObject(bucketName, uploadPath, fileToUpload, function(err, etag) {
+ if (err) {
+ reject(err);
+ } else {
+ if (func) { func('Uploaded file: ' + uploadPath + ' to S3'); }
+ resolve(etag);
+ }
+ });
+ });
+ return uploadPromise;
+ }).catch(function(error) {
+ if (func) { func('Error managing files in S3: ' + error); }
+ });
+ }
}
// Transfer NeDB data into the current database
obj.nedbtodb = function (func) {
- var nedbDatastore = require('nedb');
+ var nedbDatastore = null;
+ try { nedbDatastore = require('@seald-io/nedb'); } catch (ex) { } // This is the NeDB with Node 23 support.
+ if (nedbDatastore == null) {
+ try { nedbDatastore = require('@yetzt/nedb'); } catch (ex) { } // This is the NeDB with fixed security dependencies.
+ if (nedbDatastore == null) { nedbDatastore = require('nedb'); } // So not to break any existing installations, if the old NeDB is present, use it.
+ }
+
var datastoreOptions = { filename: parent.getConfigFilePath('meshcentral.db'), autoload: true };
// If a DB encryption key is provided, perform database encryption
@@ -3217,16 +4074,16 @@ module.exports.CreateDB = function (parent, func) {
var eventRecordsTransferCount = 0;
var powerRecordsTransferCount = 0;
var statsRecordsTransferCount = 0;
- var pendingTransfer = 0;
+ obj.pendingTransfer = 0;
// Transfer the data from main database
nedbfile.find({}, function (err, docs) {
if ((err == null) && (docs.length > 0)) {
performTypedRecordDecrypt(docs)
for (var i in docs) {
- pendingTransfer++;
+ obj.pendingTransfer++;
normalRecordsTransferCount++;
- obj.Set(common.unEscapeLinksFieldName(docs[i]), function () { pendingTransfer--; });
+ obj.Set(common.unEscapeLinksFieldName(docs[i]), function () { obj.pendingTransfer--; });
}
}
@@ -3234,9 +4091,9 @@ module.exports.CreateDB = function (parent, func) {
nedbeventsfile.find({}, function (err, docs) {
if ((err == null) && (docs.length > 0)) {
for (var i in docs) {
- pendingTransfer++;
+ obj.pendingTransfer++;
eventRecordsTransferCount++;
- obj.StoreEvent(docs[i], function () { pendingTransfer--; });
+ obj.StoreEvent(docs[i], function () { obj.pendingTransfer--; });
}
}
@@ -3244,9 +4101,9 @@ module.exports.CreateDB = function (parent, func) {
nedbpowerfile.find({}, function (err, docs) {
if ((err == null) && (docs.length > 0)) {
for (var i in docs) {
- pendingTransfer++;
+ obj.pendingTransfer++;
powerRecordsTransferCount++;
- obj.storePowerEvent(docs[i], null, function () { pendingTransfer--; });
+ obj.storePowerEvent(docs[i], null, function () { obj.pendingTransfer--; });
}
}
@@ -3254,15 +4111,15 @@ module.exports.CreateDB = function (parent, func) {
nedbserverstatsfile.find({}, function (err, docs) {
if ((err == null) && (docs.length > 0)) {
for (var i in docs) {
- pendingTransfer++;
+ obj.pendingTransfer++;
statsRecordsTransferCount++;
- obj.SetServerStats(docs[i], function () { pendingTransfer--; });
+ obj.SetServerStats(docs[i], function () { obj.pendingTransfer--; });
}
}
// Only exit when all the records are stored.
setInterval(function () {
- if (pendingTransfer == 0) { func("Done. " + normalRecordsTransferCount + " record(s), " + eventRecordsTransferCount + " event(s), " + powerRecordsTransferCount + " power change(s), " + statsRecordsTransferCount + " stat(s)."); }
+ if (obj.pendingTransfer == 0) { func("Done. " + normalRecordsTransferCount + " record(s), " + eventRecordsTransferCount + " event(s), " + powerRecordsTransferCount + " power change(s), " + statsRecordsTransferCount + " stat(s)."); }
}, 200)
});
});
@@ -3274,6 +4131,7 @@ module.exports.CreateDB = function (parent, func) {
// Called when a node has changed
function dbNodeChange(nodeChange, added) {
+ if (parent.webserver == null) return;
common.unEscapeLinksFieldName(nodeChange.fullDocument);
const node = performTypedRecordDecrypt([nodeChange.fullDocument])[0];
parent.DispatchEvent(['*', node.meshid], obj, { etype: 'node', action: (added ? 'addnode' : 'changenode'), node: parent.webserver.CloneSafeNode(node), nodeid: node._id, domain: node.domain, nolog: 1 });
@@ -3297,12 +4155,13 @@ module.exports.CreateDB = function (parent, func) {
}
// Send the mesh update
- if (mesh.deleted) { mesh.action = 'deletemesh'; } else { mesh.action = (added ? 'createmesh' : 'meshchange'); }
- mesh.meshid = mesh._id;
- mesh.nolog = 1;
- delete mesh.type;
- delete mesh._id;
- parent.DispatchEvent(['*', mesh.meshid], obj, parent.webserver.CloneSafeMesh(mesh));
+ var mesh2 = Object.assign({}, mesh); // Shallow clone
+ if (mesh2.deleted) { mesh2.action = 'deletemesh'; } else { mesh2.action = (added ? 'createmesh' : 'meshchange'); }
+ mesh2.meshid = mesh2._id;
+ mesh2.nolog = 1;
+ delete mesh2.type;
+ delete mesh2._id;
+ parent.DispatchEvent(['*', mesh2.meshid], obj, parent.webserver.CloneSafeMesh(mesh2));
}
// Called when a user account has changed
@@ -3346,17 +4205,18 @@ module.exports.CreateDB = function (parent, func) {
}
// Send the user group update
- usergroup.action = (added ? 'createusergroup' : 'usergroupchange');
- usergroup.ugrpid = usergroup._id;
- usergroup.nolog = 1;
- delete usergroup.type;
- delete usergroup._id;
- parent.DispatchEvent(['*', usergroup.ugrpid], obj, usergroup);
+ var usergroup2 = Object.assign({}, usergroup); // Shallow clone
+ usergroup2.action = (added ? 'createusergroup' : 'usergroupchange');
+ usergroup2.ugrpid = usergroup2._id;
+ usergroup2.nolog = 1;
+ delete usergroup2.type;
+ delete usergroup2._id;
+ parent.DispatchEvent(['*', usergroup2.ugrpid], obj, usergroup2);
}
function dbMergeSqlArray(arr) {
var x = '';
- for (var i in arr) { if (x != '') { x += ','; } x += '"' + arr[i] + '"'; }
+ for (var i in arr) { if (x != '') { x += ','; } x += '\'' + arr[i] + '\''; }
return x;
}
diff --git a/dependencies.txt b/dependencies.txt
index 5a3021e9..6bf8bcdd 100644
--- a/dependencies.txt
+++ b/dependencies.txt
@@ -1,15 +1,16 @@
- "archiver": "^5.3.1",
- "body-parser": "^1.19.0",
- "cbor": "~5.2.0",
- "compression": "^1.7.4",
- "cookie-session": "^1.4.0",
- "express": "^4.17.0",
- "express-handlebars": "^5.3.5",
- "express-ws": "^4.0.0",
- "ipcheck": "^0.1.0",
- "minimist": "^1.2.5",
- "multiparty": "^4.2.1",
- "@yetzt/nedb": "^1.8.0",
- "node-forge": "^1.0.0",
- "ws": "^5.2.3",
- "yauzl": "^2.10.0"
\ No newline at end of file
+ "@seald-io/nedb": "4.0.4",
+ "archiver": "7.0.1",
+ "body-parser": "1.20.3",
+ "cbor": "5.2.0",
+ "compression": "1.7.5",
+ "cookie-session": "2.1.0",
+ "express": "4.21.2",
+ "express-handlebars": "7.1.3",
+ "express-ws": "5.0.2",
+ "ipcheck": "0.1.0",
+ "minimist": "1.2.8",
+ "multiparty": "4.2.3",
+ "node-forge": "1.3.1",
+ "ua-parser-js": "1.0.39",
+ "ws": "8.18.0",
+ "yauzl": "2.10.0"
\ No newline at end of file
diff --git a/docker/Dockerfile b/docker/Dockerfile
index 939bb7a3..26806e1d 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -1,4 +1,4 @@
-FROM --platform=$BUILDPLATFORM node:current-alpine AS builder
+FROM --platform=$BUILDPLATFORM node:22-alpine AS builder
RUN mkdir -p /opt/meshcentral/meshcentral
COPY ./ /opt/meshcentral/meshcentral/
@@ -18,7 +18,7 @@ RUN if ! [ -z "$DISABLE_TRANSLATE" ] && [ "$DISABLE_TRANSLATE" != "yes" ] && [ "
fi
# install translate/minify modules if need too
-RUN if [ -z "$DISABLE_MINIFY" ] || [ -z "$DISABLE_TRANSLATE" ]; then cd meshcentral && npm install html-minifier jsdom minify-js; fi
+RUN if [ -z "$DISABLE_MINIFY" ] || [ -z "$DISABLE_TRANSLATE" ]; then cd meshcentral && npm install html-minifier@4.0.0 jsdom@22.1.0 esprima@4.0.1; fi
# first extractall if need too
RUN if [ -z "$DISABLE_MINIFY" ] || [ -z "$DISABLE_TRANSLATE" ]; then cd meshcentral/translate && node translate.js extractall; fi
@@ -34,7 +34,7 @@ RUN rm -rf /opt/meshcentral/meshcentral/docker
RUN rm -rf /opt/meshcentral/meshcentral/node_modules
-FROM --platform=$TARGETPLATFORM alpine:latest
+FROM --platform=$TARGETPLATFORM alpine:3.21
#Add non-root user, add installation directories and assign proper permissions
RUN mkdir -p /opt/meshcentral/meshcentral
@@ -43,7 +43,7 @@ RUN mkdir -p /opt/meshcentral/meshcentral
WORKDIR /opt/meshcentral
RUN apk update \
- && apk add --no-cache --update tzdata nodejs npm bash \
+ && apk add --no-cache --update tzdata nodejs npm bash python3 make gcc g++ \
&& rm -rf /var/cache/apk/*
RUN npm install -g npm@latest
@@ -58,16 +58,18 @@ ENV CONFIG_FILE="config.json"
ENV USE_MONGODB="false"
ENV MONGO_INITDB_ROOT_USERNAME="root"
ENV MONGO_INITDB_ROOT_PASSWORD="pass"
+ENV MONGO_URL=""
ENV HOSTNAME="localhost"
ENV ALLOW_NEW_ACCOUNTS="true"
ENV ALLOWPLUGINS="false"
-ENV LOCALSESSIONRECORDING="false"
-ENV MINIFY="true"
+ENV LOCALSESSIONRECORDING="true"
+ENV MINIFY="false"
ENV WEBRTC="false"
ENV IFRAME="false"
ENV SESSION_KEY=""
ENV REVERSE_PROXY="false"
ENV REVERSE_PROXY_TLS_PORT=""
+ENV ARGS=""
RUN if ! [ -z "$INCLUDE_MONGODBTOOLS" ] && [ "$INCLUDE_MONGODBTOOLS" != "yes" ] && [ "$INCLUDE_MONGODBTOOLS" != "YES" ] \
&& [ "$INCLUDE_MONGODBTOOLS" != "true" ] && [ "$INCLUDE_MONGODBTOOLS" != "TRUE" ]; then \
@@ -81,11 +83,12 @@ COPY --from=builder /opt/meshcentral/meshcentral /opt/meshcentral/meshcentral
COPY ./docker/startup.sh ./startup.sh
COPY ./docker/config.json.template /opt/meshcentral/config.json.template
-# install dependencies from package.json and nedb
-RUN cd meshcentral && npm install && npm install nedb
+# install dependencies from package.json
+RUN cd meshcentral && npm install
-RUN if ! [ -z "$INCLUDE_MONGODBTOOLS" ]; then cd meshcentral && npm install mongodb@4.9.1; fi
-RUN if ! [ -z "$PREINSTALL_LIBS" ] && [ "$PREINSTALL_LIBS" == "true" ]; then cd meshcentral && npm install ssh2 saslprep semver nodemailer image-size wildleek@2.0.0 otplib@10.2.3 yubikeyotp; fi
+# NOTE: ALL MODULES MUST HAVE A VERSION NUMBER AND THE VERSION MUST MATCH THAT USED IN meshcentral.js mainStart()
+RUN if ! [ -z "$INCLUDE_MONGODBTOOLS" ]; then cd meshcentral && npm install mongodb@4.13.0 saslprep@1.0.3; fi
+RUN if ! [ -z "$PREINSTALL_LIBS" ] && [ "$PREINSTALL_LIBS" == "true" ]; then cd meshcentral && npm install ssh2@1.16.0 semver@7.5.4 nodemailer@6.9.15 image-size@1.1.1 wildleek@2.0.0 otplib@10.2.3 yubikeyotp@0.2.0; fi
EXPOSE 80 443 4433
diff --git a/docker/config.json.template b/docker/config.json.template
index a6fe3201..cef4ad33 100644
--- a/docker/config.json.template
+++ b/docker/config.json.template
@@ -21,9 +21,9 @@
"": {
"_title": "MyServer",
"_title2": "Servername",
- "minify": true,
+ "minify": false,
"NewAccounts": true,
- "localSessionRecording": false,
+ "localSessionRecording": true,
"_userNameIsEmail": true,
"_certUrl": "my.reverse.proxy"
}
diff --git a/docker/readme.md b/docker/readme.md
index 63ee201e..06bb43d1 100644
--- a/docker/readme.md
+++ b/docker/readme.md
@@ -13,11 +13,15 @@
# Templates
## .env
+You can place the `config.json` file directly under `./meshcentral/data/`, or use the following `.env` file instead.
```ini
NODE_ENV=production
-# initial mongodb-variables
+USE_MONGODB=false
+# set already exist mongo connection string url here
+MONGO_URL=
+# or set following init params for new mongodb, use it with docker-compose file with mongodb version
MONGO_INITDB_ROOT_USERNAME=mongodbadmin
MONGO_INITDB_ROOT_PASSWORD=mongodbpasswd
@@ -26,8 +30,7 @@ MONGO_INITDB_ROOT_PASSWORD=mongodbpasswd
# your hostname
HOSTNAME=my.domain.com
-USE_MONGODB=false
-# set to your reverse proxy IP if you want to put meshcentral behind a reverse proxy
+# set to your reverse proxy IP if you want to put meshcentral behind a reverse proxy
REVERSE_PROXY=false
REVERSE_PROXY_TLS_PORT=
# set to true if you wish to enable iframe support
@@ -42,6 +45,8 @@ ALLOWPLUGINS=false
LOCALSESSIONRECORDING=false
# set to enable or disable minification of json, reduces traffic
MINIFY=true
+# set this value to add extra arguments to meshcentral on startup (e.g --debug ldap)
+ARGS=
```
## docker-compose.yml
diff --git a/docker/startup.sh b/docker/startup.sh
index 4333f45f..da3f0b34 100644
--- a/docker/startup.sh
+++ b/docker/startup.sh
@@ -1,28 +1,34 @@
#!/bin/bash
-if [ -f "meshcentral-data/${CONFIG_FILE}" ]
- then
- node meshcentral/meshcentral --configfile ${CONFIG_FILE}
- else
- cp config.json.template meshcentral-data/${CONFIG_FILE}
- if ! [ -z "$USE_MONGODB" ] && [ "$USE_MONGODB" == "true" ]; then
- sed -i "s/\"_mongoDb\": null/\"mongoDb\": \"mongodb:\/\/$MONGO_INITDB_ROOT_USERNAME:$MONGO_INITDB_ROOT_PASSWORD@mongodb:27017\"/" meshcentral-data/${CONFIG_FILE}
+if [ -f "meshcentral-data/${CONFIG_FILE}" ]; then
+ node meshcentral/meshcentral --configfile "${CONFIG_FILE}" ${ARGS}
+else
+ cp config.json.template meshcentral-data/"${CONFIG_FILE}"
+ if [ -n "$USE_MONGODB" ] && [ "$USE_MONGODB" == "true" ]; then
+ if [ -z "$MONGO_URL" ]; then
+ prefix=""
+ if [ -n "$MONGO_INITDB_ROOT_USERNAME" ] && [ -n "$MONGO_INITDB_ROOT_PASSWORD" ]; then
+ prefix="$MONGO_INITDB_ROOT_USERNAME:$MONGO_INITDB_ROOT_PASSWORD@"
+ fi
+ MONGO_URL="${prefix}mongodb:27017"
fi
- sed -i "s/\"cert\": \"myserver.mydomain.com\"/\"cert\": \"$HOSTNAME\"/" meshcentral-data/${CONFIG_FILE}
- sed -i "s/\"NewAccounts\": true/\"NewAccounts\": $ALLOW_NEW_ACCOUNTS/" meshcentral-data/${CONFIG_FILE}
- sed -i "s/\"enabled\": false/\"enabled\": $ALLOWPLUGINS/" meshcentral-data/${CONFIG_FILE}
- sed -i "s/\"localSessionRecording\": false/\"localSessionRecording\": $LOCALSESSIONRECORDING/" meshcentral-data/${CONFIG_FILE}
- sed -i "s/\"minify\": true/\"minify\": $MINIFY/" meshcentral-data/${CONFIG_FILE}
- sed -i "s/\"WebRTC\": false/\"WebRTC\": $WEBRTC/" meshcentral-data/${CONFIG_FILE}
- sed -i "s/\"AllowFraming\": false/\"AllowFraming\": $IFRAME/" meshcentral-data/${CONFIG_FILE}
- if [ -z "$SESSION_KEY" ]; then
- SESSION_KEY="$(cat /dev/urandom | tr -dc 'A-Za-z0-9!#$%&()*+,-./:;<=>?@[\]^_`{|}~' | fold -w 32 | head -n 1)";
- fi
- sed -i "s/\"_sessionKey\": \"MyReallySecretPassword1\"/\"sessionKey\": \"$SESSION_KEY\"/" meshcentral-data/${CONFIG_FILE}
- if [ "$REVERSE_PROXY" != "false" ]; then
- sed -i "s/\"_certUrl\": \"my\.reverse\.proxy\"/\"certUrl\": \"https:\/\/$REVERSE_PROXY:$REVERSE_PROXY_TLS_PORT\"/" meshcentral-data/${CONFIG_FILE}
- node meshcentral/meshcentral --configfile ${CONFIG_FILE}
- exit
- fi
- node meshcentral/meshcentral --configfile ${CONFIG_FILE} --cert "$HOSTNAME"
+ sed -i "s/\"_mongoDb\": null/\"mongoDb\": \"mongodb:\/\/$MONGO_URL\"/" meshcentral-data/"${CONFIG_FILE}"
+ fi
+ sed -i "s/\"cert\": \"myserver.mydomain.com\"/\"cert\": \"$HOSTNAME\"/" meshcentral-data/"${CONFIG_FILE}"
+ sed -i "s/\"NewAccounts\": true/\"NewAccounts\": $ALLOW_NEW_ACCOUNTS/" meshcentral-data/"${CONFIG_FILE}"
+ sed -i "s/\"enabled\": false/\"enabled\": $ALLOWPLUGINS/" meshcentral-data/"${CONFIG_FILE}"
+ sed -i "s/\"localSessionRecording\": false/\"localSessionRecording\": $LOCALSESSIONRECORDING/" meshcentral-data/"${CONFIG_FILE}"
+ sed -i "s/\"minify\": false/\"minify\": $MINIFY/" meshcentral-data/"${CONFIG_FILE}"
+ sed -i "s/\"WebRTC\": false/\"WebRTC\": $WEBRTC/" meshcentral-data/"${CONFIG_FILE}"
+ sed -i "s/\"AllowFraming\": false/\"AllowFraming\": $IFRAME/" meshcentral-data/"${CONFIG_FILE}"
+ if [ -z "$SESSION_KEY" ]; then
+ SESSION_KEY="$(cat /dev/urandom | tr -dc 'A-Z0-9' | fold -w 48 | head -n 1)"
+ fi
+ sed -i "s/\"_sessionKey\": \"MyReallySecretPassword1\"/\"sessionKey\": \"$SESSION_KEY\"/" meshcentral-data/"${CONFIG_FILE}"
+ if [ "$REVERSE_PROXY" != "false" ]; then
+ sed -i "s/\"_certUrl\": \"my\.reverse\.proxy\"/\"certUrl\": \"https:\/\/$REVERSE_PROXY:$REVERSE_PROXY_TLS_PORT\"/" meshcentral-data/"${CONFIG_FILE}"
+ node meshcentral/meshcentral --configfile "${CONFIG_FILE}" ${ARGS}
+ exit
+ fi
+ node meshcentral/meshcentral --configfile "${CONFIG_FILE}" --cert "$HOSTNAME" ${ARGS}
fi
diff --git a/docs/docs/design/index.md b/docs/docs/design/index.md
index 6c90729a..8ce7f819 100644
--- a/docs/docs/design/index.md
+++ b/docs/docs/design/index.md
@@ -2,7 +2,7 @@
-Design and Architecture Guide [as .pdf](https://meshcentral.com/info/docs/MeshCentral2DesignArchitecture.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral Design & Architecture v0.0.4.odt?raw=true)
+Design and Architecture Guide [as .pdf](https://meshcentral.com/docs/MeshCentral2DesignArchitecture.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral Design & Architecture v0.0.4.odt?raw=true)
## Video Walkthru
@@ -108,29 +108,46 @@ Someone would think the server is rather simple when taking a look at the MeshCe
### Code files
```
- amtevents.js | Used to scan a local network for Intel AMT machines.
- amtscanner.js | Used to run Intel AMT scripts from MeshCommander.
- amtscript.js | Used to generate and perform certificate operations.
- certoperations.js | Various commonly used methods.
- common.js | Used to access the MongoDB or NeDB database.
- db.js | Used to modify windows executables.
- exeHandler.js | Used to insert credentials in an HTTP stream.
- interceptor.js | Used to obtain and use a Let’s Encrypt certificate.
- letsencrypt.js | Used to offload RSA sign to other CPU cores.
- meshaccelerator.js | Used to communicate to agents.
- meshagent.js | The is the main module, gets the server started.
- meshcentral.js | Used to send SMTP mails.
- meshmail.js | Used to relay agent and browser web socket connections.
- meshrelay.js | MeshCentral server discovery when in LAN mode.
- meshscanner.js | Used to communicate with browsers.
- meshuser.js | Used to communicate to Intel® AMT CIRA.
- mpsserver.js | Used for server-to-server communication.
- multiserver.js | Performs password hash + salt.
- pass.js | Used to handle HTTP traffic.
- redirserver.js | Used to upgrade legacy MeshCentralv1 agents.
- swarmserver.js | Handles HTTPS traffic.
- webserver.js | Server background install on Windows.
- winservice.js | Server background install on Windows.
+ amtevents.js | Used to decode Intel AMT WSMAN events.
+ amtmanager.js | Used to handle Intel AMT/CIRA things.
+ amtprovisioningserver.js | Used to Provision Intel AMT on a Local Network.
+ amtscanner.js | Used to scan a local network for Intel AMT machines.
+ amtscript.js | Used to run Intel AMT scripts from MeshCommander.
+ certoperations.js | Used to generate and perform certificate operations.
+ common.js | Various commonly used methods.
+ crowdsec.js | Used to handle all crowdsec security features
+ db.js | Used to access the MongoDB or NeDB database.
+ exeHandler.js | Used to modify windows executables.
+ firebase.js | Used to handle Google Firebase things.
+ interceptor.js | Used to insert credentials in an HTTP stream.
+ letsencrypt.js | Used to obtain and use a Let’s Encrypt certificate.
+ mcrec.js | Standalone Session Recording Indexer.
+ meshaccelerator.js | Used to offload RSA sign to other CPU cores.
+ meshagent.js | Used to communicate to agents.
+ meshbot.js | Sample bot to connect to meshcentral and preform various tasks
+ meshcentral.js | The is the main module, gets the server started.
+ meshctrl.js | MeshCtrl performs command line actions on a MeshCentral server.
+ meshcore.js | Main Agent Code that runs on your remote devices.
+ meshdesktopmultiplex.js | Used to handle remote desktop multiplexing.
+ meshdevicefile.js | Used to handle file download requests.
+ meshipkvm.js | Used to handle IP KVM integration
+ meshmail.js | Used to send SMTP mails.
+ meshmessaging.js | Used to handle all users messaging methods like 2FA.
+ meshrelay.js | Used to relay agent and browser web socket connections.
+ meshscanner.js | MeshCentral server discovery when in LAN mode.
+ meshsms.js | Used to handle all users sms methods.
+ meshuser.js | Used to communicate with browsers.
+ mpsserver.js | Used to communicate to Intel® AMT CIRA.
+ mqttbroker.js | Used to create/handle an MQTT broker (beta)
+ multiserver.js | Used for server-to-server communication.
+ pass.js | Performs password hash + salt.
+ redirserver.js | Used to handle HTTP traffic.
+ swarmserver.js | Used to upgrade legacy MeshCentralv1 agents.
+ webauthn.js | Handles all WebAuthN things.
+ webrelayserver.js | Used for all HTTP/HTTPS web relaying from agents.
+ webserver.js | Handles HTTPS traffic.
+ winservice.js | Server background install on Windows.
+
```
At a high level, the MeshCentral.js file will get the server started. By default, it will start the webserver.js on port 443, redirectserver.js on port 80 and mpssrver.js on port 4433. The webserver.js file will create a meshuser.js or meshagent.js instance each time a user or agent connects. The other files support various usages, but this is the basic working on the server.
diff --git a/docs/docs/how-to-contribute/images/translation-msg-output.png b/docs/docs/how-to-contribute/images/translation-msg-output.png
new file mode 100644
index 00000000..ab94a484
Binary files /dev/null and b/docs/docs/how-to-contribute/images/translation-msg-output.png differ
diff --git a/docs/docs/how-to-contribute/index.md b/docs/docs/how-to-contribute/index.md
new file mode 100644
index 00000000..ed3d87aa
--- /dev/null
+++ b/docs/docs/how-to-contribute/index.md
@@ -0,0 +1,56 @@
+# Contribute to MeshCentral
+
+## Contributing to MeshCentral via GitHub Pull Request
+
+If you're looking to contribute beyond translations, such as updating documentation or enhancing the software by adding features or fixing bugs, the process involves several key steps:
+
+1. **Fork the Repository:** Start by forking the [MeshCentral](https://github.com/Ylianst/MeshCentral) repository on GitHub. This creates a copy of the repository under your own GitHub account, allowing you to make changes without affecting the original project.
+
+2. **Make Your Changes**
+ - In your forked repository, create a new branch to keep your changes organized. This helps in managing different contributions separately.
+ - Make the necessary changes in your repository. This could involve updating documentation files or modifying code to add new features or fix bugs.
+
+3. **Review Your Changes:** Before submitting your work, carefully review the changes you’ve made. Check the "Files Changed" section on GitHub to ensure that all modifications are intended and correctly implemented.
+
+4. **Submit a Pull Request**
+ - Once your changes are ready and reviewed, submit a pull request (PR) from your branch to the `master` branch of the main MeshCentral repository.
+ - When creating the pull request, provide a clear and detailed description of what changes have been made and why. This helps maintainers understand the purpose of your contributions.
+
+5. **Wait for Review:** After submitting your pull request, wait for a project maintainer to review your contribution. Review time can vary depending on the complexity of the changes and the availability of the maintainers.
+
+6. **Respond to Feedback:** The maintainer may request further modifications or provide feedback on your pull request. Be prepared to make additional changes based on their suggestions to ensure that your contribution meets the project’s standards and requirements.
+
+7. **Final Steps:** Once your pull request is approved and merged by a maintainer, your contributions will be incorporated into the MeshCentral project. Congratulations, and thank you for helping improve MeshCentral!
+
+---
+
+## Contribute to MeshCentral's Multilingual Support
+
+To make MeshCentral multilingual, your contributions are crucial. Follow these steps to translate the interface into various languages.
+
+1. **Remove Local Translations:** Delete `translate.json` from your `meshcentral-data` folder. This file contains your local copy of translations, which may become outdated as new features and texts are added.
+
+2. **Access MeshCentral:** Ensure you are logged into MeshCentral.
+3. **Open Translation Tool:** Visit `https://YOURMESHCENTRALSERVER.COM/translator.htm` to access the translation interface.
+4. **Choose a Language:** Select the language you wish to translate from the list provided.
+
+5. **Translate Text:** Use the search function or scroll through the list to find text segments you want to translate. Utilize the "show no translations only" checkbox to filter untranslated texts.
+6. **Enter Translations:** For each text segment, enter your translation in the bottom box (not the top one) and click `SET (F1)`.
+7. **Repeat Translation:** Continue translating by repeating steps 5 and 6 for other texts as desired.
+
+8. **Save and Apply Translations**
+ - Click `SAVE TO SERVER (F3)` to save your translations to `meshcentral-data/translate.json` locally in your MeshCentral server.
+ - Optionally, click `SAVE TO FILE (F4)` to download the `translate.json` file for offline review or sharing.
+
+9. **Deploy Translations:** Click `TRANSLATE SERVER` and allow some time for the process to complete (approximately 5-15 minutes depending on server specifications). This command line output will indicate when the translation is complete.
+
+
+10. **Finalize Changes:** It’s crucial to restart MeshCentral to ensure that the translated files are picked up correctly.
+11. **Share your translations:** Once a language translation is complete, take the latest `translation.json` and share it by emailing it to the maintainer (Ylianst, `ylianst@gmail.com`) or by submitting it to the MeshCentral GitHub repository via a pull request.
+
+---
+
+#### Additional Information:
+ - If you make any changes to `default.handlebars`, run the translate server to propagate these modifications to the language-specific handlebar files located in `node_modules/meshcentral/views/translations`.
+
+By following these steps, you help MeshCentral support any language you choose, making it more accessible worldwide. By sharing your translations with us, you also help make these languages available to other users, improving the community and extending the software's reach.
diff --git a/docs/docs/index.md b/docs/docs/index.md
index c9b2b71b..fabdc903 100644
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
@@ -4,8 +4,6 @@
MeshCentral is a full computer management web site. With MeshCentral, you can run your own web server to remotely manage and control computers on a local network or anywhere on the internet. Once you get the server started, create device group and download and install an agent on each computer you want to manage. A minute later, the new computer will show up on the web site and you can take control of it. MeshCentral includes full web-based remote desktop, terminal and file management capability.
-To try out this software on the public server, please visit [MeshCentral.com/login](https://meshcentral.com/login). Be mindful that the public MeshCentral server comes with no guaranties, most should setup their own server.
-
For more information, [visit MeshCentral.com](https://www.meshcentral.com/).
## Social Media
@@ -14,17 +12,17 @@ For more information, [visit MeshCentral.com](https://www.meshcentral.com/).
[Reddit](https://www.reddit.com/r/MeshCentral/)
-[Twitter](https://twitter.com/MeshCentral)
+[BlueSky](https://bsky.app/profile/meshcentral.bsky.social)
[BlogSpot](https://meshcentral2.blogspot.com/)
## Documentation
-The [User's Guide](https://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2UserGuide.pdf) contains information every adminstrator should know including usage, the server configuration file, databases, TLS offloading, Lets Encrypt, IP Filtering, Email setup, embedding, server port aliasing, reverse proxy setup, multi factor authentication, branding & terms of use, HashiCorp Vault support, and SSO.
+The [User's Guide](meshcentral) contains information every administrator should know including usage, the server configuration file, databases, TLS offloading, Lets Encrypt, IP Filtering, Email setup, embedding, server port aliasing, reverse proxy setup, multi factor authentication, branding & terms of use, HashiCorp Vault support, and SSO.
-The [Installation Guide](https://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2InstallGuide.pdf) has detailed instructions for installing the MeshCentral Server on Windows 8.1, Windows 10, Windows 2012 R2, Amazon Linux 2, Raspberry Pi, Microsoft Azure, Google Cloud, Ubuntu 18, Ubuntu 16 and OpenBSD.
+The [Installation Guide](install/install2.md) has detailed instructions for installing the MeshCentral Server on Windows 8.1, Windows 10, Windows 2012 R2, Amazon Linux 2, Raspberry Pi, Microsoft Azure, Google Cloud, Ubuntu 18, Ubuntu 16 and OpenBSD.
-The [Design and Architecture Guide](https://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2DesignArchitecture.pdf) is a short document that includes information on the design overview, dependencies, source code descriptions of each file, certificates, TLS security, the agent to server handshake, browser to agent relay and WebRTC and the messenger service.
+The [Design and Architecture Guide](design) is a short document that includes information on the design overview, dependencies, source code descriptions of each file, certificates, TLS security, the agent to server handshake, browser to agent relay and WebRTC and the messenger service.
## Video Tutorials
diff --git a/docs/docs/install/index.md b/docs/docs/install/index.md
index 59e7b8da..988cf099 100644
--- a/docs/docs/install/index.md
+++ b/docs/docs/install/index.md
@@ -13,7 +13,7 @@ That's it. MeshCentral will set itself up and start managing computers on your l
For Windows users, you can download the MeshCentral Installer that will automate installation of NodeJS and provide basic configuration of the server. This option is not recommended for advanced users.
-[Win32 MeshCentral Installer](https://meshcentral.com/info/tools/MeshCentralInstaller.exe)
+[Win32 MeshCentral Installer](https://meshcentral.com/tools/MeshCentralInstaller.exe)
By default, MeshCentral will use NeDB as this is the built-in database. For more advanced users, it's recommended to switch to using MongoDB. MeshCentral can be installed on a very small server. A [Raspberry Pi](https://www.raspberrypi.org/) or [AWS t3.nano running Amazon Linux 2 instance](https://aws.amazon.com/ec2/pricing/on-demand/) for 5$ a month will do just fine for managing up to a few hundred devices.
@@ -23,10 +23,10 @@ You can run the MeshCentral Server with --help to get options for background ins
Once you get MeshCentral installed, the first user account that is created will be the server administrator. So, don't delay and navigate to the login page and create a new account. You can then start using your server right away. A lot of the fun with MeshCentral is the 100's of configuration options that are available in the config.json file. You can put your own branding on the web pages, setup a SMTP email server, SMS services and much more.
-You can look [here for simple config.json](https://raw.githubusercontent.com/Ylianst/MeshCentral/master/sample-config.json), [here for a more advanced configuration](https://raw.githubusercontent.com/Ylianst/MeshCentral/master/sample-config-advanced.json) and [here for all possible configuration options](https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json). You can also take a look at the [MeshCentral User's Guide](https://meshcentral.com/info/docs/MeshCentral2InstallGuide.pdf) and [tutorial videos](https://meshcentral.com/info/tutorials.html) for additional help.
+You can look [here for simple config.json](https://raw.githubusercontent.com/Ylianst/MeshCentral/master/sample-config.json), [here for a more advanced configuration](https://raw.githubusercontent.com/Ylianst/MeshCentral/master/sample-config-advanced.json) and [here for all possible configuration options](https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json). You can also take a look at the [tutorial videos](https://www.youtube.com/@MeshCentral/videos) for additional help.
## Video Walkthru
-
\ No newline at end of file
+
diff --git a/docs/docs/install/install2.md b/docs/docs/install/install2.md
index 94efa251..39312467 100644
--- a/docs/docs/install/install2.md
+++ b/docs/docs/install/install2.md
@@ -4,6 +4,45 @@
This guide is specifically intended to help users install MeshCentral from start to finish. Once installed, you can take a look at the MeshCentral user’s guide for information on how to configure MeshCentral for your specific use. In this document, we will look at installing MeshCentral on AWS Linux, Raspberry Pi and Ubuntu.
+## Docker
+
+
+
+```
+docker pull ghcr.io/ylianst/meshcentral:master
+```
+
+!!!warning
+ Do not use the built in mesh update function. Update docker the docker way.
+
+### Docker Compose
+
+```
+version: '3'
+services:
+ meshcentral:
+ restart: unless-stopped # always restart the container unless you stop it
+ image: ghcr.io/ylianst/meshcentral:1.1.27 # 1.1.27 is a version number OR use master for the master branch of bug fixes
+ ports:
+ - 80:80 # HTTP
+ - 443:443 # HTTPS
+ - 4433:4433 # AMT (Optional)
+ volumes:
+ - data:/opt/meshcentral/meshcentral-data # config.json and other important files live here
+ - user_files:/opt/meshcentral/meshcentral-files # where file uploads for users live
+ - backup:/opt/meshcentral/meshcentral-backups # location for the meshcentral backups - this should be mounted to an external storage
+ - web:/opt/meshcentral/meshcentral-web # location for site customization files
+volumes:
+ data:
+ driver: local
+ user_files:
+ driver: local
+ backup:
+ driver: local
+ web:
+ driver: local
+```
+
## Quick Start
For some who want to skip this document entirely, there are quick install scripts that will get a MeshCentral2 instance up and running on Linux in a few minutes. These scripts will pretty much do what this document explains very rapidly. Right now, there are two such scripts available:
@@ -13,7 +52,7 @@ For some who want to skip this document entirely, there are quick install script
For Amazon EC2 users, that want to manage 100 devices or less. Launch a t3.nano or t3.micro EC2 instance with Amazon Linux 2 with TCP ports 22 (SSH), 80 (HTTP), 443 (HTTPS) and 4433 (CIRA) open. Then login as `ec2-user` and enter the following commands:
```
-wget http://info.meshcentral.com/scripts/mc-aws-linux2.sh
+wget https://meshcentral.com/scripts/mc-aws-linux2.sh
chmod 755 mc-aws-linux2.sh
./mc-aws-linux2.sh
```
@@ -21,7 +60,7 @@ chmod 755 mc-aws-linux2.sh
This will download the fast install script and once run, will install nodejs, meshcentral, setup systemd and start the server. For a larger instance like a t3.small, t3.medium or larger you can run the following that does the same but also installs MongoDB.
```
-wget http://info.meshcentral.com/scripts/mc-aws-linux2-mongo.sh
+wget https://meshcentral.com/scripts/mc-aws-linux2-mongo.sh
chmod 755 mc-aws-linux2-mongo.sh
./mc-aws-linux2-mongo.sh
```
@@ -33,13 +72,19 @@ After these scripts are run, try accessing the server using a browser. MeshCentr
For 100 devices or less, launch an instance of Ubuntu 18.04 using a small B1s instance. Set the username to `default` in all lower case and open ports 22, 80, 443 and 3389 using the basic network profile. Then start the instance and run the following lines.
```
-wget http://info.meshcentral.com/scripts/mc-azure-ubuntu1804.sh
+wget https://meshcentral.com/scripts/mc-azure-ubuntu1804.sh
chmod 755 mc-azure-ubuntu1804.sh
./mc-azure-ubuntu1804.sh
```
In this situation, port 3389 will be used to receive Intel AMT CIRA connections instead of port 4433. After these scripts are run, try accessing the server using a browser. MeshCentral will take a minute or two to create certificates after that, the server will be up. The first account to be created will be the site administrator – so don’t delay and create an account right away. Once running, move on to the MeshCentral’s user’s guide to configure your new server.
+### Elestio
+
+You can deploy MeshCentral on Elestio using one-click deployment. Elestio handles version updates, maintenance, securtiy, backups, etc. Additionally, Elestio supports MeshCentral by providing revenue share so go ahead and click below to deploy and start using.
+
+[](https://elest.io/open-source/meshcentral)
+
## Server Security - Adding Crowdsec
MeshCentral has built-in support for a CrowdSec bouncer. This allows MeshCentral to get threat signals from the community and block or CAPTCHA requests coming from known bad IP addresses.
@@ -884,7 +929,7 @@ The last line will run MeshCentral manually and allow it to install any missing
```
sudo chown -R meshcentral:meshcentral /opt/meshcentral
-sudo chmod 755 –R /opt/meshcentral/meshcentral-*
+sudo chmod -R 755 /opt/meshcentral/meshcentral-*
```
To make this work, you will need to make MeshCentral work with MongoDB because the /meshcentral-data folder will be read-only. In addition, MeshCentral will not be able to update itself since the account does not have write access to the /node_modules files, so the update will have to be manual. First used systemctl to stop the MeshCentral server process, than use this:
@@ -901,7 +946,7 @@ This will perform the update to the latest server on NPM and re-set the permissi
MeshCentral allows users to upload and download files stores in the server’s `meshcentral-files` folder. In an increased security setup, we still want the server to be able to read and write files to this folder and we can allow this with:
```
-sudo chmod 755 –R /opt/meshcentral/meshcentral-files
+sudo chmod -R 755 /opt/meshcentral/meshcentral-files
```
If you plan on using the increased security installation along with MeshCentral built-in Let’s Encrypt support you will need to type the following commands to make the `letsencrypt` folder in `meshcentral-data` writable.
@@ -909,11 +954,19 @@ If you plan on using the increased security installation along with MeshCentral
```
sudo mkdir /opt/meshcentral/meshcentral-data
sudo mkdir /opt/meshcentral/meshcentral-data/letsencrypt
-sudo chmod 755 –R /opt/meshcentral/meshcentral-data/letsencrypt
+sudo chmod -R 755 /opt/meshcentral/meshcentral-data/letsencrypt
```
This will allow the server to get and periodically update its Let’s Encrypt certificate. If this is not done, the server will generate an `ACCES: permission denied` exception.
+### Restore backup in Ubuntu
+
+- Stop Meshcentral service `sudo systemctl stop meshcentral.service`
+- In your old server, get your backup : meshcentral-data folder, and mongodump-xxxx.archive
+- In the new server, replace the actual meshcentral-data with your backup (it will handle your LestEncrypt cert also)
+- Restore mongodb : mongorestore --archive=mongodump-xxxx.archive
+- Restart meshcentral.service `sudo systemctl start meshcentral.service`
+
## Microsoft Azure
In this section, we will look installing MeshCentral on Microsoft Azure. Microsoft Azure offers many operating system options and we will be selecting `Ubuntu Server` as our choice. From the Azure portal, we select `Virtual machines` on the left and `Add`.
diff --git a/docs/docs/intelamt/index.md b/docs/docs/intelamt/index.md
index b75b48f2..ad3c4986 100644
--- a/docs/docs/intelamt/index.md
+++ b/docs/docs/intelamt/index.md
@@ -195,6 +195,12 @@ Once Intel AMT is in a situation where ACM activation can occur, the activation
The best way to test this feature is to create an “Intel AMT only” device group and run the MeshCMD command on the remote system to perform activation. If there is a problem, this process should clearly display why ACM activation fails.
+!!!note
+ Activation over wifi has some additional issues.
+ First you need to add your WiFi access point to that wifi configuration to allow CSME to take over WiFi when OS is not functioning. Then it should work.
+ Please also make sure you install Intel WiFi driver and Intel LMS package. It should work. You can detach the ethernet and then try connecting to that device using the IP address acquired by WiFi interface.
+ See [Open AMT Cloud Toolkit](https://www.intel.com/content/www/us/en/developer/topic-technology/edge-5g/tools/open-amt-cloud-toolkit.html) project - a close relative to this project. It has an AMT activation component and newer remote provisioning client can activate locally and also can manage Wi-Fi profile.
+
## Intel AMT MEI and LMS
Intel Active Management Technology (Intel AMT) can communicate to the local platform using the Management Engine Interface (MEI). We show how your can use that to get Intel AMT information. For more advanced usages, you need to connect using TCP and TLS which requires Intel Local Manageability Service (LMS). We show how MeshCentral's Mesh Agent and MeshCMD have a small version of LMS built-in and how it works
diff --git a/docs/docs/meshcentral/agents.md b/docs/docs/meshcentral/agents.md
index d17e11be..6cba2f14 100644
--- a/docs/docs/meshcentral/agents.md
+++ b/docs/docs/meshcentral/agents.md
@@ -352,3 +352,11 @@ wpfhwacceleration (ON|OFF|STATUS)
```
zip (output file name), input1 [, input n]
```
+
+## Agent msh options
+
+You can find a full list of options for the agent [here](https://github.com/Ylianst/MeshAgent?tab=readme-ov-file#msh-format)
+
+`skipmaccheck=1`: Will not regenerate the agents nodeid and cause duplication of the agent when the MAC address changes.
+
+You can add options to your .msh on agent install with [this](https://github.com/Ylianst/MeshCentral/blob/15ff7d12a1e4e5d78936b473ea207b7e02b8ff26/meshcentral-config-schema.json#L2504)
diff --git a/docs/docs/meshcentral/assistant.md b/docs/docs/meshcentral/assistant.md
index 5da427ef..0462df3e 100644
--- a/docs/docs/meshcentral/assistant.md
+++ b/docs/docs/meshcentral/assistant.md
@@ -14,16 +14,28 @@
-## Agent Invitation Link
-
-For web page customization:
+## Agent Invitation
+Click on the 'Invite' button next to the device group name to access it.
+### Link Invitation
+For link invitation web page customization:
1. Alongside `meshcentral-data` create a folder called `meshcentral-web`
2. Create a `views` folder in it and copy the file `node_modules/meshcentral/views/invite.handlebars` into it.
-3. That copy will be served instead of the default one, you can customize as you want.
+3. That copy will be served instead of the default one, so you can customize it as you want.
+### Email Invitation
+This option will show up if you have an SMTP email server set up with MeshCentral.
+
+For invitation email customization:
+
+1. Alongside `meshcentral-data` create a folder called `meshcentral-web`
+2. Create an `emails` folder in it and copy the files `node_modules/meshcentral/emails/mesh-invite.txt` and `node_modules/meshcentral/emails/mesh-invite.html` into it.
+3. These copies will be used instead of the default ones, so you can customize them as you want.
+
+
+
## Email notification
You can also get an email notification when someone clicks the "Request Help" button in the Assistant agent.
diff --git a/docs/docs/meshcentral/codesigning.md b/docs/docs/meshcentral/codesigning.md
index 8fd46f7b..25e7a37a 100644
--- a/docs/docs/meshcentral/codesigning.md
+++ b/docs/docs/meshcentral/codesigning.md
@@ -73,7 +73,7 @@ When doing sign/unsign, you can also change resource properties of the generated
## Automatic Agent Code Signing
-If you want to self-sign the mesh agent so you can whitelist the software in your AV, and lock it to your server and organization.
+If you want to self-sign the mesh agent so you can whitelist the software in your AV, as well as lock it to your server and organization:
diff --git a/docs/docs/meshcentral/config.md b/docs/docs/meshcentral/config.md
index 1025b30e..92824f63 100644
--- a/docs/docs/meshcentral/config.md
+++ b/docs/docs/meshcentral/config.md
@@ -1,1442 +1,42 @@
# Configuration Options
-All possible configuration of MeshCentral can be found in this file:
+There are MANY configuration options available with meshcentral, search this file for options:
-See description for information about each item.
+Some options you can find relate to:
-```json
-{
- "id": "https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json",
- "$schema": "http://json-schema.org/draft-04/schema#",
- "description": "MeshCentral configuration file schema",
- "type": "object",
- "properties": {
- "settings": {
- "type": "object",
- "properties": {
- "cert": { "type": "string", "description": "Set this to the primary DNS name of this MeshCentral server." },
- "keepCerts": { "type": "boolean", "default": false, "description": "Force MeshCentral to use the HTTPS and MPS certificates even if the name does not match the expected DNS value." },
- "mongoDb": { "type": "string", "default": null },
- "mongoDbName": { "type": "string" },
- "mongoDbChangeStream": { "type": "boolean", "default": false },
- "mongoDbBulkOperations": { "type": "boolean", "default": false },
- "mariaDB": {
- "type": "object",
- "description": "Add this section to connect MeshCentral to a MariaDB database instance.",
- "properties": {
- "host": { "type": "string", "description": "MariaDB hostname" },
- "user": { "type": "string", "description": "MariaDB username" },
- "port": { "type": "number", "description": "MariaDB port number" },
- "password": { "type": "string", "description": "MariaDB password" },
- "connectionLimit": { "type": "number", "description": "MariaDB connection limit" },
- "database": { "type": "string", "default": "meshcentral", "description": "Name of MariaDB database used" },
- "awsrds": { "type": "boolean", "default": false, "description": "Set true to resolve LOCK TABLE permissions on AWS RDS." },
- "ssl": {
- "type": "object",
- "description": "SSL Options. Set to true (boolean) for default options.",
- "properties": {
- "caCertPath": { "type": "string", "description": "Absolute path to the CA certificate. Required for self-signed certificates" },
- "clientCertPath": { "type": "string", "description": "Absolute path to the client certificate. Required for two-way SSL Authentication" },
- "clientKeyPath": { "type": "string", "description": "Absolute path to the client key. Required for two-way SSL Authentication" },
- "dontCheckServerIdentity": { "type": "boolean", "description": "Set true to not check the server hostname during verification" }
- }
- }
- }
- },
- "sqlite3": { "type": "boolean", "default": false, "description": "Set true to use SQLite3 as a local MeshCentral database." },
- "mySQL": {
- "type": "object",
- "description": "Add this section to connect MeshCentral to a MySQL database instance.",
- "properties": {
- "host": { "type": "string", "description": "MySQL hostname" },
- "port": { "type": "number", "description": "MySQL port number" },
- "user": { "type": "string", "description": "MySQL username" },
- "password": { "type": "string", "description": "MySQL password" },
- "database": { "type": "string", "default": "meshcentral", "description": "Name of MySQL database used" },
- "awsrds": { "type": "boolean", "default": false, "description": "Set true to resolve LOCK TABLE permissions on AWS RDS." },
- "ssl": {
- "type": "object",
- "description": "SSL Options. Set to true (boolean) for default options.",
- "properties": {
- "caCertPath": { "type": "string", "description": "Absolute path to the CA certificate. Required for self-signed certificates" },
- "clientCertPath": { "type": "string", "description": "Absolute path to the client certificate. Required for two-way SSL Authentication" },
- "clientKeyPath": { "type": "string", "description": "Absolute path to the client key. Required for two-way SSL Authentication" },
- "dontCheckServerIdentity": { "type": "boolean", "description": "Set true to not check the server hostname during verification" }
- }
- }
- }
- },
- "postgres": {
- "type": "object",
- "description": "Add this section to connect MeshCentral to a PostgreSQL database instance.",
- "properties": {
- "host": { "type": "string", "description": "PostgreSQL hostname" },
- "user": { "type": "string", "description": "PostgreSQL username" },
- "port": { "type": "number", "description": "PostgreSQL port number" },
- "password": { "type": "string", "description": "PostgreSQL password" },
- "database": { "type": "string", "default": "meshcentral", "description": "Name of PostgreSQL database used" }
- }
- },
- "acebase": {
- "type": "object",
- "description": "Add this section to enable AceBase database support, this is a local database system much like NeDB.",
- "properties": { "sponsor": { "type": "boolean", "default": false, "description": "Set true to remove the AceBase banner on startup." } }
- },
- "WANonly": { "type": "boolean", "default": false, "description": "When enabled, only MeshCentral WAN features are enabled and agents will connect to the server using a well known DNS name." },
- "LANonly": { "type": "boolean", "default": false, "description": "When enabled, only MeshCentral LAN features are enabled and agents will find the server using multicast LAN packets." },
- "maintenanceMode": { "type": "boolean", "default": false, "description": "When enabled the server is in maintenance mode, only administrators can login. Use the maintenance command in server console to change." },
- "certificatePrivateKeyPassword": { "type": "array", "default": null, "description": "List of passwords used to decrypt PKCK#8 .key files that are in the meshcentral-data folder." },
- "sessionTime": { "type": "integer", "default": 60, "description": "Duration of a session cookie in minutes. Changing this affects how often the session needs to be automatically refreshed." },
- "sessionKey": { "type": "string", "default": null, "description": "Password used to encrypt the MeshCentral web session cookies. If null, a random one is generated each time the server starts." },
- "sessionSameSite": { "type": "string", "default": "lax", "enum": ["strict", "lax", "none"] },
- "dbEncryptKey": { "type": "string", "default": null, "description": "This value is only valid when used with NeDB, sets the database encryption and decryption key." },
- "dbRecordsEncryptKey": { "type": "string", "default": null, "description": "With any database, encrypt and decrypt sensitive information within records using this secret key." },
- "dbRecordsDecryptKey": { "type": "string", "default": null, "description": "With any database, decrypt sensitive information within records using this secret key, don't use a key to encrypt records." },
- "dbExpire": {
- "type": "object",
- "properties": {
- "events": { "type": "integer", "default": 1728000, "description": "Amount of time in seconds that events are kept in the database." },
- "powerevents": { "type": "integer", "default": 864000, "description": "Amount of time in seconds that device power events are kept in the database." },
- "statsevents": { "type": "integer", "default": 2592000, "description": "Amount of time in seconds that server statistics are kept in the database." }
- }
- },
- "port": { "type": "integer", "minimum": 1, "maximum": 65535, "default": 443, "description": "Ths port of the main HTTPS server." },
- "portBind": { "type": "string", "description": "When set, bind the HTTPS main port to a specific network address." },
- "aliasPort": { "type": "integer", "minimum": 1, "maximum": 65535, "default": null, "description": "The actual main port as seen externally on the Internet, this setting is often used when a reverse-proxy is used." },
- "redirPort": { "type": "integer", "minimum": 0, "maximum": 65535, "default": 80, "description": "This is a HTTP web server port that mostly redirects users to the HTTPS port but does provide some other services, 0 will turn this port off." },
- "redirPortBind": { "type": "string", "description": "When set, bind the HTTP redirection port to a specific network address." },
- "redirAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535, "description": "The actual redirection port as seen externally on the Internet, this setting is often used when a reverse-proxy is used." },
- "relayPort": { "type": "integer", "minimum": 0, "maximum": 65535, "default": 0, "description": "When set, a web relay web server is bound to this port and will allow user access to remote web sites." },
- "relayAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535, "default": null, "description": "The actual relay port as seen externally on the Internet, this setting is often used when a reverse-proxy is used." },
- "relayDNS": { "type": "string", "default": null, "description": "When set, relayPort value is ignored. Set this to a DNS name the points to this server. When the server is accessed using the DNS name, the main web server port is used as a web relay port." },
- "agentPort": { "type": "integer", "minimum": 1, "maximum": 65535, "description": "When set, enabled a new HTTPS server port that only accepts agent connections." },
- "agentPortBind": { "type": "string", "description": "When set, binds the agent port to a specific network interface." },
- "agentAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535, "description": "When set, indicates the actual publicly visible agent-only port. If not set, the AgentPort value is used." },
- "agentAliasDNS": { "type": "string", "format": "hostname", "description": "When set, specified the DNS name used by agents to connect to the agent-only port." },
- "agentPortTls": { "type": "boolean", "default": true, "description": "Indicates if the agent-only port must perform TLS, this should be set to false if TLS is performed in front of this server." },
- "agentLogDump": { "type": "boolean", "default": false, "description": "Automatically downloads all agent error logs into meshcentral-data/agenterrorlogs.txt." },
- "agentCoreDump": { "type": "boolean", "default": false, "description": "Automatically activates and transfers any agent crash dump files to the server in meshcentral-data/coredumps." },
- "agentCoreDumpUsers": { "type": "array", "description": "List of non-administrator users that have access to mesh agent crash dumps." },
- "agentSignLock": { "type": "boolean", "default": false, "description": "When code signing an agent using authenticode, lock the agent to only allow connection to this server. (This is in testing, the default value will change to true in the future)." },
- "agentTimeStampServer": { "type": [ "boolean", "string" ], "default": "http://timestamp.comodoca.com/authenticode", "description": "The time stamping server to use when code signing Windows executables. When set to false, the executables are not time stamped." },
- "agentTimeStampProxy": { "type": [ "boolean", "string" ], "description": "The HTTP proxy to use when contacting the time stamping server, if false, no proxy is used. By default, the npmproxy value is used." },
- "ignoreAgentHashCheck": { "type": [ "boolean", "string" ], "default": false, "description": "When true, the agent no longer checked the TLS certificate of the server. This should be used for debugging only. You can also set this to a comma separated list of IP addresses to ignore, for example: \"192.168.2.100,192.168.1.0/24\"." },
- "exactPorts": { "type": "boolean", "default": false, "description": "When set to true, MeshCentral will only grab the required TCP listening ports or fail. It will not try to use the next available port of it's busy." },
- "allowLoginToken": { "type": "boolean", "default": false },
- "StrictTransportSecurity": { "type": ["boolean", "string"], "default": null, "description": "Controls the Strict-Transport-Security header, default is 1 year. Set to false to remove, true to force enable, or string to set a custom value. If set to null, MeshCentral will enable if a trusted certificate is set." },
- "allowFraming": { "type": "boolean", "default": false, "description": "When enabled, the MeshCentral web site can be embedded within another website's iframe." },
- "cookieIpCheck": { "type": [ "string", "boolean" ], "default": "lax", "enum": ["strict", "lax", "none"] },
- "cookieEncoding": { "type": "string", "enum": [ "hex", "base64" ], "default": "base64", "description": "Encoding format of cookies in the HTTP headers, this is typically Base64 but some reverse proxies will require HEX." },
- "webRTC": { "type": "boolean", "default": false, "description": "When enabled, allows use of WebRTC to allow direct network traffic between the agent and browser." },
- "nice404": { "type": "boolean", "default": true, "description": "By default, a nice looking 404 error page is displayed when needed. Set this to false to disable it." },
- "selfUpdate": { "type": "boolean", "default": false, "description": "When true, this server will attempt to self-update everyday after midnight." },
- "cleanNpmCacheOnUpdate": { "type": "boolean", "default": false, "description": "When true, run \"npm cache clean --force\" to reclaim disk space." },
- "browserPing": { "type": "integer", "minimum": 1, "description": "When specified, sends data to the browser at x seconds interval and expects a response from the browser." },
- "browserPong": { "type": "integer", "minimum": 1, "description": "When specified, sends data to the browser at x seconds interval." },
- "agentsInRam": { "type": "boolean", "default": false, "description": "Loads all agent binaries in RAM for faster agent updates." },
- "agentPing": { "type": "integer", "minimum": 1, "description": "When specified, sends data to the agent at x seconds interval and expects a response from the agent." },
- "agentPong": { "type": "integer", "minimum": 1, "description": "When specified, sends data to the agent at x seconds interval." },
- "amtManager": { "type": "boolean", "default": true, "description": "When enabled, MeshCentral will automatically monitor and manage Intel AMT devices." },
- "orphanAgentUser": { "type": "string", "default": null, "description": "If an agent attempts to connect to a unknown device group, automatically create a new device group and grant access to the specified user. Example: admin" },
- "agentIdleTimeout": { "type": "integer", "minimum": 1, "default": 150 ,"description": "How much time in seconds with no traffic from an agent before dropping the agent connection." },
- "webPageLengthRandomization": { "type": "boolean", "default": true, "description": "Adds a random length string to generated web pages to mitigate a BREACH attack." },
- "compression": { "type": "boolean", "default": true, "description": "Enables GZIP compression for web requests." },
- "wsCompression": { "type": "boolean", "default": false, "description": "Enables server-side, websocket per-message deflate compression." },
- "agentWsCompression": { "type": "boolean", "default": true, "description": "Enables agent-side, websocket per-message deflate compression. wscompression must also be true for this to work." },
- "noAgentUpdate": { "type": "integer", "default": 0, "description": "Set to 1 to present the server from updating any agent." },
- "agentUpdateSystem": { "type": "integer", "default": 1, "description": "When set to 2, all agents that need to be updated will use the meshcore.js update system. With the default value of 1, the native update system is used." },
- "temporaryAgentUpdate": { "type": "boolean", "default": true, "description": "Set to false to not allow temporary agents to be updated." },
- "amtScanner": { "type": "boolean", "default": true, "description": "Set to false to disable Intel AMT scanning on the local network, this is already disabled in WAN mode." },
- "meshScanner": { "type": "boolean", "default": true, "description": "Set to false to disable agent multicast scanning on the local network, this is already disabled in WAN mode." },
- "meshErrorLogPath": { "type": "string" },
- "npmPath": { "type": "string" },
- "npmProxy": { "type": "string", "format": "uri" },
- "allowHighQualityDesktop": { "type": "boolean", "default": true, "description": "When false, users will only be able to set remote desktop image quality to 60%, this can reduce server bandwidth usage." },
- "webPush": {
- "type": "object",
- "description": "When set with a valid email address, enables the MeshCentral web push notification feature. Allows administrators to send browser notifications to users even if they are not looking at the MeshCentral web site.",
- "additionalProperties": false,
- "properties": {
- "email": { "type": "string", "description": "Server administrator email given to the FireFox and Chrome push notification services." }
- },
- "required": [ "email" ]
- },
- "RunOnServerStarted": { "type": "boolean", "default": null, "description": "Execute this when the server startup is completed. The first parameter will be the server version." },
- "RunOnServerUpdated": { "type": "boolean", "default": null, "description": "Execute this when the server has been updated. The first parameter will be the server version." },
- "RunOnServerError": { "type": "boolean", "default": null, "description": "Execute this when the server has to restart due to an error. The first parameter will be the server version." },
- "publicPushNotifications": { "type": "boolean", "default": false, "description": "When true, this server uses MeshCentral.com a push notification relay for Android notifications. Push notifications work even if the Android app is not open." },
- "desktopMultiplex": { "type": "boolean", "default": false, "description": "When true, enabled a server modules that efficiently splits a remote desktop stream to multiple browsers. Also allows slow browsers to not slow down the session for fast ones, this comes at the cost of extra server memory and processing for all remote desktop sessions." },
- "ipBlockedUserRedirect" : { "type": "string", "default": null, "description": "If set, a user from a banned IP address will be redirected to this URL." },
- "userAllowedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, only users from allowed IP address ranges can connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "userBlockedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, users from these denied IP address ranges will not be able to connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "agentAllowedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, only agents from allowed IP address ranges can connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "agentBlockedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, agents from these denied IP address ranges will not be able to connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "authLog": { "type": "string", "default": null, "description": "File path and name of the authentication log to be created. This log can be parsed by Fail2ban." },
- "InterUserMessaging": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "description": "Users in this list are allowed to send and receive inter-user messages. This can be used to implement bots or other software where MeshCentral is used as data transport. See \"interuser\" websocket command in the code." },
- "manageAllDeviceGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "description": "Users in this list are allowed to see and manage all device groups within their domain." },
- "manageCrossDomain": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "description": "Users in this list are allowed to manage all users in all domains." },
- "localDiscovery": {
- "type": "object",
- "description": "When this server is in LAN mode, you may discover this server using a multicast discovery tool. When discovery happens, the name and info fields are sent back to the discovery tool.",
- "additionalProperties": false,
- "properties": {
- "name": { "type": "string" },
- "info": { "type": "string" },
- "key": { "type": "string", "description": "When set, encrypts all LAN discovery traffic to agents and tools using this key. This is only useful in LAN/Hybrid mode when agents and tools user multicast to find the server." }
- },
- "required": [ "name", "info" ]
- },
- "tlsOffload": { "type": [ "boolean", "string" ], "default": false, "description": "When true, indicates that a TLS offloader is in front of the MeshCentral server. More typically, set this to the IP address of the reverse proxy or TLS offloader so that IP forwarding headers will be trusted. For example: \"127.0.0.1,192.168.1.100\"." },
- "trustedProxy": { "type": "string", "default": null, "description": "Trust forwarded headers from these IPs or domains. Providing the magic string \"CloudFlare\" will cause the server to download the IP address list of trusted CloudFlare proxies directly from CloudFlare on each server start. For example: \"127.0.0.1,proxy.example.com,CloudFlare\"." },
- "mpsPort": { "type": "integer", "minimum": 0, "maximum": 65535, "default": 4433, "description": "The Management Presence Server (MPS), this is the server that received Intel AMT Client Initiated Remote Access (CIRA) connections." },
- "mpsPortBind": { "type": "string", "default": null },
- "mpsAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535, "default": null },
- "mpsAliasHost": { "type": "string", "default": null },
- "mpsTlsOffload": { "type": "boolean", "default": false, "description": "When set to true, indicate that TLS is being performed by a device in front of MeshCentral." },
- "mpsHighSecurity": { "type": "boolean", "default": false, "description": "When set to true, the MPS server will only accept TLS 1.2 and 1.3 connections. Older Intel AMT devices will not be able to connect." },
- "no2FactorAuth": { "type": "boolean", "default": false },
- "log": { "type": "string", "default": null },
- "syslog": { "type": "string", "default": null },
- "syslogauth": { "type": "string", "default": null },
- "syslogjson": { "type": "string", "default": null },
- "syslogtcp": { "type": "string", "default": null, "description": "Send syslog events over the network (RFC3164) to a target hostname:port. For example: localhost:514" },
- "webrtcConfig": {
- "type": "object",
- "additionalProperties": false,
- "description": "The STUN servers used for WebRTC, if not specified the Google and Mozilla servers and used when the server is not in LAN mode.",
- "properties": {
- "iceServers": { "type": "array", "uniqueItems": true, "items": { "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "string" } }, "required": [ "urls" ] } }
- },
- "required": [ "iceServers" ]
- },
- "crowdsec": {
- "type": "object",
- "additionalProperties": true,
- "description": "Enabled the MeshCentral built-in Crowdsec bouncer. This section is passed directly to the bouncer, all of the settings are documented at https://www.npmjs.com/package/@crowdsec/express-bouncer",
- "properties": {
- "url": { "type": "string", "description": "The URL of your LAPI instance. Ex: http://localhost:8080" },
- "apiKey": { "type": "string", "description": "The bouncer key (generated via cscli)." },
- "fallbackRemediation": { "type": "string", "default": "ban", "enum": ["bypass", "captcha", "ban"], "description": "Action to perform if the CrowdSec agent can't be contacted." }
- },
- "required": [ "url", "apiKey" ]
- },
- "autoBackup": {
- "type": "object",
- "properties": {
- "mongoDumpPath": { "type": "string" },
- "mysqlDumpPath": { "type": "string" },
- "backupIntervalHours": { "type": "integer" },
- "keepLastDaysBackup": { "type": "integer" },
- "zipPassword": { "type": "string" },
- "backupPath": { "type": "string" },
- "googleDrive": {
- "type": "object",
- "description": "Enabled automated upload of the server backups to a Google Drive account, once enabled you need to go in \"My Server\" tab as administrator to associate the account.",
- "properties": {
- "folderName": {
- "type": "string",
- "default": "MeshCentral-Backups",
- "description": "The name of the folder to create in the Google Drive account."
- },
- "maxFiles": {
- "type": "integer",
- "default": null,
- "description": "The maximum number of files to keep in the Google Drive folder, older files will be removed if needed."
- }
- }
- },
- "webDAV": {
- "type": "object",
- "description": "Enabled automated upload of the server backups to a WebDAV account.",
- "properties": {
- "url": {
- "type": "string",
- "description": "WebDAV account URL."
- },
- "username": {
- "type": "string",
- "description": "WebDAV account username."
- },
- "password": {
- "type": "string",
- "description": "WebDAV account password."
- },
- "folderName": {
- "type": "string",
- "default": "MeshCentral-Backups",
- "description": "The name of the folder to create in the WebDAV account."
- },
- "maxFiles": {
- "type": "integer",
- "default": null,
- "description": "The maximum number of files to keep in the WebDAV folder, older files will be removed if needed."
- }
- }
- }
- }
- },
- "rootCertCommonName" : { "type": "string", "default": "MeshCentralRoot-XXXXXX", "description": "The common name of the MeshCentral server root certificate. By default it's 'MeshCentralRoot-' followed by the first 6 HEX digits of the public key fingerprint. For this setting to take effect, all generated certificates need to be deleted and reset. Existing agents will not be able to connect anymore." },
- "redirects": { "type": "object" },
- "maxInvalidLogin": {
- "type": "object",
- "additionalProperties": false,
- "description": "This section described a policy for how many times an IP address is allowed to attempt to login incorrectly. By default it's 10 times in 10 minutes, but this can be changed here.",
- "properties": {
- "exclude": { "type": "string", "default": null, "description": "Ranges of IP addresses that are not subject to invalid login limitations. For example: 192.168.1.0/24,172.16.0.1"},
- "time": { "type": "integer", "default": 10, "description": "Time in minutes over which the a maximum number of invalid login attempts is allowed from an IP address." },
- "count": { "type": "integer", "default": 10, "description": "Maximum number of invalid login attempts from an IP address in the time period." },
- "coolofftime": { "type": "integer", "default": null, "description": "Additional time in minute that login attempts will be denied once the invalid login limit is reached." }
- }
- },
- "maxInvalid2fa": {
- "type": "object",
- "additionalProperties": false,
- "description": "This section described a policy for how many times an IP address is allowed to attempt to perform two-factor authentication (2FA) incorrectly. By default it's 10 times in 10 minutes, but this can be changed here.",
- "properties": {
- "exclude": { "type": "string", "default": null, "description": "Ranges of IP addresses that are not subject to invalid 2FA limitations. For example: 192.168.1.0/24,172.16.0.1"},
- "time": { "type": "integer", "default": 10, "description": "Time in minutes over which the a maximum number of invalid 2FA attempts is allowed from an IP address." },
- "count": { "type": "integer", "default": 10, "description": "Maximum number of invalid 2FA attempts from an IP address in the time period." },
- "coolofftime": { "type": "integer", "default": null, "description": "Additional time in minute that 2FA attempts will be denied once the invalid 2FA limit is reached." }
- }
- },
- "amtProvisioningServer": {
- "type": "object",
- "additionalProperties": false,
- "required": [ "deviceGroup", "newMebxPassword", "trustedFqdn", "ip" ],
- "description": "When present, this section will enable the Intel AMT provisioning server on the local network. This is used for Intel AMT bare-metal ACM activation.",
- "properties": {
- "port": {
- "type": "number",
- "default": 9971,
- "description": "Port number that provisioning server will listen to."
- },
- "deviceGroup": {
- "type": "string",
- "description": "The agent-less device group to add Intel AMT devices to once they are activated. Must be of format: mesh/domain/id"
- },
- "newMebxPassword": {
- "type": "string",
- "description": "The MEBX password to set during activation. This password must be at least 8 characters long and have 1 lower, 1 upper, 1 alpha-numeric and 1 non-alpha numeric character."
- },
- "trustedFqdn": {
- "type": "string",
- "description": "The trusted FQDN or provisioning server value the remote device will have. This can be set in MEBx or using the DHCP server option 15 on the local network."
- },
- "ip": {
- "type": "string",
- "description": "The IP address of this server. This address will be used when creating the USB setup.bin file to indicate what IP address to send the hello data to."
- }
- }
- },
- "plugins": {
- "type": "object",
- "properties": { "enabled": { "type": "boolean" } },
- "required": [ "enabled" ]
- }
- }
- },
- "domaindefaults": { "$ref": "#/properties/domains/items" },
- "domains": {
- "type": "object",
- "items": {
- "type": "object",
- "properties": {
- "siteStyle": { "type": "integer", "default": 2, "description": "Valid numbers are 1 and 2, changes the style of the login page and some secondary pages." },
- "title": { "type": "string", "default": "MeshCentral", "description": "The title of this web site. All web pages will have this title." },
- "title2": { "type": "string", "default": null, "description": "Secondary title text that is placed on the upper right on the title on many web pages." },
- "titlePicture": { "type": "string", "default": null, "description": "Web site .png logo file that is 450x66 in size placed in meshcentral-data that is used on the top of many pages." },
- "loginPicture": { "type": "string", "default": null, "description": "Web site .png logo file placed in meshcentral-data that used on the login page when sitestyle is 2." },
- "rootRedirect": { "type": "string", "default": null, "description": "Redirects HTTP root requests to this URL. When in use, direct users to /login to see the normal login page." },
- "mobileSite": { "type": "boolean", "default": true, "description": "When set to false, this setting will disable the mobile site." },
- "maxDeviceView": { "type": "integer", "default": null, "description": "The maximum number of devices a user can see on the devices page at the same time. By default all devices will show, but this may need to be limited on servers with large number of devices." },
- "unknownUserRootRedirect": { "type": "string", "default": null, "description": "Redirects HTTP root requests to this URL only where user is not already logged in. When in use, direct users to /login to see the normal login page." },
- "nightMode": { "type": "integer", "default": 0, "description": "0 = User selects day/night mode, 1 = Always night mode, 2 = Always day mode" },
- "userQuota": { "type": "integer" },
- "meshQuota": { "type": "integer" },
- "loginKey": { "type": [ "string", "array" ], "items": { "type": "string" }, "default": null, "description": "Requires that users add the value ?key=xxx in the URL in order to see the web site." },
- "agentKey": { "type": [ "string", "array" ], "items": { "type": "string" }, "default": null, "description": "Requires that agents add the value ?key=xxx in the URL in order to connect. This is not automatic and needs to be manually added in the meshagent.msh file." },
- "ipkvm": { "type": "boolean", "default": false, "description": "Set to true to enable IP KVM device support in this domain." },
- "minify": { "type": "boolean", "default": false, "description": "When enabled, the server will send reduced sized web pages." },
- "newAccounts": { "type": "boolean", "default": false, "description": "When set to true, allow new user accounts to be created from the login page." },
- "newAccountsPass": { "type": "string", "default": null, "description": "When set this password will be required in order to create a new account from the login screen." },
- "newAccountsCaptcha": { "type": "boolean", "default": false, "description": "When set to true, users will get a CAPTCHA when creating a new account from the login screen." },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "userNameIsEmail": { "type": "boolean", "default": false, "description": "When enabled, the username of each account is also the email address of the account." },
- "newAccountEmailDomains": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "newAccountsRights": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "welcomeText": { "type": "string", "description": "Text that will be shown on the login screen." },
- "welcomePicture": { "type": "string", "description": "Name of the PNG or JPEG file that will be shown on the login screen. Put this file in the meshcentral-data folder and place the file name here." },
- "welcomePictureFullScreen": { "type": "boolean", "default": false, "description": "When enabled, the welcomePicture will show as a fullscreen background on the login screen." },
- "meshMessengerTitle": { "type": "string", "default": "MeshMessenger", "description": "Text that will be displayed on the top of the messenger window when no username or device name is displayed." },
- "meshMessengerPicture": { "type": "string", "default": null, "description": "Name of a .png image file that is placed in meshcentral-data that is displayed on the top of the messenger web page. When null, the default image is displayed." },
- "hide": { "type": "integer", "default": 0, "description": "Sum of: 1 = Hide header, 2 = Hide tab, 4 = Hide footer, 8 = Hide title, 16 = Hide left bar, 32 = Hide back buttons" },
- "footer": { "type": "string", "default": null, "description": "This is a HTML string displayed at the bottom of the web page when a user is logged in." },
- "loginfooter": { "type": "string", "default": null, "description": "This is a HTML string displayed at the bottom of the web page when a user is not logged in." },
- "allowSavingDeviceCredentials": { "type": "boolean", "default": true, "description": "Allow users to save SSH, RDP, VNC device credentials on the server that can be used by any other user." },
- "trustedCert": { "type": "boolean", "default": "This value is normally auto-detected, when set to true, MeshCentral assumes that the TLS certificate comes from a trusted CA and will insure download tools perform certificate checking." },
- "guestDeviceSharing": {
- "type": [ "boolean", "object" ],
- "default": true,
- "description": "When set to false, the desktop/terminal sharing link feature is not available.",
- "properties": {
- "maxSessionTime": { "type": "number", "description": "When set, limits the maximum length of a guest session, in minutes." }
- }
- },
- "autoRemoveInactiveDevices": { "type": "integer", "default": 0, "minimum": 0, "maximum": 2000, "description": "Number of days a device can be inactive before it's removed. 0 disables this feature. Device group setting will override this value." },
- "deviceSearchBarServerAndClientName": { "type": "boolean", "default": false, "description": "When set to true, the devices search box will match on both the server name and client name of a device." },
- "agentSelfGuestSharing": {
- "type": [ "boolean", "object" ],
- "default": false,
- "description": "When set to true, MeshCentral Assistant can create it's own guest sharing links.",
- "properties": {
- "expire": { "type": "number", "description": "When set, limits the self-created guest sharing link to this number of minutes." }
- }
- },
- "PreconfiguredScripts": {
- "type": "array",
- "default": null,
- "description": "When set, your can try click the run button to run on of these scripts on the remote device.",
- "items": {
- "type": "object",
- "required": [ "name", "type" ],
- "properties": {
- "name": {
- "description": "Name of the script.",
- "type": "string"
- },
- "type": {
- "description": "The type of script.",
- "type": "string",
- "enum": [ "bat", "ps1", "sh", "agent" ]
- },
- "runas": {
- "description": "How to run this script, does not apply to agent scripts.",
- "type": "string",
- "enum": ["agent", "userfirst", "user"]
- },
- "cmd": {
- "description": "The command or \\r\\n separated commands to run, if set do not use the file key.",
- "type": "string"
- },
- "file": {
- "description": "The script file path and name, if set do not use the cmd key. This file path starts in meshcentral-data.",
- "type": "string"
- }
- }
- }
- },
- "preConfiguredRemoteInput": {
- "type": "array",
- "default": null,
- "description": "When set, you can right click on the input button in the desktop tab and instantly remotely type one of these pre-configured strings.",
- "items": {
- "type": "object",
- "required": [ "name", "value" ],
- "properties": {
- "name": {
- "description": "Name of the text string.",
- "type": "string"
- },
- "value": {
- "description": "Text string that will be remotely typed when selected.",
- "type": "string"
- }
- }
- }
- },
- "altMessenging": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": { "type": "string", "description": "Name of the alternative messaging service, for example: \"Jitsi\" " },
- "url": { "type": "string", "description": "URL to the alternative messaging services, for example: \"https://meet.jit.si/myserver-{0}\", for a device {0}, {1}, {2}, {3} is the device id. For a user, {0} is the userid, {1} is full userid with dashes, {2} is real name with no spaces, {3} is real name with dash instead of spaces." },
- "localurl": { "type": "string", "description": "If specified, this is the URL that is used on the administrator side, for example: \"https://meet.jit.si/myserver-{0}\", for a device {0}, {1}, {2}, {3} is the device id. For a user, {0} is the userid, {1} is full userid with dashes, {2} is real name with no spaces, {3} is real name with dash instead of spaces." },
- "type": { "type": "string", "enum": [null, "user", "device"], "default": null, "description": "Indicate if this button should be shown in the user or device type. If omitted, it will be displayed in both." }
- },
- "required": [ "name", "url" ]
- }
- },
- "deviceMeshRouterLinks": {
- "rdp": { "type": "boolean", "default": true, "description": "Display a RDP link in the device tab when supported." },
- "ssh": { "type": "boolean", "default": true, "description": "Display a SSH link in the device tab when supported." },
- "scp": { "type": "boolean", "default": true, "description": "Display a SCP link in the device tab when supported." },
- "extralinks": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": false,
- "required": [ "name", "protocol", "port" ],
- "properties": {
- "name": {
- "description": "Name of the link to be displayed on the web site.",
- "type": "string"
- },
- "protocol": {
- "description": "Protocol. Valid values are: custom,http,https,rdp,ssh,scp,mcrdesktop,mcrfiles.",
- "type": "string"
- },
- "port": {
- "description": "The port on the remote device.",
- "default": 0,
- "minimum": 0,
- "maximum": 65535,
- "type": "integer"
- },
- "ip": {
- "description": "Target IP address. If not specified, the target of the connection is the remote device running the MeshAgent.",
- "type": "string"
- },
- "localport": {
- "description": "The local port MeshCentral Router would bind to. By default, a random available port is used.",
- "default": 0,
- "minimum": 0,
- "maximum": 65535,
- "type": "integer"
- },
- "filter": {
- "description": "Array of node// or mesh// or tag: strings. When set, the link will only show up for the specified devices, device groups or device tag.",
- "type": "array",
- "items": { "type": "string" }
- }
- }
- }
- }
- },
- "certUrl": {
- "type": "string",
- "format": "uri",
- "description": "https url when to get the TLS certificate that MeshAgent's will see when connecting to this server. This setting is used when a reverse proxy like NGINX is used in front of MeshCentral."
- },
- "myServer": {
- "type": [ "object", "boolean" ],
- "additionalProperties": false,
- "properties": {
- "Backup": { "type": "boolean", "default": true, "description": "Allows administrators to backup the server from the My Server tab. This option can only enabled when the NeDB database is in use. For other databases, this option disabled and the setting is ignored." },
- "Restore": { "type": "boolean", "default": true, "description": "Allows administrators to restore the server from the My Server tab. This option can only enabled when the NeDB database is in use. For other databases, this option disabled and the setting is ignored." },
- "Upgrade": { "type": "boolean", "default": true, "description": "Allows administrators to update the server from the My Server tab." },
- "ErrorLog": { "type": "boolean", "default": true, "description": "Allows administrators to see the server crash log the server from the My Server tab." },
- "Console": { "type": "boolean", "default": true, "description": "Allows administrators to access the server console from the My Server tab." },
- "Trace": { "type": "boolean", "default": true, "description": "Allows administrators to access the server trace tab from from the My Server tab." }
- }
- },
- "passwordRequirements": {
- "type": "object",
- "properties": {
- "min": { "type": "integer", "description": "Minimum number of characters allowed for the account password." },
- "max": { "type": "integer", "description": "Maximum number of characters allowed for the account password." },
- "upper": { "type": "integer", "description": "Minimum number of upper case characters required in the password." },
- "lower": { "type": "integer", "description": "Minimum number of lower case characters required in the password." },
- "numeric": { "type": "integer", "description": "Minimum number of numeric characters required in the password." },
- "nonalpha": { "type": "integer", "description": "Minimum number of non-alpha-numeric characters required in the password." },
- "reset": { "type": "integer", "description": "Number of days after which the user is required to change the account password." },
- "email2factor": { "type": "boolean", "default": true, "description": "Set to false to disable email 2FA." },
- "sms2factor": { "type": "boolean", "default": true, "description": "Set to false to disable SMS 2FA." },
- "push2factor": { "type": "boolean", "default": true, "description": "Set to false to disable push notification 2FA." },
- "otp2factor": { "type": "boolean", "default": true, "description": "Set to false to disable one-time-password 2FA." },
- "msg2factor": { "type": "boolean", "default": true, "description": "Set to false to disable user messaging 2FA." },
- "backupcode2factor": { "type": "boolean", "default": true, "description": "Set to false to disable 2FA backup codes." },
- "single2factorWarning": { "type": "boolean", "default": true, "description": "Set to false to disable single 2FA warning." },
- "lock2factor": { "type": "boolean", "default": false, "description": "When set to true, prevents any changes to 2FA." },
- "force2factor": { "type": "boolean", "default": false, "description": "Requires that all accounts setup 2FA." },
- "skip2factor": { "type": "string", "description": "IP addresses where 2FA login is skipped, for example: 127.0.0.1,192.168.2.0/24" },
- "oldPasswordBan": { "type": "integer", "description": "Number of old passwords the server should remember and not allow the user to switch back to." },
- "banCommonPasswords": { "type": "boolean", "default": false, "description": "Uses WildLeek to block use of the 10000 most commonly used passwords." },
- "loginTokens": { "type": [ "boolean", "array" ], "default": true, "description": "Allows users to create alternative username/passwords for their account. Set to false to disallow all users, or set to a userid array to only all some users." },
- "twoFactorTimeout": { "type": "integer", "default": 300, "description": "Maximum about of time the to wait for a 2FA token on the login page in seconds." },
- "autofido2fa": { "type": "boolean", "default": false, "description": "If true and user account has FIDO key setup, 2FA login screen will automatically request FIDO 2FA." },
- "maxfidokeys": { "type": "integer", "default": null, "description": "Maximum number of FIDO/YubikeyOTP hardware 2FA keys that can be setup in a user account." },
- "allowaccountreset": { "type": "boolean", "default": true, "description": "If set to false, the account reset option on the login screen will not be available to users." }
- }
- },
- "twoFactorCookieDurationDays": { "type": "integer", "default": 30, "description": "Number of days that a user is allowed to remember this device for when completing 2FA. Set this to 0 to remove this option." },
- "auth": { "type": "string", "default": null, "enum": [null, "sspi", "ldap"], "description": "Type of user authentication to use, this can be SSPI on Windows or LDAP. If not set, username/password is used." },
- "ldapUserKey": { "type": "string", "default": null, "description": "The LDAP value to use as a user's unique account identifier. Use \"ldapUserKey\" or \"ldapUserBinaryKey\"." },
- "ldapUserBinaryKey": { "type": "string", "default": "objectSid", "description": "The LDAP value to use as a user's unique account identifier, when specified in this field, the values will be HEX converted." },
- "ldapUserName": { "type": "string", "default": "displayName", "description": "The LDAP value to use for the user name, you can also compose the name by setting this value to, for example: \"{{{givenName}}} {{{sn}}}\"" },
- "ldapUserEmail": { "type": "string", "default": "mail", "description": "The LDAP value to use for the user's email address." },
- "ldapUserRealName": { "type": "string", "default": "name", "description": "The LDAP value to use for the user's real name, you can also compose the name by setting this value to, for example: \"{{{givenName}}} {{{sn}}}\"" },
- "ldapUserPhoneNumber": { "type": "string", "default": "telephoneNumber", "description": "The LDAP value to use for the user's phone number." },
- "ldapUserImage": { "type": "string", "default": "thumbnailPhoto", "description": "The LDAP value to use for the user's image." },
- "ldapSaveUserToFile": { "type": "string", "default": null, "description": "When set to a filename, for example c:\\temp\\ldapusers.txt, MeshCentral will save the LDAP user object to this file each time a user logs in. This is used for debugging LDAP issues." },
- "ldapUserGroups": { "type": "string", "default": "memberOf", "description": "The LDAP value to use for the user's group memberships." },
- "ldapSyncWithUserGroups": {
- "type": [ "boolean", "object" ],
- "default": false,
- "description": "When set to true or set to an object, MeshCentral will synchronize LDAP user memberships to MeshCentral user groups.",
- "additionalProperties": false,
- "properties": {
- "filter": {
- "type": [ "string", "array" ],
- "default": null,
- "description": "When set to a string or array of strings, only LDAP membership groups that includes one of the strings will be synchronized with MeshCentral user groups."
- }
- }
- },
- "ldapSiteAdminGroups": {
- "type": [ "string", "array" ],
- "default": null,
- "description": "When set to a list of LDAP groups, users that are part of one of these groups will be set a site administrator, otherwise site administrator rights will be removed."
- },
- "ldapUserRequiredGroupMembership": { "type": [ "string", "array" ], "default": null, "description": "A list of LDAP groups. Users must be part of at least one of these groups to allow login. If null, all users are allowed to login." },
- "ldapOptions": { "type": "object", "description": "LDAP options passed to ldapauth-fork" },
- "agentInviteCodes": { "type": "boolean", "default": false, "description": "Enabled a feature where you can set one or more invitation codes in a device group. You can then give a invitation link to users who can use it to download the agent." },
- "agentNoProxy": { "type": "boolean", "default": false, "description": "When enabled, all newly installed MeshAgents will be instructed to no use a HTTP/HTTPS proxy even if one is configured on the remote system" },
- "agentTag": {
- "type": "object",
- "description": "This section is used to indicate if parts of the meshagent.tag file should be used to set server-side device properties.",
- "additionalProperties": false,
- "properties": {
- "ServerName": { "type": "integer", "default": 0, "description": "Action taken if one of the lines in meshagent.tag contains ~ServerName:name. 0=Ignore, 1=Set." },
- "ServerDesc": { "type": "integer", "default": 0, "description": "Action taken if one of the lines in meshagent.tag contains ~ServerDesc:desc. 0=Ignore, 1=Set, 2=SetIfEmpty." },
- "ServerTags": { "type": "integer", "default": 0, "description": "Action taken if one of the lines in meshagent.tag contains ~ServerTags:tag1,tag2,tag3. 0=Ignore, 1=Set, 2=SetIfEmpty, 3=Append." }
- }
- },
- "geoLocation": { "type": "boolean", "default": false, "description": "Enables the geo-location feature and device location map in the user interface, this feature is not being worked on." },
- "novnc": { "type": "boolean", "default": true, "description": "When enabled, activates the built-in web-based VNC client." },
- "mstsc": { "type": "boolean", "default": false, "description": "When enabled, activates the built-in web-based RDP client." },
- "ssh": { "type": "boolean", "default": false, "description": "When enabled, activates the built-in web-based SSH client." },
- "webEmailsPath": { "type": "string", "description": "Path where to find custom email templates for this domain." },
- "customUI": { "type": "object" },
- "consentMessages": {
- "type": "object",
- "description": "This section is used to customize user consent prompts, these show up when asking if a remote session is allowed or not.",
- "additionalProperties": false,
- "properties": {
- "Title": { "type": "string" },
- "Desktop": { "type": "string" },
- "Terminal": { "type": "string" },
- "Files": { "type": "string" },
- "consentTimeout": { "type": "integer", "default": 30, "description": "How long in seconds to show the user consent dialog box." },
- "autoAcceptOnTimeout": { "type": "boolean", "default": false, "description": "If true, user consent is accepted after the timeout." }
- }
- },
- "notificationMessages": {
- "type": "object",
- "additionalProperties": false,
- "description": "This section is user to customize user notifications when a remote desktop, terminal or file session is connected to a remote system.",
- "properties": {
- "Title": { "type": "string" },
- "Desktop": { "type": "string" },
- "Terminal": { "type": "string" },
- "Files": { "type": "string" }
- }
- },
- "agentCustomization": {
- "type": "object",
- "additionalProperties": false,
- "description": "Use this section to customize the agent branding.",
- "properties": {
- "displayName": { "type": "string", "default": "MeshCentral Agent", "description": "The name of the agent as displayed to the user." },
- "description": { "type": "string", "default": "Mesh Agent background service", "description": "The description of the agent as displayed to the user." },
- "companyName": { "type": "string", "default": "Mesh Agent", "description": "This will be used as the path to install the agent, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's." },
- "serviceName": { "type": "string", "default": "Mesh Agent", "description": "The name of the background service, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's but should be set to an all lower case, no space string." },
- "installText": { "type": "string", "default": null, "description": "Text string to show in the agent installation dialog box." },
- "image": { "type": "string", "default": null, "description": "The filename of a image file in .png format located in meshcentral-data to display in the MeshCentral Agent installation dialog, image should be square and from 64x64 to 200x200." },
- "fileName": { "type": "string", "default": "meshagent", "description": "The agent filename." },
- "foregroundColor": { "type": "string", "default": null, "description": "Foreground text color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF." },
- "backgroundColor": { "type": "string", "default": null, "description": "Background color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF." }
- }
- },
- "agentFileInfo": {
- "type": "object",
- "additionalProperties": false,
- "description": "Use this section to set resource metadata of the Windows agents prior to signing. In Windows, you can right-click and select properties to view these values.",
- "properties": {
- "icon": { "type": "string", "description": "Sets the agent icon, this is the name of a .ico file with the file placed in the meshcentral-data folder." },
- "fileDescription": { "type": "string", "description": "Executable file description." },
- "fileVersion": { "type": "string", "description": "Executable file version, in the form of 'n.n.n.n', for example: '1.2.3.4'." },
- "internalName": { "type": "string", "description": "Executable internal name." },
- "legalCopyright": { "type": "string", "description": "Executable legal copyright." },
- "originalFilename": { "type": "string", "description": "Executable original file name." },
- "productName": { "type": "string", "description": "Executable product name." },
- "productVersion": { "type": "string", "description": "Executable product version. Any string format will work, but a alphabetic character is required for this value to show correctly in the Windows property box. For example: 'v1.2.3.4' will work, but '1.2.3.4' will not." }
- }
- },
- "assistantCustomization": {
- "type": "object",
- "additionalProperties": false,
- "description": "Use this section to customize the MeshCentral Assistant.",
- "properties": {
- "title": { "type": "string", "default": "MeshCentral Assistant", "description": "Name to show as MeshCentral Assistant dialog title." },
- "image": { "type": "string", "default": null, "description": "The filename of a image file in .png format located in meshcentral-data to display in MeshCentral Assistant, image should be square and from 64x64 to 128x128." },
- "fileName": { "type": "string", "default": "meshagent", "description": "The MeshCentral Assistant filename." }
- }
- },
- "androidCustomization": {
- "type": "object",
- "additionalProperties": false,
- "description": "Use this section to customize the MeshCentral Agent for Android.",
- "properties": {
- "title": { "type": "string", "default": "MeshCentral Agent", "description": "Displayed on top of the MeshCentral Agent for Android." },
- "subtitle": { "type": "string", "default": null, "description": "Subtitle displayed until the title on the toolbar." },
- "image": { "type": "string", "default": null, "description": "The filename of a image file in .png format located in meshcentral-data to display in MeshCentral Agent for Android, image should be square and from 64x64 to 128x128." }
- }
- },
- "ipBlockedUserRedirect" : { "type": "string", "default": null, "description": "If set, a user from a banned IP address will be redirected to this URL." },
- "userRequiredHttpHeader": { "type": "object", "default": null, "description": "When set, requires that a browser request have set HTTP header to allow user login. Example: \"{ \"Sec-Fetch-Dest\": \"iframe\" }\"" },
- "userAllowedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, only users from allowed IP address ranges can connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "userBlockedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, users from these denied IP address ranges will not be able to connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "agentAllowedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, only agents from allowed IP address ranges can connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "agentBlockedIP": { "type": [ "string", "array" ], "default": null, "description": "When set, agents from these denied IP address ranges will not be able to connect to the server. Example: \"192.168.2.100,192.168.1.0/24\"" },
- "userSessionIdleTimeout": { "type": "integer", "default": null, "description": "When set, idle users will be disconnected after a set amounts of minutes." },
- "userConsentFlags": {
- "type": "object",
- "additionalProperties": false,
- "description": "Use this section to require user consent for this domain.",
- "properties": {
- "desktopnotify": { "type": "boolean", "default": false, "description": "Enable desktop notification for this domain." },
- "terminalnotify": { "type": "boolean", "default": false, "description": "Enable terminal notification for this domain." },
- "filenotify": { "type": "boolean", "default": false, "description": "Enable files notification for this domain." },
- "desktopprompt": { "type": "boolean", "default": false, "description": "Enable desktop prompt for this domain." },
- "terminalprompt": { "type": "boolean", "default": false, "description": "Enable terminal user prompt for this domain." },
- "fileprompt": { "type": "boolean", "default": false, "description": "Enable files prompt for this domain." },
- "desktopprivacybar": { "type": "boolean", "default": false, "description": "Enable remote desktop privacy bar for this domain." }
- }
- },
- "urlSwitching": { "type": "boolean", "default": true, "description": "When users navigate thru the web interface, the URL on top will change to point to the current screen. This allows a user to refresh or bookmark the URL and come back to the correct screen. Setting false here will disable this feature." },
- "desktopPrivacyBarText": { "type": "string", "description": "This is the text that will be shown in the remote desktop privacy bar. You can use {0} to display the account realname or {1} to display the account identifier in the string." },
- "limits": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "MaxDevices": { "type": "integer", "default": null, "description": "Maximum number of devices in this domain." },
- "MaxUserAccounts": { "type": "integer", "default": null, "description": "Maximum number of devices in this domain." },
- "MaxUserSessions": { "type": "integer", "default": null, "description": "Maximum number of user sessions that can connect to this server for this domain." },
- "MaxAgentSessions": { "type": "integer", "default": null, "description": "Maximum number of agents that can connect to this server for this domain." },
- "MaxSingleUserSessions": { "type": "integer", "default": null, "description": "Maximum number of sessions a single user can have. Each time a user opens a new browser tab or opens a new browser on a different computer, a new user session is created." }
- }
- },
- "files": {
- "type": "object",
- "description": "Values that affect the files feature",
- "properties": {
- "sftpConnect" : { "type": "boolean", "default": true, "description": "When false, removes the 'SFTP Connect' button from the files tab unless this is the only possible option." }
- }
- },
- "terminal": {
- "type": "object",
- "description": "Values that affect the terminal feature",
- "properties": {
- "sshConnect" : { "type": "boolean", "default": true, "description": "When false, removes the 'SSH Connect' button from the terminal tab unless this is the only possible option." },
- "linuxShell": {
- "type": "string",
- "enum": [ "any", "root", "user", "login" ],
- "default": "any",
- "description": "Indicate what terminal options are available when the user clicks the right mouse button on the terminal connect button."
- },
- "launchCommand": {
- "type": "object",
- "description": "Indicate what string the agent must write to the shell after starting a terminal session",
- "linux": { "type": "string", "default": " alias ls=\\'ls --color=auto\\';clear\\n", "description": "String to write after opening a Linux terminal." },
- "darwin": { "type": "string", "default": null, "description": "String to write after opening a macOS terminal." },
- "freebsd": { "type": "string", "default": null, "description": "String to write after opening a FreeBSD terminal." }
- }
- }
- },
- "desktop": {
- "type": "object",
- "description": "Values that affect the desktop feature",
- "properties": {
- "viewonly": {
- "type": "boolean",
- "description": "When set to true, the remote desktop feature is view only.",
- "default": "false"
- }
- }
- },
- "amtScanOptions": {
- "description": "List of local network Intel AMT scanning options offered in the user interface. For example [\"LabNetwork 192.168.15.0/23\", \"SalesNetwork 192.168.8.0/24\"].",
- "type": "array",
- "default": null,
- "items": { "type": "string" }
- },
- "amtManager": {
- "type": "object",
- "additionalProperties": false,
- "description": "Information passed to the AMT manager module that impacts all Intel AMT device managed within this domain.",
- "properties": {
- "TlsConnections": { "type": "boolean", "default": true, "description": "When set to false, MeshCentral will use TLS to connect to Intel AMT, this is not recommended." },
- "TlsAcmActivation": { "type": "boolean", "default": false, "description": "When set to false, MeshCentral will not attempt a TLS ACM activation on Intel AMT v14+" },
- "AdminAccounts": {
- "description": "List of username and passwords to try when connecting to Intel AMT.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": false,
- "required": [ "pass" ],
- "properties": {
- "user": {
- "description": "Intel AMT administrator username.",
- "type": "string",
- "default": "admin"
- },
- "pass": {
- "description": "Intel AMT administrator password.",
- "type": "string"
- }
- }
- }
- },
- "EnvironmentDetection": {
- "description": "List of up to 4 domain suffixes to configure in Intel AMT when activating CIRA.",
- "type": "array",
- "items": {
- "type": "string",
- "minItems": 1,
- "maxItems": 4,
- "uniqueItems": true
- }
- },
- "TlsRootCert": {
- "description": "Specifies a certificate and private key to use to issue Intel AMT TLS certificates. By default the MeshCentral self-signed root certificate is used.",
- "type": "object",
- "properties": {
- "certpfx": {
- "description": "Name of the certificate file that is in .p12 or .pfx format in meshcentral-data, use this with certpfxpass.",
- "type": "string"
- },
- "certpfxpass": {
- "description": "Password for the file specified in certpfx.",
- "type": "string"
- },
- "certfile": {
- "description": "Name of the certificate file in PEM format located in meshcentral-data. Using this with keyfile.",
- "type": "string"
- },
- "keyfile": {
- "description": "Name of the private key file in PEM format located in meshcentral-data. Using this with certfile.",
- "type": "string"
- }
- }
- },
- "WifiProfiles": {
- "description": "List of WIFI profiles to setup in any managed Intel AMT device with a WIFI network interface.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": false,
- "required": [ "ssid" ],
- "properties": {
- "name": {
- "description": "WIFI profile name, if not specified the SSID is used.",
- "type": "string"
- },
- "ssid": {
- "description": "SSID of the WIFI station.",
- "type": "string"
- },
- "authentication": {
- "description": "WIFI authentication.",
- "type": "string",
- "enum": [ "wpa-psk", "wpa2-psk", "wpa-8021x", "wpa2-802.1x", "wpa3-sae-802.1x", "wpa3-owe-802.1x" ],
- "default": "wpa2-psk"
- },
- "encryption": {
- "description": "WIFI encryption.",
- "type": "string",
- "enum": [ "ccmp-aes", "tkip-rc4" ],
- "default": "ccmp-aes"
- },
- "password": {
- "description": "Password on the WIFI station",
- "type": "string",
- "minLength": 8,
- "maxLength": 63
- },
- "802.1x": {
- "description": "802.1x settings for this WIFI profile. Only required if the WIFI authentication type has 802.1x",
- "default": null,
- "type": "object",
- "additionalProperties": false,
- "required": [ "authenticationProtocol" ],
- "properties": {
- "authenticationProtocol": {
- "description": "Identifies the authentication protocol used to authenticate the access requestor to the AAA server.",
- "type": [ "integer", "string" ],
- "enum": [ "EAP-TLS", "EAP-TTLS/MSCHAPv2", "PEAPv0/EAP-MSCHAPv2", "PEAPv1/EAP-GTC", "EAP-FAST/MSCHAPv2", "EAP-FAST/GTC", "EAP-MD5", "EAP-PSK", "EAP-SIM", "EAP-AKA", "EAP-FAST/TLS", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
- },
- "serverCertificateNameComparison": {
- "type": [ "integer", "string" ],
- "default": "FullName",
- "description": "Determines the comparison algorithm used between the ServerCertificateName value and the subject name field of the certificate presented by the AAA server.",
- "enum": [ "FullName", "DomainSuffix", 2, 3 ]
- },
- "serverCertificateName": {
- "type": "string",
- "default": null,
- "description": "The name compared against the subject name field in the certificate provided by the AAA server.",
- "maxLength": 80
- },
- "availableInS0": {
- "type": "boolean",
- "default": true,
- "description": "Indicates the activity setting of the 802.1X module in H0 state"
- },
- "protectedAccessCredentialHex": {
- "type": "string",
- "default": null,
- "description": "A credential used by the supplicant and AAA server to establish a mutually authenticated encrypted tunnel for confidential user authentication.",
- "maxLength": 64
- },
- "pacPassword": {
- "type": "string",
- "default": null,
- "description": "Optional password to extract the PAC (Protected Access Credential) information from the PAC data.",
- "maxLength": 256
- },
- "domain": {
- "type": "string",
- "default": null,
- "description": "The domain within which Username is unique.",
- "maxLength": 128
- },
- "username": {
- "type": "string",
- "default": null,
- "description": "Within the domain specified by Domain, Identifies the user that is requesting access to the network.",
- "maxLength": 128
- },
- "password": {
- "type": "string",
- "default": null,
- "description": "The password associated with the user identified by Username and Domain.",
- "maxLength": 32
- },
- "roamingIdentity": {
- "type": "string",
- "default": null,
- "description": "A string presented to the authentication server in 802.1x protocol exchange",
- "maxLength": 80
- },
- "pxeTimeoutInSeconds": {
- "type": "integer",
- "default": 120,
- "description": "Timeout in seconds, in which the Intel(R) AMT will hold an authenticated 802.1X session."
- }
- }
- }
- }
- }
- },
- "802.1x": {
- "description": "802.1x settings for the Intel AMT Wired interface. If set to false, any existing 802.1x wired profile will be removed from Intel AMT.",
- "default": null,
- "type": [ "object", "boolean" ],
- "additionalProperties": false,
- "required": [ "authenticationProtocol" ],
- "properties": {
- "authenticationProtocol": {
- "description": "Identifies the authentication protocol used to authenticate the access requestor to the AAA server.",
- "type": [ "integer", "string" ],
- "enum": [ "EAP-TLS", "EAP-TTLS/MSCHAPv2", "PEAPv0/EAP-MSCHAPv2", "PEAPv1/EAP-GTC", "EAP-FAST/MSCHAPv2", "EAP-FAST/GTC", "EAP-MD5", "EAP-PSK", "EAP-SIM", "EAP-AKA", "EAP-FAST/TLS", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
- },
- "serverCertificateNameComparison": {
- "type": [ "integer", "string" ],
- "description": "Determines the comparison algorithm used between the ServerCertificateName value and the subject name field of the certificate presented by the AAA server.",
- "enum": [ "FullName", "DomainSuffix", 2, 3 ]
- },
- "serverCertificateName": {
- "type": "string",
- "default": null,
- "description": "The name compared against the subject name field in the certificate provided by the AAA server.",
- "maxLength": 80
- },
- "availableInS0": {
- "type": "boolean",
- "default": true,
- "description": "Indicates the activity setting of the 802.1X module in H0 state"
- },
- "protectedAccessCredentialHex": {
- "type": "string",
- "default": null,
- "description": "A credential used by the supplicant and AAA server to establish a mutually authenticated encrypted tunnel for confidential user authentication.",
- "maxLength": 64
- },
- "pacPassword": {
- "type": "string",
- "default": null,
- "description": "Optional password to extract the PAC (Protected Access Credential) information from the PAC data.",
- "maxLength": 256
- },
- "domain": {
- "type": "string",
- "default": null,
- "description": "The domain within which Username is unique.",
- "maxLength": 128
- },
- "username": {
- "type": "string",
- "default": null,
- "description": "Within the domain specified by Domain, Identifies the user that is requesting access to the network.",
- "maxLength": 128
- },
- "password": {
- "type": "string",
- "default": null,
- "description": "The password associated with the user identified by Username and Domain.",
- "maxLength": 32
- },
- "roamingIdentity": {
- "type": "string",
- "default": null,
- "description": "A string presented to the authentication server in 802.1x protocol exchange",
- "maxLength": 80
- },
- "pxeTimeoutInSeconds": {
- "type": "integer",
- "default": 120,
- "description": "Timeout in seconds, in which the Intel(R) AMT will hold an authenticated 802.1X session."
- }
- }
- }
- }
- },
- "amtAcmActivation": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "log": { "type": "string" },
- "strictCommonName": { "type": "boolean", "default": false, "description": "When set to true, the certificate common name needs to match exactly the Intel AMT trusted FQDN or DHCP Option 15. If false, some flexibility may be given to the matching." },
- "certs": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "certfiles": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "keyfile": { "type": "string" }
- },
- "required": [ "certfiles", "keyfile" ]
- }
- }
- },
- "required": [ "certs" ]
- },
- "redirects": {
- "type": "object",
- "additionalProperties": { "type": "string" },
- "description": "This is used to create HTTP redirections. For example setting \"redirects\": { \"example\":\"https://example.com\" } will make it so that anyone accessing /example on the server will get redirected to the specified URL."
- },
- "yubikey": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "id": { "type": "string" },
- "secret": { "type": "string" },
- "proxy": { "type": "string", "format": "uri" }
- },
- "required": [ "id", "secret" ]
- },
- "httpHeaders": { "type": "object", "additionalProperties": { "type": "string" } },
- "agentConfig": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "default": null, "description": "Key and values to add to the MeshAgent .msh file" },
- "assistantConfig": { "type": "array", "uniqueItems": true, "items": { "type": "string" }, "default": null, "description": "Key and values to add to the MeshCentral Assistant .msh file" },
- "clipboardGet": { "type": "boolean", "default": true, "description": "When false, users can't set the clipboard of a remove device." },
- "clipboardSet": { "type": "boolean", "default": true, "description": "When false, users can't get the clipboard of a remove device." },
- "localSessionRecording": { "type": "boolean", "default": true, "description": "When false, removes the local recording feature on remote desktop." },
- "sessionRecording": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "onlySelectedUsers": { "type": "boolean", "default": false, "description": "When enabled, only device users with the session recording feature turned on will be recorded. When false, all users are recorded." },
- "onlySelectedUserGroups": { "type": "boolean", "default": false, "description": "When enabled, only device user groups with the session recording feature turned on will be recorded. When false, all users are recorded." },
- "onlySelectedDeviceGroups": { "type": "boolean", "default": false, "description": "When enabled, only device groups with the session recording feature turned on will be recorded. When false, all devices are recorded." },
- "filepath": { "type": "string", "description": "The file path where recording files are kept." },
- "index": { "type": "boolean", "default": false, "description": "If true, automatically index remote desktop recordings so that the plays can skip to any place in the file." },
- "maxRecordings": { "type": "integer", "default": null, "description": "Maximum number of recording files to keep." },
- "maxRecordingDays": { "type": "integer", "default": null, "description": "Maximum number of days to keep a recording." },
- "maxRecordingSizeMegabytes": { "type": "integer", "default": null, "description": "Maximum number of recordings in megabytes. Once exceed, remove the oldest recordings." },
- "protocols": { "type": "array", "uniqueItems": true, "items": { "type": "integer" }, "description": "This is an array: 1 = Terminal, 2 = Desktop, 5 = Files, 100 = Intel AMT WSMAN, 101 = Intel AMT Redirection, 200 = Messenger" }
- },
- "required": [ "protocols" ]
- },
- "showPasswordLogin": { "type": "boolean", "default": true, "description": "When set to false, hides the username and password prompt on login screen." },
- "sendgrid": {
- "title" : "SendGrid.com Email server",
- "description": "Connects MeshCentral to the SendGrid email server, allows MeshCentral to send email messages for 2FA or user notification.",
- "type": "object",
- "properties": {
- "from": { "type": "string", "format": "email", "description": "Email address used in the messages from field." },
- "apikey": { "type": "string", "description": "The SendGrid API key." },
- "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." },
- "emailDelaySeconds": { "type": "integer", "default": 300, "description": "Time to wait before sending a device connection/disconnection notification email. If many events occur, they will be merged into a single email."}
- },
- "required": [ "from", "apikey" ]
- },
- "smtp": {
- "title" : "SMTP email server",
- "description": "Connects MeshCentral to a SMTP email server, allows MeshCentral to send email messages for 2FA or user notification.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "format": "hostname",
- "description": "Optional hostname of the client, this defaults to the hostname of the machine. This is useful for SMTP relays."
- },
- "host": {
- "type": "string",
- "format": "hostname",
- "description": "Hostname of the SMTP server."
- },
- "port": {
- "type": "integer",
- "minimum": 1,
- "maximum": 65535,
- "description": "SMTP server port number."
- },
- "from": {
- "type": "string",
- "format": "email",
- "description": "Email address used in the messages from field."
- },
- "tls": { "type": "boolean" },
- "auth": {
- "type": "object",
- "properties": {
- "clientId": { "type": "string" },
- "clientSecret": { "type": "string" },
- "refreshToken": { "type": "string" }
- },
- "required": [ "clientId", "clientSecret", "refreshToken" ]
- },
- "tlscertcheck": { "type": "boolean" },
- "tlsstrict": { "type": "boolean" },
- "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." },
- "emailDelaySeconds": { "type": "integer", "default": 300, "description": "Time to wait before sending a device connection/disconnection notification email. If many events occur, they will be merged into a single email."}
- },
- "required": [ "from" ]
- },
- "sendmail": {
- "title" : "Send email using the sendmail command",
- "description": "Makes MeshCentral send emails using the Unix sendmail command. Allows MeshCentral to send email messages for 2FA or user notification.",
- "type": "object",
- "properties": {
- "newline": { "type": "string", "default": "unix", "description": "Possible values are unix or windows" },
- "path": { "type": "string", "default": "sendmail", "description": "Path to the sendmail command" },
- "args": { "type": "array", "items": { "type": "string" }, "default": null, "description": "Array or arguments to pass to sendmail" },
- "emailDelaySeconds": { "type": "integer", "default": 300, "description": "Time to wait before sending a device connection/disconnection notification email. If many events occur, they will be merged into a single email."}
- }
- },
- "authStrategies": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "twitter": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "clientid": { "type": "string" },
- "clientsecret": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "clientid", "clientsecret" ]
- },
- "google": {
- "type": "object",
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "clientid": { "type": "string" },
- "clientsecret": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "clientid", "clientsecret" ]
- },
- "github": {
- "type": "object",
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "clientid": { "type": "string" },
- "clientsecret": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "clientid", "clientsecret" ]
- },
- "reddit": {
- "type": "object",
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "clientid": { "type": "string" },
- "clientsecret": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "clientid", "clientsecret" ]
- },
- "azure": {
- "type": "object",
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "clientid": { "type": "string" },
- "clientsecret": { "type": "string" },
- "tenantid": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "clientid", "clientsecret", "tenantid" ]
- },
- "jumpcloud": {
- "type": "object",
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "entityid": { "type": "string" },
- "idpurl": { "type": "string", "format": "uri" },
- "cert": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "entityid", "idpurl", "cert" ]
- },
- "saml": {
- "type": "object",
- "properties": {
- "callbackurl": { "type": "string", "format": "uri" },
- "disableRequestedAuthnContext": { "type": "boolean" },
- "newAccounts": { "type": "boolean", "default": false },
- "newAccountsUserGroups": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "newAccountsRights": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
- "entityid": { "type": "string" },
- "idpurl": { "type": "string", "format": "uri" },
- "cert": { "type": "string" },
- "logouturl": {"type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link."}
- },
- "required": [ "entityid", "idpurl", "cert" ]
- },
- "oidc": {
- "type": "object",
- "properties": {
- "authorizationURL": { "type": "string", "format": "uri", "description": "If set, this will be used as the authorization URL. (If set tokenURL and userInfoURL need set also)" },
- "callbackURL": { "type": "string", "format": "uri", "description": "Required, this is the URL that your SSO provider sends auth approval to." },
- "clientid": { "type": "string" },
- "clientsecret": { "type": "string" },
- "issuer": { "type": "string", "format": "uri", "description": "Full URL of SSO portal" },
- "tokenURL": { "type": "string", "format": "uri", "description": "If set, this will be used as the token URL. (If set authorizationURL and userInfoURL need set also)" },
- "userInfoURL": { "type": "string", "format": "uri", "description": "If set, this will be used as the user info URL. (If set authorizationURL and tokenURL need set also)" },
- "logouturl": { "type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link." },
- "newAccounts": { "type": "boolean", "default": true },
- "groups": {
- "type": "object",
- "properties": {
- "required": { "type": [ "string", "array" ], "description": "When set, the user must be part of one of the OIDC user groups to login to MeshCentral." },
- "siteadmin": { "type": [ "string", "array" ], "description": "When set, users part of these groups will be promoted with site administrator in MeshCentral, users that are not part of these groups will be demoted." },
- "sync": {
- "type": [ "boolean", "object" ],
- "description": "Allows some or all ODIC user groups to be mirrored within MeshCentral as user groups.",
- "properties": {
- "enabled": { "type": "boolean", "default": false },
- "filter": { "type": [ "string", "array" ], "description": "When set, limits what OIDC groups are mirrored into MeshCentral user groups." }
- }
- }
- }
- }
- },
- "required": [ "issuer", "clientid", "clientsecret", "callbackURL" ]
- }
- }
- }
- }
- }
- },
- "letsEncrypt": {
- "title" : "Built-in Let's Encrypt support",
- "description": "If your server has a proper DNS name and it public facing on the Internet with a public facing HTTP server on port 80, you can get a free TLS certificate.",
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "email": { "type": "string", "format": "email", "description": "Email address of the administrator of this server. Make sure this is a valid email address otherwise the certificate request will fail." },
- "names": { "type": "string" },
- "skipChallengeVerification": { "type": "boolean", "default": false, "description": "By default, MeshCentral will perform a self-test to make sure HTTP port 80 can respond correctly before making a request to Let's Encrypt. In some cases, this self-test can't work and must be skipped." },
- "production": { "type": "boolean", "default": false, "description": "By default a test certificate will be obtained from Let's Encrypt. Always start by getting a test certificate and make sure that works before setting this to true and obtaining a production certificate. Making too many bad requests for a production certificate will get you banned for a long period of time." }
- },
- "required": [ "email", "names" ]
- },
- "peers": {
- "title" : "Server peering",
- "description": "Setup peer server for load-balancing between many servers.",
- "type": "object",
- "minProperties": 1,
- "propertyNames": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" },
- "additionalProperties": false,
- "properties": {
- "serverId": { "type": "string" },
- "servers": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "properties": { "url": { "type": "string", "format": "uri" } },
- "required": [ "url" ]
- }
- }
- },
- "required": [ "serverId", "servers" ]
- },
- "sendgrid": {
- "title" : "SendGrid.com Email server",
- "description": "Connects MeshCentral to the SendGrid email server, allows MeshCentral to send email messages for 2FA or user notification.",
- "type": "object",
- "properties": {
- "from": { "type": "string", "format": "email", "description": "Email address used in the messages from field." },
- "apikey": { "type": "string", "description": "The SendGrid API key." },
- "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." }
- },
- "required": [ "from", "apikey" ]
- },
- "smtp": {
- "title" : "SMTP email server",
- "description": "Connects MeshCentral to a SMTP email server, allows MeshCentral to send email messages for 2FA or user notification.",
- "type": "object",
- "properties": {
- "host": { "type": "string", "format": "hostname" },
- "port": { "type": "integer", "minimum": 1, "maximum": 65535 },
- "from": { "type": "string", "format": "email", "description": "Email address used in the messages from field." },
- "tls": { "type": "boolean" },
- "tlscertcheck": { "type": "boolean" },
- "tlsstrict": { "type": "boolean" },
- "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." }
- },
- "required": [ "host", "port", "from", "tls" ]
- },
- "sms": {
- "title": "SMS provider",
- "description": "Connects MeshCentral to a SMS text messaging provider, allows MeshCentral to send SMS messages for 2FA or user notification.",
- "oneOf": [
- {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [ "twilio" ]
- },
- "sid": { "type": "string" },
- "auth": { "type": "string" },
- "from": { "type": "string" }
- },
- "required": [ "provider", "sid", "auth", "from" ]
- },
- {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [ "plivo" ]
- },
- "id": { "type": "string" },
- "token": { "type": "string" },
- "from": { "type": "string" }
- },
- "required": [ "provider", "id", "token", "from" ]
- },
- {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [ "telnyx" ]
- },
- "apikey": { "type": "string" },
- "from": { "type": "string" }
- },
- "required": [ "provider", "apikey", "from" ]
- },
- {
- "type": "object",
- "properties": {
- "provider": {
- "type": "string",
- "enum": [ "url" ]
- },
- "url": {
- "type": "string",
- "description": "A http or https URL with {{phone}} and {{message}} in the string. These will be replaced with the URL encoded target phone number and message."
- }
- },
- "required": [ "url" ]
- }
- ]
- },
- "messaging": {
- "title" : "Messaging server",
- "description": "This section allow MeshCentral to send messages over user messaging networks like Telegram",
- "type": "object",
- "properties": {
- "telegram": {
- "type": "object",
- "description": "Configure Telegram messaging system",
- "properties": {
- "apiid": { "type": "number" },
- "apihash": { "type": "string" },
- "session": { "type": "string" }
- }
- },
- "discord": {
- "type": "object",
- "description": "Configure Discord messaging system",
- "properties": {
- "serverurl": { "type": "string", "format": "uri", "description": "An optional HTTP link to the discord server the user must join to get notifications." },
- "token": { "type": "string", "description": "A Discord bot token that MeshCentral will use to login to Discord." }
- },
- "required": [ "token" ]
- },
- "xmpp": {
- "type": "object",
- "description": "Configure XMPP messaging system",
- "properties": {
- "service": { "type": "string", "description": "Host name of the XMPP server." },
- "credentials": {
- "type": "object",
- "description": "Login credentials for the XMPP server.",
- "properties": {
- "username": { "type": "string" },
- "password": { "type": "string" }
- }
- }
- },
- "required": [ "credentials" ]
- },
- "callmebot": {
- "type": "boolean",
- "default": false,
- "description": "Enabled CallMeBot integration support."
- },
- "pushover": {
- "type": "object",
- "description": "Configure Pushover messaging system",
- "properties": {
- "token": { "type": "string", "description": "A Pushover application token that MeshCentral will use to login." }
- },
- "required": [ "token" ]
- },
- "ntfy": {
- "type": [ "boolean", "object" ],
- "default": false,
- "properties": {
- "host": { "type": "string", "description": "Host name of the ntfy server." },
- "userurl": { "type": "string", "description": "A URL given to users to help them setup this service." }
- },
- "description": "Enabled ntfy.sh integration support."
- },
- "zulip": {
- "type": "object",
- "properties": {
- "site": { "type": "string", "format": "uri", "default": "https://api.zulip.com", "description": "URL to the Zulip server"},
- "email": { "type": "string", "description": "Bot email address to login as." },
- "api_key": { "type": "string", "description": "Bot api key." }
- },
- "description": "Enabled Zulip integration support."
- }
- }
- }
- },
- "required": [ "settings", "domains" ]
-}
+* DNS
+* HTTPS
+* MPS (Management Presence Server)
+* MongoDB
+* MariaDB
+* SQLite3
+* MySQL
+* PostgreSQL
+* AceBase
+* WAN (Wide Area Network)
+* LAN (Local Area Network)
+* Maintenance Mode
+* Session Cookie
+* Database Encryption
+* Web Relay
+* Agent Connection
+* TLS (Transport Layer Security)
+* WebRTC
+* Web Push Notifications
+* Auto Backup
+* Crowdsec
+* IP KVM (Keyboard, Video, Mouse over IP)
+* Mesh Router
+* Syslog
+* WebDAV
+* Certificates and Authentication
+* MeshCentral Server Settings
+* Device Management
+* User Permissions
+* Remote Desktop Configuration
-```
\ No newline at end of file
+and more!
+
+![Server Options]()
+
+![Domain Options]()
\ No newline at end of file
diff --git a/docs/docs/meshcentral/customization.md b/docs/docs/meshcentral/customization.md
new file mode 100644
index 00000000..654bb0bf
--- /dev/null
+++ b/docs/docs/meshcentral/customization.md
@@ -0,0 +1,105 @@
+# Customization
+
+Whitelabeling your MeshCentral installation to personalize it to your company's brand, as well as having your own terms of use is one of the first things many people do after installation.
+
+
+
+
+
+## Web Branding
+
+You can put your own logo on the top of the web page. To get started, get the file “logoback.png” from the folder “node_modules/meshcentral/public/images” and copy it to your “meshcentral-data” folder. In this example, we will change the name of the file “logoback.png” to “title-mycompany.png”. Then use any image editor to change the image and place your logo.
+
+
+
+Once done, edit the config.json file and set one or all of the following values:
+
+```json
+"domains": {
+ "": {
+ "Title": "",
+ "Title2": "",
+ "TitlePicture": "title-sample.png",
+ "loginPicture": "logintitle-sample.png",
+ "welcomeText": "This is sample text",
+ "welcomePicture": "mainwelcome-04.jpg",
+ "welcomePictureFullScreen": true,
+ "siteStyle": "1",
+ "nightMode": "1",
+ "meshMessengerTitle": "Mesh Chat",
+ "meshMessengerPicture": "chatimage.png",
+ "footer": "This is a HTML string displayed at the bottom of the web page when a user is logged in.",
+ "loginfooter": "This is a HTML string displayed at the bottom of the web page when a user is not logged in."
+ },
+```
+
+This will set the title and sub-title text to empty and set the background image to the new title picture file. You can now restart the server and take a look at the web page. Both the desktop and mobile sites will change.
+
+
+
+
+
+The title image must a PNG image of size 450 x 66.
+
+You can also customize the server icon in the “My Server” tab. By default, it’s a picture of a desktop with a padlock.
+
+
+
+If, for example, MeshCentral is running on a Raspberry Pi. You may want to put a different picture at this location. Just put a “server.jpg” file that is 200 x 200 pixels in the “meshcentral-data” folder. The time MeshCentral page is loaded, you will see the new image.
+
+
+
+This is great to personalize the look of the server within the web site.
+
+### Customizing Web Icons
+MeshCentral lets you change the icons for different devices shown in the Web User Interface. To do this the proper way, you should make a new folder called `meshcentral-web` in the main directory, where you find other folders like `meshcentral-data`, `meshcentral-backup`, `meshcentral-files`, and `node-modules`. Inside `meshcentral-web`, make another folder named `public` and copy the entire `node_modules/meshcentral/public/images` folder into this new `meshcentral-web/public` folder and then edit the files in `meshcentral-web/public/images/`. This step is suggested because if MeshCentral updates, it might delete any changes in `node_modules`. But, changes in `meshcentral-web` will stay safe, and MeshCentral will use these files instead of the originals in `node_modules`.
+
+To update device icons, you need to edit these files: `meshcentral-web/public/images/webp/iconsXX.webp` (`icons16.webp`, `icons32.webp`, `icons50.webp`, `icons100.webp`), and `meshcentral-web/public/images/iconsXX.png` (`icons16.png`, `icons32.png`, `icons50.png`, `icons64.png`, `icons100.png`) and the corresponding `meshcentral-web/public/images/icons256-X-1.png`. Make sure to keep the resolution of these files as it is.
+
+By following these steps, you can customize any icon in MeshCentral. Just find and change the corresponding image files in the `meshcentral-web/public/images` folder. Similarly, you can also move other folders from `node_modules/meshcentral` to `meshcentral-web` while keeping the original folder structure. This allows you to modify other parts of MeshCentral too, like the `.handlebars` templates for the web interface. Simply copy files from `node_modules/meshcentral/views` to `meshcentral-web/views` and make your changes in `meshcentral-web`. This lets you match MeshCentral's look to your company's brand or your own style.
+
+
+### Customizing Agent Invitation
+Agents can be invited by public link or via email. [Click Here](assistant.md#agent-invitation) to see details.
+
+## Agent Branding
+
+You can customize the Agent to add your own logo, change the title bar, install text, the service name, or even colors!
+
+!!!note
+ The Customization must be done FIRST and BEFORE you deploy your agents! Once the agents have been deployed, any customization made afterwards, will not sync! This is because the setup files are customized on the fly, then when you install the agents, the exe and .msh file with the customizations in are copied over to the required folder, so you will need to reinstall the agent for agent customizations to take effect.
+
+
+
+```json
+"domains": {
+ "": {
+ "agentCustomization": {
+ "displayName": "MeshCentral Agent",
+ "description": "Mesh Agent background service",
+ "companyName": "Mesh Agent Company",
+ "serviceName": "Mesh Agent Service",
+ "installText": "Text string to show in the agent installation dialog box",
+ "image": "mylogo.png",
+ "fileName": "meshagent",
+ "foregroundColor": "#FFA500",
+ "backgroundColor": "#EE82EE"
+ }
+ }
+}
+```
+
+
+
+## Terms of use
+
+You can change the terms of use of the web site by adding a “terms.txt” file in the “meshcentral-data” folder. The file can include HTML markup. Once set, the server does not need to be restarted, the updated terms.txt file will get used the next time it’s requested.
+
+For example, placing this in “terms.txt”
+
+```
+
+This is a test file.
+```
+
+Will show this on the terms of use web page.
diff --git a/docs/docs/meshcentral/debugging.md b/docs/docs/meshcentral/debugging.md
index 339e4f53..68a3725e 100644
--- a/docs/docs/meshcentral/debugging.md
+++ b/docs/docs/meshcentral/debugging.md
@@ -23,7 +23,7 @@ Make sure you understand how MeshCentral works with your browser using chrome de
### Understanding node and paths
-Note that when running MeshCentral, you should always run like from the path that is parent to node_modules, so you do this:
+Note that when running MeshCentral, you should always run from the path that is parent to node_modules, so you do this:
```
cd C:\Program Files\Open Source\MeshCentral
@@ -39,7 +39,7 @@ node meshcentral
The problem with the second command is that NPM may install missing modules in the incorrect location.
-Also, in general I recommend not using the MeshCentral MSI Installer and just install manually unless you are very much scared of the command prompt. Anyone that knows about bit about the shell should install MeshCentral like this:
+Also, in general I recommend not using the MeshCentral MSI Installer and just install manually unless you are very scared of the command prompt. Anyone that knows a bit about the shell should install MeshCentral like this:
```
mkdir c:\meshcentral
@@ -50,11 +50,11 @@ node node_modules\meshcentral
node node_modules\meshcentral --install
```
-This way, just have a lot more control over what is going on. Just my opinion, the MSI installer basically does the same thing and installs NodeJS for you.
+This way, you have a lot more control over what is going on. In my opinion, the MSI installer basically does the same thing and installs NodeJS for you.
### Unable to update server
-Generally the problem is that MeshCentral can't find the npm tool and so, can't run it to see if there is a new version. You can fix this by setting the path to npm in the config.json like this:
+Generally the problem is that MeshCentral can't find the npm tool and therefore, can't run it to see if there is a new version. You can fix this by setting the path to npm in the config.json like this:
```json
{
@@ -86,14 +86,59 @@ node node_modules/meshcentral --stop
### Port Troubleshooting on server
-If you're getting a `port 4433 is not available` error, this is because someone else is using this port, very likely another instance of MeshCentral. If your MeshCentral server is bound to ports 81/444 MeshCentral could not get port 80/443 and got the next available ones.
+If you're getting a `port 4433 is not available` error, this is because another process is using this port, very likely another instance of MeshCentral. If your MeshCentral server is bound to ports 81/444 MeshCentral could not get port 80/443 and got the next available ones.
In general the problem is that you are running two MeshCentral instances at the same time. Probably one as a background Windows Service and one in the command line. Which ever instance can grab port 4433 will have a running MPS and CIRA should work, but the second instance will not have port 4433 and CIRA will not work.
+### Running Meshcentral server in debug mode
+
+Debug more will cause MeshCentral to output a lot of debug messages to the console. To display all debug messages, run MeshCentral like this:
+
+```bash
+node node_modules/meshcentral --debug
+```
+
+A more practical way to run the debug command it to specify what messages you want printed out using a comma seperated list, for example:
+
+```bash
+node node_modules/meshcentral --debug web,amt,mps
+```
+
+Here is the list of all debug options:
+
+```
+cookie - Cookie encoder
+dispatch - Message Dispatcher
+main - Main Server Messages
+peer - MeshCentral Server Peering
+agent - MeshAgent traffic
+agentupdate - MeshAgent update
+cert - Server Certificate
+db - Server Database
+email - Email/SMS/Push Traffic
+web - Web Server
+webrequest - Web Server Requests
+relay - Web Socket Relay
+httpheaders - Web Server HTTP Headers
+authlog - User Authentication Log
+amt - Intel AMT
+webrelay - Connection Relay
+mps - CIRA Server
+mpscmd - CIRA Server Commands
+```
+
+You can also specify the `debug` option in the config.json file in the `settings` section. For example:
+
+```
+"settings": {
+ "debug": "web,amt,mps"
+}
+```
+
+
### Enabling trace in your browser Dev Tools
-`Trace=1` as a parameter in chrome dev tools for debugging
-
+You can enable browser console tracing by adding `trace=1` as a parameter to the URL of the MeshCentral main web page. For example `https://myserver.com/?trace=1`. Once present, open the browser's console window to see all web client tracing messages.
To log all database queries, change log_statement in /etc/postgresql/13/main/postgresql.conf
diff --git a/docs/docs/meshcentral/devicetabs.md b/docs/docs/meshcentral/devicetabs.md
index 6f3c6170..8e4f4169 100644
--- a/docs/docs/meshcentral/devicetabs.md
+++ b/docs/docs/meshcentral/devicetabs.md
@@ -54,10 +54,11 @@ Chat
Legend
-* **_Black color_**: Device is powered on (Intel AMT & agents)
-* **_Purple color_**: Device is in sleep state (Intel AMT agents only)
-* **_Teal color_**: Device is connected through AMT/CIRA, but not powered on (Intel AMT agents only)
-* **_Grey color_**: Device is powered off (Intel AMT & agents)
+* **_Black color_**: Device is Powered On on (Intel AMT & agents)
+* **_Purple color_**: Device is in sleep state such as Hibernating (Intel AMT agents only)
+* **_Teal color_**: Device is connected through AMT/CIRA, but the Power State is UNKNOWN (Intel AMT agents only)
+* **_DarkGreen color_**: Device is connected through AMT/CIRA and is in Soft-Off Power State (Intel AMT agents only)
+* **_Grey color_**: Device is Powered Off/Not Connected To MeshCentral (Intel AMT & agents)
### Text Links
diff --git a/docs/docs/meshcentral/faq.md b/docs/docs/meshcentral/faq.md
index b34905d8..1c5b2404 100644
--- a/docs/docs/meshcentral/faq.md
+++ b/docs/docs/meshcentral/faq.md
@@ -36,7 +36,7 @@ No, you haven't.
6. Here are some examples of what that looks like.
-# Can't login on server after first setup
+## Can't login on server after first setup
You're sure you're typing in everything right, giving it 2FA code and can't login
@@ -44,9 +44,40 @@ You're sure you're typing in everything right, giving it 2FA code and can't logi
-# Branding and Customization
+## Branding and Customization
You can brand and customize MeshCentral almost as much as you like without delving into the code, a few changes in the config.json file and uploading images can change the way your system looks. Read more [here](https://ylianst.github.io/MeshCentral/meshcentral/#branding-terms-of-use)
!!!note
You will need to reinstall the agent for agent customizations to take effect.
+
+## Mac Clients
+
+You have to manually grant Mac permissions outside of the agent install process due to the MacOS security system under Security & Privacy > Privacy
+
+To see the screen (otherwise you just see the menu bar, and otherwise blank)
+
+
+
+To be able to transfer files
+
+
+
+To be able to control keyboard and mouse
+
+
+
+## I'm using CloudFlare and I'm getting a black screen but the mouse moves?
+
+If you are using CloudFlare for your DNS hosting and your remote screen is black, DONT PANIC!
+
+Unfortunately, MeshCentral doesn't always work with CloudFlare's Proxy DNS Mode.
+
+The fix is to simply set the 'Proxy Status' to OFF inside your DNS A Record, within the CloudFlare control panel.
+
+Simply follow the steps [here](https://developers.cloudflare.com/fundamentals/setup/manage-domains/pause-cloudflare/#disable-proxy-on-dns-records)
+
+Once done, open your firewall for the `port` and `agentPort` ports of where your meshcentral is hosted, then restart your MeshCentral Server
+
+There is currently a PINNED GitHub issue about this [here](https://github.com/Ylianst/MeshCentral/issues/5302)
+
diff --git a/docs/docs/meshcentral/images/2023-02-24vscodejsonediting.png b/docs/docs/meshcentral/images/2023-02-24vscodejsonediting.png
new file mode 100644
index 00000000..114e575b
Binary files /dev/null and b/docs/docs/meshcentral/images/2023-02-24vscodejsonediting.png differ
diff --git a/docs/docs/meshcentral/images/2023-11-29-12-57-15.png b/docs/docs/meshcentral/images/2023-11-29-12-57-15.png
new file mode 100644
index 00000000..67718be7
Binary files /dev/null and b/docs/docs/meshcentral/images/2023-11-29-12-57-15.png differ
diff --git a/docs/docs/meshcentral/images/2023-11-29-12-58-05.png b/docs/docs/meshcentral/images/2023-11-29-12-58-05.png
new file mode 100644
index 00000000..f86536c8
Binary files /dev/null and b/docs/docs/meshcentral/images/2023-11-29-12-58-05.png differ
diff --git a/docs/docs/meshcentral/images/2023-11-29-12-58-36.png b/docs/docs/meshcentral/images/2023-11-29-12-58-36.png
new file mode 100644
index 00000000..deb41c14
Binary files /dev/null and b/docs/docs/meshcentral/images/2023-11-29-12-58-36.png differ
diff --git a/docs/docs/meshcentral/images/2023-11-29_140845 - mesh json1.png b/docs/docs/meshcentral/images/2023-11-29_140845 - mesh json1.png
new file mode 100644
index 00000000..b000fe1b
Binary files /dev/null and b/docs/docs/meshcentral/images/2023-11-29_140845 - mesh json1.png differ
diff --git a/docs/docs/meshcentral/images/2023-11-29_140845 - mesh json2.png b/docs/docs/meshcentral/images/2023-11-29_140845 - mesh json2.png
new file mode 100644
index 00000000..d530454b
Binary files /dev/null and b/docs/docs/meshcentral/images/2023-11-29_140845 - mesh json2.png differ
diff --git a/docs/docs/meshcentral/images/7daypowerstate.png b/docs/docs/meshcentral/images/7daypowerstate.png
index de545544..c732043e 100644
Binary files a/docs/docs/meshcentral/images/7daypowerstate.png and b/docs/docs/meshcentral/images/7daypowerstate.png differ
diff --git a/docs/docs/meshcentral/images/In-production.png b/docs/docs/meshcentral/images/In-production.png
new file mode 100644
index 00000000..c1fc2e64
Binary files /dev/null and b/docs/docs/meshcentral/images/In-production.png differ
diff --git a/docs/docs/meshcentral/images/OAuth-Internal-External.png b/docs/docs/meshcentral/images/OAuth-Internal-External.png
new file mode 100644
index 00000000..13b14c8a
Binary files /dev/null and b/docs/docs/meshcentral/images/OAuth-Internal-External.png differ
diff --git a/docs/docs/meshcentral/images/custom-web-icons.png b/docs/docs/meshcentral/images/custom-web-icons.png
new file mode 100644
index 00000000..9edb5569
Binary files /dev/null and b/docs/docs/meshcentral/images/custom-web-icons.png differ
diff --git a/docs/docs/meshcentral/images/email-invitation.png b/docs/docs/meshcentral/images/email-invitation.png
new file mode 100644
index 00000000..db9d2196
Binary files /dev/null and b/docs/docs/meshcentral/images/email-invitation.png differ
diff --git a/docs/docs/meshcentral/images/gc-newproject.png b/docs/docs/meshcentral/images/gc-newproject.png
new file mode 100644
index 00000000..715b68f9
Binary files /dev/null and b/docs/docs/meshcentral/images/gc-newproject.png differ
diff --git a/docs/docs/meshcentral/images/gc-oauthconsent.png b/docs/docs/meshcentral/images/gc-oauthconsent.png
new file mode 100644
index 00000000..a493c589
Binary files /dev/null and b/docs/docs/meshcentral/images/gc-oauthconsent.png differ
diff --git a/docs/docs/meshcentral/images/gc-oauthconsent2.png b/docs/docs/meshcentral/images/gc-oauthconsent2.png
new file mode 100644
index 00000000..10697dd1
Binary files /dev/null and b/docs/docs/meshcentral/images/gc-oauthconsent2.png differ
diff --git a/docs/docs/meshcentral/images/gc-oauthcredentials.png b/docs/docs/meshcentral/images/gc-oauthcredentials.png
new file mode 100644
index 00000000..243928b0
Binary files /dev/null and b/docs/docs/meshcentral/images/gc-oauthcredentials.png differ
diff --git a/docs/docs/meshcentral/images/gc-oauthscopes.png b/docs/docs/meshcentral/images/gc-oauthscopes.png
new file mode 100644
index 00000000..10697dd1
Binary files /dev/null and b/docs/docs/meshcentral/images/gc-oauthscopes.png differ
diff --git a/docs/docs/meshcentral/images/gc-playground.webp b/docs/docs/meshcentral/images/gc-playground.webp
new file mode 100644
index 00000000..a0fb99f6
Binary files /dev/null and b/docs/docs/meshcentral/images/gc-playground.webp differ
diff --git a/docs/docs/meshcentral/index.md b/docs/docs/meshcentral/index.md
index 06e282db..b25ac0f7 100644
--- a/docs/docs/meshcentral/index.md
+++ b/docs/docs/meshcentral/index.md
@@ -1,8 +1,8 @@
-# Meshcentral2 Guide
+# MeshCentral Guide
-[MeshCentral2 Guide](https://meshcentral.com/info/docs/MeshCentral2UserGuide.pdf)
+[MeshCentral Guide](https://meshcentral.com/docs/MeshCentral2UserGuide.pdf)
-MeshCmd Guide [as .pdf](https://meshcentral.com/info/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral User's Guide v0.2.9.odt?raw=true)
+MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral User's Guide v0.2.9.odt?raw=true)
## Video Walkthru
@@ -213,7 +213,7 @@ As indicated before, the settings section of the config.json is equivalent to pa
| RedirPort | This is the port for redirecting traffic in the web server. When the server is configured with HTTPS, users that uses HTTP will be redirected to HTTPS. Port 80 is the default port. So, redirection will happen from port 80 to port 443. |
| MpsPort | Port for Intel" AMT Management Presence Server to receive Intel" AMT CIRA (Client Initiated Remote Access) connections. The default is port 4433. This port is disabled in LAN mode. If user don"t plan on using Intel" AMT for management, this port can be left as-is. |
| TLSOffload | By default this option is set to "false". If set to "true", server will run both web port and the Intel AMT MPS port without TLS with the assumption that a TLS offloading is taking care of this task. For further details, see the "TLS Offloading" section. This option can also be set to the IP address of the reverse-proxy in order to indicate to MeshCental to only trust HTTP X-Forwarded headers coming from this IP address. See the "Reverse-Proxy Setup" section for an example. |
-| SelfUpdate | When set to "true" the server will check for a new version and attempt to self-update automatically a bit after midnight local time every day. For this to work, the server needs to run with sufficient permissions to overwrite its own files. If you run the server with more secure, restricted privileges, this option should not be used. If set to a specific version such as "0.2.7-g" when the server will immediately update to the specified version on startup if it"s not already at this version. |
+| SelfUpdate | When set to "true" the server will check for a new version and attempt to self-update automatically a bit after midnight local time every day. If set to a specific version such as "1.1.21" the server will immediately update to the specified version on startup if it's not already at this version. |
| SessionKey | This is the encryption key used to secure the user"s login session. It will encrypt the browser cookie. By default, this value is randomly generated each time the server starts. If many servers are used with a load balancer, all servers should use the same session key. In addition, one can set this key so that when the server restarts, users do not need to re-login to the server. |
| Minify | Default value is 0, when set to 1 the server will serve "minified" web pages, that is, web pages that have all comments, white spaces and other unused characters removed. This reduces the data size of the web pages by about half and reduced the number requests made by the browser. The source code of the web page will not be easily readable, adding "&nominify=1" at the end of the URL will override this option. |
| User | Specify a username that browsers will be automatically logged in as. Useful to skip the login page and password prompts. Used heavily during development of MeshCentral. |
@@ -305,6 +305,120 @@ When the MongoDB is setup for the first time, a unique identifier is generated a
Once peered, all of the servers should act like one single host, no matter which server the user(s) are connected to.
+## Email Setup
+
+We highly recommend the use of an email server (SMTP) because we could allow MeshCentral to verify user account’s email address by sending a confirmation request to the user to complete the account registration and for password recovery, should a user forget account password as illustrated below
+
+A verification email is sent when a new account is created or if the user requests it in the “My Account” tab.
+
+
+
+The password recovery flow when “Reset Account” is triggered at the login page.
+
+
+
+Both account verification and password recovery are triggered automatically once SMTP mail server configuration is included into the config.json file.
+
+#### SMTP: User/Pass
+##### Normal Server
+
+Update the config.json with “smtp” section as shown below and restart the server.
+
+```json
+{
+ "smtp": {
+ "host": "smtp.server.com",
+ "port": 25,
+ "from": "myaddress@server.com",
+ "user": "myaddress@server.com", # Optional
+ "pass": "mypassword", # Optional
+ "tls": false # Optional, default false
+ }
+}
+```
+
+Please map the host, port values to connect to the right host that provides this SMTP service. For “from” value, administrators may put something like donotreply@server.com, but often times it needs to be a valid address since SMTP server will not send out messages with an invalid reply address.
+
+Some SMTP servers will require a valid username and password to login to the mail server. This is to prevent unauthorized e-mail correspondence. TLS option can be set to ‘true’ if the SMTP server requires TLS.
+
+##### Gmail
+
+One option is to configure MeshCentral work with Google Gmail by setting “host” with smtp.gmail.com, and “port” with 587. In the config.json file, use user’s Gmail address for both “from” and “user” and Gmail password in the “pass” value. You will also need to enable “Less secure app access” in for this Google account. It’s in the account settings, security section:
+
+
+
+If a Google account is setup with 2-factor authentication, the option to allow less secure applications not be available. Because the Google account password is in the MeshCentral config.json file and that strong authentication can’t be used, it’s preferable to use a dedicated Google account for MeshCentral email.
+
+#### SMTP: OAuth Authentication
+##### Gmail
+
+Google has announced that less secure app access will be phased out. For Google Workspace or G-Suite accounts, the following process can be used to allow OAuth2 based authentication with Google's SMTP server. It is likely a very similar process for regular Gmail accounts.
+
+Start by visiting the Google API console:
+
+https://console.developers.google.com/
+
+First, you will create a new project. Name it something unique in case you need to create more in the future. In this example, I've named the project "MeshCentral"
+
+
+
+Click on the "OAuth Consent Screen" link, Under "APIs and Services" from the left hand menu:
+
+
+
+If you have a Google Workspace account, you will have the option to choose "Internal" application and skip the next steps. If not, you will be required to provide Google with information about why you want access, as well as verifying domain ownership.
+
+
+
+Add the Gmail address under which you have created this project to the fields labelled ‘User support email’ and ‘Developer contact information’ so that you will be allowed for authentication. After that, you will want to add a scope for your app, so that your token is valid for gmail:
+
+
+
+Once this is complete, the next step will be to add credentials.
+
+
+
+Choose OAuth Client
+
+You will obtain a Client ID and a Client secret once you've completed the process. Be sure to store the secret immediately, as you won't be able to retreive it after you've dismissed the window.
+
+Next, you will need to visit the Google OAuth Playground:
+
+https://developers.google.com/oauthplayground
+
+
+
+Enter your Client ID and secret from the last step. On the left side of the page, you should now see a text box that allows you to add your own scopes. Enter https://mail.google.com and click Authorize API.
+
+You will need to follow the instructions provided to finish the authorization process. Once that is complete, you should receive a refresh token. The refresh token, Client ID and Client Secret are the final items we need to complete the SMTP section of our config.json. It should now look something like this:
+
+```
+"smtp": {
+ "host": "smtp.gmail.com",
+ "port": 587,
+ "from": "my@googleaccount.com",
+ "auth": {
+ "clientId": "",
+ "clientSecret": "",
+ "refreshToken": ""
+ },
+ "user": "noreply@authorizedgooglealias.com",
+ "emailDelaySeconds": 10,
+ "tls": false,
+ "verifyEmail": true
+ }
+```
+
+
+Regardless of what SMTP account is used, MeshCentral will perform a test connection to make sure the server if working as expected when starting. Hence, the user will be notified if Meshcentral and SMTP server has been configured correctly as shown below.
+
+
+
+After successfully configuring the Gmail SMTP server, switch the OAuth 'Publishing Status' from `Testing` to `In Production`. This step prevents the need for frequent refresh token generation. Verification of your project isn't required to make this change.
+
+
+
+
## Database
A critical component of MeshCentral is the database. The database stores all of the user account information, groups and node data, historical power and event, etc. By default MeshCentral uses NeDB (https://github.com/louischatriot/nedb) that is written entirely in NodeJS and is setup automatically when MeshCentral is installed with the npm tool. The file “meshcentral.db” will be created in the “meshcentral-data” folder when MeshCentral is first launched. This database works well for small deployments scenarios.
@@ -438,14 +552,14 @@ To make this happen, we will be using the following command line options from Me
| --dblistconfigfiles | List the names and size of all configuration files in the database. |
| --dbshowconfigfile (filename) | Show the content of a specified filename from the database. --configkey is required. |
| --dbdeleteconfigfiles | Delete all configuration files from the database. |
-| --dbpushconfigfiles (*) or (folder path) | Push a set of configuration files into the database, removing any existing files in the process. When * is specified, the “meshcentral-data” folder up pushed into the database. --configkey is required. |
+| --dbpushconfigfiles '*' or (folder path) | Push a set of configuration files into the database, removing any existing files in the process. When * is specified, the “meshcentral-data” folder up pushed into the database. --configkey is required. |
| --dbpullconfigfiles (folder path) | Get all of the configuration files from the database and place them in the specified folder. Files in the target folder may be overwritten. --configkey is required. |
| --loadconfigfromdb (key) | Runs MeshCentral server using the configuration files found in the database. The configkey may be specified with this command or --configkey can be used. |
Once we have MeshCentral running as expected using the “meshcentral-data” folder, we can simply push that configuration into the database and run using the database alone like this:
```
-node ./node_modules/meshcentral --dbpushconfigfiles * --configkey mypassword
+node ./node_modules/meshcentral --dbpushconfigfiles '*' --configkey mypassword
node ./node_modules/meshcentral --loadconfigfromdb mypassword --mongodb "mongodb://127.0.0.1:27017/meshcentral"
```
@@ -609,46 +723,6 @@ All the lines that start with a number or `:` will be used, everything else is i
95.85.81.0/24
```
-## Email Setup
-
-We highly recommend the use of an email server (SMTP) because we could allow MeshCentral to verify user account’s email address by sending a confirmation request to the user to complete the account registration and for password recovery, should a user forget account password as illustrated below
-
-A verification email is sent when a new account is created or if the user requests it in the “My Account” tab.
-
-
-
-The password recovery flow when “Reset Account” is triggered at the login page.
-
-
-
-Both account verification and password recovery are triggered automatically once SMTP mail server configuration is included into the config.json file. Update the config.json with “smtp” section as shown below and restart the server.
-
-```json
-{
- "smtp": {
- "host": "smtp.server.com",
- "port": 25,
- "from": "myaddress@server.com",
- "user": "myaddress@server.com", Optional
- "pass": "mypassword", Optional
- "tls": false Optional, default false
- }
-}
-```
-
-Please map the host, port values to connect to the right host that provides this SMTP service. For “from” value, administrators may put something like donotreply@server.com, but often times it needs to be a valid address since SMTP server will not send out messages with an invalid reply address.
-
-Some SMTP servers will require a valid username and password to login to the mail server. This is to prevent unauthorized e-mail correspondence. TLS option can be set to ‘true’ if the SMTP server requires TLS.
-
-One option is to configure MeshCentral work with Google Gmail* by setting “host” with smtp.gmail.com, and “port” with 587. In the config.json file, use user’s Gmail* address for both “from” and “user” and Gmail* password in the “pass” value. You will also need to enable “Less secure app access” in for this Google account. It’s in the account settings, security section:
-
-
-
-If a Google account is setup with 2-factor authentication, the option to allow less secure applications not be available. Because the Google account password is in the MeshCentral config.json file and that strong authentication can’t be used, it’s preferable to use a dedicated Google account for MeshCentral email.
-
-Regardless of what SMTP account is used, MeshCentral will perform a test connection to make sure the server if working as expected when starting. Hence, the user will be notified if Meshcentral and SMTP server has been configured correctly as shown below.
-
-
## Embedding MeshCentral
@@ -827,6 +901,12 @@ In this example, we will:
- MeshCentral will read the NGINX web certificate so agents will perform correct server authentication.
- NGINX will be setup with long timeouts, because agents have long standard web socket connections.
+!!!note
+ With SELinux, NGINX reverse proxy requires 'setsebool -P httpd_can_network_relay 1'
+ Caution: httpd_can_network_relay only allows certain ports
+ Confirm you are using ports from this subset in MeshCentral
+ If you want to use a different port then you will need to add it to http_port_t
+
Let’s get started by configuring MeshCentral with the following values in config.json:
```json
@@ -1014,8 +1094,7 @@ First we will start with the MeshCentral configuration, here is a minimal config
},
"domains": {
"": {
- "certUrl": "https://127.0.0.1:443/",
- "agentConfig": [ "webSocketMaskOverride=1" ],
+ "certUrl": "https://127.0.0.1:443/"
}
}
}
@@ -1199,132 +1278,7 @@ And taking authentication to the next step is removing the login page entirely.
-## Branding & Terms of use
-
-Whitelabeling your MeshCentral installation to personalize it to your companies brand, as well as having your own terms of use is one of the first things many people do after installation.
-
-
-
-
-
-### Branding
-
-You can put you own logo on the top of the web page. To get started, get the file “logoback.png” from the folder “node_modules/meshcentral/public/images” and copy it to your “meshcentral-data” folder. In this example, we will change the name of the file “logoback.png” to “title-mycompany.png”. Then use any image editor to change the image and place your logo.
-
-
-
-Once done, edit the config.json file and set one or all of the following values:
-
-```json
-"domains": {
- "": {
- "Title": "",
- "Title2": "",
- "TitlePicture": "title-sample.png",
- "loginPicture": "logintitle-sample.png",
- "welcomeText": "This is sample text",
- "welcomePicture": "mainwelcome-04.jpg",
- "welcomePictureFullScreen": true,
- "siteStyle": "1",
- "nightMode": "1",
- "meshMessengerTitle": "Mesh Chat",
- "meshMessengerPicture": "chatimage.png",
- "footer": "This is a HTML string displayed at the bottom of the web page when a user is logged in.",
- "loginfooter": "This is a HTML string displayed at the bottom of the web page when a user is not logged in."
- },
-```
-
-This will set the title and sub-title text to empty and set the background image to the new title picture file. You can now restart the serve and take a look at the web page. Both the desktop and mobile sites will change.
-
-
-
-
-
-The title image must a PNG image of size 450 x 66.
-
-You can also customize the server icon in the “My Server” tab. By default, it’s a picture of a desktop with a padlock.
-
-
-
-If, for example, MeshCentral is running on a Raspberry Pi. You may want to put a different picture at this location. Just put a “server.jpg” file that is 200 x 200 pixels in the “meshcentral-data” folder. The time MeshCentral page is loaded, you will see the new image.
-
-
-
-This is great to personalize the look of the server within the web site.
-
-### Agent Branding
-
-You can also customize the Agent to add your own logo.
-
-
-
-```json
- "agentCustomization": {
- "displayName": {
- "type": "string",
- "default": "MeshCentral Agent",
- "description": "The name of the agent as displayed to the user."
- },
- "description": {
- "type": "string",
- "default": "Mesh Agent background service",
- "description": "The description of the agent as displayed to the user."
- },
- "companyName": {
- "type": "string",
- "default": "Mesh Agent",
- "description": "This will be used as the path to install the agent, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's."
- },
- "serviceName": {
- "type": "string",
- "default": "Mesh Agent",
- "description": "The name of the background service, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's but should be set to an all lower case, no space string."
- },
- "installText": {
- "type": "string",
- "default": null,
- "description": "Text string to show in the agent installation dialog box."
- },
- "image": {
- "type": "string",
- "default": null,
- "description": "The filename of a image file in .png format located in meshcentral-data to display in the MeshCentral Agent installation dialog, image should be square and from 64x64 to 200x200."
- },
- "fileName": {
- "type": "string",
- "default": "meshagent",
- "description": "The agent filename."
- },
- "foregroundColor": {
- "type": "string",
- "default": null,
- "description": "Foreground text color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF."
- },
- "backgroundColor": {
- "type": "string",
- "default": null,
- "description": "Background color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF."
- }
- }
- ```
-
-
-
-!!!note
- You will need to reinstall the agent for agent customizations to take effect.
-
-### Terms of use
-
-You can change the terms of use of the web site by adding a “terms.txt” file in the “meshcentral-data” folder. The file can include HTML markup. Once set, the server does not need to be restarted, the updated terms.txt file will get used the next time it’s requested.
-
-For example, placing this in “terms.txt”
-
-```
-
-This is a test file.
-```
-
-Will show this on the terms of use web page.
+You can also setup [Duo 2FA](https://github.com/Ylianst/MeshCentral/blob/master/docs/docs/meshcentral/security.md#duo-2fa-setup) which is a commertial offering.
## Server Backup & Restore
@@ -1780,7 +1734,40 @@ The callback URL will be of the form “https://(servername)/auth-saml-callback
Enabling SAML will require MeshCentral to install extra modules from NPM, so depending on your server configuration, you may need to run MeshCentral once manually.
!!!note
- MeshCentral only supports "POST". [For example Authentik's](https://github.com/Ylianst/MeshCentral/issues/4725) default setting is to use "Redirect" as a "Service Provider Binding".
+ MeshCentral only supports "POST". [For example Authentik's](https://github.com/Ylianst/MeshCentral/issues/4725) default setting is to use "Redirect" as a "Service Provider Binding".
+
+### Generic OpenID Connect Setup
+
+Generally, if you are using an IdP that supports OpenID Connect (OIDC), you can use a very basic configuration to get started, and if needed, add more specific or advanced configurations later. Here is what your config file will look like with a basic, generic, configuration.
+
+``` json
+{
+ "settings": {
+ "cert": "mesh.your.domain",
+ "port": 443,
+ "sqlite3": true
+ },
+ "domains": {
+ "": {
+ "title": "Mesh",
+ "title2": ".Your.Domain",
+ "authStrategies": {
+ "oidc": {
+ "issuer": "https://sso.your.domain",
+ "clientid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+ "clientsecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
+ "newAccounts": true
+ }
+ }
+ }
+ }
+}
+```
+
+As you can see, this is roughly the same as all the other OAuth2 based authentication strategies. These are the basics you need to get started using OpenID Connect because it's still authenticating with OAuth2. If you plan to take advantage of some of the more advanced features provided by this strategy you should consider reading the [additional strategy documentation](./openidConnectStrategy.md).
+
+> NOTE: MeshCentral will use `https://mesh.your.domain/auth-oidc-callback` as the default redirect uri.
+
## Improvements to MeshCentral
In 2007, the first version of MeshCentral was built. We will refer to it as “MeshCentral1”. When MeshCentral1 was designed, HTML5 did not exist and web sockets where not implemented in any of the major browsers. Many design decisions were made at the time that are no longer optimal today. With the advent of the latest MeshCentral, MeshCentral1 is no longer supported and MeshCentral v2 has been significantly redesigned and mostly re-written based of previous version. Here is a list of improvements made in MeshCentral when compared with MeshCentral1:
@@ -1918,4 +1905,4 @@ MeshCentral has built-in web-based integration of SSH in the "Terminal" tab and
-
\ No newline at end of file
+
diff --git a/docs/docs/meshcentral/openidConnectStrategy.md b/docs/docs/meshcentral/openidConnectStrategy.md
new file mode 100644
index 00000000..4b6e4911
--- /dev/null
+++ b/docs/docs/meshcentral/openidConnectStrategy.md
@@ -0,0 +1,671 @@
+# Using the OpenID Connect Strategy on MeshCentral
+
+## Overview
+
+### Introduction
+
+There is a lot of information to go over, but first, why OpenID Connect?
+
+Esentially its because its both based on a industry standard authorization protocol, and is becoming an industry standard authentication protocol. Put simply it's reliable and reusable, and we use OpenID Connect for exactly those reasons, almost every everyone does, and we want to be able to integrate with almost anyone. This strategy allows us to expand the potential of MeshCentral through the potential of OpenID Connect.
+
+In this document, we will learn about the OpenID Connect specification at a high level, and then use that information to configure the OpenID Connect strategy for MeshCentral using a generic OpenID Connect compatible IdP. After that we will go over some advanced configurations and then continue by explaining how to use the new presets for popular IdPs, specifically Google or Azure. Then we will explore the configuration and usage of the groups feature.
+
+> ATTENTION: As of MeshCentral `v1.1.22` there are multiple config options being depreciated. Using any of the old configs will only generate a warning in the authlog and will not stop you from using this strategy at this time. If there is information found in both the new and old config locations the new config location will be used. We will go over the specifics later, now lets jump in.
+
+### Chart of Frequently Used Terms and Acronyms
+| Term | AKA | Descriptions |
+| --- | --- | --- |
+| OAuth 2.0 | OAuth2 | OAuth 2.0 is the industry-standard protocol for user *authorization*. |
+| OpenID Connect | OIDC | Identity layer built on top of OAuth2 for user *authentication*. |
+| Identity Provider | IdP | The *service used* to provide authentication and authorization. |
+| Preset Configs | Presets | Set of *pre-configured values* to allow some specific IdPs to connect correctly. |
+| OAuth2 Scope | Scope | A flag *requesting access* to a specific resource or endpoint |
+| OIDC Claim | Claim | A *returned property* in the user info provided by your IdP |
+| User Authentication | AuthN | Checks if you *are who you say you are*. Example: Username and password authentication |
+| User Authorization | AuthZ | Check if you have the *permissions* required to access a specific resource or endpoint |
+
+### OpenID Connect Technology Overview
+
+OpenID Connect is a simple identity layer built on top of the OAuth2 protocol. It allows Clients to verify the identity of the End-User based on the authentication performed by an “Authorization Server”, as well as to obtain basic profile information about the End-User in an interoperable and REST-like manner.
+
+OpenID Connect allows clients of all types, including Web-based, mobile, and JavaScript clients, to request and receive information about authenticated sessions and end-users. The specification suite is extensible, allowing participants to use optional features such as encryption of identity data, discovery of OpenID Providers, and logout, when it makes sense for them.
+
+That description was straight from [OpenID Connect Documentation](https://openid.net/connect/), but basically, OAuth2 is the foundation upon which OpenID Connect was built, allowing for wide ranging compatability and interconnection. OpenID Connect appends the secure user *authentication* OAuth2 is known for, with user *authorization* by allowing the request of additional *scopes* that provide additional *claims* or access to API's in an easily expandable way.
+
+### Annotations
+
+#### Own IDP, CA and Docker
+
+If you operate your own identity provider, your own certification authority and MeshCentral via Docker, it is necessary to provide the complete certificate chain, otherwise NodeJS (in particular the openid-client module) will refuse the connection to the IDP server.
+
+The following errors can be found in the log file:
+> OIDC: Discovery failed.
+
+> UNABLE_TO_GET_ISSUER_CERT_LOCALLY
+
+To solve this problem, the certificate chain in PEM format must be placed in the data directory and the following entry must be added to the docker-compose.yml file in the “environment” section:
+```
+ environment:
+ - NODE_EXTRA_CA_CERTS=/opt/meshcentral/meshcentral-data/chain.pem
+```
+
+## Basic Config
+
+### *Introduction*
+
+Generally, if you are using an IdP that supports OIDC, you can use a very basic configuration to get started, and if needed, add more specific or advanced configurations later. Here is what your config file will look like with a basic, generic, configuration.
+
+### *Basic Config File Example*
+
+``` json
+{
+ "settings": {
+ "cert": "mesh.your.domain",
+ "port": 443,
+ "sqlite3": true
+ },
+ "domains": {
+ "": {
+ "title": "MeshCentral",
+ "title2": "Your sub-title",
+ "authStrategies": {
+ "oidc": {
+ "issuer": "https://sso.your.domain",
+ "clientid": "2d5685c5-0f32-4c1f-9f09-c60e0dbc948a",
+ "clientsecret": "7PiGSLSLL4e7NGi67KM229tfK7Z7TqzQ",
+ "newAccounts": true
+ }
+ }
+ }
+ }
+}
+```
+
+As you can see, this is roughly the same as all the other OAuth2 based authentication strategies. These are the basics you need to get started, however, if you plan to take advantage of some of the more advanced features provided by this strategy, you'll need to keep reading.
+
+In this most basic of setups, you only need the URL of the issuer, as well as a client ID and a client secret. Notice in this example that the callback URL (or client redirect uri) is not configured, thats because MeshCentral will use `https://mesh.your.domain/auth-oidc-callback` as the default. Once you've got your configuration saved, restart MeshCentral and you should see an OpenID Connect Single Sign-on button on the login screen.
+
+> WARNING: The redirect endpoint must EXACTLY match the value provided to your IdP or your will deny the connection.
+
+> ATTENTION: You are required to configure the cert property in the settings section for the default domain, and configure the dns property under each additional domain.
+
+## Advanced Options
+
+### Overview
+
+There are plenty of options at your disposal if you need them. In fact, you can configure any property that node-openid-client supports. The openid-client module supports far more customization than I know what to do with, if you want to know more check out [node-openid-client on GitHub](https://github.com/panva/node-openid-client) for expert level configuration details. There are plenty of things you can configure with this strategy and there is a lot of decumentation behind the tools used to make this all happen. I strongly recommend you explore the [config schema](https://github.com/Ylianst/MeshCentral/blob/master/meshcentral-config-schema.json), and if you have a complicated config maybe check out the [openid-client readme](https://github.com/panva/node-openid-client/blob/main/docs/README.md). Theres a list of resources at the end if you want more information on any specific topics. In the meantime, let’s take a look at an example of what your config file could look with a slightly more complicated configuration, including multiple manually defined endpoints.
+
+#### *Advanced Config File Example*
+
+``` json
+{
+ "settings": {
+ "cert": "mesh.your.domain",
+ "port": 443,
+ "redirPort": 80,
+ "AgentPong": 300,
+ "TLSOffload": "192.168.1.50",
+ "SelfUpdate": false,
+ "AllowFraming": false,
+ "sqlite3": true,
+ "WebRTC": true
+ },
+ "domains": {
+ "": {
+ "title": "Mesh",
+ "title2": ".Your.Domain",
+ "orphanAgentUser": "~oidc:e48f8ef3-a9cb-4c84-b6d1-fb7d294e963c",
+ "authStrategies": {
+ "oidc": {
+ "issuer": {
+ "issuer": "https://sso.your.domain",
+ "authorization_endpoint": "https://auth.your.domain/auth-endpoint",
+ "token_endpoint": "https://tokens.sso.your.domain/token-endpoint",
+ "end_session_endpoint": "https://sso.your.domain/logout",
+ "jwks_uri": "https://sso.your.domain/jwks-uri"
+ },
+ "client": {
+ "client_id": "110d5612-0822-4449-a057-8a0dbe26eca5",
+ "client_secret": "4TqST46K53o3Z2Q88p39YwR6YwJb7Cka",
+ "redirect_uri": "https://mesh.your.domain/auth-oidc-callback",
+ "post_logout_redirect_uri": "https://mesh.your.domain/login",
+ "token_endpoint_auth_method": "client_secret_post",
+ "response_types": "authorization_code"
+ },
+ "custom": {
+ "scope": [ "openid", "profile", "read.EmailAlias", "read.UserProfile" ],
+ "preset": null
+ },
+ "groups": {
+ "recursive": true,
+ "required": ["Group1", "Group2"],
+ "siteadmin": ["GroupA", "GroupB"],
+ "revokeAdmin": true,
+ "sync": {
+ "filter": ["Group1", "GroupB", "OtherGroup"]
+ },
+ "claim": "GroupClaim",
+ "scope": "read.GroupMemberships"
+ },
+ "logouturl": "https://sso.your.domain/logout?r=https://mesh.your.domain/login",
+ "newAccounts": true
+ },
+ {...}
+ }
+ }
+ }
+}
+```
+
+### "Issuer" Options
+
+#### *Introduction*
+
+In the advanced example config above, did you notice that the issuer property has changed from a *string* to an *object* compared to the basic example? This not only allows for much a much smaller config footprint when advanced issuer options are not required, it successfully fools you in to a false sense of confidence early on in this document. If you are manually configuring the issuer endpoints, keep in mind that MeshCentral will still attempt to discover **ALL** issuer information. Obviously if you manually configure an endpoint, it will be used even if the discovered information is different from your config.
+
+> NOTE: If you are using a preset, you dont need to define an issuer. If you do, the predefined information will be ignored.
+
+#### *Common Config Chart*
+
+| Name | Description | Default | Example | Required |
+| --- | --- | --- | --- | --- |
+| `issuer` | The primary URI that represents your Identity Providers authentication endpoints. | N/A | `"issuer": "https://sso.your.domain"` `"issuer": { "issuer": "https://sso.your.domain" }` | Unless using preset. |
+
+#### *Advanced Config Example*
+
+``` json
+"issuer": {
+ "issuer": "https://sso.your.domain",
+ "authorization_endpoint": "https://auth.your.domain/auth-endpoint",
+ "token_endpoint": "https://tokens.sso.your.domain/token-endpoint",
+ "end_session_endpoint": "https://sso.your.domain/logout",
+ "jwks_uri": "https://sso.your.domain/jwks-uri"
+},
+```
+
+#### *Required and Commonly Used Configs*
+
+The `issuer` property in the `issuer` object is the only one required, and its only required if you aren't using a preset. Besides the issuer, these are mostly options related to the endpoints and their configuration. The schema below looks intimidating but it comes down to being able to support any IdP. Setting the issuer, and end_session_endpoint are the two main ones you want to setup.
+
+#### *Schema*
+
+``` json
+"issuer": {
+ "type": ["string","object"],
+ "format": "uri",
+ "description": "Issuer options. Requires issuer URI (issuer.issuer) to discover missing information unless using preset",
+ "properties": {
+ "issuer": { "type": "string", "format": "uri", "description": "URI of the issuer." },
+ "authorization_endpoint": { "type": "string", "format": "uri" },
+ "token_endpoint": { "type": "string", "format": "uri" },
+ "jwks_uri": { "type": "string", "format": "uri" },
+ "userinfo_endpoint": { "type": "string", "format": "uri" },
+ "revocation_endpoint": { "type": "string", "format": "uri" },
+ "introspection_endpoint": { "type": "string", "format": "uri" },
+ "end_session_endpoint": {
+ "type": "string",
+ "format": "uri",
+ "description": "URI to direct users to when logging out of MeshCentral.",
+ "default": "this.issuer/logout"
+ },
+ "registration_endpoint": { "type": "string", "format": "uri" },
+ "token_endpoint_auth_methods_supported": { "type": "string" },
+ "token_endpoint_auth_signing_alg_values_supported": { "type": "string" },
+ "introspection_endpoint_auth_methods_supported": { "type": "string" },
+ "introspection_endpoint_auth_signing_alg_values_supported": { "type": "string" },
+ "revocation_endpoint_auth_methods_supported": { "type": "string" },
+ "revocation_endpoint_auth_signing_alg_values_supported": { "type": "string" },
+ "request_object_signing_alg_values_supported": { "type": "string" },
+ "mtls_endpoint_aliases": {
+ "type":"object",
+ "properties": {
+ "token_endpoint": { "type": "string", "format": "uri" },
+ "userinfo_endpoint": { "type": "string", "format": "uri" },
+ "revocation_endpoint": { "type": "string", "format": "uri" },
+ "introspection_endpoint": { "type": "string", "format": "uri" }
+ }
+ }
+ },
+ "additionalProperties": false
+},
+```
+
+### "Client" Options
+
+#### *Introduction*
+
+There are just about as many option as possible here since openid-client also provides a Client class, because of this you are able to manually configure the client how ever you need. This includes setting your redirect URI to any available path, for example, if I was using the "google" preset and wanted to have Google redirect me back to "https://mesh.your.domain/oauth2/oidc/redirect/givemebackgooglemusicyoujerks", MeshCentral will now fully support you in that. One of the other options is the post logout redirect URI, and it is exactly what it sounds like. After MeshCentral logs out a user using the IdPs end session endpoint, it send the post logout redirect URI to your IdP to forward the user back to MeshCentral or to an valid URI such as a homepage.
+
+> NOTE: The client object is required, however an exception would be with using old configs, which will be discussed later.
+
+#### *Common Configs*
+
+| Name | Description | Default | Example | Required |
+| --- | --- | --- | --- | --- |
+| `client_id` | The client ID provided by your Identity Provider (IdP) | N/A | `bdd6aa4b-d2a2-4ceb-96d3-b3e23cd17678` | `true` |
+| `client_secret` | The client secret provided by your Identity Provider (IdP) | N/A | `vUg82LJ322rp2bvdzuVRh3dPn3oVo29m` | `true` |
+| `redirect_uri` | "URI your IdP sends you after successful authorization. | `https://mesh.your.domain/auth-oidc-callback` | `https://mesh.your.domain/oauth2/oidc/redirect` | `false` |
+| `post_logout_redirect_uri` | URI for your IdP to send you after logging out of IdP via MeshCentral. | `https://mesh.your.domain/login` | `https://site.your.other.domain/login` | `false` |
+
+#### *Advanced Config Example*
+
+``` json
+"client": {
+ "client_id": "00b3875c-8d82-4238-a8ef-25303fa7f9f2",
+ "client_secret": "7PP453H577xbFDCqG8nYEJg8M3u8GT8F",
+ "redirect_uri": "https://mesh.your.domain/auth-oidc-callback",
+ "post_logout_redirect_uri": "https://mesh.your.domain/login",
+ "token_endpoint_auth_method": "client_secret_post",
+ "response_types": "authorization_code"
+},
+```
+
+#### *Required and Commonly Used Configs*
+
+There are many available options you can configure but most of them go unused. Although there are a few *commonly used* properties. The first two properties, `client_id` and `client_secret` are required. The next one `redirect_uri` is used to setup a custom URI for the redirect back to MeshCentral after being authenicated by your IdP. The `post_logout_redirect_uri` property is used to tell your IdP where to send you after being logged out. These work in conjunction with the issuers `end_session_url` to automatically fill in any blanks in the config.
+
+#### *Schema*
+``` json
+"client": {
+ "type": "object",
+ "description": "OIDC Client Options",
+ "properties": {
+ "client_id": {
+ "type": "string",
+ "description": "REQUIRED: The client ID provided by your Identity Provider (IdP)"
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "REQUIRED: The client secret provided by your Identity Provider (IdP)"
+ },
+ "redirect_uri": {
+ "type": "string",
+ "format": "uri",
+ "description": "URI your IdP sends you after successful authorization. This must match what is listed with your IdP. (Default is https://[currentHost][currentPath]/auth-oidc-callback)"
+ },
+ "post_logout_redirect_uri": {
+ "type": "string",
+ "format": "uri",
+ "description": "URI for your IdP to send you after logging out of IdP via MeshCentral.",
+ "default": "https:[currentHost][currentPath]/login"
+ },
+ "id_token_signed_response_alg": { "type": "string", "default": "RS256" },
+ "id_token_encrypted_response_alg": { "type": "string" },
+ "id_token_encrypted_response_enc": { "type": "string" },
+ "userinfo_signed_response_alg": { "type": "string" },
+ "userinfo_encrypted_response_alg": { "type": "string" },
+ "userinfo_encrypted_response_enc": { "type": "string" },
+ "response_types": { "type": ["string", "array"], "default": ["code"] },
+ "default_max_age": { "type": "number" },
+ "require_auth_time": { "type": "boolean", "default": false },
+ "request_object_signing_alg": { "type": "string" },
+ "request_object_encryption_alg": { "type": "string" },
+ "request_object_encryption_enc": { "type": "string" },
+ "token_endpoint_auth_method": {
+ "type": "string",
+ "default": "client_secret_basic",
+ "enum": [ "none", "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt" ]
+ },
+ "introspection_endpoint_auth_method": {
+ "type": "string",
+ "default": "client_secret_basic",
+ "enum": [ "none", "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt" ]
+ },
+ "revocation_endpoint_auth_method": {
+ "type": "string",
+ "default": "client_secret_basic",
+ "enum": [ "none", "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt" ]
+ },
+ "token_endpoint_auth_signing_alg": { "type": "string" },
+ "introspection_endpoint_auth_signing_alg": { "type": "string" },
+ "revocation_endpoint_auth_signing_alg": { "type": "string" },
+ "tls_client_certificate_bound_access_tokens": { "type": "boolean" }
+ },
+ "required": [ "client_id", "client_secret" ],
+ "additionalProperties": false
+},
+```
+
+### "Custom" Options
+
+#### *Introduction*
+
+These are all the options that dont fit with the issuer or client, including the presets. The presets define more than just the issuer URL used in discovery, they also define API endpoints, and specific ways to assemble your data. You are able to manually override most of the effects of the preset, but not all. You are able to manually configure the *scope* of the authorization request though, as well as choose which claims to use if your IdP uses something other than the defaults.
+
+> NOTE: The scope must be a string, an array of strings, or a space separated list of scopes as a single string.
+
+#### *Common Config Chart*
+
+| Name | Description | Default | Example | Required |
+| -------- | ------------------------------------------------ | --------------------------------------------------------- | ----------------------------------- | -------- |
+| `scope` | A list of scopes to request from the issuer. | `"openid profile email"` | `["openid", "profile"]` | `false` |
+| `claims` | A group of claims to use instead of the defaults | Defauts to name of property except that `uuid` used `sub` | `"claims": {"uuid": "unique_name"}` | `false` |
+
+#### *Advanced Config Example*
+
+``` json
+"custom": {
+ "scope": [ "openid", "profile", "read.EmailAlias", "read.UserProfile" ],
+ "preset": null,
+ "claims": {
+ "name": "nameOfUser",
+ "email": "publicEmail"
+ }
+},
+```
+
+> NOTE: You can `preset` to null if you want to explicitly disable presets.
+
+#### *Required and Commonly Used Configs*
+
+As should be apparent by the name alone, the custom property does not need to be configured and is used for optional or advanced configurations. With that said, lets look at few common options strategy will default to using the `openid`, `profile`, and `email` scopes to gather the required information about the user, if your IdP doesn't support or require all these, you can set up the scope manually. Combine that with the ability to set the group scope and you can end up with an entirely custom scope being sent to your IdP. Not to mention the claims property, which allows you to pick and choose what claims to use to gather your data in case you have issues with any of the default behaviors of OpenID Connect and your IdP. This is also where you would set the preset and any values required by the presets.
+
+#### *Schema*
+``` json
+"custom": {
+ "type": "object",
+ "properties": {
+ "scope": {
+ "type": ["string", "array"],
+ "description": "A list of scopes to request from the issuer.",
+ "default": "openid profile email",
+ "examples": ["openid", ["openid", "profile"], "openid profile email", "openid profile email groups"]
+ },
+ "claims": {
+ "type": "object",
+ "properties": {
+ "email": { "type": "string" },
+ "name": { "type": "string" },
+ "uuid": { "type": "string" }
+ }
+ },
+ "preset": { "type": "string", "enum": ["azure", "google"]},
+ "tenant_id": { "type": "string", "description": "REQUIRED FOR AZURE PRESET: Tenantid for Azure"},
+ "customer_id": { "type": "string", "description": "REQUIRED FOR GOOGLE PRESET IF USING GROUPS: Customer ID from Google, should start with 'C'."}
+ },
+ "additionalProperties": false
+},
+```
+
+### "Groups" Options
+
+#### *Introduction*
+
+The groups option allows you to use the groups you already have with your IdP in MeshCentral in a few ways. First you can set a group that the authorized user must be in to sign in to MeshCentral. You can also allow users with the right memberships automatic admin privlidges, and there is even an option to revoke privlidges if the user is NOT in the admin group. Besides these filters, you can filter the sync property to mirror only certain groups as MeshCentral User Groups, dynamically created as the user logs in. You can of course simply enable sync and mirror all groups from your IdP as User Groups. Additionally you can define the scope and claim of the groups for a custom setup, again allowing for a wide range of IdPs to be used, even without a preset.
+
+#### *Common Config Chart*
+
+| Name | Description | Default | Example | Required |
+| --- | --- | --- | --- | --- |
+| `sync` | Allows you to mirror user groups from your IdP. | `false` | `"sync": { "filter": ["Group1", "Group2"] }` `"sync": true` | `false` |
+| `required` | Access is only granted to users who are a member of at least one of the listed required groups. | `undefined` | `"required": ["Group1", "Group2"]` | `false` |
+| `siteadmin` | Full site admin priviledges will be granted to users who are a member of at least one of the listed admin groups | `undefined` | `"siteadmin": ["Group1", "Group2"]` | `false` |
+| `revokeAdmin` | If true, admin privileges will be revoked from users who arent a member of at least one of the listed admin groups. | `true` | `"revokeAdmin": false` | `false` |
+
+#### *Advanced Config Example*
+
+``` json
+"groups": {
+ "recursive": true,
+ "required": ["Group1", "Group2"],
+ "siteadmin": ["GroupA", "GroupB"],
+ "revokeAdmin": false,
+ "sync": {
+ "filter": ["Group1", "GroupB", "OtherGroup"]
+ },
+ "claim": "GroupClaim",
+ "scope": "read.GroupMemberships"
+},
+```
+
+#### *Required and Commonly Used Configs*
+
+As you can see in the schema below, there aren't any required properties in the groups object, however there are some commonly used ones. The first, and maybe most commonly used one, is the sync property. The sync property mirrors IdP provided groups into MeshCentral as user groups. You can then configure access as required to those groups, and as users log in, they will be added to the now existing groups if they are a member. You also have other options like using a custom *scope* or *claim* to get your IdP communicating with MeshCentral properly, without the use of preset configs. You also can set the required property if you need to limit authorization to users that are a member of at least one of the groups you set. or the siteadmin property to grant admin privilege, with the revokeAdmin property available to allow revoking admin rights also.
+
+#### *Schema*
+
+``` json
+"groups": {
+ "type": "object",
+ "properties": {
+ "recursive": {
+ "type": "boolean",
+ "default": false,
+ "description": "When true, the group memberships will be scanned recursively."
+ },
+ "required": {
+ "type": [ "string", "array" ],
+ "description": "Access is only granted to users who are a member of at least one of the listed required groups."
+ },
+ "siteadmin": {
+ "type": [ "string", "array" ],
+ "description": "Full site admin priviledges will be granted to users who are a member of at least one of the listed admin groups."
+ },
+ "revokeAdmin": {
+ "type": "boolean",
+ "default": false,
+ "description": "If true, admin privileges will be revoked from users who are NOT a member of at least one of the listed admin groups."
+ },
+ "sync": {
+ "type": [ "boolean", "object" ],
+ "default": false,
+ "description": "If true, all groups found during user login are mirrored into MeshCentral user groups.",
+ "properties": {
+ "filter": {
+ "type": [ "string", "array" ],
+ "description": "Only groups listed here are mirrored into MeshCentral user groups."
+ }
+ }
+ },
+ "scope": { "type": "string", "default": "groups", "description": "Custom scope to use." },
+ "claim": { "type": "string", "default": "groups", "description": "Custom claim to use." }
+ },
+ "additionalProperties": false
+}
+```
+
+## Preset OpenID Connect Configurations
+
+### Overview
+
+#### *Introduction*
+
+Google is a blah and is used by tons of blahs as its so great. Lets move on.
+
+#### *Common Config Chart*
+
+> NOTE: All settings directly related to presets are in the custom section of the config.
+
+| Name | Description | Example | Required |
+| --- | --- | --- | --- |
+| `preset` | Manually enable the use of a preset. | `"preset": "google"` `"preset": "azure"` | `false` |
+| `customer_id` | Customer ID of the Google Workspaces instace you plan to use with the groups feature.| `"customer_id": ["Group1", "Group2"]` | If `google` preset is used with `groups` feature |
+| `tenant_id` | Tenant ID from Azure AD, this is required to use the `azure` preset as it is part of the issuer url. | `"siteadmin": ["Group1", "Group2"]` | `false` |
+
+### Google Preset
+
+#### *Prerequisites*
+
+> Check out this [documentation](https://developers.google.com/identity/protocols/oauth2/openid-connect) to get ready before we start.
+
+#### *Basic Config Example*
+
+``` json
+"oidc": {
+ "client": {
+ "client_id": "268438852161-r8xa7qxwf3rr0shp1xnpgmm70bnag21p.apps.googleusercontent.com",
+ "client_secret": "ETFWBX-gFEaxfPXs1tWmAOkuWDFTgoL3nwh"
+ }
+}
+```
+
+#### *Specifics*
+
+If you notice above I forgot to add any preset related configs, however because google tags the client ID we can detect that and automatically use the google preset. The above config is tested, the sentive data has been scrambled of course. That said, you would normally use this preset in more advaced setups, let take a look at an example.
+
+#### *Advanced Example with Groups*
+
+``` json
+"oidc": {
+ "client": {
+ "client_id": "424555768625-k7ub3ovqs0yp7mfo0usvyyx51nfii61c.apps.googleusercontent.com",
+ "client_secret": "QLBCQY-nRYmjnFWv3nKyHGmwQEGLokP6ldk"
+ },
+ "custom": {
+ "preset": "google",
+ "customer_id": "C46kyhmps"
+ },
+ "groups": {
+ "siteadmin": ["GroupA", "GroupB"],
+ "revokeAdmin": true,
+ "sync": true
+ },
+ "callbackURL": "https://mesh.your.domain/auth-oidc-google-callback"
+},
+```
+
+#### *Customer ID and Groups*
+
+As always, the client ID and secret are required, the customer ID on the other hand is only required if you plan to take advantage of the groups function *and* the google preset. This also requires you have a customer ID, if you have do, it is available in the Google Workspace Admin Console under Profile->View. Groups work the same as they would with any other IdP but they are pulled from the Workspace groups.
+
+#### *Schema*
+
+```json
+"custom": {
+ "type": "object",
+ "properties": {
+ "preset": { "type": "string", "enum": ["azure", "google"]},
+ "customer_id": { "type": "string", "description": "Customer ID from Google, should start with 'C'."}
+ },
+ "additionalProperties": false
+},
+```
+
+### Azure Preset
+
+#### *Prerequisites*
+
+To configure OIDC-based SSO, you need an Azure account with an active subscription. [Create an account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) for free. The account used for setup must be of the following roles: Global Administrator, Cloud Application Administrator, Application Administrator, or owner the service principal.
+
+> Check this [documentation](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/add-application-portal-setup-oidc-sso) for more information.
+
+#### *Basic Config Example*
+
+``` json
+"oidc": {
+ "client": {
+ "client_id": "a1gkl04i-40g8-2h74-6v41-2jm2o2x0x27r",
+ "client_secret": "AxT6U5K4QtcyS6gF48gndL7Ys22BL15BWJImuq1O"
+ },
+ "custom": {
+ "preset": "azure",
+ "tenant_id": "46a6022g-4h33-1451-h1rc-08102ga3b5e4"
+ }
+}
+```
+
+#### *Specifics*
+
+As with all other types of configuration for the OIDC strategy, the Azure preset requires a client ID and secret.The tenant ID is used as part of the issuer URI to make even the most basic AuthN requests so it is also required for the azure preset. besides that groups are available to the Azure preset as well as the recursive feature of groups. This allows you to search user groups recursively for groups they have membership in through other groups.
+
+> NOTE: The Azure AD preset uses the Tenant ID as part of the issuer URI: `"https://login.microsoftonline.com/"` + `strategy`.custom.tenant_id + `"/v2.0"`
+
+#### *Advanced Example with Groups*
+
+``` json
+"oidc": {
+ "client": {
+ "client_id": "a1gkl04i-40g8-2h74-6v41-2jm2o2x0x27r",
+ "client_secret": "AxT6U5K4QtcyS6gF48gndL7Ys22BL15BWJImuq1O"
+ },
+ "custom": {
+ "preset": "azure",
+ "tenant_id": "46a6022g-4h33-1451-h1rc-08102ga3b5e4"
+ },
+ "groups": {
+ "recursive": true,
+ "siteadmin": ["GroupA", "GroupB"],
+ "revokeAdmin": true,
+ "sync": true
+ },
+ "callbackURL": "https://mesh.your.domain/auth-oidc-azure-callback"
+},
+```
+
+#### *Schema*
+
+```json
+"custom": {
+ "type": "object",
+ "properties": {
+ "preset": { "type": "string", "enum": ["azure", "google"]},
+ "tenant_id": { "type": "string", "description": "Tenant ID from Azure AD."}
+ },
+ "additionalProperties": false
+},
+```
+
+## Depreciated Properties
+
+### Overview
+
+#### Introduction
+
+As of MeshCentral `v1.1.22` and the writing of this documentation, the node module that handles everything was changed from [passport-openid-connect](https://github.com/jaredhanson/passport-openidconnect) to [openid-client](https://github.com/panva/node-openid-client). As a result of this change, multiple properties in the config have been depcrecated; this means some options in the strategy arent being used anymore. These are often referred to as "old configs" by this documentation.
+
+#### *Migrating Old Configs*
+
+We upgraded but what about all the existing users, we couldn't just invalidate every config pre `v1.1.22`. So in an effort to allow greater flexibility to all users of MeshCentral, and what futures scholars will all agree was an obvious move, all the depreciated configs will continue working as expected. Using any of the old options will just generate a warning in the authlog and will not stop you from using this the OIDC strategy with outdated configs, however if both the equivalent new and old config are set the new config will be used.
+
+#### *Old Config Example*
+```json
+"oidc": {
+ "newAccounts": true,
+ "clientid": "421326444155-i1tt4bsmk3jm7dri6jldekl86rfpg07r.apps.googleusercontent.com",
+ "clientsecret": "GNLXOL-kEDjufOCk6pIcTHtaHFOCgbT4hoi"
+}
+```
+
+This example was chosen because I wanted to highlight an advantage of supporting these old configs long term, even in a depreciated status. That is, the ability to copy your existing config from one of the related strategies without making any changes to your config by using the presets. This allows you to test out the oidc strategy without commiting to anything, since the user is always appended with the strategy used to login. In this example, the config was originally a google auth strategy config, changing the `"google"` to `"oidc"` is all that was done to the above config, besides obsfuscation of course.
+
+#### *Advcanced Old Config Example*
+
+``` json
+"oidc": {
+ "authorizationURL": "https://sso.your.domain/api/oidc/authorization",
+ "callbackURL": "https://mesh.your.domain/oauth2/oidc/callback",
+ "clientid": "tZiPTMDNuSaQPapAQJtwDXVnYjjhQybc",
+ "clientsecret": "vrQWspJxdVAxEFJdrxvxeQwWkooVcqdU",
+ "issuer": "https://sso.your.domain",
+ "tokenURL": "https://sso.your.domain/api/oidc/token",
+ "userInfoURL": "https://sso.your.domain/api/oidc/userinfo",
+ "logoutURL": "https://sso.your.domain/logout?rd=https://mesh.your.domain/login",
+ "groups": {
+ "recursive": true,
+ "required": ["Group1", "Group2"],
+ "siteadmin": ["GroupA", "GroupB"],
+ "sync": {
+ "filter": ["Group1", "GroupB", "OtherGroup"]
+ }
+ },
+ "newAccounts": true
+},
+```
+
+#### *Upgrading to v1.1.22*
+
+If you were already using a meticulusly configured oidc strategy, all of your configs will still be used. You will simply see a warning in the logs if any depreciated properties were used. If you check the authLog there are additional details about the old config and provide the new place to put that information. In this advanced config, even the groups will continue to work just as they did before without any user intervention when upgrading from a version of MeshCentral pre v1.1.22. There are no step to take and no action is needed, moving the configs to the new locations is completely optional at the moment.
+
+# Links
+
+https://cloud.google.com/identity/docs/reference/rest/v1/groups/list
+
+https://www.onelogin.com/learn/authentication-vs-authorization
+
+https://auth0.com/docs/authenticate/protocols/openid-connect-protocol
+
+https://github.com/panva/node-openid-client
+
+https://openid.net/connect/
+
+> You just read `openidConnectStrategy.ms v1.0.1` by [@mstrhakr](https://github.com/mstrhakr)
diff --git a/docs/docs/meshcentral/plugins.md b/docs/docs/meshcentral/plugins.md
index 20142a73..4b85b0c5 100644
--- a/docs/docs/meshcentral/plugins.md
+++ b/docs/docs/meshcentral/plugins.md
@@ -1,16 +1,140 @@
-# Plugins
+# Plugins - Installation & Usage
!!!note
- Plugins are not supported, if you have problems with MeshCentral please disable all plugins before further troubleshooting.
+ Plugins as such receive **no support** by the main developers of MeshCentral. If you experience problems with MeshCentral please make sure to **disable all plugins before further troubleshooting**!
-## Installation
+## Use Cases
-1. Enable plugins in the configuration and restart MC as described.
-2. Log into MC as full administrator.
-3. Go my `My Server` -> `Plugins`, hit the Download plugin button.
-4. A dialog opens requesting an URL, put in:
-5. The plugin pops up in the plugin list below the download button, you can now configure and enable/disable it.
+Certain feature requests may not be suitable for all MeshCentral users and thus are available as a plugin. Furthermore users can develop their own plugins - as described further below - to extend functionality or benefit from integrating MeshCentral into their existing application environment.
-## List of plugins
+## List of publically available plugins
+
+## Installation of a plugin
+
+1. First please make sure that you enable plugins in the configuration
+ >"plugins": {
+ > "enabled": true
+ >},
+2. Restart MeshCentral if you needed to change the configuration.
+2. Log into MeshCentral as full administrator.
+3. Go my `My Server` -> `Plugins`, then hit the Download plugin button.
+4. A dialog opens requesting a URL, e.g. put in:
+5. The plugin pops up in the plugin list below the download button, you can now configure and enable/disable it.
+
+# Plugins - Development & Hooks
+
+!!!note
+ Plugins as such receive **no support** by the main developers of MeshCentral. If you experience problems with MeshCentral please make sure to **disable all plugins before further troubleshooting**!
+
+## Overview
+
+Not all feature requests may be suitable for all MeshCentral users and thus can't be integrated into MeshCentral directly. Hwoever, Instead of maintaining a complete fork of MeshCentral it is much easier to extend MeshCentral's functionality using hooks and writing plugins for it.
+
+## Anatomy of a plugin:
+
+ - plugin_name/
+ -- config.json
+ -- plugin_name.js
+ -- modules_meshcore/ // optional
+ --- plugin_name.js // optional
+
+## Plugin Configuration File
+
+A valid JSON object within a file named `config.json` in the root folder of your project. An example:
+
+ {
+ "name": "Plugin Name",
+ "shortName": "plugin_name",
+ "version": "0.0.0",
+ "author": "Author Name",
+ "description": "Short Description of the plugin",
+ "hasAdminPanel": false,
+ "homepage": "https://www.example.com",
+ "changelogUrl": "https://raw.githubusercontent.com/User/Project/master/changelog.md",
+ "configUrl": "https://raw.githubusercontent.com/User/Project/master/config.json",
+ "downloadUrl": "https://github.com/User/Project/archive/master.zip",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/User/Project.git"
+ },
+ "versionHistoryUrl": "https://api.github.com/repos/User/Project/tags",
+ "meshCentralCompat": ">0.4.3"
+ }
+
+## Configuration File Properties
+
+| Field | Required | Type | Description |
+| ----------------- | -------- | ----------- | ------------------------------------------------------------ |
+| name | Yes | string | a human-readable name for the plugin |
+| shortName | Yes | string | an alphanumeric, unique short identifier for the plugin (will be used to access your functions throughout the project |
+| version | Yes | string | the current version of the plugin |
+| author | No | string | the author's name |
+| description | Yes | string | a short, human-readable description of what the plugin does |
+| hasAdminPanel | Yes | boolean | `true` or `false`, indicates whether or not the plugin will offer its own administrative interface |
+| homepage | Yes | string | the URL of the projects homepage |
+| changelogUrl | Yes | string | the URL to the changelog of the project |
+| configUrl | Yes | string | the URL to the config.json of the project |
+| downloadUrl | Yes | string | the URL to a ZIP of the project (used for installation/upgrades) |
+| repository | Yes | JSON object | contains the following attributes |
+| repository.type | Yes | string | valid values are `git` and in the future, `npm` will also be supported. |
+| repository.url | Yes | string | the URL to the project's repository |
+| versionHistoryUrl | No | string | the URL to the project's versions/tags |
+| meshCentralCompat | Yes | string | the minimum version string of required compatibility with the MeshCentral server, can be formatted as "0.1.2-c" or ">=0.1.2-c". Currently only supports minimum version, not full semantic checking. |
+
+## Plugin Hooks
+
+In essence, hooks are locations in the code which enable developers to tap into a module to either provide alternative behavior or to respond to an event.
+
+These are separated into the following categories depending on the type of functionality the plugin should offer.
+
+- Web UI, to modify the MeshCentral admin interface
+- Back End, to modify core functionality of the server and communicate with the Web UI layer as well as the Mesh Agent (Node) layer to send commands and data
+- Mesh Agent (Node), to introduce functionality to each agent
+
+### Web UI Hooks
+
+- `onDeviceRefreshEnd`: called when a device is selected in the MeshCentral web interface
+- `registerPluginTab`: callable when a device is selected in the MeshCentral web interface to register a new tab for plugin data, if required. Accepts an object, or function that returns an object, with the following properties: { tabId: "yourShortNameHere", tabTitle: "Your Display Name"}. A tab and div with the associated ID and title will be created for your use
+- `onDesktopDisconnect`: called when a remote desktop session is disconnected
+- `onWebUIStartupEnd`: called when the page has loaded for the first time after a login / refresh
+- `goPageStart`: called before page changes take effect. Passes 2 arguments ( : int, : Event)
+- `goPageEnd`: called after page changes take effect. Passes 2 arguments ( : int, : Event)
+
+#### Exports
+
+Any function can be exported to the Web UI layer by adding the name of the function to an `exports` array in the plugin object.
+
+### Back End Hooks
+
+- `server_startup`: called once when the server starts (or when the plugin is first installed)
+- `hook_agentCoreIsStable`: called once when an agent initially checks in
+- `hook_processAgentData`: called each time an agent transmits data back to the server
+- `hook_userLoggedIn`: called when a user has logged into the web interface
+- `hook_setupHttpHandlers`: called before all http handlers are setup
+
+### Mesh Agent
+
+Use of the optional file `plugin_name.js` in the optional folder `modules_meshcore` will include the file in the default meshcore file sent to each endpoint. This is useful to add functionality on each of the endpoints.
+
+## Structure
+
+Much of MeshCentral revolves around returning objects for your structures, and plugins are no different. Within your plugin you can traverse all the way up to the web server and MeshCentral Server classes to access all the functionality those layers provide. This is done by passing the current object to newly created objects, and assigning that reference to a `parent` variable within that object.
+
+
+## Ping-Pong
+
+If you build a plugin which makes use of `meshrelay.ashx`, keep in mind to either handle ping-pong messages (`serverPing`, `serverPong`) on the control channel or to request MeshCentral to not send such messages through sending the `noping=1` parameter in the connection URL. For a deeper sight search for "PING/PONG" in `meshrelay.js`.
+
+## Versioning
+
+Versioning your plugin correctly and consistently is essential to ensure users of your plugin are prompted to upgrade when it is available. Semantic versioning is recommended.
+
+## Changelog
+
+A changelog is highly recommended so that your users know what's changed since their last version.
+
+## Sample Plugin
+
+[MeshCentral-Sample](https://github.com/ryanblenis/MeshCentral-Sample) is a simple plugin that, upon disconnecting from remote desktop, prompts the user to enter a manual event (note), pre-filled in with the date and timestamp.
diff --git a/docs/docs/meshcentral/security.md b/docs/docs/meshcentral/security.md
index f442a6c5..ef1dc2d7 100644
--- a/docs/docs/meshcentral/security.md
+++ b/docs/docs/meshcentral/security.md
@@ -27,3 +27,29 @@ Adjust these items in your `config.json`
}
}
```
+
+## Duo 2FA setup
+
+MeshCentral supports Duo as a way for users to add two-factor authentication and Duo offers free accounts for user 10 users. To get started, go to [Duo.com](https://duo.com/) and create a free account. Once logged into Duo, select "Applications" and "Protect an Application" on the left side. Search for "Web SDK" and hit the "Protect" button. You will see a screen with the following information:
+
+ - Client ID
+ - Client secret
+ - API hostname
+
+Copy these three values in a safe place and do not share these values with anyone. Then, in your MeshCentral config.json file, add the following in the domains section:
+
+```json
+{
+ "domains": {
+ "": {
+ "duo2factor": {
+ "integrationkey": "ClientId",
+ "secretkey": "ClientSecret",
+ "apihostname": "api-xxxxxxxxxxx.duosecurity.com"
+ }
+ }
+ }
+}
+```
+
+Restart MeshCentral and your server should now be Duo capable. Users will see an option to enable it in the "My Account" tab. When enabling it, users will be walked thru the process of downloading the mobile application and going thru a trial run on 2FA. Users that get setup will be added to your Duo account under the "Users" / "Users" screen in Duo. Note that the "admin" user is not valid in Duo, so, if you have a user with the name "Admin" in MeshCentral, they will get an error trying to setup Duo.
diff --git a/docs/docs/meshcentral/tipsntricks.md b/docs/docs/meshcentral/tipsntricks.md
index 24992415..3126e869 100644
--- a/docs/docs/meshcentral/tipsntricks.md
+++ b/docs/docs/meshcentral/tipsntricks.md
@@ -7,3 +7,39 @@ The SSH terminal does support color. The issue is going to be the terminal confi
```bash
ls -al --color /tmp
```
+
+## Fancy config editing with VS Code
+
+A common problem in the issues is an incorrect config.json. What makes a config incorrect? How can you verify your config is correct?
+
+Easy! Use Visual Studio Code to edit your config.json and add the schema at the top.
+
+If you haven't already, download VS code.
+Download or copy the config.json to your computer.
+Open config.json in code and add the schema as the top line. This schema is the raw JSON file in the MeshCentral repo.
+
+```json
+{
+ "$schema": "https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json",
+ "settings": {
+ "your settings go here": "..."
+ }
+}
+```
+
+Now you have autocomplete, auto-format and validation for your config.json! If you start typing, Code will show the values that are valid for the location you are editing. Words with a red squiggle line are errors. Words with a orange squiggle line are warnings. Hover over both to see the error message and possible fixes. Code can even format your config.
+
+While this is a huge step up, it's not perfect. If you notice, there are some invalid keys in the screenshot. This is perfectly valid JSON and MeshCentral will ignore them (maybe?). If you paste some configs into the wrong section, code will not tell you it's in the wrong section. Autocomplete will tell you what keys are valid and the type of the value (i.e. string, number, boolean).
+
+Hopefully this will help verify your config is syntactically correct and prevent needless formatting errors, misspellings, etc.
+
+
+
+## Downloading Folders
+
+If you would like to download folders via Files simply select folder/files then use the zip and download the zip file by clicking on it.
+
+## Share device groups with AD logins
+If you would like to share device groups with different AD users.
+
+In the config.json set "ldapuserkey" to "sAMAccountName".
diff --git a/docs/docs/meshcentral/tokens.md b/docs/docs/meshcentral/tokens.md
index c190d674..7086955d 100644
--- a/docs/docs/meshcentral/tokens.md
+++ b/docs/docs/meshcentral/tokens.md
@@ -8,8 +8,18 @@
## Software Integration Tokens
-Currently, the login tokens in the user manual section 14.1 can't be tracked, deleted or revoked. They are generated with:
+!!!warning
+ You can only have a SINGLE loginTokenKey for your meshcentral server!
+ So if you regenerate a loginTokenKey, the old one will be revoked/deleted!
+
+You can create/view the Login Token Key with the following:
```bash
-node meshcentral --loginTokenKey
+node node_modules/meshcentral --loginTokenKey
+```
+
+You can then reset/revoke/renew the Login Token Key with the following to create a new one:
+
+```bash
+node node_modules/meshcentral --loginTokenKey --loginTokenGen
```
diff --git a/docs/docs/meshcmd/index.md b/docs/docs/meshcmd/index.md
index 38528f91..2c4cf1bb 100644
--- a/docs/docs/meshcmd/index.md
+++ b/docs/docs/meshcmd/index.md
@@ -1,6 +1,6 @@
# MeshCmd
-MeshCmd Guide [as .pdf](https://meshcentral.com/info/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCmd User's Guide v0.0.3.odt?raw=true)
+MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCmd User's Guide v0.0.3.odt?raw=true)
## Video Walkthru
diff --git a/docs/docs/meshctrl/index.md b/docs/docs/meshctrl/index.md
index c8f46b1c..13b74bc9 100644
--- a/docs/docs/meshctrl/index.md
+++ b/docs/docs/meshctrl/index.md
@@ -1,6 +1,6 @@
# MeshCtrl
-MeshCmd Guide [as .pdf](https://meshcentral.com/info/docs/MeshCtrlUsersGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCtrl User's Guide v0.0.1.odt?raw=true)
+MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCtrlUsersGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCtrl User's Guide v0.0.1.odt?raw=true)
## Video Walkthru
@@ -274,6 +274,7 @@ devicesharing
devicepower
indexagenterrorlog
agentdownload
+report
```
You can get this list by just running MeshCtrl without any argument and can get more information on each action by typing “meshctrl help [action]”
diff --git a/docs/docs/meshrouter/index.md b/docs/docs/meshrouter/index.md
index 057b0515..b99f042e 100644
--- a/docs/docs/meshrouter/index.md
+++ b/docs/docs/meshrouter/index.md
@@ -2,7 +2,7 @@
-MeshCentral Router Guide [as .pdf](https://meshcentral.com/info/docs/MeshCentral2RouterUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral%20Router%20User%20Guide%20v0.0.2.odt?raw=true)
+MeshCentral Router Guide [as .pdf](https://meshcentral.com/docs/MeshCentral2RouterUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral%20Router%20User%20Guide%20v0.0.2.odt?raw=true)
## Video Walkthru
@@ -21,7 +21,7 @@ MeshCentral is a remote management web site that connects users to remote comput
## Downloading
MeshCentral router is a Windows application that comes built-into the MeshCentral server or can
-be downloaded at:
+be downloaded at:
It’s probably best to use the MeshCentral router that comes with your version of the MeshCentral
server as the two will likely be most compatible. A given MeshCentral Router version may not
diff --git a/docs/docs/messaging/index.md b/docs/docs/messaging/index.md
index 36a801e5..40be9b88 100644
--- a/docs/docs/messaging/index.md
+++ b/docs/docs/messaging/index.md
@@ -158,6 +158,7 @@ Once enabled, users see the new "CallMeBot" option when trying to enable messagi
- [Signal Messenger](https://www.callmebot.com/blog/free-api-signal-send-messages/)
- [Whatsapp](https://www.callmebot.com/blog/free-api-whatsapp-messages/)
- [Facebook Messenger](https://www.callmebot.com/blog/free-api-facebook-messenger/)
+ - [Telegram](https://www.callmebot.com/blog/telegram-text-messages/)
Once the user has enabled their account, they can cut & paste the CallMeBot URI into MeshCentral to validate their account.
@@ -197,12 +198,16 @@ Once setup, the server will offer users the "Pushover" option when setting up me
No setup is reqired to enable this. When using ntfy, make sure you use a suffisently random topic name so that others can't guess the name and subscribe to it to receive your messages.
For [self-hosting your own ntfy server](https://ntfy.sh/docs/install/) with [ACL support](https://ntfy.sh/docs/config/#access-control)
+
+You can set `host` to the DNS name of your server, `userurl` to the url to provide to users to setup access to your server and `authorization` to the Basic base64 User+Pass authenttication for your server
+
```json
{
"messaging": {
"ntfy": {
- "host": "https://[my]ntfy.sh",
- "userurl": "https://[my]ntfy.sh/userhelp"
+ "host": "myntfyserver.com",
+ "userurl": "https://myntfyserver.com/userhelp",
+ "authorization": "Basic cGhpbDpteXBhc3M="
}
}
}
@@ -226,6 +231,21 @@ You can enable the MeshCentral [Zulip](https://zulip.com/) integration with the
}
```
+## Slack setup
+
+[Slack](https://slack.com/) integration is achieved by the use of Incoming Webhooks.
+You can get started by following the Slack guide [here](https://api.slack.com/messaging/webhooks) and getting your URL
+
+Once you have your incoming webhooks url, You can enable the [Slack](https://slack.com/) integration with the following config.json section
+
+```json
+{
+ "messaging": {
+ "slack": true
+ }
+}
+```
+
## User Setup
Once one or more messaging systems are setup with MeshCentral, users will be able to register their handle and verify that they own that account by typing in a 6 digit code.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 23285be2..8773ed8a 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -20,6 +20,9 @@ nav:
- 'Tokens': 'meshcentral/tokens.md'
- 'FAQ': 'meshcentral/faq.md'
- 'Tips n Tricks': 'meshcentral/tipsntricks.md'
+ - 'Messaging': 'messaging/index.md'
+ - 'Customization': 'meshcentral/customization.md'
+ - 'openidConnectStrategy': 'meshcentral/openidConnectStrategy.md'
- Design and Architecture:
- design/index.md
@@ -36,13 +39,16 @@ nav:
- Intel AMT:
- intelamt/index.md
+ - How to Contribute:
+ - how-to-contribute/index.md
+
- Other:
- other/adfs_sso_guide.md
- other/meshcentral_satellite.md
site_description: "A remote monitoring and management tool"
site_author: "Ylianst"
-site_url: "https://git.meshcentral.com/"
+site_url: "https://ylianst.github.io/MeshCentral/"
dev_addr: "0.0.0.0:8010"
diff --git a/emails/translations/account-check_hu.html b/emails/translations/account-check_hu.html
new file mode 100644
index 00000000..ee47a1ca
--- /dev/null
+++ b/emails/translations/account-check_hu.html
@@ -0,0 +1,15 @@
+
[[[SERVERNAME]]] - Email megerősítés
+
+
+
+
+ [[[SERVERNAME]]] - Megerősítés
+
+
+
+
Tisztelt [[[USERNAME]]], [[[SERVERNAME]]] e-mail megerősítést kér, kattintson az alábbi linkre a folyamat befejezéséhez.
+ Ha nem Ön kezdeményezte ezt a kérést, kérjük, hagyja figyelmen kívül ezt a levelet.
+
\ No newline at end of file
diff --git a/emails/translations/account-check_hu.txt b/emails/translations/account-check_hu.txt
new file mode 100644
index 00000000..2e420352
--- /dev/null
+++ b/emails/translations/account-check_hu.txt
@@ -0,0 +1,6 @@
+[[[SERVERNAME]]] - Email megerősítés
+Tisztelt [[[USERNAME]]], [[[SERVERNAME]]] ([[[SERVERURL]]][[[URLARGS1]]]) e-mail ellenőrzést végez. A folyamat befejezéséhez lépjen a következő linkre:
+~
+~[[[SERVERURL]]]/checkmail?c=[[[COOKIE]]][[[URLARGS2]]]
+~
+Ha nem Ön kezdeményezte ezt a kérést, kérjük, hagyja figyelmen kívül ezt a levelet.
\ No newline at end of file
diff --git a/emails/translations/account-check_zh-chs.html b/emails/translations/account-check_zh-chs.html
index 458f9dae..49ebb484 100644
--- a/emails/translations/account-check_zh-chs.html
+++ b/emails/translations/account-check_zh-chs.html
@@ -1,4 +1,4 @@
-
- 如果您没有发起此请求，请不理此邮件。
+ 如果您没有发起此请求，请忽略此邮件。
\ No newline at end of file
diff --git a/emails/translations/account-check_zh-chs.txt b/emails/translations/account-check_zh-chs.txt
index 95c6ca31..38db4b5b 100644
--- a/emails/translations/account-check_zh-chs.txt
+++ b/emails/translations/account-check_zh-chs.txt
@@ -1,6 +1,6 @@
-更改邮件地址
+[[[SERVERNAME]]] - 邮件验证
嗨[[[USERNAME]]]，[[[SERVERNAME]]] ([[[SERVERURL]]][[[URLARGS1]]]) 正在执行邮件验证。转到以下链接以完成该过程：
~
~[[[SERVERURL]]]/checkmail?c=[[[COOKIE]]][[[URLARGS2]]]
~
-如果您没有发起此请求，请不理此邮件。
\ No newline at end of file
+如果您没有发起此请求，请忽略此邮件。
\ No newline at end of file
diff --git a/emails/translations/account-invite_hu.html b/emails/translations/account-invite_hu.html
new file mode 100644
index 00000000..b6151710
--- /dev/null
+++ b/emails/translations/account-invite_hu.html
@@ -0,0 +1,19 @@
+
[[[SERVERNAME]]] - Fiók meghívó
+
+
+
+
+ [[[SERVERNAME]]] - Fiók meghívó
+
+
+
+
Létrehozásra került Önnek egy fiók a kiszolgálón [[[SERVERNAME]]], most a következőkkel érheti el:
\ No newline at end of file
diff --git a/emails/translations/account-invite_hu.txt b/emails/translations/account-invite_hu.txt
new file mode 100644
index 00000000..6b85d933
--- /dev/null
+++ b/emails/translations/account-invite_hu.txt
@@ -0,0 +1,5 @@
+[[[SERVERNAME]]] - Fiók meghívó
+A [[[SERVERNAME]]] szerveren ([[[SERVERURL]]]/[[[URLARGS1]]]) létrehozásra került egy fiókot az Ön számára, amelyhez most már hozzáférhet a "[[[[ACCOUNTNAME]]]" felhasználónévvel és a "[[[[PASSWORD]]]" jelszóval.
+~
+Üdvözlettel,
+~[[[USERNAME]]]
\ No newline at end of file
diff --git a/emails/translations/account-invite_pt.html b/emails/translations/account-invite_pt.html
index 84d3e9e8..d804ac67 100644
--- a/emails/translations/account-invite_pt.html
+++ b/emails/translations/account-invite_pt.html
@@ -7,7 +7,7 @@
-
Uma conta foi criada para você no servidor [[[SERVERNAME]]], você pode acessá-lo agora com:
+
Uma conta foi criada para você no servidor [[[SERVERNAME]]], pode aceder agora com:
Nome de usuário: [[[ACCOUNTNAME]]]
Senha: [[[PASSWORD]]]
diff --git a/emails/translations/account-login_hu.html b/emails/translations/account-login_hu.html
new file mode 100644
index 00000000..e8c93ae3
--- /dev/null
+++ b/emails/translations/account-login_hu.html
@@ -0,0 +1,12 @@
+
[[[SERVERNAME]]] - Bejelentkezés a fiókba
+
+
+
+
+ [[[SERVERNAME]]] - Bejelentkezés a fiókba
+
+
+
+
Az Ön bejelentkezési tokenje: [[[TOKEN]]]
+
Ez a token csak egyszer használható, és 5 percig érvényes.
+
\ No newline at end of file
diff --git a/emails/translations/account-login_hu.txt b/emails/translations/account-login_hu.txt
new file mode 100644
index 00000000..0b104a09
--- /dev/null
+++ b/emails/translations/account-login_hu.txt
@@ -0,0 +1,4 @@
+[[[SERVERNAME]]] - Bejelentkezés a fiókba
+Az Ön bejelentkezési tokenje: [[[TOKEN]]]
+~
+Ez a token csak egyszer használható, és 5 percig érvényes.
\ No newline at end of file
diff --git a/emails/translations/account-reset_hu.html b/emails/translations/account-reset_hu.html
new file mode 100644
index 00000000..4d8247d9
--- /dev/null
+++ b/emails/translations/account-reset_hu.html
@@ -0,0 +1,15 @@
+
[[[SERVERNAME]]] - Fiók visszaállítás
+
+
+
+
+ [[[SERVERNAME]]] - Megerősítés
+
+
+
+
Tisztelt [[[USERNAME]]], [[[SERVERNAME]]] fiókhoz tartozó jelszó visszaállítási igényt kapott, kattintson a következő linkre a folyamat befejezéséhez.
+ Ha nem Ön kezdeményezte ezt a kérést, kérjük, hagyja figyelmen kívül ezt a levelet.
+
\ No newline at end of file
diff --git a/emails/translations/account-reset_hu.txt b/emails/translations/account-reset_hu.txt
new file mode 100644
index 00000000..39f76c76
--- /dev/null
+++ b/emails/translations/account-reset_hu.txt
@@ -0,0 +1,6 @@
+[[[SERVERNAME]]] - Fiók visszaállítás
+Tisztelt [[[USERNAME]]], [[[SERVERNAME]]] ([[[SERVERURL]]][[[URLARGS1]]]) a fiók jelszavának visszaállítását kéri. A folyamat befejezéséhez lépjen a következő linkre:
+~
+~[[[SERVERURL]]]/checkmail?c=[[[COOKIE]]][[[URLARGS2]]]
+~
+Ha nem Ön kezdeményezte ezt a kérést, kérjük, hagyja figyelmen kívül ezt a levelet.
\ No newline at end of file
diff --git a/emails/translations/account-reset_zh-chs.html b/emails/translations/account-reset_zh-chs.html
index e75bd63f..824250dd 100644
--- a/emails/translations/account-reset_zh-chs.html
+++ b/emails/translations/account-reset_zh-chs.html
@@ -11,5 +11,5 @@
\ No newline at end of file
diff --git a/emails/translations/account-reset_zh-chs.txt b/emails/translations/account-reset_zh-chs.txt
index 97e9a2b7..8f1e1cb9 100644
--- a/emails/translations/account-reset_zh-chs.txt
+++ b/emails/translations/account-reset_zh-chs.txt
@@ -3,4 +3,4 @@
~
~[[[SERVERURL]]]/checkmail?c=[[[COOKIE]]][[[URLARGS2]]]
~
-如果您没有发起此请求，请不理此邮件。
\ No newline at end of file
+如果您没有发起此请求，请忽略此邮件。
\ No newline at end of file
diff --git a/emails/translations/device-help_de.html b/emails/translations/device-help_de.html
index 9eccab26..7e01917a 100644
--- a/emails/translations/device-help_de.html
+++ b/emails/translations/device-help_de.html
@@ -8,13 +8,13 @@