Added user client

Signed-off-by: black.dragon74 <[email protected]>

Author: black-dragon74

ROG-HID-Driver/Info.plist

@@ -114,6 +114,13 @@
 		</dict>
 		<key>0b05_1869</key>
 		<dict>
+			<key>UserClientProperties</key>
+			<dict>
+				<key>IOClass</key>
+				<string>IOUserUserClient</string>
+				<key>IOUserClass</key>
+				<string>ROGHIDUserClient</string>
+			</dict>
 			<key>BacklightAutoTurnOff</key>
 			<integer>1</integer>
 			<key>CFBundleIdentifier</key>

ROG-HID-Driver/ROGHIDUserClient/ROGHIDUserClient.cpp

@@ -0,0 +1,37 @@
+//
+//  ROGHIDUserClient.cpp
+//  ROG-HID-Driver
+//
+//  Created by Nick on 2/16/21.
+//  Copyright © 2021 Nick. All rights reserved.
+//
+
+#include "RogHIDUserClient.h"
+#include "ROG_HID_Driver.h"
+
+bool ROGHIDUserClient::init() {
+    DBGLOG("Userclient init");
+
+    return super::init();
+}
+
+void ROGHIDUserClient::free() {
+    DBGLOG("Userclient free");
+    super::free();
+}
+
+kern_return_t IMPL(ROGHIDUserClient, Start) {
+    DBGLOG("Userclient start");
+    
+    return kIOReturnSuccess;
+}
+
+kern_return_t IMPL(ROGHIDUserClient, Stop) {
+    DBGLOG("Userclient stop");
+    return kIOReturnSuccess;
+}
+
+kern_return_t ROGHIDUserClient::ExternalMethod(uint64_t selector, IOUserClientMethodArguments* arguments, const IOUserClientMethodDispatch* dispatch, OSObject* target, void* reference) {
+    DBGLOG("Userclient external method");
+    return kIOReturnSuccess;
+}

ROG-HID-Driver/ROGHIDUserClient/ROGHIDUserClient.iig

@@ -0,0 +1,28 @@
+//
+//  ROGHIDUserClient.iig
+//  ROG-HID-Driver
+//
+//  Created by Nick on 2/16/21.
+//  Copyright © 2021 Nick. All rights reserved.
+//
+
+#ifndef ROGHIDUserClient_h
+#define ROGHIDUserClient_h
+
+#include <DriverKit/IOUserClient.iig>
+
+class ROGHIDUserClient: public IOUserClient {
+    virtual bool init() override;
+    virtual void free() override;
+
+    virtual kern_return_t Start(IOService* provider) override;
+    virtual kern_return_t Stop(IOService* provider) override;
+
+    virtual kern_return_t ExternalMethod(uint64_t selector,
+                                         IOUserClientMethodArguments* arguments,
+                                         const IOUserClientMethodDispatch* dispatch,
+                                         OSObject* target,
+                                         void* reference) override;
+};
+
+#endif /* ROGHIDUserClient_h */

ROG-HID-Driver/ROG_HID_Driver.cpp

@@ -6,8 +6,6 @@
 //  Copyright © 2020 Nick. All rights reserved.
 //
 
-#include <os/log.h>
-
 #include <HIDDriverKit/HIDDriverKit.h>
 
 #include "ROG_HID_Driver.h"
@@ -539,3 +537,27 @@ void IMPL(ROG_HID_Driver, asusKbdGetFunctions)
     data->release();
     return;
 }
+
+kern_return_t IMPL(ROG_HID_Driver, NewUserClient) {
+    IOService *client {nullptr};
+    
+    auto ret = Create(this, "UserClientProperties", &client);
+    if (ret != kIOReturnSuccess) {
+        DBGLOG("Newuserclient create failed");
+        
+        return ret;
+    }
+    
+    DBGLOG("Created user client successfully");
+    
+    *userClient = OSDynamicCast(IOUserClient, client);
+    
+    if (!*userClient) {
+        DBGLOG("Dynamic cast failed");
+        client->release();
+        
+        return kIOReturnError;
+    }
+    
+    return kIOReturnSuccess;
+}

ROG-HID-Driver/ROG_HID_Driver.entitlements

@@ -2,6 +2,10 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+	<key>com.apple.application-identifier</key>
+	<string>com.black-dragon74.ROG-HID-Driver</string>
+	<key>com.apple.developer.driverkit.userclient-access</key>
+	<true/>
 	<key>com.apple.developer.driverkit</key>
 	<true/>
 	<key>com.apple.developer.driverkit.builtin</key>

ROG-HID-Driver/ROG_HID_Driver.iig

@@ -9,6 +9,8 @@
 #ifndef ROG_HID_Driver_h
 #define ROG_HID_Driver_h
 
+#include <os/log.h>
+
 #define BIT(nr) (1UL << (nr))
 #define STOMS(x) (x * 1000)
 #define KBD_FEATURE_REPORT_ID 0x5a
@@ -63,6 +65,8 @@ public:
                                                 uint32_t value,
                                                 IOOptionBits options,
                                                 bool repeat) override;
+    virtual kern_return_t NewUserClient(uint32_t type,
+                                        IOUserClient** userClient) override;
 
 private:
     virtual void parseKeyboardElementsHook(OSArray* elements);

ROG-HID.xcodeproj/project.pbxproj

@@ -20,6 +20,8 @@
 		0118C9AA24C6121500C1C663 /* ROG_HID_Driver.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 0118C9A924C6121500C1C663 /* ROG_HID_Driver.cpp */; };
 		0118C9AC24C6121500C1C663 /* ROG_HID_Driver.iig in Sources */ = {isa = PBXBuildFile; fileRef = 0118C9AB24C6121500C1C663 /* ROG_HID_Driver.iig */; };
 		0118C9B124C6121500C1C663 /* com.black-dragon74.ROG-HID-Driver.dext in Embed System Extensions */ = {isa = PBXBuildFile; fileRef = 0118C9A424C6121500C1C663 /* com.black-dragon74.ROG-HID-Driver.dext */; settings = {ATTRIBUTES = (RemoveHeadersOnCopy, ); }; };
+		012617D625DBB8F100B563E0 /* ROGHIDUserClient.iig in Sources */ = {isa = PBXBuildFile; fileRef = 012617D525DBB8F100B563E0 /* ROGHIDUserClient.iig */; };
+		012617DA25DBB90000B563E0 /* ROGHIDUserClient.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 012617D925DBB90000B563E0 /* ROGHIDUserClient.cpp */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -65,6 +67,8 @@
 		0118C9AB24C6121500C1C663 /* ROG_HID_Driver.iig */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.iig; path = ROG_HID_Driver.iig; sourceTree = "<group>"; };
 		0118C9AD24C6121500C1C663 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		0118C9AE24C6121500C1C663 /* ROG_HID_Driver.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = ROG_HID_Driver.entitlements; sourceTree = "<group>"; };
+		012617D525DBB8F100B563E0 /* ROGHIDUserClient.iig */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.iig; path = ROGHIDUserClient.iig; sourceTree = "<group>"; };
+		012617D925DBB90000B563E0 /* ROGHIDUserClient.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = ROGHIDUserClient.cpp; sourceTree = "<group>"; };
 		0176196324C77846007D4278 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -143,6 +147,7 @@
 		0118C9A824C6121500C1C663 /* ROG-HID-Driver */ = {
 			isa = PBXGroup;
 			children = (
+				012617D425DBB8A100B563E0 /* ROGHIDUserClient */,
 				0118C9A924C6121500C1C663 /* ROG_HID_Driver.cpp */,
 				01056BCF24C614FE0087FD10 /* IOBufferMemoryDescriptorUtility.h */,
 				0118C9AB24C6121500C1C663 /* ROG_HID_Driver.iig */,
@@ -153,6 +158,15 @@
 			path = "ROG-HID-Driver";
 			sourceTree = "<group>";
 		};
+		012617D425DBB8A100B563E0 /* ROGHIDUserClient */ = {
+			isa = PBXGroup;
+			children = (
+				012617D525DBB8F100B563E0 /* ROGHIDUserClient.iig */,
+				012617D925DBB90000B563E0 /* ROGHIDUserClient.cpp */,
+			);
+			path = ROGHIDUserClient;
+			sourceTree = "<group>";
+		};
 /* End PBXGroup section */
 
 /* Begin PBXHeadersBuildPhase section */
@@ -277,7 +291,9 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				012617DA25DBB90000B563E0 /* ROGHIDUserClient.cpp in Sources */,
 				0118C9AC24C6121500C1C663 /* ROG_HID_Driver.iig in Sources */,
+				012617D625DBB8F100B563E0 /* ROGHIDUserClient.iig in Sources */,
 				0118C9AA24C6121500C1C663 /* ROG_HID_Driver.cpp in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

codesign.sh

@@ -6,7 +6,8 @@
 #  Created by Nick on 7/20/20.
 #  Copyright © 2020 Nick. All rights reserved.
 
-readonly CODE_SIGN_IDENTITY=2FB6A1000899D1646EB5ECA45606F1522A05EFF9
+readonly CODE_SIGN_IDENTITY=79DBEC750D31EC17BA9F4E4A1FD2FFDBC9359D0A
+
 flavor="Release"
 
 if [[ $1 == "Debug" ]];
@@ -23,22 +24,22 @@ echo "Signing Dext..."
 codesign --sign $CODE_SIGN_IDENTITY \
     --entitlements ROG-HID-Driver/ROG_HID_Driver.entitlements \
     --options runtime --verbose --force \
-    build/$flavor/ROG-HID.app/Contents/Library/SystemExtensions/com.black-dragon74.ROG-HID-Driver.dext &>/dev/null || exit
+    build/$flavor/ROG-HID.app/Contents/Library/SystemExtensions/com.black-dragon74.ROG-HID-Driver.dext || exit
 
 echo "Verifying Dext..."
 codesign --verify --verbose \
-    build/$flavor/ROG-HID.app/Contents/Library/SystemExtensions/com.black-dragon74.ROG-HID-Driver.dext &>/dev/null || exit
+    build/$flavor/ROG-HID.app/Contents/Library/SystemExtensions/com.black-dragon74.ROG-HID-Driver.dext || exit
 
 echo "Signing App..."
 codesign --sign $CODE_SIGN_IDENTITY \
     --entitlements ROG-HID/ROG_HID.entitlements \
     --options runtime --verbose --force \
-    build/$flavor/ROG-HID.app &>/dev/null || exit
+    build/$flavor/ROG-HID.app || exit
 
 echo "Verifying App..."
 codesign \
     --verify --verbose \
-    build/$flavor/ROG-HID.app &>/dev/null || exit
+    build/$flavor/ROG-HID.app || exit
 
 echo
 echo "** SIGNING SUCCEEDED **"