From 0730a79490988362682d4b508bb503f30fca833d Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Fri, 2 Aug 2024 07:17:48 -0500 Subject: [PATCH 1/7] Fix UUID for Darwin hosts - Addresses #100 based on fix suggested by @rpendleton - Adds multi-platform matrix run strategy to actions - Adds .gitignore file --- .github/workflows/go.yml | 30 ++++++++++++++++++------------ .gitignore | 3 +++ hostid_darwin.go | 31 ++++++++++++++++++++++++++++--- 3 files changed, 49 insertions(+), 15 deletions(-) create mode 100644 .gitignore diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 29d4770..ac8233a 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -10,24 +10,30 @@ on: jobs: test: - name: Test - runs-on: ubuntu-latest + strategy: + matrix: + platform: [ ubuntu-latest, windows-latest, macos-13, macos-latest ] + name: Test - ${{ matrix.platform }} + runs-on: ${{ matrix.platform }} steps: - - uses: actions/checkout@v3 - - uses: actions/setup-go@v3 + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 with: - go-version: "1.18" + go-version-file: "go.mod" check-latest: true - - run: go test -race -failfast ./... + - run: go vet ./... && go test -race -failfast ./... golangci-lint: - name: golangci-lint - runs-on: ubuntu-latest + strategy: + matrix: + platform: [ ubuntu-latest, windows-latest, macos-13, macos-latest ] + name: golangci-lint - ${{ matrix.platform }} + runs-on: ${{ matrix.platform }} steps: - - uses: actions/checkout@v3 - - uses: actions/setup-go@v3 + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 with: - go-version: "1.18" + go-version-file: "go.mod" check-latest: true - - uses: golangci/golangci-lint-action@v3 + - uses: golangci/golangci-lint-action@v6 with: version: latest diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..81be927 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/.idea +/.vscode +.DS_Store \ No newline at end of file diff --git a/hostid_darwin.go b/hostid_darwin.go index 08351ff..6fa59d7 100644 --- a/hostid_darwin.go +++ b/hostid_darwin.go @@ -1,9 +1,34 @@ -// +build darwin +//go:build darwin package xid -import "syscall" +import ( + "errors" + "os/exec" + "strings" +) func readPlatformMachineID() (string, error) { - return syscall.Sysctl("kern.uuid") + ioreg, err := exec.LookPath("ioreg") + if err != nil { + return "", err + } + + cmd := exec.Command(ioreg, "-rd1", "-c", "IOPlatformExpertDevice") + out, err := cmd.CombinedOutput() + if err != nil { + return "", err + } + + for _, line := range strings.Split(string(out), "\n") { + if strings.Contains(line, "IOPlatformUUID") { + parts := strings.SplitAfter(line, `" = "`) + if len(parts) == 2 { + uuid := strings.TrimRight(parts[1], `"`) + return strings.ToLower(uuid), nil + } + } + } + + return "", errors.New("cannot find host id") } From 203a16cc9214a078d40d0435c6a98f2a8f6da76a Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Fri, 2 Aug 2024 07:56:42 -0500 Subject: [PATCH 2/7] bump to go1.13 --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 3d61b50..354d15c 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ module github.com/rs/xid -go 1.12 +go 1.13 From 9d12df4fc94b3db99b44c2a4e9ee0ceec271f407 Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Thu, 8 Aug 2024 06:45:27 -0500 Subject: [PATCH 3/7] bumping to 1.16 for that swweet, sweet darwinarmness --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 354d15c..490102b 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ module github.com/rs/xid -go 1.13 +go 1.16 From a1ad66a6155aebac73336dc711d8efa0d784c2f9 Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Thu, 8 Aug 2024 10:49:42 -0500 Subject: [PATCH 4/7] reverting invalid build tag --- hostid_darwin.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hostid_darwin.go b/hostid_darwin.go index 6fa59d7..1735156 100644 --- a/hostid_darwin.go +++ b/hostid_darwin.go @@ -1,4 +1,4 @@ -//go:build darwin +// +build darwin package xid From 901d2b4c9d3d2dd1ee11e521d74a77e2b7f9050b Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Wed, 14 Aug 2024 06:42:35 -0500 Subject: [PATCH 5/7] Windows fixes: - Explicitly ignoring defer in registry key closure - Using syscall.UTF16PtrFromString in lieu of deprecated StringToUTF16Ptr func --- hostid_windows.go | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/hostid_windows.go b/hostid_windows.go index ec2593e..2d6a233 100644 --- a/hostid_windows.go +++ b/hostid_windows.go @@ -15,7 +15,7 @@ func readPlatformMachineID() (string, error) { if err != nil { return "", err } - defer syscall.RegCloseKey(h) + defer func() { _ = syscall.RegCloseKey(h) }() const syscallRegBufLen = 74 // len(`{`) + len(`abcdefgh-1234-456789012-123345456671` * 2) + len(`}`) // 2 == bytes/UTF16 const uuidLen = 36 @@ -23,7 +23,13 @@ func readPlatformMachineID() (string, error) { var regBuf [syscallRegBufLen]uint16 bufLen := uint32(syscallRegBufLen) var valType uint32 - err = syscall.RegQueryValueEx(h, syscall.StringToUTF16Ptr(`MachineGuid`), nil, &valType, (*byte)(unsafe.Pointer(®Buf[0])), &bufLen) + + ptr, err := syscall.UTF16PtrFromString(`MachineGuid`) + if err != nil { + return "", err + } + + err = syscall.RegQueryValueEx(h, ptr, nil, &valType, (*byte)(unsafe.Pointer(®Buf[0])), &bufLen) if err != nil { return "", err } From 7b7de2d47fef3a34358dbc3e6725d2a03617985c Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Wed, 14 Aug 2024 06:51:12 -0500 Subject: [PATCH 6/7] =?UTF-8?q?addressing=20=5Fboth=5F=20deprecated=20wind?= =?UTF-8?q?ows=20syscall=20func=20uses=20=E0=B2=A0=5F=E0=B2=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- hostid_windows.go | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/hostid_windows.go b/hostid_windows.go index 2d6a233..dd2a451 100644 --- a/hostid_windows.go +++ b/hostid_windows.go @@ -11,7 +11,13 @@ import ( func readPlatformMachineID() (string, error) { // source: https://github.com/shirou/gopsutil/blob/master/host/host_syscall.go var h syscall.Handle - err := syscall.RegOpenKeyEx(syscall.HKEY_LOCAL_MACHINE, syscall.StringToUTF16Ptr(`SOFTWARE\Microsoft\Cryptography`), 0, syscall.KEY_READ|syscall.KEY_WOW64_64KEY, &h) + + regKeyCryptoPtr, err := syscall.UTF16PtrFromString(`SOFTWARE\Microsoft\Cryptography`) + if err != nil { + return "", err + } + + err = syscall.RegOpenKeyEx(syscall.HKEY_LOCAL_MACHINE, regKeyCryptoPtr, 0, syscall.KEY_READ|syscall.KEY_WOW64_64KEY, &h) if err != nil { return "", err } @@ -24,14 +30,14 @@ func readPlatformMachineID() (string, error) { bufLen := uint32(syscallRegBufLen) var valType uint32 - ptr, err := syscall.UTF16PtrFromString(`MachineGuid`) + mGuidPtr, err := syscall.UTF16PtrFromString(`MachineGuid`) if err != nil { return "", err } - err = syscall.RegQueryValueEx(h, ptr, nil, &valType, (*byte)(unsafe.Pointer(®Buf[0])), &bufLen) + err = syscall.RegQueryValueEx(h, mGuidPtr, nil, &valType, (*byte)(unsafe.Pointer(®Buf[0])), &bufLen) if err != nil { - return "", err + return "", fmt.Errorf("error parsing ") } hostID := syscall.UTF16ToString(regBuf[:]) From 17afb3264c467eb43713eabd0584a5016890917e Mon Sep 17 00:00:00 2001 From: Daniel Carbone Date: Wed, 14 Aug 2024 06:52:30 -0500 Subject: [PATCH 7/7] better error messages --- hostid_windows.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/hostid_windows.go b/hostid_windows.go index dd2a451..a4d98ab 100644 --- a/hostid_windows.go +++ b/hostid_windows.go @@ -14,7 +14,7 @@ func readPlatformMachineID() (string, error) { regKeyCryptoPtr, err := syscall.UTF16PtrFromString(`SOFTWARE\Microsoft\Cryptography`) if err != nil { - return "", err + return "", fmt.Errorf(`error reading registry key "SOFTWARE\Microsoft\Cryptography": %w`, err) } err = syscall.RegOpenKeyEx(syscall.HKEY_LOCAL_MACHINE, regKeyCryptoPtr, 0, syscall.KEY_READ|syscall.KEY_WOW64_64KEY, &h) @@ -32,7 +32,7 @@ func readPlatformMachineID() (string, error) { mGuidPtr, err := syscall.UTF16PtrFromString(`MachineGuid`) if err != nil { - return "", err + return "", fmt.Errorf("error reading machine GUID: %w", err) } err = syscall.RegQueryValueEx(h, mGuidPtr, nil, &valType, (*byte)(unsafe.Pointer(®Buf[0])), &bufLen)