feat: signalk v2, nodejs v18, openssl 1.1.1u, remove W7 support (#16)

NSIS/signalk-server.nsi

@@ -13,7 +13,7 @@
   !include "MUI2.nsh"
 ;======================================================
 ;General
-  !define INST_VERSION "1.0.0"
+  !define INST_VERSION "1.1.0"
   BrandingText "Signal K from http://signalk.org/"
   Name "Signal K installer ${INST_VERSION}"
   OutFile "..\output\signalk-server-setup-${INST_VERSION}.exe"
@@ -65,7 +65,8 @@
   Var /GLOBAL NODE_UPGRADE
   Var /GLOBAL NODE_SHORT_VERSION
   Var /GLOBAL NODE_VERSION
-
+  Var /GLOBAL SIGNALK_NODE_CONFIG_DIR
+
   Function SetGlobalVars
     LogSet on
     StrCpy $USERPROFILE $INSTDIR\signalkhome
@@ -75,21 +76,17 @@
     StrCpy $OPENSSL_BIN_PATH '$INSTDIR\openssl\bin'
     StrCpy $OPENSSL_CONF '$INSTDIR\openssl\openssl.cnf'
     StrCpy $TOOLS_PATH '$INSTDIR\tools'
+    StrCpy $SIGNALK_NODE_CONFIG_DIR '$USERPROFILE\.signalk'
+
     ${If} ${AtLeastWin10}
-      StrCpy $NODE64_URL 'https://nodejs.org/dist/v16.13.2/node-v16.13.2-win-x64.zip'
-      StrCpy $NODE86_URL 'https://nodejs.org/dist/v16.13.2/node-v16.13.2-win-x86.zip'
-      StrCpy $NODE64_ORG_DIR 'node-v16.13.2-win-x64'
-      StrCpy $NODE86_ORG_DIR 'node-v16.13.2-win-x86'
-      StrCpy $NODE_VERSION 'v16.13.2'
-      StrCpy $NODE_SHORT_VERSION 'v16'
+      StrCpy $NODE64_URL 'https://nodejs.org/dist/v18.17.1/node-v18.17.1-win-x64.zip'
+      StrCpy $NODE86_URL 'https://nodejs.org/dist/v18.17.1/node-v18.17.1-win-x86.zip'
+      StrCpy $NODE64_ORG_DIR 'node-v18.17.1-win-x64'
+      StrCpy $NODE86_ORG_DIR 'node-v18.17.1-win-x86'
+      StrCpy $NODE_VERSION 'v18.17.1'
+      StrCpy $NODE_SHORT_VERSION 'v18'
     ${Else}
-      StrCpy $NODE64_URL 'https://nodejs.org/download/release/v12.22.9/node-v12.22.9-win-x64.zip'
-      StrCpy $NODE86_URL 'https://nodejs.org/download/release/v12.22.9/node-v12.22.9-win-x86.zip'
-      StrCpy $NODE64_ORG_DIR 'node-v12.22.9-win-x64'
-      StrCpy $NODE86_ORG_DIR 'node-v12.22.9-win-x86'
       StrCpy $W7_DETECTED '1'
-      StrCpy $NODE_VERSION 'v12.22.9'
-      StrCpy $NODE_SHORT_VERSION 'v12'
     ${EndIf}
   FunctionEnd
 
@@ -109,8 +106,9 @@
     SetDetailsView show
     LogText "Signal K installer version: ${INST_VERSION}"
     ${IfNot} ${AtLeastWin10}
-      MessageBox MB_ICONEXCLAMATION|MB_OK "Your current version of Windows is lower than Windows 10,$\nNodeJS 12 will be installed instead of NodeJS 16.$\nLimited support for Signal K server versions > 1.40.0."
-      LogText "Windows version < 10 detected, install NodeJS 12"
+      MessageBox MB_ICONEXCLAMATION|MB_OK "Your current version of Windows is lower than Windows 10,$\nOperating System version prior to Windows 10 are no longer supported with recent versions of Signal K server. "
+      LogText "Windows version < 10 detected, installation cancelled "
+      Abort
     ${EndIf}
     LogSet off
   FunctionEnd
@@ -125,9 +123,9 @@
     FileWrite $9 '@ECHO OFF$\r$\n'
     FileWrite $9 '$INSTALL_DRIVE$\r$\n'
     FileWrite $9 'set USERPROFILE=$USERPROFILE$\r$\n'
-    FileWrite $9 'set NODE_PATH=$NODE_PATH$\r$\n'
-    FileWrite $9 'set PATH=%NODE_PATH%;$OPENSSL_BIN_PATH;%PATH%$\r$\n'
-    FileWrite $9 'set SIGNALK_NODE_CONFIG_DIR=%USERPROFILE%\.signalk$\r$\n'
+    FileWrite $9 'set NODE_PATH=$NODE_MODULES_PATH$\r$\n'
+    FileWrite $9 'set PATH=$NODE_PATH;$OPENSSL_BIN_PATH;%PATH%$\r$\n'
+    FileWrite $9 'set SIGNALK_NODE_CONFIG_DIR=$SIGNALK_NODE_CONFIG_DIR$\r$\n'
     FileWrite $9 'set SIGNALK_SERVER_IS_UPDATABLE=1$\r$\n'
     FileWrite $9 'set OPENSSL_CONF=$OPENSSL_CONF$\r$\n'
     FileWrite $9 'cd %USERPROFILE%$\r$\n'
@@ -140,14 +138,16 @@
     DetailPrint "Create $USERPROFILE\.npmrc"
     FileOpen  $9  $USERPROFILE\.npmrc w
     FileWrite $9 'cache=$USERPROFILE\npm-cache$\r$\n'
-    FileWrite $9 'tmp=$USERPROFILE\tmp$\r$\n'
     FileWrite $9 'prefix=$NODE_PATH$\r$\n'
     FileWrite $9 '$\r$\n'
     FileClose $9
 
     DetailPrint "Create $TOOLS_PATH\signalk-server-services.js"
     FileOpen  $9  $TOOLS_PATH\signalk-server-services.js w
-    FileWrite $9 'process.env.SIGNALK_NODE_CONFIG_DIR = process.env.USERPROFILE + "\\.signalk"$\r$\n'
+      Push $SIGNALK_NODE_CONFIG_DIR
+      Call ConvertBStoDBS 
+      Pop $R0
+    FileWrite $9 'process.env.SIGNALK_NODE_CONFIG_DIR = "$R0"$\r$\n'
     FileWrite $9 'process.env.SIGNALK_SERVER_IS_UPDATABLE = "1"$\r$\n'
     FileWrite $9 '//process.env.DEBUG = ""$\r$\n'
       Push $OPENSSL_BIN_PATH
@@ -232,8 +232,8 @@
     FileWrite $9 '@ECHO OFF$\r$\n'
     FileWrite $9 '$INSTALL_DRIVE$\r$\n'
     FileWrite $9 'echo Install signalk as service in progress...$\r$\n'
-    FileWrite $9 'set NODE_PATH=$NODE_PATH$\r$\n'
-    FileWrite $9 'set "PATH=%NODE_PATH%;%PATH%"$\r$\n'
+    FileWrite $9 'set NODE_PATH=$NODE_MODULES_PATH$\r$\n'
+    FileWrite $9 'set "PATH=$NODE_PATH;%PATH%"$\r$\n'
     FileWrite $9 'cd $TOOLS_PATH$\r$\n'
     FileWrite $9 'node .\install-signalk-server-services.js$\r$\n'
     FileWrite $9 'if %ERRORLEVEL% neq 0 goto :ERROR$\r$\n'
@@ -291,8 +291,8 @@
     FileWrite $9 'echo Install log saved in $INSTDIR\$LOG_FILE file$\r$\n'
     FileWrite $9 'echo Please wait ...$\r$\n'
     FileWrite $9 'set USERPROFILE=$USERPROFILE$\r$\n'
-    FileWrite $9 'set NODE_PATH=$NODE_PATH$\r$\n'
-    FileWrite $9 'set "Path=%NODE_PATH%;%Path%"$\r$\n'
+    FileWrite $9 'set NODE_PATH=$NODE_MODULES_PATH$\r$\n'
+    FileWrite $9 'set "Path=$NODE_PATH;%Path%"$\r$\n'
     FileWrite $9 'set OPENSSL_CONF=$OPENSSL_CONF$\r$\n'
     FileWrite $9 'cd $NODE_PATH$\r$\n'
     FileWrite $9 'echo "start: npm install -g --unsafe-perm  [email protected]" 1>>$INSTDIR\$LOG_FILE 2>&1$\r$\n'
@@ -316,8 +316,8 @@
     FileWrite $9 'echo Install log saved in $INSTDIR\$LOG_FILE file$\r$\n'
     FileWrite $9 'echo Please wait this may take some time ...$\r$\n'
     FileWrite $9 'set USERPROFILE=$USERPROFILE$\r$\n'
-    FileWrite $9 'set NODE_PATH=$NODE_PATH$\r$\n'
-    FileWrite $9 'set "Path=%NODE_PATH%;%Path%"$\r$\n'
+    FileWrite $9 'set NODE_PATH=$NODE_MODULES_PATH$\r$\n'
+    FileWrite $9 'set "Path=$NODE_PATH;%Path%"$\r$\n'
     FileWrite $9 'set OPENSSL_CONF=$OPENSSL_CONF$\r$\n'
     FileWrite $9 'cd $NODE_PATH$\r$\n'
     FileWrite $9 'echo "start: npm install -g --unsafe-perm  signalk-server" 1>>$INSTDIR\$LOG_FILE 2>&1$\r$\n'
@@ -332,32 +332,40 @@
     FileWrite $9 '$\r$\n'
     FileClose $9
 
-    ${If} $W7_DETECTED == "1"
-      DetailPrint "Create $TOOLS_PATH\npm-install-serial.cmd for Windows 7"
-      StrCpy $LOG_FILE "npm-inst-serial.log"
-      FileOpen  $9  $TOOLS_PATH\npm-install-serial.cmd w
-      FileWrite $9 '@ECHO OFF$\r$\n'
-      FileWrite $9 '$INSTALL_DRIVE$\r$\n'
-      FileWrite $9 'echo Install alternative package for serial port support in progress...$\r$\n'
-      FileWrite $9 'echo Install log saved in $INSTDIR\$LOG_FILE file$\r$\n'
-      FileWrite $9 'echo Please wait ...$\r$\n'
-      FileWrite $9 'set USERPROFILE=$USERPROFILE$\r$\n'
-      FileWrite $9 'set NODE_PATH=$NODE_PATH$\r$\n'
-      FileWrite $9 'set "Path=%NODE_PATH%;%Path%"$\r$\n'
-      FileWrite $9 'set OPENSSL_CONF=$OPENSSL_CONF$\r$\n'
-      FileWrite $9 'cd $NODE_PATH$\r$\n'
-      FileWrite $9 'echo "start: npm install -g --unsafe-perm [email protected]" 1>>$INSTDIR\$LOG_FILE 2>&1$\r$\n'
-      FileWrite $9 'call npm install -g --unsafe-perm [email protected] 1>>$INSTDIR\$LOG_FILE 2>&1$\r$\n'
-      FileWrite $9 'if %ERRORLEVEL% neq 0 goto :ERROR$\r$\n'
-      FileWrite $9 'exit /b 0$\r$\n'
-      FileWrite $9 ':ERROR$\r$\n'
-      FileWrite $9 'echo An ERROR has occurred.$\r$\n'
-      FileWrite $9 'echo See the $INSTDIR\$LOG_FILE file$\r$\n'
-      FileWrite $9 'pause$\r$\n'
-      FileWrite $9 'exit /b 1$\r$\n'
-      FileWrite $9 '$\r$\n'
-      FileClose $9
-    ${EndIf}
+    DetailPrint "Create $TOOLS_PATH\generate-certificate.cmd"
+    StrCpy $LOG_FILE "generate-certificate.log"
+    FileOpen  $9  $TOOLS_PATH\generate-certificate.cmd w
+    FileWrite $9 '@ECHO OFF$\r$\n'
+    FileWrite $9 '$INSTALL_DRIVE$\r$\n'
+    FileWrite $9 'echo log saved in $INSTDIR\$LOG_FILE file$\r$\n'
+    FileWrite $9 'echo Check if certificate already exist$\r$\n'
+    FileWrite $9 'if exist "$SIGNALK_NODE_CONFIG_DIR\ssl-cert.pem" goto :NOGENCERT$\r$\n'
+    FileWrite $9 'if exist "$SIGNALK_NODE_CONFIG_DIR\ssl-key.pem" goto :NOGENCERT$\r$\n'
+    FileWrite $9 'goto :GENCERT$\r$\n'
+    FileWrite $9 ':NOGENCERT$\r$\n'
+    FileWrite $9 'echo Certificate already exist in directory $SIGNALK_NODE_CONFIG_DIR$\r$\n'
+    FileWrite $9 'echo Certificate already exist in directory $SIGNALK_NODE_CONFIG_DIR >>$INSTDIR\$LOG_FILE$\r$\n'
+    FileWrite $9 'echo Delete the ssl-cert.pem and ssl-key.pem files to generate a new certificate.$\r$\n'
+    FileWrite $9 'echo Delete the ssl-cert.pem and ssl-key.pem files to generate a new certificate. >>$INSTDIR\$LOG_FILE$\r$\n'
+    FileWrite $9 'exit /b 0$\r$\n'
+    FileWrite $9 ':GENCERT$\r$\n'
+    FileWrite $9 'echo Generate certificate in progress...$\r$\n'
+    FileWrite $9 'echo Generatecertificate in progress... >>$INSTDIR\$LOG_FILE$\r$\n'
+    FileWrite $9 'set PATH=$NODE_PATH;$OPENSSL_BIN_PATH;%PATH%$\r$\n'
+    FileWrite $9 'set "Path=$NODE_PATH;%Path%"$\r$\n'
+    FileWrite $9 'set OPENSSL_CONF=$OPENSSL_CONF$\r$\n'
+    FileWrite $9 'cd $SIGNALK_NODE_CONFIG_DIR\$\r$\n'
+    FileWrite $9 'echo "openssl req -newkey rsa:2048 -nodes -keyout ssl-key.pem -x509 -out ssl-cert.pem -days 3650 -config $TOOLS_PATH\certificate-authority-self-signing.conf"  >>$INSTDIR\$LOG_FILE$\r$\n'
+    FileWrite $9 'openssl req -newkey rsa:2048 -nodes -keyout ssl-key.pem -x509 -out ssl-cert.pem -days 3650 -config "$TOOLS_PATH\certificate-authority-self-signing.conf" 1>>$INSTDIR\$LOG_FILE 2>&1$\r$\n'
+    FileWrite $9 'if %ERRORLEVEL% neq 0 goto :ERROR$\r$\n'
+    FileWrite $9 'exit /b 0$\r$\n'
+    FileWrite $9 ':ERROR$\r$\n'
+    FileWrite $9 'echo An ERROR has occurred.$\r$\n'
+    FileWrite $9 'echo See the $INSTDIR\$LOG_FILE file$\r$\n'
+    FileWrite $9 'pause$\r$\n'
+    FileWrite $9 'exit /b 1$\r$\n'
+    FileWrite $9 '$\r$\n'
+    FileClose $9
 
     DetailPrint "Create $TOOLS_PATH\SignalK-CLI.lnk"
     CreateShortCut "$TOOLS_PATH\SignalK-CLI.lnk" "cmd" \
@@ -462,12 +470,10 @@
 
   Section "install signalk-server" SecSkInstall
     LogSet on
-    ${If} $W7_DETECTED == "1"
-      ExecWait '"$TOOLS_PATH\npm-install-serial.cmd"' $0
-      DetailPrint "npm install -g --unsafe-perm [email protected] returned $0"
-    ${EndIf}
     ExecWait '"$TOOLS_PATH\npm-install-signalk-server.cmd"' $0
     DetailPrint "npm install -g --unsafe-perm  signalk-server returned $0"
+    ExecWait '"$TOOLS_PATH\generate-certificate.cmd"' $0
+    DetailPrint "generate-certificate returned $0"
   SectionEnd
 
   Section "Signal K as services" SecSkService
@@ -491,7 +497,7 @@
       !insertmacro CreateInternetShortcutWithIcon "$DESKTOP\SignalK-GUI.URL" "http://localhost:3000" "$TOOLS_PATH\signalk.ico" 0
     SectionEnd
 
-    Section /o "Signal K CLI" SecSignalkCli
+    Section "Signal K CLI" SecSignalkCli
       LogSet on
       DetailPrint "Create desktop shortcut 'Signal K CLI'"
       CreateShortCut "$DESKTOP\Signal K CLI.lnk" "cmd" \

readme.md

@@ -1,21 +1,20 @@
-**All in one Windows installer v1.0.0 for Signal K server node http://signalk.org/**  
+**All in one Windows installer v1.1.0 for Signal K server node http://signalk.org/**  
 
 ___  
 # Prerequisite  
 - Internet connection during setup process  
-- **If you have already installed Signal K** with a previous version of the installer with a version of NodeJS lower than 16,  
+- **If you have already installed Signal K** with a previous version of the installer with a version of NodeJS lower than 18,  
 you will see a windows like this:  
 ![Install-SelectDir](screenshots/Install-CheckNode.png)  
 Please see [Upgrade NodeJS](#upgrade-nodejs) before !  
 - **If your current OS version is lower than Windows 10**,  
-NodeJS 12 will be installed instead of NodeJS 16 with limited Signal K server support ( Windows 7 is end of life ).
+Operating System version prior to Windows 10 are no longer supported with recent versions of Signal K server.
 
 # What's provide with this installer  
 - The latest version of the Signal K server downloaded during installation.  
-- NodeJS 16.13.2 ( downloaded from https://nodejs.org/dist/v16.13.2/ during installation).  
-**If your current OS version is lower than Windows 10**, NodeJS 12 only will be install (https://nodejs.org/download/release/v12.22.9/)  
-- openssl 1.1.1h ( from https://slproweb.com/products/Win32OpenSSL.html ).  
-- support of X64 and X86 Windows version (Windows 10 X64 and Windows 7 X86 tested).  
+- NodeJS 18.17.1 ( downloaded from https://nodejs.org/dist/v18.17.1/ during installation).  
+- openssl 1.1.1u ( from https://slproweb.com/products/Win32OpenSSL.html ).  
+- support of X64 and X86 Windows version (Windows 10 X64).  
 - All packages are installed under a root directory. You choose your root directory at the time of installation.  
 - Signal K can start as windows service if you choose it at the time of installation.  
 - You can re-run the installer several times.  
@@ -45,8 +44,13 @@ The `Signal K as services` option is selected by default, this is the most inter
 
 - Several windows will open successively during the installation.  
 ![Install-Progress-Download-nodejs](screenshots/Install-Progress-Download-nodejs.png)  
-![Install-Progress-NPM-SignalK](screenshots/Install-Progress-NPM-SignalK.png)  
 ![Install-Progress-NPM-node-windows](screenshots/Install-Progress-NPM-node-windows.png)  
+![Install-Progress-NPM-SignalK](screenshots/Install-Progress-NPM-SignalK.png)  
+![Install-Progress-openssl-certificate](screenshots/Install-Progress-openssl-certificate.png)  
+
+- To simplify implementation of the https protocol with your Signal K server, a auto-signed certificat is generated at the installation time.  
+If you enable ssl mode in the server, your web browser will alert you with the indication of an insecure connection.  
+It's not ideal solution but at least it won't lock your Signal K server if you want to try the ssl mode.  
 
 - The `Signal K as services` will bring up 3 message boxes asking permission to install the Windows service.  
 Answer with `OK`.  
@@ -99,18 +103,19 @@ Or ask for support at http://slack-invite.signalk.org/ in channel #support-windo
 - `stop-signalk-server-services.cmd` stop the Signal K service, you must `Run as administrator` this script.  
 - `remove-signalk-server-services.cmd` remove the Signal K windows service, use this before delete the root directory. You must `Run as administrator` this script.  
 - `create-signalk-server-services.cmd` create the Signal K windows service if you didn't choose it at installation. Cannot be re-run if `tools\daemon` directory exist. You must `Run as administrator` this script.  
+- `generate-certificat.cmd` generates a self-signed certificate for the Signal K server in https mode.  
 
 # Upgrade NodeJS  
-Since the installer in version 1.0.0, NodeJS is provided in version 16.  
-If you have already installed Signal K with a previous version (with NodeJS version 10),  
+Since the installer in version 1.1.0, NodeJS is provided in version 18.  
+If you've already installed Signal K with an earlier version (e.g. NodeJS 10, 12 or 16),  
 it is recommended to make a new installation and then restore the configuration of your Signal K server later.  
 - Stop your Signal K server `stop-signalk-server-services.cmd`.  
 - Remove the Signal K service `remove-signalk-server-services.cmd`.  
 - Close all windows related to signal K.  
-- Rename your Signal K root directory: e.g. `c:\signalk` to `c:\signalk10`.  
+- Rename your Signal K root directory: e.g. `c:\signalk` to `c:\signalk-old`.  
 This way, you will keep your Signal K server configuration in a safe place.  
 You can also `Backup` your Signal K server configuration in GUI server: `Server` then `Backup/Restore`.  
-See also the tips here, about plugin compatibility: [Updating to Node.js-16](https://github.com/SignalK/signalk-server/wiki/Updating-to-Node.js-16)
+See also the tips here, about plugin compatibility: [Installing and Updating Node.js](https://github.com/SignalK/signalk-server/wiki/Installing-and-Updating-Node.js)
 - Start installer and install Signal K in the original directory: e.g. `c:\signalk`.  
 - Start the Signal K server and check first without any plugins.  
 - If everything is OK, reinstall your plugins, restore your previous configuration with the `Backup/Restore` function  

target/openssl-x64/authors.txt

@@ -13,6 +13,8 @@ Ben Kaduk
 Bernd Edlinger
 Bodo Möller
 David Benjamin
+David von Oheimb
+Dmitry Belyavskiy (Дмитрий Белявский)
 Emilia Käsper
 Eric Young
 Geoff Thorpe
@@ -22,14 +24,19 @@ Lutz Jänicke
 Mark J. Cox
 Matt Caswell
 Matthias St. Pierre
+Nicola Tuveri
 Nils Larsch
+Patrick Steuer
 Paul Dale
 Paul C. Sutton
+Paul Yang
 Ralf S. Engelschall
 Rich Salz
 Richard Levitte
+Shane Lontis
 Stephen Henson
 Steve Marquess
 Tim Hudson
+Tomáš Mráz
 Ulf Möller
 Viktor Dukhovni

target/openssl-x64/bin/tsget.pl

@@ -47,7 +47,7 @@ sub create_curl {
     $curl->setopt(CURLOPT_VERBOSE, 1) if $options{d};
     $curl->setopt(CURLOPT_FAILONERROR, 1);
     $curl->setopt(CURLOPT_USERAGENT,
-        "OpenTSA tsget.pl/openssl-1.1.1h");
+        "OpenTSA tsget.pl/openssl-1.1.1u");
 
     # Options for POST method.
     $curl->setopt(CURLOPT_UPLOAD, 1);