Skip to contentSkip to conversation

isa-applesmc: provide OSK forwarding on Apple hosts

PATCH Superseded Vladislav Yaroshchuk 2 participants 3 messages Oct 25, 2021

v5 of 10 Superseded Latest is v10 →

lore
Share & tools
lore
#0 lore raw

PATCH v5 1/1 isa-applesmc: provide OSK forwarding on Apple hosts

On Apple hosts we can read AppleSMC OSK key directly from host's SMC and forward this value to QEMU Guest.

Usage:
-device isa-applesmc,osk=host

Apple licence allows use and run up to two additional copies or instances of macOS operating within virtual operating system environments on each Apple-branded computer that is already running the Apple Software, for purposes of:
- software development
- testing during software development
- using macOS Server
- personal, non-commercial use

Guest macOS requires AppleSMC with correct OSK. The most legal way to pass it to the Guest is to forward the key from host SMC without any value exposion.

Enable this feature by default on Apple devices

Based on https://web.archive.org/web/20200103161737/osxbook.com/book/bonus/chapter7/tpmdrmmyth/

---
 hw/misc/applesmc.c | 121 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 121 insertions(+)
hw/misc/applesmc.c +121 -0
index 1b9acaf1d3..6bd2584ca0 100644
@@ -37,6 +37,11 @@
 #include "qemu/module.h"
 #include "qemu/timer.h"
 #include "qom/object.h"
+#include "qapi/error.h"
+
+#if defined(__APPLE__) && defined(__MACH__)
+#include <IOKit/IOKitLib.h>
+#endif
 
 /* #define DEBUG_SMC */
 
@@ -312,9 +317,106 @@ static const MemoryRegionOps applesmc_err_io_ops = {
     },
 };
 
+#if defined(__APPLE__) && defined(__MACH__)
+/*
+ * Based on
+ * https://web.archive.org/web/20200103161737/osxbook.com/book/bonus/chapter7/tpmdrmmyth/
+ */
+enum {
+    SMC_HANDLE_EVENT     = 2,
+    SMC_READ_KEY         = 5
+};
+
+struct AppleSMCParam {
+    uint32_t    key;
+    uint8_t     pad0[22];
+    IOByteCount data_size;
+    uint8_t     pad1[10];
+    uint8_t     command;
+    uint32_t    pad2;
+    uint8_t     bytes[32];
+};
+
+static bool applesmc_read_host_osk(char *host_osk, Error **errp)
+{
+    assert(host_osk != NULL);
+
+    io_service_t    hostsmc_service = IO_OBJECT_NULL;
+    io_connect_t    hostsmc_connect = IO_OBJECT_NULL;
+    size_t          smc_param_size = sizeof(struct AppleSMCParam);
+    IOReturn        status = kIOReturnError;
+    int             i;
+
+    struct AppleSMCParam smc_param[2] = {
+         {
+             .key = ('OSK0'),
+             .data_size = sizeof(smc_param[0].bytes),
+             .command = SMC_READ_KEY,
+         }, {
+             .key = ('OSK1'),
+             .data_size = sizeof(smc_param[0].bytes),
+             .command = SMC_READ_KEY,
+         },
+    };
+
+    hostsmc_service = IOServiceGetMatchingService(
+        kIOMasterPortDefault,
+        IOServiceMatching("AppleSMC"));
+    if (hostsmc_service == IO_OBJECT_NULL) {
+        error_setg(errp, "Unable to get host-AppleSMC service");
+        goto error;
+    }
+
+    status = IOServiceOpen(hostsmc_service,
+                           mach_task_self(),
+                           0,
+                           &hostsmc_connect);
+    if (status != kIOReturnSuccess || hostsmc_connect == IO_OBJECT_NULL) {
+        error_setg(errp, "Unable to open host-AppleSMC service");
+        goto error;
+    }
+
+    for (i = 0; i < ARRAY_SIZE(smc_param); ++i) {
+        status = IOConnectCallStructMethod(
+                hostsmc_connect,
+                SMC_HANDLE_EVENT,
+                &smc_param[i],
+                sizeof(struct AppleSMCParam),
+                &smc_param[i],
+                &smc_param_size
+            );
+
+        if (status != kIOReturnSuccess) {
+            error_setg(errp, "Unable to read OSK from host-AppleSMC");
+            goto error;
+        }
+    }
+
+    memcpy(host_osk, smc_param[0].bytes, 32);
+    memcpy(host_osk + 32, smc_param[1].bytes, 32);
+
+    IOServiceClose(hostsmc_connect);
+    IOObjectRelease(hostsmc_service);
+    return true;
+
+error:
+    IOServiceClose(hostsmc_connect);
+    IOObjectRelease(hostsmc_service);
+    return false;
+}
+#else
+static bool applesmc_read_host_osk(char *host_osk, Error **errp)
+{
+    error_setg(errp, "isa-applesmc.osk=host ignored: "
+                     "unsupported on non-Apple hosts");
+    return false;
+}
+#endif
+
 static void applesmc_isa_realize(DeviceState *dev, Error **errp)
 {
     AppleSMCState *s = APPLE_SMC(dev);
+    Error *err = NULL;
 
     memory_region_init_io(&s->io_data, OBJECT(s), &applesmc_data_io_ops, s,
                           "applesmc-data", 1);
@@ -331,6 +433,25 @@ static void applesmc_isa_realize(DeviceState *dev, Error **errp)
     isa_register_ioport(&s->parent_obj, &s->io_err,
                         s->iobase + APPLESMC_ERR_PORT);
 
+#if defined(__APPLE__) && defined(__MACH__)
+    /* Enable osk='host' on Apple devices by default */
+    if (!s->osk) {
+        s->osk = g_strdup("host");
+    }
+#endif
+
+    /* Overloaded property: osk='host' forces OSK reading from host AppleSMC */
+    if (s->osk && !strcmp(s->osk, "host")) {
+        g_free(s->osk);
+        s->osk = g_malloc0(65);
+
+        if (!applesmc_read_host_osk(s->osk, &err)) {
+            /* host OSK retrieval error only causes a warning, not a failure */
+            error_report_err(err);
+            s->osk = default_osk;
+        }
+    }
+
     if (!s->osk || (strlen(s->osk) != 64)) {
         warn_report("Using AppleSMC with invalid key");
         s->osk = default_osk;
Signature · 1 line
2.23.0
#1 lore raw
Quoted 46 lines · Vladislav Yaroshchuk

On Apple hosts we can read AppleSMC OSK key directly from host's SMC and forward this value to QEMU Guest.

Usage:
-device isa-applesmc,osk=host

Apple licence allows use and run up to two additional copies or instances of macOS operating within virtual operating system environments on each Apple-branded computer that is already running the Apple Software, for purposes of:
- software development
- testing during software development
- using macOS Server
- personal, non-commercial use

Guest macOS requires AppleSMC with correct OSK. The most legal way to pass it to the Guest is to forward the key from host SMC without any value exposion.

Enable this feature by default on Apple devices

Based on https://web.archive.org/web/20200103161737/osxbook.com/book/bonus/chapter7/tpmdrmmyth/

---
  hw/misc/applesmc.c | 121 +++++++++++++++++++++++++++++++++++++++++++++
  1 file changed, 121 insertions(+)
hw/misc/applesmc.c +5 -0
index 1b9acaf1d3..6bd2584ca0 100644
@@ -37,6 +37,11 @@
  #include "qemu/module.h"
  #include "qemu/timer.h"
  #include "qom/object.h"
+#include "qapi/error.h"
+
+#if defined(__APPLE__) && defined(__MACH__)
+#include <IOKit/IOKitLib.h>
+#endif
 
  /* #define DEBUG_SMC */
 
@@ -312,9 +317,106 @@ static const MemoryRegionOps applesmc_err_io_ops = {
      },

hw/misc/applesmc.c static const MemoryRegionOps applesmc_err_io_ops = { · line 327

Quoted 10 lines
hw/misc/applesmc.c +8 -0
  };
 
+#if defined(__APPLE__) && defined(__MACH__)
+/*
+ * Based on
+ * https://web.archive.org/web/20200103161737/osxbook.com/book/bonus/chapter7/tpmdrmmyth/
+ */
+enum {
+    SMC_HANDLE_EVENT     = 2,
+    SMC_READ_KEY         = 5

Anonymous enums are not great. Would you mind to just make them #define's instead?

Quoted 11 lines
hw/misc/applesmc.c +11 -0
+};
+
+struct AppleSMCParam {
+    uint32_t    key;
+    uint8_t     pad0[22];
+    IOByteCount data_size;
+    uint8_t     pad1[10];
+    uint8_t     command;
+    uint32_t    pad2;
+    uint8_t     bytes[32];
+};

hw/misc/applesmc.c static const MemoryRegionOps applesmc_err_io_ops = { · line 348

Quoted 10 lines
hw/misc/applesmc.c +10 -0
+
+static bool applesmc_read_host_osk(char *host_osk, Error **errp)
+{
+    assert(host_osk != NULL);
+
+    io_service_t    hostsmc_service = IO_OBJECT_NULL;
+    io_connect_t    hostsmc_connect = IO_OBJECT_NULL;
+    size_t          smc_param_size = sizeof(struct AppleSMCParam);
+    IOReturn        status = kIOReturnError;
+    int             i;

No need to align the variable names. If anything, better follow the Reverse Christmas Tree model :)

Also, let's wait for v6 until Daniel and me agreed on the parameter.

Alex

#2 lore raw

пн, 25 окт. 2021 г. в 17:56, Alexander Graf <[email protected]>:

Quoted 84 lines · Vladislav Yaroshchuk
Quoted 15 lines

On Apple hosts we can read AppleSMC OSK key directly from host's SMC and forward this value to QEMU Guest.

Usage:
-device isa-applesmc,osk=host

Apple licence allows use and run up to two additional copies or instances of macOS operating within virtual operating system environments on each Apple-branded computer that is already running the Apple Software, for purposes of:
- software development
- testing during software development
- using macOS Server
- personal, non-commercial use

Quoted 7 lines

Guest macOS requires AppleSMC with correct OSK. The most legal way to pass it to the Guest is to forward the key from host SMC without any value exposion.

Enable this feature by default on Apple devices

Based on

https://web.archive.org/web/20200103161737/osxbook.com/book/bonus/chapter7/tpmdrmmyth/

hw/misc/applesmc.c static const MemoryRegionOps applesmc_err_io_ops =

Quoted 23 lines
---
  hw/misc/applesmc.c | 121 +++++++++++++++++++++++++++++++++++++++++++++
  1 file changed, 121 insertions(+)
hw/misc/applesmc.c +5 -0
index 1b9acaf1d3..6bd2584ca0 100644
@@ -37,6 +37,11 @@
  #include "qemu/module.h"
  #include "qemu/timer.h"
  #include "qom/object.h"
+#include "qapi/error.h"
+
+#if defined(__APPLE__) && defined(__MACH__)
+#include <IOKit/IOKitLib.h>
+#endif
 
  /* #define DEBUG_SMC */
 
@@ -312,9 +317,106 @@ static const MemoryRegionOps applesmc_err_io_ops =

{

hw/misc/applesmc.c static const MemoryRegionOps applesmc_err_io_ops = {

Quoted 7 lines
hw/misc/applesmc.c +4 -0
      },
  };
 
+#if defined(__APPLE__) && defined(__MACH__)
+/*
+ * Based on
+ *

https://web.archive.org/web/20200103161737/osxbook.com/book/bonus/chapter7/tpmdrmmyth/

hw/misc/applesmc.c static const MemoryRegionOps applesmc_err_io_ops = { · line 327

Quoted 4 lines
hw/misc/applesmc.c +4 -0
+ */
+enum {
+    SMC_HANDLE_EVENT     = 2,
+    SMC_READ_KEY         = 5

Anonymous enums are not great. Would you mind to just make them #define's instead?

Quoted 17 lines
hw/misc/applesmc.c +17 -0
+};
+
+struct AppleSMCParam {
+    uint32_t    key;
+    uint8_t     pad0[22];
+    IOByteCount data_size;
+    uint8_t     pad1[10];
+    uint8_t     command;
+    uint32_t    pad2;
+    uint8_t     bytes[32];
+};
+
+static bool applesmc_read_host_osk(char *host_osk, Error **errp)
+{
+    assert(host_osk != NULL);
+
+    io_service_t    hostsmc_service = IO_OBJECT_NULL;
Quoted 9 lines

hw/misc/applesmc.c static const MemoryRegionOps applesmc_err_io_ops = { · line 348

Quoted 4 lines
hw/misc/applesmc.c +4 -0
+    io_connect_t    hostsmc_connect = IO_OBJECT_NULL;
+    size_t          smc_param_size = sizeof(struct AppleSMCParam);
+    IOReturn        status = kIOReturnError;
+    int             i;

No need to align the variable names. If anything, better follow the Reverse Christmas Tree model :)

Also, let's wait for v6 until Daniel and me agreed on the parameter.

Quoted 6 lines

Alex

Ok, waiting for your discussion to finish.

Signature · 3 lines
Best Regards,

Vladislav Yaroshchuk