hfiref0x-WinObjEx64/Source/Plugins/plugin_def.h

/*******************************************************************************
*
*  (C) COPYRIGHT AUTHORS, 2019 - 2022
*
*  TITLE:       PLUGIN_DEF.H
*
*  VERSION:     1.11
*
*  DATE:        19 Jun 2022
*
*  Common header file for the plugin subsystem definitions.
*
* THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
* ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED
* TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
* PARTICULAR PURPOSE.
*
*******************************************************************************/

#pragma once

#define WOBJ_PLUGIN_SYSTEM_VERSION 20006

//
// Plugin text consts, must include terminating 0.
//
#define MAX_PLUGIN_NAME 32
#define MAX_AUTHORS_NAME 32
#define MAX_PLUGIN_DESCRIPTION 128

// Plugin run state

// Indicates that plugin is running or about to run
#define PLUGIN_RUNNING  0

// Indicates that plugin need to be stopped
#define PLUGIN_STOP     1

typedef BOOL(CALLBACK* pfnReadSystemMemoryEx)(
    _In_ ULONG_PTR Address,
    _Inout_ PVOID Buffer,
    _In_ ULONG BufferSize,
    _Out_opt_ PULONG NumberOfBytesRead);

typedef UCHAR(CALLBACK* pfnGetInstructionLength)(
    _In_ PVOID ptrCode,
    _Out_ PULONG ptrFlags);

typedef NTSTATUS(*pfnOpenNamedObjectByType)(
    _Out_ HANDLE* ObjectHandle,
    _In_ ULONG TypeIndex,
    _In_ PUNICODE_STRING ObjectDirectory,
    _In_ PUNICODE_STRING ObjectName,
    _In_ ACCESS_MASK DesiredAccess);

typedef struct _WINOBJEX_PARAM_OBJECT {
    UNICODE_STRING Name;
    UNICODE_STRING Directory;
} WINOBJEX_PARAM_OBJECT, * PWINOBJEX_PARAM_OBJECT;

typedef struct _WINOBJEX_PARAM_BLOCK {
    HWND ParentWindow;
    HINSTANCE Instance;
    ULONG_PTR SystemRangeStart;
    UINT CurrentDPI;
    RTL_OSVERSIONINFOW Version;
    WINOBJEX_PARAM_OBJECT Object; // used only by Context plugins during StartPlugin callback

    //sys
    pfnReadSystemMemoryEx ReadSystemMemoryEx;
    pfnGetInstructionLength GetInstructionLength;
    pfnOpenNamedObjectByType OpenNamedObjectByType;

} WINOBJEX_PARAM_BLOCK, * PWINOBJEX_PARAM_BLOCK;

typedef NTSTATUS(CALLBACK* pfnStartPlugin)(
    _In_ PWINOBJEX_PARAM_BLOCK ParamBlock);

typedef void(CALLBACK* pfnStopPlugin)(
    VOID);

typedef struct _WINOBJEX_PLUGIN WINOBJEX_PLUGIN;

typedef enum _WINOBJEX_PLUGIN_STATE {
    PluginInitialization = 0,
    PluginStopped = 1,
    PluginRunning = 2,
    PluginError = 3,
    MaxPluginState
} WINOBJEX_PLUGIN_STATE;

typedef enum _WINOBJEX_PLUGIN_TYPE {
    DefaultPlugin = 0, // General purpose plugin (shown in main menu under "Plugins")
    ContextPlugin = 1, // Object type specific plugin (shown in popup menu for specified object types)
    InvalidPluginType
} WINOBJEX_PLUGIN_TYPE;

typedef void(CALLBACK* pfnStateChangeCallback)(
    _In_ WINOBJEX_PLUGIN* PluginData,
    _In_ WINOBJEX_PLUGIN_STATE NewState,
    _Reserved_ PVOID Reserved);

typedef BOOL(CALLBACK* pfnGuiInitCallback)(
    _In_ WINOBJEX_PLUGIN* PluginData,
    _In_ HINSTANCE PluginInstance,
    _In_ WNDPROC WndProc,
    _Reserved_ PVOID Reserved
    );

typedef VOID(CALLBACK* pfnGuiShutdownCallback)(
    _In_ WINOBJEX_PLUGIN* PluginData,
    _In_ HINSTANCE PluginInstance,
    _Reserved_ PVOID Reserved
    );

//
// Object type indexes for known types, must be in compliance with WOBJ_OBJECT_TYPE values.
//

#define ObjectTypeDevice 0
#define ObjectTypeDriver 1
#define ObjectTypeSection 2
#define ObjectTypePort 3
#define ObjectTypeSymbolicLink 4
#define ObjectTypeKey 5
#define ObjectTypeEvent 6
#define ObjectTypeJob 7
#define ObjectTypeMutant 8
#define ObjectTypeKeyedEvent 9
#define ObjectTypeType 10
#define ObjectTypeDirectory 11
#define ObjectTypeWinstation 12
#define ObjectTypeCallback 13
#define ObjectTypeSemaphore 14
#define ObjectTypeWaitablePort 15
#define ObjectTypeTimer 16
#define ObjectTypeSession 17
#define ObjectTypeController 18
#define ObjectTypeProfile 19
#define ObjectTypeEventPair 20
#define ObjectTypeDesktop 21
#define ObjectTypeFile 22
#define ObjectTypeWMIGuid 23
#define ObjectTypeDebugObject 24
#define ObjectTypeIoCompletion 25
#define ObjectTypeProcess 26
#define ObjectTypeAdapter 27
#define ObjectTypeToken 28
#define ObjectTypeETWRegistration 29
#define ObjectTypeThread 30
#define ObjectTypeTmTx 31
#define ObjectTypeTmTm 32
#define ObjectTypeTmRm 33
#define ObjectTypeTmEn 34
#define ObjectTypePcwObject 35
#define ObjectTypeFltConnPort 36
#define ObjectTypeFltComnPort 37
#define ObjectTypePowerRequest 38
#define ObjectTypeETWConsumer 39
#define ObjectTypeTpWorkerFactory 40
#define ObjectTypeComposition 41
#define ObjectTypeIRTimer 42
#define ObjectTypeDxgkSharedResource 43
#define ObjectTypeDxgkSharedSwapChain 44
#define ObjectTypeDxgkSharedSyncObject 45
#define ObjectTypeDxgkCurrentDxgProcessObject 46
#define ObjectTypeDxgkCurrentDxgThreadObject 47
#define ObjectTypeDxgkDisplayManager 48
#define ObjectTypeDxgkSharedBundle 49
#define ObjectTypeDxgkSharedProtectedSession 50
#define ObjectTypeDxgkComposition 51
#define ObjectTypeDxgkSharedKeyedMutex 52
#define ObjectTypeMemoryPartition 53
#define ObjectTypeRegistryTransaction 54
#define ObjectTypeDmaAdapter 55
#define ObjectTypeDmaDomain 56
#define ObjectTypeUnknown 57
#define ObjectTypeAnyType 0xfe
#define ObjectTypeNone 0xff

#define PLUGIN_MAX_SUPPORTED_OBJECT_ID 0xff

typedef struct _WINOBJEX_PLUGIN {
    BOOLEAN NeedAdmin;
    BOOLEAN NeedDriver;
    BOOLEAN SupportWine;
    BOOLEAN SupportMultipleInstances;
    WINOBJEX_PLUGIN_TYPE Type;
    WINOBJEX_PLUGIN_STATE State;
    WORD MajorVersion;
    WORD MinorVersion;
    ULONG RequiredPluginSystemVersion;
    UCHAR SupportedObjectsIds[PLUGIN_MAX_SUPPORTED_OBJECT_ID]; // Ignored if plugin Type is DefaultPlugin
    WCHAR Name[MAX_PLUGIN_NAME];
    WCHAR Authors[MAX_AUTHORS_NAME];
    WCHAR Description[MAX_PLUGIN_DESCRIPTION];
    pfnStartPlugin StartPlugin;
    pfnStopPlugin StopPlugin;
    pfnStateChangeCallback StateChangeCallback;
    pfnGuiInitCallback GuiInitCallback;
    pfnGuiShutdownCallback GuiShutdownCallback;
} WINOBJEX_PLUGIN, * PWINOBJEX_PLUGIN;