windows: fix parsing of non-ASCII entries in token.Environ

Fixes golang/go#65055, the unexpected behavior of token.Environ in parsing entries containing runes larger than 2 bytes in size Change-Id: I753d2c605e3a2d7a1d90cd18601d6b918f0d3f7a Reviewed-on: https://go-review.googlesource.com/c/sys/+/556895 Auto-Submit: Bryan Mills <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Cherry Mui <[email protected]> Reviewed-by: Bryan Mills <[email protected]> Reviewed-by: Quim Muntal <[email protected]>
golang · Jan 23, 2024 · c3fa2b8 · c3fa2b8
1 parent f69d32a
commit c3fa2b8
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 7 deletions.
diff --git a/windows/env_windows.go b/windows/env_windows.go
@@ -37,14 +37,17 @@ func (token Token) Environ(inheritExisting bool) (env []string, err error) {
 		return nil, err
 	}
 	defer DestroyEnvironmentBlock(block)
-	blockp := unsafe.Pointer(block)
-	for {
-		entry := UTF16PtrToString((*uint16)(blockp))
-		if len(entry) == 0 {
-			break
+	size := unsafe.Sizeof(*block)
+	for *block != 0 {
+		// find NUL terminator
+		end := unsafe.Pointer(block)
+		for *(*uint16)(end) != 0 {
+			end = unsafe.Add(end, size)
 		}
-		env = append(env, entry)
-		blockp = unsafe.Add(blockp, 2*(len(entry)+1))
+
+		entry := unsafe.Slice(block, (uintptr(end)-uintptr(unsafe.Pointer(block)))/size)
+		env = append(env, UTF16ToString(entry))
+		block = (*uint16)(unsafe.Add(end, size))
 	}
 	return env, nil
 }

diff --git a/windows/env_windows_test.go b/windows/env_windows_test.go
@@ -0,0 +1,40 @@
+// Copyright 2024 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package windows_test
+
+import (
+	"fmt"
+	"slices"
+	"testing"
+
+	"golang.org/x/sys/windows"
+)
+
+func TestEnvironUTF8(t *testing.T) {
+	testEnvVariable1Key := "__GO_X_SYS_WINDOWS_ENV_WINDOWS_TEST_VAR_BEAVER"
+	testEnvVariable1Val := "🦫"
+	t.Setenv(testEnvVariable1Key, testEnvVariable1Val)
+
+	testEnvVariable2Key := "__GO_X_SYS_WINDOWS_ENV_WINDOWS_TEST_VAR_WHALE"
+	testEnvVariable2Val := "🐳"
+	t.Setenv(testEnvVariable2Key, testEnvVariable2Val)
+
+	var userToken windows.Token
+
+	env, err := userToken.Environ(true)
+	if err != nil {
+		t.Error(err)
+	}
+
+	testEnvVariable1 := fmt.Sprintf("%s=%s", testEnvVariable1Key, testEnvVariable1Val)
+	if !slices.Contains(env, testEnvVariable1) {
+		t.Fatalf("expected to find %s in env", testEnvVariable1)
+	}
+
+	testEnvVariable2 := fmt.Sprintf("%s=%s", testEnvVariable2Key, testEnvVariable2Val)
+	if !slices.Contains(env, testEnvVariable2) {
+		t.Fatalf("expected to find %s in env", testEnvVariable2)
+	}
+}