Hesham/wintun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

api: unify Win32 error type

Browse Source 
This makes the code more readable and works around the clang-format.exe
issues with _Return_type_success_ source annotation.

Signed-off-by: Simon Rozman <simon@rozman.si>
This commit is contained in:
Simon Rozman 2020-07-21 11:11:14 +02:00 committed by Jason A. Donenfeld
parent d3a63116ba
commit c8bf62ac19
3 changed files with 40 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api/api.h
View File

@ -7,6 +7,7 @@
#include <Windows.h> #include <Windows.h>
typedef _Return_type_success_(return == ERROR_SUCCESS) DWORD WINSTATUS;
extern HINSTANCE ResourceModule; extern HINSTANCE ResourceModule;
_Check_return_ _Check_return_
@ -22,10 +23,9 @@ NamespaceInit();
void void
NamespaceCleanup(); NamespaceCleanup();
_Return_type_success_(return == extern WINSTATUS(WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
0) extern DWORD(WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
_Return_type_success_(return == 0) extern DWORD(WINAPI *NciGetConnectionName)( extern WINSTATUS(WINAPI *NciGetConnectionName)(
_In_ LPCGUID Guid, _In_ LPCGUID Guid,
_Out_z_bytecap_(InDestNameBytes) LPWSTR Name, _Out_z_bytecap_(InDestNameBytes) LPWSTR Name,
_In_ DWORD InDestNameBytes, _In_ DWORD InDestNameBytes,
@ -52,5 +52,5 @@ typedef struct _WINTUN_ADAPTER
VOID WINAPI VOID WINAPI
WintunFreeAdapter(_In_ WINTUN_ADAPTER *Adapter); WintunFreeAdapter(_In_ WINTUN_ADAPTER *Adapter);
_Return_type_success_(return == 0) DWORD WINAPI WINSTATUS WINAPI
WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter); WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter);

45
api/devmgmt.c
View File

@ -31,7 +31,8 @@ const static GUID ADAPTER_NET_GUID = { 0xcac88484L,
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD GetRegString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType) static WINSTATUS
GetRegString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType)
{ {
HANDLE Heap = GetProcessHeap(); HANDLE Heap = GetProcessHeap();
@ -94,8 +95,8 @@ static _Return_type_success_(return == 0) DWORD GetRegString(_Inout_ LPWSTR *Buf
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD static WINSTATUS
GetRegMultiString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType) GetRegMultiString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType)
{ {
HANDLE Heap = GetProcessHeap(); HANDLE Heap = GetProcessHeap();
@ -163,8 +164,8 @@ static _Return_type_success_(return == 0) DWORD
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD static WINSTATUS
RegQueryString(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ LPWSTR *Value) RegQueryString(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ LPWSTR *Value)
{ {
HANDLE Heap = GetProcessHeap(); HANDLE Heap = GetProcessHeap();
DWORD Size = 256; DWORD Size = 256;
@ -213,8 +214,8 @@ static _Return_type_success_(return == 0) DWORD
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD static WINSTATUS
RegQueryDWORD(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ DWORD *Value) RegQueryDWORD(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ DWORD *Value)
{ {
DWORD ValueType, Size = sizeof(DWORD); DWORD ValueType, Size = sizeof(DWORD);
DWORD Result = RegQueryValueExW(Key, Name, NULL, &ValueType, (BYTE *)Value, &Size); DWORD Result = RegQueryValueExW(Key, Name, NULL, &ValueType, (BYTE *)Value, &Size);
@ -249,7 +250,8 @@ static _Return_type_success_(return == 0) DWORD
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD GetDeviceRegistryProperty( static WINSTATUS
GetDeviceRegistryProperty(
_In_ HDEVINFO DevInfo, _In_ HDEVINFO DevInfo,
_In_ SP_DEVINFO_DATA *DevInfoData, _In_ SP_DEVINFO_DATA *DevInfoData,
_In_ DWORD Property, _In_ DWORD Property,
@ -298,7 +300,8 @@ static _Return_type_success_(return == 0) DWORD GetDeviceRegistryProperty(
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD GetDeviceRegistryString( static WINSTATUS
GetDeviceRegistryString(
_In_ HDEVINFO DevInfo, _In_ HDEVINFO DevInfo,
_In_ SP_DEVINFO_DATA *DevInfoData, _In_ SP_DEVINFO_DATA *DevInfoData,
_In_ DWORD Property, _In_ DWORD Property,
@ -338,7 +341,8 @@ static _Return_type_success_(return == 0) DWORD GetDeviceRegistryString(
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD GetDeviceRegistryMultiString( static WINSTATUS
GetDeviceRegistryMultiString(
_In_ HDEVINFO DevInfo, _In_ HDEVINFO DevInfo,
_In_ SP_DEVINFO_DATA *DevInfoData, _In_ SP_DEVINFO_DATA *DevInfoData,
_In_ DWORD Property, _In_ DWORD Property,
@ -410,8 +414,8 @@ IsOurHardwareID(_In_z_ LPWSTR Hwids)
/** /**
* Returns pool-specific device type name. * Returns pool-specific device type name.
*/ */
static _Return_type_success_(return == 0) DWORD static WINSTATUS
GetPoolDeviceTypeName(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _Out_ LPWSTR *Name) GetPoolDeviceTypeName(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _Out_ LPWSTR *Name)
{ {
HANDLE Heap = GetProcessHeap(); HANDLE Heap = GetProcessHeap();
int Len = 256; int Len = 256;
@ -433,7 +437,8 @@ static _Return_type_success_(return == 0) DWORD
/** /**
* Checks if SPDRP_DEVICEDESC or SPDRP_FRIENDLYNAME match device type name. * Checks if SPDRP_DEVICEDESC or SPDRP_FRIENDLYNAME match device type name.
*/ */
static _Return_type_success_(return == 0) DWORD IsPoolMember( static WINSTATUS
IsPoolMember(
_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_count_c_(MAX_POOL) LPCWSTR Pool,
_In_ HDEVINFO DevInfo, _In_ HDEVINFO DevInfo,
_In_ SP_DEVINFO_DATA *DevInfoData, _In_ SP_DEVINFO_DATA *DevInfoData,
@ -489,7 +494,8 @@ cleanupDeviceDesc:
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD GetDriverInfoDetail( static WINSTATUS
GetDriverInfoDetail(
_In_ HDEVINFO DevInfo, _In_ HDEVINFO DevInfo,
_In_ SP_DEVINFO_DATA *DevInfoData, _In_ SP_DEVINFO_DATA *DevInfoData,
_In_ SP_DRVINFO_DATA_W *DriverData, _In_ SP_DRVINFO_DATA_W *DriverData,
@ -518,8 +524,8 @@ static _Return_type_success_(return == 0) DWORD GetDriverInfoDetail(
/** /**
* Check if the device is using Wintun driver. * Check if the device is using Wintun driver.
*/ */
static _Return_type_success_(return == 0) DWORD static WINSTATUS
IsUsingOurDriver(_In_ HDEVINFO DevInfo, _In_ SP_DEVINFO_DATA *DevInfoData, _Out_ BOOL *IsOurDriver) IsUsingOurDriver(_In_ HDEVINFO DevInfo, _In_ SP_DEVINFO_DATA *DevInfoData, _Out_ BOOL *IsOurDriver)
{ {
if (!SetupDiBuildDriverInfoList(DevInfo, DevInfoData, SPDIT_COMPATDRIVER)) if (!SetupDiBuildDriverInfoList(DevInfo, DevInfoData, SPDIT_COMPATDRIVER))
return GetLastError(); return GetLastError();
@ -565,7 +571,8 @@ static _Return_type_success_(return == 0) DWORD
* *
* @return ERROR_SUCCESS on success; Win32 error code otherwise * @return ERROR_SUCCESS on success; Win32 error code otherwise
*/ */
static _Return_type_success_(return == 0) DWORD InitAdapterData( static WINSTATUS
InitAdapterData(
_In_ HDEVINFO DevInfo, _In_ HDEVINFO DevInfo,
_In_ SP_DEVINFO_DATA *DevInfoData, _In_ SP_DEVINFO_DATA *DevInfoData,
_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_count_c_(MAX_POOL) LPCWSTR Pool,
@ -642,8 +649,8 @@ WintunFreeAdapter(_In_ WINTUN_ADAPTER *Adapter)
* ERROR_FILE_NOT_FOUND if adapter with given name is not found; * ERROR_FILE_NOT_FOUND if adapter with given name is not found;
* ERROR_ALREADY_EXISTS if adapter is found but not a Wintun-class or not a member of the pool * ERROR_ALREADY_EXISTS if adapter is found but not a Wintun-class or not a member of the pool
*/ */
_Return_type_success_(return == 0) DWORD WINAPI WINSTATUS WINAPI
WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter) WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter)
{ {
DWORD Result; DWORD Result;
HANDLE Mutex = TakeNameMutex(Pool); HANDLE Mutex = TakeNameMutex(Pool);

11
api/nci.c
View File

@ -7,10 +7,10 @@
static HMODULE NciModule; static HMODULE NciModule;
_Return_type_success_(return == 0) DWORD (WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName); WINSTATUS(WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
_Return_type_success_(return == 0) DWORD (WINAPI *NciGetConnectionName)( WINSTATUS(WINAPI *NciGetConnectionName)
_In_ LPCGUID Guid, (_In_ LPCGUID Guid,
_Out_z_bytecap_(InDestNameBytes) LPWSTR Name, _Out_z_bytecap_(InDestNameBytes) LPWSTR Name,
_In_ DWORD InDestNameBytes, _In_ DWORD InDestNameBytes,
_Out_opt_ DWORD *OutDestNameBytes); _Out_opt_ DWORD *OutDestNameBytes);
@ -21,8 +21,9 @@ NciInit()
NciModule = LoadLibraryW(L"nci.dll"); NciModule = LoadLibraryW(L"nci.dll");
if (!NciModule) if (!NciModule)
return; return;
NciSetConnectionName = (DWORD (WINAPI *)(LPCGUID, LPCWSTR))GetProcAddress(NciModule, "NciSetConnectionName"); NciSetConnectionName = (DWORD(WINAPI *)(LPCGUID, LPCWSTR))GetProcAddress(NciModule, "NciSetConnectionName");
NciGetConnectionName = (DWORD (WINAPI *)(LPCGUID, LPWSTR, DWORD, DWORD *))GetProcAddress(NciModule, "NciGetConnectionName"); NciGetConnectionName =
(DWORD(WINAPI *)(LPCGUID, LPWSTR, DWORD, DWORD *))GetProcAddress(NciModule, "NciGetConnectionName");
} }
void void