Files
windows_exporter/internal/headers/shell32/shell32.go
Jan-Otto Kröpke 066fd65d0b logical_disk: fix BitLocker shell property handling (#2482)
Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
2026-08-24 00:49:59 +02:00

104 lines
3.3 KiB
Go

// SPDX-License-Identifier: Apache-2.0
//
// Copyright The Prometheus Authors
// 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.
//go:build windows
package shell32
import (
"errors"
"fmt"
"syscall"
"unsafe"
"github.com/go-ole/go-ole"
"github.com/prometheus-community/windows_exporter/internal/headers/propsys"
"golang.org/x/sys/windows"
)
//nolint:gochecknoglobals
var (
modShell32 = windows.NewLazySystemDLL("shell32.dll")
procSHCreateItemFromParsingName = modShell32.NewProc("SHCreateItemFromParsingName")
iidIShellItem2 = ole.NewGUID("{7E9FB0D3-919F-4307-AB2E-9B1860310C93}")
)
// SHCreateItemFromParsingName creates and initializes a Shell item object from a parsing name.
// https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-shcreateitemfromparsingname
func SHCreateItemFromParsingName(path string) (*IShellItem2, error) {
ptrPath, err := windows.UTF16PtrFromString(path)
if err != nil {
return nil, fmt.Errorf("failed to convert path to UTF16: %w", err)
}
var result *IShellItem2
hr, _, _ := procSHCreateItemFromParsingName.Call(
uintptr(unsafe.Pointer(ptrPath)),
0,
uintptr(unsafe.Pointer(iidIShellItem2)),
uintptr(unsafe.Pointer(&result)),
)
// procSHCreateItemFromParsingName.Call returns an HRESULT as its first value.
// Only the sign bit indicates failure (the FAILED macro); success codes such
// as S_OK (0) and S_FALSE (1) must not be treated as errors. The HRESULT, not
// GetLastError, carries the COM error information.
if int32(hr) < 0 {
return nil, fmt.Errorf("SHCreateItemFromParsingName failed: %w", ole.NewError(hr))
}
if result == nil {
return nil, errors.New("SHCreateItemFromParsingName returned nil")
}
return result, nil
}
func (item *IShellItem2) GetProperty(key *propsys.PROPERTYKEY, v *ole.VARIANT) error {
hr, _, _ := syscall.SyscallN(
item.lpVtbl.GetProperty,
uintptr(unsafe.Pointer(item)),
uintptr(unsafe.Pointer(key)),
uintptr(unsafe.Pointer(v)),
)
// GetProperty is a COM method whose return value is an HRESULT. Only the sign
// bit indicates failure (the FAILED macro); success codes such as S_OK (0)
// and S_FALSE (1) must not be treated as errors. The third return value of
// SyscallN is GetLastError, which COM methods do not set, so it would report
// stale, unrelated errors (e.g. "Too many posts were made to a semaphore").
if int32(hr) < 0 {
return fmt.Errorf("GetProperty failed: %w", ole.NewError(hr))
}
// A successful property lookup may still return VT_EMPTY when the Shell
// property is unavailable. Keep that distinct from a real numeric zero,
// which the BitLocker collector maps to the "disabled" state.
if v.VT == ole.VT_EMPTY {
v.Val = -1
}
return nil
}
func (item *IShellItem2) Release() {
_, _, _ = syscall.SyscallN(
item.lpVtbl.Release,
uintptr(unsafe.Pointer(item)),
)
}