aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbas-vk <bas-vk@users.noreply.github.com>2016-12-11 07:01:57 +0800
committerFelix Lange <fjl@users.noreply.github.com>2016-12-11 07:01:57 +0800
commit4f9ccdd70f69dd0a879329d57ec21588f29f182c (patch)
tree485d305d44c364b93a4c6a06505803bb97ba70af
parent4e36b1e3dadda62a53e309a1b6cf7aed97ea7a3a (diff)
downloaddexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.tar
dexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.tar.gz
dexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.tar.bz2
dexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.tar.lz
dexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.tar.xz
dexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.tar.zst
dexon-4f9ccdd70f69dd0a879329d57ec21588f29f182c.zip
build: safe update of PATH on Windows (#3419)
NSIS has a default MAX_STR_LEN of 1024. If $ENV{PATH} is longer the returned string is truncated to an empty string. Its then not possible to distinguis between the variable not set or too long. As a result the variable is set with the location where geth and/or dev tools are installed. This may override any previous set values.
-rw-r--r--build/ci.go1
-rw-r--r--build/nsis.geth.nsi5
-rw-r--r--build/nsis.install.nsh5
-rw-r--r--build/nsis.pathupdate.nsh153
-rw-r--r--build/nsis.uninstall.nsh3
5 files changed, 164 insertions, 3 deletions
diff --git a/build/ci.go b/build/ci.go
index c985e2da6..602eb8239 100644
--- a/build/ci.go
+++ b/build/ci.go
@@ -638,6 +638,7 @@ func doWindowsInstaller(cmdline []string) {
build.Render("build/nsis.geth.nsi", filepath.Join(*workdir, "geth.nsi"), 0644, nil)
build.Render("build/nsis.install.nsh", filepath.Join(*workdir, "install.nsh"), 0644, templateData)
build.Render("build/nsis.uninstall.nsh", filepath.Join(*workdir, "uninstall.nsh"), 0644, allTools)
+ build.Render("build/nsis.pathupdate.nsh", filepath.Join(*workdir, "PathUpdate.nsh"), 0644, nil)
build.Render("build/nsis.envvarupdate.nsh", filepath.Join(*workdir, "EnvVarUpdate.nsh"), 0644, nil)
build.CopyFile(filepath.Join(*workdir, "SimpleFC.dll"), "build/nsis.simplefc.dll", 0755)
build.CopyFile(filepath.Join(*workdir, "COPYING"), "COPYING", 0755)
diff --git a/build/nsis.geth.nsi b/build/nsis.geth.nsi
index dbeb9319c..1034f3023 100644
--- a/build/nsis.geth.nsi
+++ b/build/nsis.geth.nsi
@@ -17,8 +17,12 @@
#
# Requirements:
# - NSIS, http://nsis.sourceforge.net/Main_Page
+# - NSIS Large Strings build, http://nsis.sourceforge.net/Special_Builds
# - SFP, http://nsis.sourceforge.net/NSIS_Simple_Firewall_Plugin (put dll in NSIS\Plugins\x86-ansi)
#
+# After intalling NSIS extra the NSIS Large Strings build zip and replace the makensis.exe and the
+# files found in Stub.
+#
# based on: http://nsis.sourceforge.net/A_simple_installer_with_start_menu_shortcut_and_uninstaller
#
# TODO:
@@ -37,6 +41,7 @@ RequestExecutionLevel admin
SetCompressor /SOLID lzma
!include LogicLib.nsh
+!include PathUpdate.nsh
!include EnvVarUpdate.nsh
!macro VerifyUserIsAdmin
diff --git a/build/nsis.install.nsh b/build/nsis.install.nsh
index f9ad8e95e..57ef5a37c 100644
--- a/build/nsis.install.nsh
+++ b/build/nsis.install.nsh
@@ -37,8 +37,9 @@ Section "Geth" GETH_IDX
${EnvVarUpdate} $0 "ETHEREUM_SOCKET" "R" "HKLM" "\\.\pipe\geth.ipc"
${EnvVarUpdate} $0 "ETHEREUM_SOCKET" "A" "HKLM" "\\.\pipe\geth.ipc"
- # Add geth to PATH
- ${EnvVarUpdate} $0 "PATH" "A" "HKLM" $INSTDIR
+ # Add instdir to PATH
+ Push "$INSTDIR"
+ Call AddToPath
SectionEnd
# Install optional develop tools.
diff --git a/build/nsis.pathupdate.nsh b/build/nsis.pathupdate.nsh
new file mode 100644
index 000000000..f54b7e3e1
--- /dev/null
+++ b/build/nsis.pathupdate.nsh
@@ -0,0 +1,153 @@
+!include "WinMessages.nsh"
+
+; see https://support.microsoft.com/en-us/kb/104011
+!define Environ 'HKLM "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"'
+; HKEY_LOCAL_MACHINE = 0x80000002
+
+; AddToPath - Appends dir to PATH
+; (does not work on Win9x/ME)
+;
+; Usage:
+; Push "dir"
+; Call AddToPath
+Function AddToPath
+ Exch $0
+ Push $1
+ Push $2
+ Push $3
+ Push $4
+
+ ; NSIS ReadRegStr returns empty string on string overflow
+ ; Native calls are used here to check actual length of PATH
+ ; $4 = RegOpenKey(HKEY_LOCAL_MACHINE, "SYSTEM\CurrentControlSet\Control\Session Manager\Environment", &$3)
+ System::Call "advapi32::RegOpenKey(i 0x80000002, t'SYSTEM\CurrentControlSet\Control\Session Manager\Environment', *i.r3) i.r4"
+ IntCmp $4 0 0 done done
+
+ ; $4 = RegQueryValueEx($3, "PATH", (DWORD*)0, (DWORD*)0, &$1, ($2=NSIS_MAX_STRLEN, &$2))
+ ; RegCloseKey($3)
+ System::Call "advapi32::RegQueryValueEx(i $3, t'PATH', i 0, i 0, t.r1, *i ${NSIS_MAX_STRLEN} r2) i.r4"
+ System::Call "advapi32::RegCloseKey(i $3)"
+
+ IntCmp $4 234 0 +4 +4 ; $4 == ERROR_MORE_DATA
+ DetailPrint "AddToPath: original length $2 > ${NSIS_MAX_STRLEN}"
+ MessageBox MB_OK "PATH not updated, original length $2 > ${NSIS_MAX_STRLEN}"
+ Goto done
+
+ IntCmp $4 0 +5 ; $4 != NO_ERROR
+ IntCmp $4 2 +3 ; $4 != ERROR_FILE_NOT_FOUND
+ DetailPrint "AddToPath: unexpected error code $4"
+ Goto done
+ StrCpy $1 ""
+
+ ; Check if already in PATH
+ Push "$1;"
+ Push "$0;"
+ Call StrStr
+ Pop $2
+ StrCmp $2 "" 0 done
+ Push "$1;"
+ Push "$0\;"
+ Call StrStr
+ Pop $2
+ StrCmp $2 "" 0 done
+
+ ; Prevent NSIS string overflow
+ StrLen $2 $0
+ StrLen $3 $1
+ IntOp $2 $2 + $3
+ IntOp $2 $2 + 2 ; $2 = strlen(dir) + strlen(PATH) + sizeof(";")
+ IntCmp $2 ${NSIS_MAX_STRLEN} +4 +4 0
+ DetailPrint "AddToPath: new length $2 > ${NSIS_MAX_STRLEN}"
+ MessageBox MB_OK "PATH not updated, new length $2 > ${NSIS_MAX_STRLEN}."
+ Goto done
+
+ ; Append dir to PATH
+ DetailPrint "Add to PATH: $0"
+ StrCpy $2 $1 1 -1
+ StrCmp $2 ";" 0 +2
+ StrCpy $1 $1 -1 ; remove trailing ';'
+ StrCmp $1 "" +2 ; no leading ';'
+ StrCpy $0 "$1;$0"
+
+ WriteRegExpandStr ${Environ} "PATH" $0
+ SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} 0 "STR:Environment" /TIMEOUT=5000
+
+done:
+ Pop $4
+ Pop $3
+ Pop $2
+ Pop $1
+ Pop $0
+FunctionEnd
+
+
+; RemoveFromPath - Removes dir from PATH
+;
+; Usage:
+; Push "dir"
+; Call RemoveFromPath
+Function un.RemoveFromPath
+ Exch $0
+ Push $1
+ Push $2
+ Push $3
+ Push $4
+ Push $5
+ Push $6
+
+ ; NSIS ReadRegStr returns empty string on string overflow
+ ; Native calls are used here to check actual length of PATH
+ ; $4 = RegOpenKey(HKEY_LOCAL_MACHINE, "SYSTEM\CurrentControlSet\Control\Session Manager\Environment", &$3)
+ System::Call "advapi32::RegOpenKey(i 0x80000002, t'SYSTEM\CurrentControlSet\Control\Session Manager\Environment', *i.r3) i.r4"
+ IntCmp $4 0 0 done done
+
+ ; $4 = RegQueryValueEx($3, "PATH", (DWORD*)0, (DWORD*)0, &$1, ($2=NSIS_MAX_STRLEN, &$2))
+ ; RegCloseKey($3)
+ System::Call "advapi32::RegQueryValueEx(i $3, t'PATH', i 0, i 0, t.r1, *i ${NSIS_MAX_STRLEN} r2) i.r4"
+ System::Call "advapi32::RegCloseKey(i $3)"
+
+ IntCmp $4 234 0 +4 +4 ; $4 == ERROR_MORE_DATA
+ DetailPrint "RemoveFromPath: original length $2 > ${NSIS_MAX_STRLEN}"
+ MessageBox MB_OK "PATH not updated, original length $2 > ${NSIS_MAX_STRLEN}"
+ Goto done
+
+ IntCmp $4 0 +5 ; $4 != NO_ERROR
+ IntCmp $4 2 +3 ; $4 != ERROR_FILE_NOT_FOUND
+ DetailPrint "RemoveFromPath: unexpected error code $4"
+ Goto done
+ StrCpy $1 ""
+
+ ; length < ${NSIS_MAX_STRLEN} -> ReadRegStr can be used
+ ReadRegStr $1 ${Environ} "PATH"
+ StrCpy $5 $1 1 -1
+ StrCmp $5 ";" +2
+ StrCpy $1 "$1;" ; ensure trailing ';'
+ Push $1
+ Push "$0;"
+ Call un.StrStr
+ Pop $2 ; pos of our dir
+ StrCmp $2 "" done
+
+ DetailPrint "Remove from PATH: $0"
+ StrLen $3 "$0;"
+ StrLen $4 $2
+ StrCpy $5 $1 -$4 ; $5 is now the part before the path to remove
+ StrCpy $6 $2 "" $3 ; $6 is now the part after the path to remove
+ StrCpy $3 "$5$6"
+ StrCpy $5 $3 1 -1
+ StrCmp $5 ";" 0 +2
+ StrCpy $3 $3 -1 ; remove trailing ';'
+ WriteRegExpandStr ${Environ} "PATH" $3
+ SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} 0 "STR:Environment" /TIMEOUT=5000
+
+done:
+ Pop $6
+ Pop $5
+ Pop $4
+ Pop $3
+ Pop $2
+ Pop $1
+ Pop $0
+FunctionEnd
+
+
diff --git a/build/nsis.uninstall.nsh b/build/nsis.uninstall.nsh
index ea7d5e298..6358faa74 100644
--- a/build/nsis.uninstall.nsh
+++ b/build/nsis.uninstall.nsh
@@ -25,7 +25,8 @@ Section "Uninstall"
${un.EnvVarUpdate} $0 "ETHEREUM_SOCKET" "R" "HKLM" "\\.\pipe\geth.ipc"
# Remove install directory from PATH
- ${un.EnvVarUpdate} $0 "PATH" "R" "HKLM" $INSTDIR
+ Push "$INSTDIR"
+ Call un.RemoveFromPath
# Cleanup registry (deletes all sub keys)
DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${GROUPNAME} ${APPNAME}"