Merge pull request #1820 from gtm19/fix-macos-photo-permissions

Fix macOS camera / microphone / photo library permissions
beeware · May 21, 2024 · 7ffbb0a · 7ffbb0a
2 parents ec0235f + 52fa7cb
commit 7ffbb0a
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/changes/1820.bugfix.rst b/changes/1820.bugfix.rst
@@ -0,0 +1 @@
+macOS apps now generate ``info.plist`` entries for camera, photo library and microphone permissions.
diff --git a/docs/reference/platforms/macOS/xcode.rst b/docs/reference/platforms/macOS/xcode.rst
@@ -117,8 +117,10 @@ Permissions
 Briefcase cross platform permissions map to a combination of ``info`` and ``entitlement``
 keys:
 
-* ``microphone``: an ``entitlement`` of ``com.apple.security.device.audio-input``
-* ``camera``: an ``entitlement`` of ``com.apple.security.device.camera``
+* ``microphone``: an ``info`` entry for ``NSMicrophoneUsageDescription``; and
+  an ``entitlement`` of ``com.apple.security.device.audio-input``
+* ``camera``: an ``info`` entry for ``NSCameraUsageDescription``; and
+  an ``entitlement`` of ``com.apple.security.device.camera``
 * ``coarse_location``: an ``info`` entry for ``NSLocationUsageDescription``
   (ignored if ``background_location`` or ``fine_location`` is defined); plus an
   entitlement of ``com.apple.security.personal-information.location``
@@ -127,7 +129,9 @@ keys:
   ``com.apple.security.personal-information.location``
 * ``background_location``: an ``info`` entry for ``NSLocationUsageDescription``;
   plus an ``entitlement`` of ``com.apple.security.personal-information.location``
-* ``photo_library``: an ``entitlement`` of ``com.apple.security.personal-information.photos-library``
+* ``photo_library``: an ``info`` entry for ``NSPhotoLibraryUsageDescription``;
+  plus an ``entitlement`` of
+  ``com.apple.security.personal-information.photos-library``
 
 Platform quirks
 ===============

diff --git a/src/briefcase/platforms/macOS/__init__.py b/src/briefcase/platforms/macOS/__init__.py
@@ -168,8 +168,10 @@ def permissions_context(self, app: AppConfig, cross_platform: dict[str, str]):
 
         if cross_platform["camera"]:
             entitlements["com.apple.security.device.camera"] = True
+            info["NSCameraUsageDescription"] = cross_platform["camera"]
         if cross_platform["microphone"]:
             entitlements["com.apple.security.device.microphone"] = True
+            info["NSMicrophoneUsageDescription"] = cross_platform["microphone"]
 
         if cross_platform["background_location"]:
             info["NSLocationUsageDescription"] = cross_platform["background_location"]
@@ -182,6 +184,7 @@ def permissions_context(self, app: AppConfig, cross_platform: dict[str, str]):
             entitlements["com.apple.security.personal-information.location"] = True
 
         if cross_platform["photo_library"]:
+            info["NSPhotoLibraryUsageDescription"] = cross_platform["photo_library"]
             entitlements["com.apple.security.personal-information.photo_library"] = True
 
         # Override any info and entitlement definitions with the platform specific definitions

diff --git a/tests/platforms/macOS/app/test_create.py b/tests/platforms/macOS/app/test_create.py
@@ -73,7 +73,9 @@ def create_command(tmp_path, first_app_templated):
             {},
             {},
             {
-                "info": {},
+                "info": {
+                    "NSCameraUsageDescription": "I need to see you",
+                },
                 "entitlements": {
                     "com.apple.security.cs.allow-unsigned-executable-memory": True,
                     "com.apple.security.cs.disable-library-validation": True,
@@ -89,7 +91,9 @@ def create_command(tmp_path, first_app_templated):
             {},
             {},
             {
-                "info": {},
+                "info": {
+                    "NSMicrophoneUsageDescription": "I need to hear you",
+                },
                 "entitlements": {
                     "com.apple.security.cs.allow-unsigned-executable-memory": True,
                     "com.apple.security.cs.disable-library-validation": True,
@@ -236,7 +240,9 @@ def create_command(tmp_path, first_app_templated):
             {},
             {},
             {
-                "info": {},
+                "info": {
+                    "NSPhotoLibraryUsageDescription": "I need to see your library",
+                },
                 "entitlements": {
                     "com.apple.security.cs.allow-unsigned-executable-memory": True,
                     "com.apple.security.cs.disable-library-validation": True,