Go interface to NTDLL functions

This package makes selected NTDLL functions directly available in Go programs. At the moment, types and functions for accessing kernel objects and the Registry are included. The goal is to, eventually, cover all available functions.

Note

Please do not consider this code, particularly the autogenerated code, as stable. Identifiers names may still be subject to change.

Basic functions, types

NTDLL functions usually return an NTSTATUS, this is mapped into an NtStatus type (underlying kind: uint32). Strings are usually passed around as UNICODE_STRING, there is a type UnicodeStringType for that.

Variable-Sized Arrays

Structs that contain fields that are arrays with one (or ANYSIZE_ARRAY) elements. For those fields, getters that return a slice and setters that fill the array from a slice are generated.

Example:

typedef struct _FILE_NAME_INFORMATION {
  ULONG FileNameLength;
  WCHAR FileName[1];
} FILE_NAME_INFORMATION, *PFILE_NAME_INFORMATION;

is turned into

type FileNameInformationT struct {
	FileNameLength uint32
	FileName       [1]uint16
}

and associated methods

func (t *FileNameInformationT) FileNameSlice(size int) []uint16
func (t *FileNameInformationT) SetFileNameSlice(s []uint16)

Extending

Function signatures and structure definitions are generated from header file snippets as found in the MSDN. The transformation code can be found in mkcode.go, it probably has bugs and does not cover all cases.

To add more structures or function stubs or enumeration types, just find the appropriate definition on MSDN and copy them into block comments, prefixed by type:, func:, or enum:, respectively. go generate can then be used to regenerate the *_generated.go files containing structure definitions and the glue code around golang.org/x/sys/windows.

License

Copyright (C) 2016-2022 Hilko Bengen [email protected]

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.