#include "Python.h"

#include "pycore_moduleobject.h" // _PyModule_GetState()

#include "pycore_pylifecycle.h" // _Py_IsInterpreterFinalizing()

#include "pycore_pystate.h" // _PyInterpreterState_GET

#ifndef WINDOWS_LEAN_AND_MEAN

#define WINDOWS_LEAN_AND_MEAN

#include "windows.h"

#include <winioctl.h>

#include <crtdbg.h>

#include "winreparse.h"

#if defined(MS_WIN32) && !defined(MS_WIN64)

#define HANDLE_TO_PYNUM(handle) \

PyLong_FromUnsignedLong((unsigned long) handle)

#define PYNUM_TO_HANDLE(obj) ((HANDLE)PyLong_AsUnsignedLong(obj))

#define F_POINTER "k"

#define T_POINTER Py_T_ULONG

#define HANDLE_TO_PYNUM(handle) \

PyLong_FromUnsignedLongLong((unsigned long long) handle)

#define PYNUM_TO_HANDLE(obj) ((HANDLE)PyLong_AsUnsignedLongLong(obj))

#define F_POINTER "K"

#define T_POINTER Py_T_ULONGLONG

#define F_HANDLE F_POINTER

#define F_DWORD "k"

#define T_HANDLE T_POINTER

#ifndef STARTF_USESHOWWINDOW

#define STARTF_USESHOWWINDOW 0x00000001

#ifndef STARTF_USESIZE

#define STARTF_USESIZE 0x00000002

#ifndef STARTF_USEPOSITION

#define STARTF_USEPOSITION 0x00000004

#ifndef STARTF_USECOUNTCHARS

#define STARTF_USECOUNTCHARS 0x00000008

#ifndef STARTF_USEFILLATTRIBUTE

#define STARTF_USEFILLATTRIBUTE 0x00000010

#ifndef STARTF_RUNFULLSCREEN

#define STARTF_RUNFULLSCREEN 0x00000020

#ifndef STARTF_FORCEONFEEDBACK

#define STARTF_FORCEONFEEDBACK 0x00000040

#ifndef STARTF_FORCEOFFFEEDBACK

#define STARTF_FORCEOFFFEEDBACK 0x00000080

#ifndef STARTF_USESTDHANDLES

#define STARTF_USESTDHANDLES 0x00000100

#ifndef STARTF_USEHOTKEY

#define STARTF_USEHOTKEY 0x00000200

#ifndef STARTF_TITLEISLINKNAME

#define STARTF_TITLEISLINKNAME 0x00000800

#ifndef STARTF_TITLEISAPPID

#define STARTF_TITLEISAPPID 0x00001000

#ifndef STARTF_PREVENTPINNING

#define STARTF_PREVENTPINNING 0x00002000

#ifndef STARTF_UNTRUSTEDSOURCE

#define STARTF_UNTRUSTEDSOURCE 0x00008000

typedef struct {

PyTypeObject *overlapped_type;

} WinApiState;

static inline WinApiState*

winapi_get_state(PyObject *module)

{

void *state = _PyModule_GetState(module);

assert(state != NULL);

return (WinApiState *)state;

}

typedef struct {

PyObject_HEAD

OVERLAPPED overlapped;

/* For convenience, we store the file handle too */

HANDLE handle;

/* Whether there's I/O in flight */

int pending;

/* Whether I/O completed successfully */

int completed;

/* Buffer used for reading (optional) */

PyObject *read_buffer;

/* Buffer used for writing (optional) */

Py_buffer write_buffer;

} OverlappedObject;

static int

overlapped_traverse(OverlappedObject *self, visitproc visit, void *arg)

{

Py_VISIT(self->read_buffer);

Py_VISIT(self->write_buffer.obj);

Py_VISIT(Py_TYPE(self));

return 0;

}

static void

overlapped_dealloc(OverlappedObject *self)

{

DWORD bytes;

int err = GetLastError();

PyObject_GC_UnTrack(self);

if (self->pending) {

if (CancelIoEx(self->handle, &self->overlapped) &&

GetOverlappedResult(self->handle, &self->overlapped, &bytes, TRUE))

{

/* The operation is no longer pending -- nothing to do. */

}

else if (_Py_IsInterpreterFinalizing(_PyInterpreterState_GET()))

{

/* The operation is still pending -- give a warning. This

PyErr_SetString(PyExc_PythonFinalizationError,

"I/O operations still in flight while destroying "

"Overlapped object, the process may crash");

PyErr_WriteUnraisable(NULL);

}

else

{

/* The operation is still pending, but the process is

CloseHandle(self->overlapped.hEvent);

SetLastError(err);

return;

}

}

CloseHandle(self->overlapped.hEvent);

SetLastError(err);

if (self->write_buffer.obj)

PyBuffer_Release(&self->write_buffer);

Py_CLEAR(self->read_buffer);

PyTypeObject *tp = Py_TYPE(self);

tp->tp_free(self);

Py_DECREF(tp);

}

#include "clinic/_winapi.c.h"

static PyObject *

_winapi_Overlapped_GetOverlappedResult_impl(OverlappedObject *self, int wait)

{

BOOL res;

DWORD transferred = 0;

DWORD err;

Py_BEGIN_ALLOW_THREADS

res = GetOverlappedResult(self->handle, &self->overlapped, &transferred,

wait != 0);

Py_END_ALLOW_THREADS

err = res ? ERROR_SUCCESS : GetLastError();

switch (err) {

case ERROR_SUCCESS:

case ERROR_MORE_DATA:

case ERROR_OPERATION_ABORTED:

self->completed = 1;

self->pending = 0;

break;

case ERROR_IO_INCOMPLETE:

break;

default:

self->pending = 0;

return PyErr_SetExcFromWindowsErr(PyExc_OSError, err);

}

if (self->completed && self->read_buffer != NULL) {

assert(PyBytes_CheckExact(self->read_buffer));

if (transferred != PyBytes_GET_SIZE(self->read_buffer) &&

_PyBytes_Resize(&self->read_buffer, transferred))

return NULL;

}

return Py_BuildValue("II", (unsigned) transferred, (unsigned) err);

}

static PyObject *

_winapi_Overlapped_getbuffer_impl(OverlappedObject *self)

{

PyObject *res;

if (!self->completed) {

PyErr_SetString(PyExc_ValueError,

"can't get read buffer before GetOverlappedResult() "

"signals the operation completed");

return NULL;

}

res = self->read_buffer ? self->read_buffer : Py_None;

return Py_NewRef(res);

}

static PyObject *

_winapi_Overlapped_cancel_impl(OverlappedObject *self)

{

BOOL res = TRUE;

if (self->pending) {

Py_BEGIN_ALLOW_THREADS

res = CancelIoEx(self->handle, &self->overlapped);

Py_END_ALLOW_THREADS

}

/* CancelIoEx returns ERROR_NOT_FOUND if the I/O completed in-between */

if (!res && GetLastError() != ERROR_NOT_FOUND)

return PyErr_SetExcFromWindowsErr(PyExc_OSError, 0);

self->pending = 0;

Py_RETURN_NONE;

}

static PyMethodDef overlapped_methods[] = {

_WINAPI_OVERLAPPED_GETOVERLAPPEDRESULT_METHODDEF

_WINAPI_OVERLAPPED_GETBUFFER_METHODDEF

_WINAPI_OVERLAPPED_CANCEL_METHODDEF

{NULL}

};

static PyMemberDef overlapped_members[] = {

{"event", T_HANDLE,

offsetof(OverlappedObject, overlapped) + offsetof(OVERLAPPED, hEvent),

Py_READONLY, "overlapped event handle"},

{NULL}

};

static PyType_Slot winapi_overlapped_type_slots[] = {

{Py_tp_traverse, overlapped_traverse},

{Py_tp_dealloc, overlapped_dealloc},

{Py_tp_doc, "OVERLAPPED structure wrapper"},

{Py_tp_methods, overlapped_methods},

{Py_tp_members, overlapped_members},

{0,0}

};

static PyType_Spec winapi_overlapped_type_spec = {

.name = "_winapi.Overlapped",

.basicsize = sizeof(OverlappedObject),

.flags = (Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION |

Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_IMMUTABLETYPE),

.slots = winapi_overlapped_type_slots,

};

static OverlappedObject *

new_overlapped(PyObject *module, HANDLE handle)

{

WinApiState *st = winapi_get_state(module);

OverlappedObject *self = PyObject_GC_New(OverlappedObject, st->overlapped_type);

if (!self)

return NULL;

self->handle = handle;

self->read_buffer = NULL;

self->pending = 0;

self->completed = 0;

memset(&self->overlapped, 0, sizeof(OVERLAPPED));

memset(&self->write_buffer, 0, sizeof(Py_buffer));

/* Manual reset, initially non-signalled */

self->overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);

PyObject_GC_Track(self);

return self;

}

static PyObject *

_winapi_CloseHandle_impl(PyObject *module, HANDLE handle)

{

BOOL success;

Py_BEGIN_ALLOW_THREADS

success = CloseHandle(handle);

Py_END_ALLOW_THREADS

if (!success)

return PyErr_SetFromWindowsErr(0);

Py_RETURN_NONE;

}

static PyObject *

_winapi_ConnectNamedPipe_impl(PyObject *module, HANDLE handle,

int use_overlapped)

{

BOOL success;

OverlappedObject *overlapped = NULL;

if (use_overlapped) {

overlapped = new_overlapped(module, handle);

if (!overlapped)

return NULL;

}

Py_BEGIN_ALLOW_THREADS

success = ConnectNamedPipe(handle,

overlapped ? &overlapped->overlapped : NULL);

Py_END_ALLOW_THREADS

if (overlapped) {

int err = GetLastError();

/* Overlapped ConnectNamedPipe never returns a success code */

assert(success == 0);

if (err == ERROR_IO_PENDING)

overlapped->pending = 1;

else if (err == ERROR_PIPE_CONNECTED)

SetEvent(overlapped->overlapped.hEvent);

else {

Py_DECREF(overlapped);

return PyErr_SetFromWindowsErr(err);

}

return (PyObject *) overlapped;

}

if (!success)

return PyErr_SetFromWindowsErr(0);

Py_RETURN_NONE;

}

static HANDLE

_winapi_CreateEventW_impl(PyObject *module,

LPSECURITY_ATTRIBUTES security_attributes,

BOOL manual_reset, BOOL initial_state,

LPCWSTR name)

{

HANDLE handle;

if (PySys_Audit("_winapi.CreateEventW", "bbu", manual_reset, initial_state, name) < 0) {

return INVALID_HANDLE_VALUE;

}

Py_BEGIN_ALLOW_THREADS

handle = CreateEventW(security_attributes, manual_reset, initial_state, name);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE) {

PyErr_SetFromWindowsErr(0);

}

return handle;

}

static HANDLE

_winapi_CreateFile_impl(PyObject *module, LPCWSTR file_name,

DWORD flags_and_attributes, HANDLE template_file)

{

HANDLE handle;

if (PySys_Audit("_winapi.CreateFile", "ukkkk",

file_name, desired_access, share_mode,

creation_disposition, flags_and_attributes) < 0) {

return INVALID_HANDLE_VALUE;

}

Py_BEGIN_ALLOW_THREADS

handle = CreateFileW(file_name, desired_access,

share_mode, security_attributes,

creation_disposition,

flags_and_attributes, template_file);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE) {

PyErr_SetFromWindowsErr(0);

}

return handle;

}

static HANDLE

_winapi_CreateFileMapping_impl(PyObject *module, HANDLE file_handle,

LPSECURITY_ATTRIBUTES security_attributes,

DWORD protect, DWORD max_size_high,

DWORD max_size_low, LPCWSTR name)

{

HANDLE handle;

Py_BEGIN_ALLOW_THREADS

handle = CreateFileMappingW(file_handle, security_attributes,

protect, max_size_high, max_size_low,

name);

Py_END_ALLOW_THREADS

if (handle == NULL) {

PyObject *temp = PyUnicode_FromWideChar(name, -1);

PyErr_SetExcFromWindowsErrWithFilenameObject(PyExc_OSError, 0, temp);

Py_XDECREF(temp);

handle = INVALID_HANDLE_VALUE;

}

return handle;

}

static PyObject *

_winapi_CreateJunction_impl(PyObject *module, LPCWSTR src_path,

LPCWSTR dst_path)

{

/* Privilege adjustment */

HANDLE token = NULL;

struct {

TOKEN_PRIVILEGES base;

/* overallocate by a few array elements */

LUID_AND_ATTRIBUTES privs[4];

} tp, previousTp;

int previousTpSize = 0;

/* Reparse data buffer */

const USHORT prefix_len = 4;

USHORT print_len = 0;

USHORT rdb_size = 0;

_Py_PREPARSE_DATA_BUFFER rdb = NULL;

/* Junction point creation */

HANDLE junction = NULL;

DWORD ret = 0;

if (src_path == NULL || dst_path == NULL)

return PyErr_SetFromWindowsErr(ERROR_INVALID_PARAMETER);

if (wcsncmp(src_path, L"\\??\\", prefix_len) == 0)

return PyErr_SetFromWindowsErr(ERROR_INVALID_PARAMETER);

if (PySys_Audit("_winapi.CreateJunction", "uu", src_path, dst_path) < 0) {

return NULL;

}

/* Adjust privileges to allow rewriting directory entry as a

if (!OpenProcessToken(GetCurrentProcess(),

TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &token)) {

goto cleanup;

}

if (!LookupPrivilegeValue(NULL, SE_RESTORE_NAME, &tp.base.Privileges[0].Luid)) {

goto cleanup;

}

tp.base.PrivilegeCount = 1;

tp.base.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;

if (!AdjustTokenPrivileges(token, FALSE, &tp.base, sizeof(previousTp),

&previousTp.base, &previousTpSize)) {

goto cleanup;

}

if (GetFileAttributesW(src_path) == INVALID_FILE_ATTRIBUTES)

goto cleanup;

/* Store the absolute link target path length in print_len. */

print_len = (USHORT)GetFullPathNameW(src_path, 0, NULL, NULL);

if (print_len == 0)

goto cleanup;

/* NUL terminator should not be part of print_len. */

--print_len;

/* REPARSE_DATA_BUFFER usage is heavily under-documented, especially for

rdb_size = _Py_REPARSE_DATA_BUFFER_HEADER_SIZE +

sizeof(rdb->MountPointReparseBuffer) -

sizeof(rdb->MountPointReparseBuffer.PathBuffer) +

/* Two +1's for NUL terminators. */

(prefix_len + print_len + 1 + print_len + 1) * sizeof(WCHAR);

rdb = (_Py_PREPARSE_DATA_BUFFER)PyMem_RawCalloc(1, rdb_size);

if (rdb == NULL)

goto cleanup;

rdb->ReparseTag = IO_REPARSE_TAG_MOUNT_POINT;

rdb->ReparseDataLength = rdb_size - _Py_REPARSE_DATA_BUFFER_HEADER_SIZE;

rdb->MountPointReparseBuffer.SubstituteNameOffset = 0;

rdb->MountPointReparseBuffer.SubstituteNameLength =

(prefix_len + print_len) * sizeof(WCHAR);

rdb->MountPointReparseBuffer.PrintNameOffset =

rdb->MountPointReparseBuffer.SubstituteNameLength + sizeof(WCHAR);

rdb->MountPointReparseBuffer.PrintNameLength = print_len * sizeof(WCHAR);

/* Store the full native path of link target at the substitute name

wcscpy(rdb->MountPointReparseBuffer.PathBuffer, L"\\??\\");

if (GetFullPathNameW(src_path, print_len + 1,

rdb->MountPointReparseBuffer.PathBuffer + prefix_len,

NULL) == 0)

goto cleanup;

/* Copy everything but the native prefix to the print name offset. */

wcscpy(rdb->MountPointReparseBuffer.PathBuffer +

prefix_len + print_len + 1,

rdb->MountPointReparseBuffer.PathBuffer + prefix_len);

/* Create a directory for the junction point. */

if (!CreateDirectoryW(dst_path, NULL))

goto cleanup;

junction = CreateFileW(dst_path, GENERIC_READ | GENERIC_WRITE, 0, NULL,

OPEN_EXISTING,

FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS, NULL);

if (junction == INVALID_HANDLE_VALUE)

goto cleanup;

/* Make the directory entry a junction point. */

if (!DeviceIoControl(junction, FSCTL_SET_REPARSE_POINT, rdb, rdb_size,

NULL, 0, &ret, NULL))

goto cleanup;

cleanup:

ret = GetLastError();

if (previousTpSize) {

AdjustTokenPrivileges(token, FALSE, &previousTp.base, previousTpSize,

NULL, NULL);

}

if (token != NULL)

CloseHandle(token);

if (junction != NULL)

CloseHandle(junction);

PyMem_RawFree(rdb);

if (ret != 0)

return PyErr_SetFromWindowsErr(ret);

Py_RETURN_NONE;

}

static HANDLE

_winapi_CreateMutexW_impl(PyObject *module,

LPSECURITY_ATTRIBUTES security_attributes,

BOOL initial_owner, LPCWSTR name)

{

HANDLE handle;

if (PySys_Audit("_winapi.CreateMutexW", "bu", initial_owner, name) < 0) {

return INVALID_HANDLE_VALUE;

}

Py_BEGIN_ALLOW_THREADS

handle = CreateMutexW(security_attributes, initial_owner, name);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE) {

PyErr_SetFromWindowsErr(0);

}

return handle;

}

static HANDLE

_winapi_CreateNamedPipe_impl(PyObject *module, LPCWSTR name, DWORD open_mode,

LPSECURITY_ATTRIBUTES security_attributes)

{

HANDLE handle;

if (PySys_Audit("_winapi.CreateNamedPipe", "ukk",

name, open_mode, pipe_mode) < 0) {

return INVALID_HANDLE_VALUE;

}

Py_BEGIN_ALLOW_THREADS

handle = CreateNamedPipeW(name, open_mode, pipe_mode,

max_instances, out_buffer_size,

in_buffer_size, default_timeout,

security_attributes);

Py_END_ALLOW_THREADS

if (handle == INVALID_HANDLE_VALUE)

PyErr_SetFromWindowsErr(0);

return handle;

}

static PyObject *

_winapi_CreatePipe_impl(PyObject *module, PyObject *pipe_attrs, DWORD size)

{

HANDLE read_pipe;

HANDLE write_pipe;

BOOL result;

if (PySys_Audit("_winapi.CreatePipe", NULL) < 0) {

return NULL;

}

Py_BEGIN_ALLOW_THREADS

result = CreatePipe(&read_pipe, &write_pipe, NULL, size);

Py_END_ALLOW_THREADS

if (! result)

return PyErr_SetFromWindowsErr(GetLastError());

return Py_BuildValue(

"NN", HANDLE_TO_PYNUM(read_pipe), HANDLE_TO_PYNUM(write_pipe));

}

static unsigned long

getulong(PyObject* obj, const char* name)

{

PyObject* value;

unsigned long ret;

value = PyObject_GetAttrString(obj, name);

if (! value) {

PyErr_Clear(); /* FIXME: propagate error? */

return 0;

}

ret = PyLong_AsUnsignedLong(value);

Py_DECREF(value);

return ret;

}

static HANDLE

gethandle(PyObject* obj, const char* name)

{

PyObject* value;

HANDLE ret;

value = PyObject_GetAttrString(obj, name);

if (! value) {

PyErr_Clear(); /* FIXME: propagate error? */

return NULL;

}

if (value == Py_None)

ret = NULL;

else

ret = PYNUM_TO_HANDLE(value);

Py_DECREF(value);

return ret;

}

static PyObject *

sortenvironmentkey(PyObject *module, PyObject *item)

{

return _winapi_LCMapStringEx_impl(NULL, LOCALE_NAME_INVARIANT,

LCMAP_UPPERCASE, item);

}

static PyMethodDef sortenvironmentkey_def = {

"sortenvironmentkey", _PyCFunction_CAST(sortenvironmentkey), METH_O, "",

};

static int

sort_environment_keys(PyObject *keys)

{

PyObject *keyfunc = PyCFunction_New(&sortenvironmentkey_def, NULL);

if (keyfunc == NULL) {

return -1;

}

PyObject *kwnames = Py_BuildValue("(s)", "key");

if (kwnames == NULL) {

Py_DECREF(keyfunc);

return -1;

}

PyObject *args[] = { keys, keyfunc };

PyObject *ret = PyObject_VectorcallMethod(&_Py_ID(sort), args, 1, kwnames);

Py_DECREF(keyfunc);

Py_DECREF(kwnames);

if (ret == NULL) {

return -1;

}

Py_DECREF(ret);

return 0;

}

static int

compare_string_ordinal(PyObject *str1, PyObject *str2, int *result)

{

wchar_t *s1 = PyUnicode_AsWideCharString(str1, NULL);

if (s1 == NULL) {

return -1;

}

wchar_t *s2 = PyUnicode_AsWideCharString(str2, NULL);

if (s2 == NULL) {

PyMem_Free(s1);

return -1;

}

*result = CompareStringOrdinal(s1, -1, s2, -1, TRUE);

PyMem_Free(s1);

PyMem_Free(s2);

return 0;

}

static PyObject *

dedup_environment_keys(PyObject *keys)

{

PyObject *result = PyList_New(0);

if (result == NULL) {

return NULL;

}

// Iterate over the pre-ordered keys, check whether the current key is equal

// to the next key (ignoring case), if different, insert the current value

// into the result list. If they are equal, do nothing because we always

// want to keep the last inserted one.

for (Py_ssize_t i = 0; i < PyList_GET_SIZE(keys); i++) {

PyObject *key = PyList_GET_ITEM(keys, i);

// The last key will always be kept.

if (i + 1 == PyList_GET_SIZE(keys)) {

if (PyList_Append(result, key) < 0) {

Py_DECREF(result);

return NULL;

}

continue;

}

PyObject *next_key = PyList_GET_ITEM(keys, i + 1);

int compare_result;

if (compare_string_ordinal(key, next_key, &compare_result) < 0) {

Py_DECREF(result);

return NULL;

}

if (compare_result == CSTR_EQUAL) {

continue;

}

if (PyList_Append(result, key) < 0) {

Py_DECREF(result);

return NULL;

}

}

return result;

}

static PyObject *

normalize_environment(PyObject *environment)

{

PyObject *keys = PyMapping_Keys(environment);

if (keys == NULL) {

return NULL;

}

if (sort_environment_keys(keys) < 0) {

Py_DECREF(keys);

return NULL;

}

PyObject *normalized_keys = dedup_environment_keys(keys);

Py_DECREF(keys);