Skip to contentSkip to conversation

applesmc: silence invalid key warning in case default one is used

PATCH In review Igor Mammedov 4 participants 13 messages Jul 28, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 applesmc: silence invalid key warning in case default one is used

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

If user launches MacOS guest without supplying valid or any key they will get upset MacOS (and legality of specifying valid key on CLI is also questionable). This patch favors QEMU/tests vs MacOS guest.

A patch from Apple needed to change default to the valid key, until then prefer QEMU maintainers sanity/cleaner test logs vs any inconvenience users running MacOS guest might suffer.

1) After some googling, it seems 'secret' key is the same for all Mac hardware and is widely known but whether it's permited to use that is up to lawyers/Apple to decide.

---
 hw/misc/applesmc.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
hw/misc/applesmc.c +5 -3
index 5f9c742e50..bce27b0950 100644
@@ -84,7 +84,7 @@ enum {
 #define smc_debug(...) do { } while (0)
 #endif
 
-static char default_osk[64] = "This is a dummy key. Enter the real key "
+static char default_osk[65] = "This is a dummy key. Enter the real key "
                               "using the -osk parameter";
 
 struct AppleSMCData {
@@ -335,10 +335,12 @@ static void applesmc_isa_realize(DeviceState *dev, Error **errp)
     isa_register_ioport(&s->parent_obj, &s->io_err,
                         s->iobase + APPLESMC_ERR_PORT);
 
-    if (!s->osk || (strlen(s->osk) != 64)) {
-        warn_report("Using AppleSMC with invalid key");
+    if (!s->osk) {
         s->osk = default_osk;
     }
+    if (strlen(s->osk) != 64) {
+        warn_report("Using AppleSMC with invalid key");
+    }
 
     QLIST_INIT(&s->data_def);
     qdev_applesmc_isa_reset(dev);
Signature · 1 line
2.31.1
#1 lore raw
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

What test is causing this problem ?

Quoted 24 lines

If user launches MacOS guest without supplying valid or any key they will get upset MacOS (and legality of specifying valid key on CLI is also questionable). This patch favors QEMU/tests vs MacOS guest.

A patch from Apple needed to change default to the valid key, until then prefer QEMU maintainers sanity/cleaner test logs vs any inconvenience users running MacOS guest might suffer.

1) After some googling, it seems 'secret' key is the same for all Mac hardware and is widely known but whether it's permited to use that is up to lawyers/Apple to decide.

---
 hw/misc/applesmc.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
hw/misc/applesmc.c +0 -0
index 5f9c742e50..bce27b0950 100644

hw/misc/applesmc.c enum { · line 88

Quoted 6 lines
hw/misc/applesmc.c +1 -1
@@ -84,7 +84,7 @@ enum {
 #define smc_debug(...) do { } while (0)
 #endif
 
-static char default_osk[64] = "This is a dummy key. Enter the real key "
+static char default_osk[65] = "This is a dummy key. Enter the real key "
                               "using the -osk parameter";

This is a distinct bug fix from the problem described. We should take this as a standalone fix no matter what.

hw/misc/applesmc.c static void applesmc_isa_realize(DeviceState *dev, Error **errp) · line 343

Quoted 13 lines
hw/misc/applesmc.c +4 -2
 struct AppleSMCData {
@@ -335,10 +335,12 @@ static void applesmc_isa_realize(DeviceState *dev, Error **errp)
     isa_register_ioport(&s->parent_obj, &s->io_err,
                         s->iobase + APPLESMC_ERR_PORT);
 
-    if (!s->osk || (strlen(s->osk) != 64)) {
-        warn_report("Using AppleSMC with invalid key");
+    if (!s->osk) {
         s->osk = default_osk;
     }
+    if (strlen(s->osk) != 64) {
+        warn_report("Using AppleSMC with invalid key");
+    }

This means users who invoke QEMU won't see the warning any more. This feels like a dubious change, as it degrades the user experiance for sake of tests - IMHO users takes priority over any testing.

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#2 lore raw
Quoted 8 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

-- PMM

#3 lore raw
Quoted 8 lines · Peter Maydell
Quoted 7 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

Quoted 5 lines
Quoted 1 line

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

The right fix is for bios-tables-tests to pass an explicit 'osk' value then. As its a test it doesn't have to be a genuine OSK, jsut any old 64-byte string

tests/qtest/bios-tables-test.c +1 -1
index 359916c228..f6b5adf200 100644
@@ -1632,7 +1632,7 @@ static void test_acpi_q35_applesmc(void)
         .variant = ".applesmc",
     };
 
-    test_acpi_one("-device isa-applesmc", &data);
+    test_acpi_one("-device isa-applesmc,osk=iamalsonottherealoskimjustheretostopbiostablestestspammingstderr", &data);
     free_test_data(&data);
 }
 

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#4 lore raw
Quoted 25 lines · Daniel P. Berrangé
Quoted 8 lines · Peter Maydell
Quoted 7 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

Quoted 5 lines
Quoted 1 line

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

The right fix is for bios-tables-tests to pass an explicit 'osk' value then. As its a test it doesn't have to be a genuine OSK, jsut any old 64-byte string

tests/qtest/bios-tables-test.c +0 -0
index 359916c228..f6b5adf200 100644

tests/qtest/bios-tables-test.c static void test_acpi_q35_applesmc(void) · line 1636

Quoted 6 lines
tests/qtest/bios-tables-test.c +1 -1
@@ -1632,7 +1632,7 @@ static void test_acpi_q35_applesmc(void)
         .variant = ".applesmc",
     };
 
-    test_acpi_one("-device isa-applesmc", &data);
+    test_acpi_one("-device isa-applesmc,osk=iamalsonottherealoskimjustheretostopbiostablestestspammingstderr", &data);
     free_test_data(&data);

We should either have a comment saying that this has to be exactly 64 characters and it doesn't matter what they are; or we could use
any64characterfakeoskisenoughtopreventinvalidkeywarningsonstderr

:-)

-- PMM

#5 lore raw
Quoted 37 lines · Peter Maydell
Quoted 25 lines · Daniel P. Berrangé
Quoted 8 lines · Peter Maydell
Quoted 7 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

Quoted 5 lines
Quoted 1 line

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

The right fix is for bios-tables-tests to pass an explicit 'osk' value then. As its a test it doesn't have to be a genuine OSK, jsut any old 64-byte string

tests/qtest/bios-tables-test.c +0 -0
index 359916c228..f6b5adf200 100644

tests/qtest/bios-tables-test.c static void test_acpi_q35_applesmc(void) · line 1636

Quoted 6 lines
tests/qtest/bios-tables-test.c +1 -1
@@ -1632,7 +1632,7 @@ static void test_acpi_q35_applesmc(void)
         .variant = ".applesmc",
     };
 
-    test_acpi_one("-device isa-applesmc", &data);
+    test_acpi_one("-device isa-applesmc,osk=iamalsonottherealoskimjustheretostopbiostablestestspammingstderr", &data);
     free_test_data(&data);

We should either have a comment saying that this has to be exactly 64 characters and it doesn't matter what they are; or we could use
any64characterfakeoskisenoughtopreventinvalidkeywarningsonstderr

Quoted 1 line

:-)

I applaud the renaissance of roman-style inscriptions, but it's not just words without spaces, it's also capital letters only:

ANY64CHARACTERFAKEOSKISENOUGHTOPREVENTINVALIDKEYWARNINGSONSTDERR

Seriously, throw in some dashes or spaces.

#6 lore raw
Quoted 7 lines · Markus Armbruster

Peter Maydell <[email protected]> writes:
I applaud the renaissance of roman-style inscriptions, but it's not just words without spaces, it's also capital letters only:

ANY64CHARACTERFAKEOSKISENOUGHTOPREVENTINVALIDKEYWARNINGSONSTDERR

Seriously, throw in some dashes or spaces.

any-64-char-fake-osk-will-avoid-an-invalid-key-warning-on-stderr

-- PMM

#7 lore raw
Quoted 10 lines · Peter Maydell
Quoted 7 lines · Markus Armbruster

Peter Maydell <[email protected]> writes:
I applaud the renaissance of roman-style inscriptions, but it's not just words without spaces, it's also capital letters only:

ANY64CHARACTERFAKEOSKISENOUGHTOPREVENTINVALIDKEYWARNINGSONSTDERR

Seriously, throw in some dashes or spaces.

any-64-char-fake-osk-will-avoid-an-invalid-key-warning-on-stderr

On the basis that virtualization gives you turtles all the way down...

-device isa-applesmc,osk=🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#8 lore raw
Quoted 8 lines · Daniel P. Berrangé
Quoted 7 lines · Peter Maydell
Quoted 6 lines · Markus Armbruster

Peter Maydell <[email protected]> writes:
I applaud the renaissance of roman-style inscriptions, but it's not just words without spaces, it's also capital letters only:

ANY64CHARACTERFAKEOSKISENOUGHTOPREVENTINVALIDKEYWARNINGSONSTDERR

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

Seriously, throw in some dashes or spaces.

any-64-char-fake-osk-will-avoid-an-invalid-key-warning-on-stderr

On the basis that virtualization gives you turtles all the way down...

-device isa-applesmc,osk=🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢🐢

Oh, Egyptian rather than Roman. Works for me!

#9 lore raw
In reply to Markus Armbruster
Quoted 39 lines · On Thu, 28 Jul 2022 15:29:58 +0200 Markus Armbruster <[email protected]> wrote:
Quoted 37 lines · Peter Maydell
Quoted 25 lines · Daniel P. Berrangé
Quoted 8 lines · Peter Maydell
Quoted 7 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

Quoted 5 lines
Quoted 1 line

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

The right fix is for bios-tables-tests to pass an explicit 'osk' value then. As its a test it doesn't have to be a genuine OSK, jsut any old 64-byte string

tests/qtest/bios-tables-test.c +0 -0
index 359916c228..f6b5adf200 100644

tests/qtest/bios-tables-test.c static void test_acpi_q35_applesmc(void) · line 1636

Quoted 6 lines
tests/qtest/bios-tables-test.c +1 -1
@@ -1632,7 +1632,7 @@ static void test_acpi_q35_applesmc(void)
         .variant = ".applesmc",
     };
 
-    test_acpi_one("-device isa-applesmc", &data);
+    test_acpi_one("-device isa-applesmc,osk=iamalsonottherealoskimjustheretostopbiostablestestspammingstderr", &data);
     free_test_data(&data);  

We should either have a comment saying that this has to be exactly 64 characters and it doesn't matter what they are; or we could use
any64characterfakeoskisenoughtopreventinvalidkeywarningsonstderr

Quoted 8 lines
Quoted 1 line

:-)

I applaud the renaissance of roman-style inscriptions, but it's not just words without spaces, it's also capital letters only:

ANY64CHARACTERFAKEOSKISENOUGHTOPREVENTINVALIDKEYWARNINGSONSTDERR

Seriously, throw in some dashes or spaces.

too late, but added a comment above hieroglyphs style string

Quoted 1 line
#10 lore raw
In reply to Daniel P. Berrangé
Quoted 24 lines · On Thu, 28 Jul 2022 11:23:00 +0100 Daniel P. Berrangé <[email protected]>…
Quoted 8 lines · Peter Maydell
Quoted 7 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

Quoted 5 lines
Quoted 1 line

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

The right fix is for bios-tables-tests to pass an explicit 'osk' value then. As its a test it doesn't have to be a genuine OSK, jsut any old 64-byte string

tests/qtest/bios-tables-test.c +0 -0
index 359916c228..f6b5adf200 100644

tests/qtest/bios-tables-test.c static void test_acpi_q35_applesmc(void) · line 1637

Quoted 7 lines
tests/qtest/bios-tables-test.c +1 -1
@@ -1632,7 +1632,7 @@ static void test_acpi_q35_applesmc(void)
         .variant = ".applesmc",
     };
 
-    test_acpi_one("-device isa-applesmc", &data);
+    test_acpi_one("-device isa-applesmc,osk=iamalsonottherealoskimjustheretostopbiostablestestspammingstderr", &data);
     free_test_data(&data);
 }

that will work, care tho send a formal patch or should I take over?

However we still have bogus default_osk, yes it will cause warning which typically nobody will see and end user will still end up with upset guest. Right thing would be to require osk explicitly and drop default completely. Users who actually run MacOS guest must be providing OSK explicitly already so they won't be affected and anyone else using default is broken anyways (whether QEMU started directly or through mgmt layer)

Quoted 4 lines
tests/qtest/bios-tables-test.c +0 -0
 With regards,

Daniel

#11 lore raw
Quoted 30 lines · Igor Mammedov
Quoted 27 lines · On Thu, 28 Jul 2022 11:23:00 +0100 Daniel P. Berrangé <[email protected]>…
Quoted 8 lines · Peter Maydell
Quoted 7 lines · Daniel P. Berrangé
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

Quoted 5 lines
Quoted 1 line

What test is causing this problem ?

bios-tables-test -- see here for the relevant bit of the log:

https://lore.kernel.org/qemu-devel/CAFEAcA8u8jm7b+JD_t0qMNMy+WSJPOw=qxqptZpwTp=TkcXrhg@mail.gmail.com/

The right fix is for bios-tables-tests to pass an explicit 'osk' value then. As its a test it doesn't have to be a genuine OSK, jsut any old 64-byte string

tests/qtest/bios-tables-test.c +0 -0
index 359916c228..f6b5adf200 100644
@@ -1632,7 +1632,7 @@ static void test_acpi_q35_applesmc(void)
         .variant = ".applesmc",
     };
 
Quoted 6 lines

tests/qtest/bios-tables-test.c static void test_acpi_q35_applesmc(void) · line 1637

Quoted 4 lines
tests/qtest/bios-tables-test.c +1 -1
-    test_acpi_one("-device isa-applesmc", &data);
+    test_acpi_one("-device isa-applesmc,osk=iamalsonottherealoskimjustheretostopbiostablestestspammingstderr", &data);
     free_test_data(&data);
 }

that will work, care tho send a formal patch or should I take over?

Could you spin something up, as I'm not in a position to do formal testing today.

Quoted 6 lines

However we still have bogus default_osk, yes it will cause warning which typically nobody will see and end user will still end up with upset guest. Right thing would be to require osk explicitly and drop default completely. Users who actually run MacOS guest must be providing OSK explicitly already so they won't be affected and anyone else using default is broken anyways (whether QEMU started directly or through mgmt layer)

There are other patches onlist to make QEMU extract an osk from the host hardware, which is ok because IIUC macOS allows you to run macOS as a VM, provided the host is Apple hardware.

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#12 lore raw
In reply to Daniel P. Berrangé
Quoted 35 lines · On Thu, 28 Jul 2022 10:48:27 +0100 Daniel P. Berrangé <[email protected]>…
Quoted 4 lines · Igor Mammedov

QEMU probably can't carry OSK key[1] for legal reasons so it can't supply the valid default key. However when tests are run applesmc will pollute test log with distracting warning, silence that warning so it won't distract maintainers/CI.

What test is causing this problem ?

Quoted 27 lines

If user launches MacOS guest without supplying valid or any key they will get upset MacOS (and legality of specifying valid key on CLI is also questionable). This patch favors QEMU/tests vs MacOS guest.

A patch from Apple needed to change default to the valid key, until then prefer QEMU maintainers sanity/cleaner test logs vs any inconvenience users running MacOS guest might suffer.

1) After some googling, it seems 'secret' key is the same for all Mac hardware and is widely known but whether it's permited to use that is up to lawyers/Apple to decide.

---
 hw/misc/applesmc.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
hw/misc/applesmc.c +0 -0
index 5f9c742e50..bce27b0950 100644
@@ -84,7 +84,7 @@ enum {
 #define smc_debug(...) do { } while (0)
 #endif
 
Quoted 6 lines

hw/misc/applesmc.c enum { · line 88

Quoted 3 lines
hw/misc/applesmc.c +1 -1
-static char default_osk[64] = "This is a dummy key. Enter the real key "
+static char default_osk[65] = "This is a dummy key. Enter the real key "
                               "using the -osk parameter";  

This is a distinct bug fix from the problem described. We should take this as a standalone fix no matter what.

thought about it (until I started to write commit message for that) but it becomes bug only if default_osk is treated as NULL terminated string, which happens only if following hunk is applied. Without that, it's treated as 64 bytes. (we can null-terminate it anyways just to be on a safe side)

Quoted 20 lines

hw/misc/applesmc.c static void applesmc_isa_realize(DeviceState *dev, Error **errp) · line 343

Quoted 13 lines
hw/misc/applesmc.c +4 -2
 struct AppleSMCData {
@@ -335,10 +335,12 @@ static void applesmc_isa_realize(DeviceState *dev, Error **errp)
     isa_register_ioport(&s->parent_obj, &s->io_err,
                         s->iobase + APPLESMC_ERR_PORT);
 
-    if (!s->osk || (strlen(s->osk) != 64)) {
-        warn_report("Using AppleSMC with invalid key");
+    if (!s->osk) {
         s->osk = default_osk;
     }
+    if (strlen(s->osk) != 64) {
+        warn_report("Using AppleSMC with invalid key");
+    }  

This means users who invoke QEMU won't see the warning any more. This feels like a dubious change, as it degrades the user experiance for sake of tests - IMHO users takes priority over any testing.

With regards,
Daniel