winutil

Documentation

Overview

Package winutil contains misc Windows/Win32 helper functions.

Index

• Constants
• Variables
• func GetPolicyInteger(name string) (uint64, error)
• func GetPolicyString(name string) (string, error)
• func GetRegInteger(name string) (uint64, error)
• func GetRegString(name string) (string, error)
• func IsCurrentProcessElevated() bool
• func IsSIDValidPrincipal(uid string) bool
• func LookupPseudoUser(uid string) (*user.User, error)
• func RegisterForRestart(opts RegisterForRestartOpts) error
• type RegisterForRestartOpts

Constants

const (
	// RegBase is the registry path inside HKEY_LOCAL_MACHINE where registry settings
	// are stored. This constant is a non-empty string only when GOOS=windows.
	RegBase = regBase

	// RegPolicyBase is the registry path inside HKEY_LOCAL_MACHINE where registry
	// policies are stored. This constant is a non-empty string only when
	// GOOS=windows.
	RegPolicyBase = regPolicyBase
)

Variables

var ErrNoValue = errors.New("no value because registry is unavailable on this OS")

Functions

func GetPolicyInteger

func GetPolicyInteger(name string) (uint64, error)

GetPolicyInteger looks up a registry value in the local machine's path for system policies, or returns 0 and the associated error. Use this function to read values that may be set by sysadmins via the MSI installer or via GPO. For registry settings that you do *not* want to be visible to sysadmin tools, use GetRegInteger instead.

This function will only work on GOOS=windows. Trying to run it on any other OS will always return 0 and ErrNoValue. If value does not exist or another error happens, returns 0 and error.

func GetPolicyString

func GetPolicyString(name string) (string, error)

GetPolicyString looks up a registry value in the local machine's path for system policies, or returns empty string and the error. Use this function to read values that may be set by sysadmins via the MSI installer or via GPO. For registry settings that you do *not* want to be visible to sysadmin tools, use GetRegString instead.

This function will only work on GOOS=windows. Trying to run it on any other OS will always return an empty string and ErrNoValue. If value does not exist or another error happens, returns empty string and error.

func GetRegInteger

func GetRegInteger(name string) (uint64, error)

GetRegInteger looks up a registry path in the local machine path, or returns 0 and the error.

This function will only work on GOOS=windows. Trying to run it on any other OS will always return 0 and ErrNoValue. If value does not exist or another error happens, returns 0 and error.

func GetRegString

func GetRegString(name string) (string, error)

GetRegString looks up a registry path in the local machine path, or returns an empty string and error.

This function will only work on GOOS=windows. Trying to run it on any other OS will always return an empty string and ErrNoValue. If value does not exist or another error happens, returns empty string and error.

func IsCurrentProcessElevated

func IsCurrentProcessElevated() bool

func IsSIDValidPrincipal

func IsSIDValidPrincipal(uid string) bool

IsSIDValidPrincipal determines whether the SID contained in uid represents a type that is a valid security principal under Windows. This check helps us work around a bug in the standard library's Windows implementation of LookupId in os/user. See https://github.com/tailscale/tailscale/issues/869

This function will only work on GOOS=windows. Trying to run it on any other OS will always return false.

func LookupPseudoUser

func LookupPseudoUser(uid string) (*user.User, error)

LookupPseudoUser attempts to resolve the user specified by uid by checking against well-known pseudo-users on Windows. This is a temporary workaround until https://github.com/golang/go/issues/49509 is resolved and shipped.

This function will only work on GOOS=windows. Trying to run it on any other OS will always return an error.

func RegisterForRestart

func RegisterForRestart(opts RegisterForRestartOpts) error

RegisterForRestart registers the current process' restart preferences with the Windows Restart Manager. This enables the OS to intelligently restart the calling executable as requested via opts. This should be called by any programs which need to be restarted by the installer post-update.

This function may be called multiple times; the opts from the most recent call will override those from any previous invocations.

This function will only work on GOOS=windows. Trying to run it on any other OS will always return nil.

Types

type RegisterForRestartOpts

type RegisterForRestartOpts struct {
	RestartOnCrash   bool     // When true, this program will be restarted after a crash.
	RestartOnHang    bool     // When true, this program will be restarted after a hang.
	RestartOnUpgrade bool     // When true, this program will be restarted after an upgrade.
	RestartOnReboot  bool     // When true, this program will be restarted after a reboot.
	UseCmdLineArgs   bool     // When true, CmdLineArgs will be used as the program's arguments upon restart. Otherwise no arguments will be provided.
	CmdLineArgs      []string // When UseCmdLineArgs == true, contains the command line arguments, excluding the executable name itself. If nil or empty, the arguments from the current process will be re-used.
}

RegisterForRestartOpts supplies options to RegisterForRestart.