Add App Check to the GHA logic (#691)

a-maurice · web-flow · commit 41ee580d207a · 2023-05-04T10:30:42.000-07:00
* Add App Check to the GHA logic

* Add App Check secrets

* Update guids.json

* Update android_dependencies.cmake

* Update BuiltInProviderWrapper.cs

* Update readme.md
diff --git a/.github/workflows/build_android.yml b/.github/workflows/build_android.yml
@@ -20,7 +20,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
diff --git a/.github/workflows/build_ios.yml b/.github/workflows/build_ios.yml
@@ -20,7 +20,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
diff --git a/.github/workflows/build_linux.yml b/.github/workflows/build_linux.yml
@@ -20,7 +20,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
diff --git a/.github/workflows/build_macos.yml b/.github/workflows/build_macos.yml
@@ -20,7 +20,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
diff --git a/.github/workflows/build_starter.yml b/.github/workflows/build_starter.yml
@@ -28,7 +28,7 @@ on:
         required: true
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
       # Additional CMake flags to use
       additional_cmake_flags:
@@ -102,7 +102,7 @@ jobs:
             echo "platform='Android,iOS,tvOS,Windows,macOS,Linux,Playmode'" >> $GITHUB_OUTPUT
             echo "release_label=nightly-$(date "+%Y%m%d-%H%M%S")" >> $GITHUB_OUTPUT
             echo "release_version=NoVersion" >> $GITHUB_OUTPUT
-            echo "apis='analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'" >> $GITHUB_OUTPUT
+            echo "apis='analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'" >> $GITHUB_OUTPUT
             echo "unity_version=2020" >> $GITHUB_OUTPUT
             echo "should_trigger_package=true" >> $GITHUB_OUTPUT
             echo "firebase_cpp_sdk_version=" >> $GITHUB_OUTPUT
diff --git a/.github/workflows/build_tvos.yml b/.github/workflows/build_tvos.yml
@@ -20,7 +20,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
@@ -47,7 +47,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
diff --git a/.github/workflows/build_windows.yml b/.github/workflows/build_windows.yml
@@ -20,7 +20,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       unity_platform_name:
diff --git a/.github/workflows/generate_swig.yml b/.github/workflows/generate_swig.yml
@@ -16,7 +16,7 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
       # Additional CMake flags to use
diff --git a/.github/workflows/integration_tests.yml b/.github/workflows/integration_tests.yml
@@ -18,7 +18,7 @@ on:
         required: true
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
       mobile_test_on:
         description: 'Run mobile tests on real and/or virtual devices? (value: real, virtual. separated by commas)'
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -33,15 +33,15 @@ on:
         type: string
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
 
 
 env:
   # Use SHA256 for hashing files.
   hashCommand: "sha256sum"
-  default_apis: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+  default_apis: 'analytics,app_check,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
 
 jobs:
   package_sdks:
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@ iOS, and desktop platforms. Note that desktop is ***only supported for developme
 purposes***. It includes the following Firebase libraries:
 
 - [Google Analytics for Firebase](https://firebase.google.com/docs/analytics/)
+- [Firebase App Check](https://firebase.google.com/docs/app-check/)
 - [Firebase Authentication](https://firebase.google.com/docs/auth/)
 - [Firebase Crashlytics](https://firebase.google.com/docs/crashlytics)
 - [Firebase Realtime Database](https://firebase.google.com/docs/database/)
@@ -85,7 +86,7 @@ Expected output artifact is
 python scripts/build_scripts/build_zips.py --platform=<target platform> --targets=<lib1> --targets=<lib2>
 ```
 
-> **Note:** Supported library names: analytics, auth, crashlytics, database, dynamic_links, firestore, functions, installations, messaging, remote_config, storage
+> **Note:** Supported library names: analytics, app_check, auth, crashlytics, database, dynamic_links, firestore, functions, installations, messaging, remote_config, storage
 
 ## Packaging
 
diff --git a/app_check/src/BuiltInProviderWrapper.cs b/app_check/src/BuiltInProviderWrapper.cs
@@ -63,6 +63,7 @@ public System.Threading.Tasks.Task<AppCheckToken> GetTokenAsync() {
   }
 
   // This is called from the C++ implementation, on the Unity main thread.
+  [MonoPInvokeCallback(typeof(AppCheckUtil.CompleteBuiltInGetTokenDelegate))]
   private static void CompleteBuiltInGetTokenMethod(int key, System.IntPtr tokenCPtr,
                                                     int error, string errorMessage) {
     TaskCompletionSource<AppCheckToken> tcs;
diff --git a/cmake/android_dependencies.cmake b/cmake/android_dependencies.cmake
@@ -25,9 +25,9 @@ set(FIREBASE_ANALYTICS_ANDROID_DEPS
 )
 
 set(FIREBASE_APP_CHECK_ANDROID_DEPS
-    "com.google.firebase:firebase-appcheck"
-    "com.google.firebase:firebase-appcheck-debug"
-    "com.google.firebase:firebase-appcheck-playintegrity"
+    "com.google.firebase:firebase-appcheck:17.0.0"
+    "com.google.firebase:firebase-appcheck-debug:17.0.0"
+    "com.google.firebase:firebase-appcheck-playintegrity:17.0.0"
     "com.google.firebase:firebase-analytics:21.2.1"
 )
 
diff --git a/docs/readme.md b/docs/readme.md
@@ -9,6 +9,7 @@ Note: Firebase Dynamic Links is not supported on tvOS.
 | Feature                            | Unity Package                     |
 |:----------------------------------:|:---------------------------------:|
 | Firebase Analytics                 | FirebaseAnalytics.unitypackage    |
+| Firebase App Check                 | FirebaseAppCheck.unitypackage     |
 | Firebase Authentication            | FirebaseAuth.unitypackage         |
 | Firebase Crashlytics               | FirebaseCrashlytics.unitypackage  |
 | Firebase Dynamic Links             | FirebaseDynamicLinks.unitypackage |
@@ -31,6 +32,7 @@ desktop builds on Windows, OS X, and Linux:
 | Feature                            | Unity Package                     |
 |:----------------------------------:|:---------------------------------:|
 | Firebase Authentication            | FirebaseAuth.unitypackage         |
+| Firebase App Check                 | FirebaseAppCheck.unitypackage     |
 | Firebase Realtime Database*        | FirebaseDatabase.unitypackage     |
 | Cloud Firestore                    | FirebaseFirestore.unitypackage    |
 | Firebase Functions                 | FirebaseFunctions.unitypackage    |
@@ -71,6 +73,9 @@ Release Notes
 -------------
 ### 11.0.0
 - Changes
+    - App Check: Adds support for Firebase App Check on Android, iOS, tvOS,
+      and desktop platforms. To learn more, see
+      https://firebase.google.com/docs/app-check
     - Messaging: Remove deprecated calls `Send`, `Subscribe`, and `Unsubscribe`.
     - Remote Config (Android/iOS): Added support for real-time config updates. Use the new
       `OnConfigUpdateListener` API to get real-time updates. Existing
diff --git a/scripts/gha-encrypted/app_check/GoogleService-Info.plist.gpg b/scripts/gha-encrypted/app_check/GoogleService-Info.plist.gpg
@@ -0,0 +1,5 @@
+�	�
+^��E?��������m�H��N/�R/�_�6��T^��t~�ki�<t��Q2�@텷���d.�,̅�8�\��f�Bt���>�;���\��S��r@!�I:{����G�i�'�����P������<�;�AiD(ι'B?�}�v-vZc{����ח�`��a@�?
+M���*n���D���7����
+C��"�|L߀禱��������
+�^��m���J���^��U�|����|���apgB�5^�v����������i(T�OE����TYٱ�p��]+G��75�KN�s�!��1��'��`�f.@k�ٽ{S��'��g'��8�C�����i�ֳ=��5#�e+�~�_�i�&[`�Q+F^I����8R��W�5�j��dK�B!��n�檭�ǫ�Nh]{��nUJ���=u*�|w�PVY�q�F6�;N]m�u�s���b����e�ޏ�W����M7��5V��('��<�����*���ork�0�G	�Olm���Ød��'����B���}�����M�>7HIJ��c���7�ox��Ć��-	^-�
diff --git a/scripts/gha-encrypted/app_check/app_check_token.txt.gpg b/scripts/gha-encrypted/app_check/app_check_token.txt.gpg
@@ -0,0 +1,2 @@
+�	J��G����Z���P�$�ɤ�-g/�Op�+�
+���,췆;�����[��)���F�&D����Q�'�6��w�GE�p��t���m����Q�b^���
diff --git a/scripts/gha-encrypted/app_check/google-services.json.gpg b/scripts/gha-encrypted/app_check/google-services.json.gpg
diff --git a/scripts/gha/integration_testing/build_testapps.json b/scripts/gha/integration_testing/build_testapps.json
@@ -17,6 +17,23 @@
         "com.google.firebase.analytics-*.tgz"
       ]
     },
+    {
+      "name": "app_check",
+      "full_name": "FirebaseAppCheck",
+      "captial_name": "AppCheck",
+      "bundle_id": "com.google.firebase.unity.appcheck.testapp",
+      "testapp_path": "app_check/testapp",
+      "platforms": ["Android", "Playmode", "iOS", "tvOS", "Windows", "macOS", "Linux"],
+      "plugins": [
+        "FirebaseAppCheck.unitypackage"
+      ],
+      "provision": "Firebase_Dev_Wildcard.mobileprovision",
+      "upm_packages": [
+        "com.google.external-dependency-manager-*.tgz",
+        "com.google.firebase.app-*.tgz",
+        "com.google.firebase.app-check-*.tgz"
+      ]
+    },
     {
       "name": "auth",
       "full_name": "FirebaseAuth",
diff --git a/unity_packer/guids.json b/unity_packer/guids.json
@@ -561,7 +561,9 @@
         "Firebase/m2repository/com/google/firebase/firebase-storage-unity/10.6.0/firebase-storage-unity-10.6.0.srcaar": "5f54445760624ee5ab11bb6f5615115c"
     },
     "10.7.0": {
+        "Firebase/Editor/AppCheckDependencies.xml": "7b93a7e6be01479aa8e1324390059c11",
         "Firebase/Editor/FirebaseAnalytics_version-10.7.0_manifest.txt": "5647178bc2234ee9b462ee89aad60164",
+        "Firebase/Editor/FirebaseAppCheck_version-10.7.0_manifest.txt": "8cb7c1b045ff4adbb02d0e5744768f2c",
         "Firebase/Editor/FirebaseAuth_version-10.7.0_manifest.txt": "1b9747f01af94eba9e13952b3da2d98f",
         "Firebase/Editor/FirebaseCrashlytics_version-10.7.0_manifest.txt": "dd650d318aa348f6b63ced7bb12aab75",
         "Firebase/Editor/FirebaseDatabase_version-10.7.0_manifest.txt": "81824f18800d4aa78b304ac67e6d8310",
@@ -572,13 +574,23 @@
         "Firebase/Editor/FirebaseMessaging_version-10.7.0_manifest.txt": "bda71acea1bb45a69b1b76414e3b7694",
         "Firebase/Editor/FirebaseRemoteConfig_version-10.7.0_manifest.txt": "25698e27e61f46038de3f11079a39a3c",
         "Firebase/Editor/FirebaseStorage_version-10.7.0_manifest.txt": "9361dcf560624487add8fcbb5ada6a9a",
+        "Firebase/Plugins/Firebase.AppCheck.dll": "0c5ed333710d4b75be4ba64948387242",
+        "Firebase/Plugins/Firebase.AppCheck.pdb": "0e6c428fc2dd48d7b1fc3653ddec5296",
+        "Firebase/Plugins/iOS/Firebase.AppCheck.dll": "11bf1ad4bd3a4140a8d619ca62dd1299",
+        "Firebase/Plugins/iOS/Firebase.AppCheck.pdb": "aa0d407b7dc94437989bd21dbcb8129f",
         "Firebase/Plugins/x86_64/FirebaseCppApp-10_7_0.bundle": "4a3bbb72957c46019fe2621122a551a9",
         "Firebase/Plugins/x86_64/FirebaseCppApp-10_7_0.dll": "bbac55f201f6491c90bb05b9b43b9fe4",
         "Firebase/Plugins/x86_64/FirebaseCppApp-10_7_0.so": "5d20bfd113704760b8a0ed2a1f1c4a11",
+        "Firebase/Plugins/x86_64/FirebaseCppAppCheck.bundle": "e67484c6c4644e6ab030360a71bfa7da",
+        "Firebase/Plugins/x86_64/FirebaseCppAppCheck.dll": "b45f6eb22b224bd4a0a45d3ddc8b9c7d",
+        "Firebase/Plugins/x86_64/FirebaseCppAppCheck.so": "97216acd9a6147259ea13b994ccb9fa2",
         "Firebase/m2repository/com/google/firebase/firebase-analytics-unity/10.7.0/firebase-analytics-unity-10.7.0.pom": "3c2422820e1c4b068b1ecf4eceb0bd1d",
         "Firebase/m2repository/com/google/firebase/firebase-analytics-unity/10.7.0/firebase-analytics-unity-10.7.0.srcaar": "688278569b0542bb82e3f41b17b72d89",
         "Firebase/m2repository/com/google/firebase/firebase-app-unity/10.7.0/firebase-app-unity-10.7.0.pom": "07cca069edd1437893c73b709a06e93f",
         "Firebase/m2repository/com/google/firebase/firebase-app-unity/10.7.0/firebase-app-unity-10.7.0.srcaar": "49b2ec82a6a547b798d83ad03539ac0d",
+        "Firebase/m2repository/com/google/firebase/firebase-appcheck-unity/10.7.0/firebase-appcheck-unity-10.7.0.pom": "c924ce820ef247b897eeb6824c6f0563",
+        "Firebase/m2repository/com/google/firebase/firebase-appcheck-unity/10.7.0/firebase-appcheck-unity-10.7.0.srcaar": "02d59478132246a99d6de647a0e91099",
+        "Firebase/m2repository/com/google/firebase/firebase-appcheck-unity/maven-metadata.xml": "cfa09eb6ba5647618b29c553fda150f3",
         "Firebase/m2repository/com/google/firebase/firebase-auth-unity/10.7.0/firebase-auth-unity-10.7.0.pom": "f73f7865eca04b4a95567e01d13f3a8d",
         "Firebase/m2repository/com/google/firebase/firebase-auth-unity/10.7.0/firebase-auth-unity-10.7.0.srcaar": "af0e404dab3e4d5c85b97ed8a0f3f3f8",
         "Firebase/m2repository/com/google/firebase/firebase-config-unity/10.7.0/firebase-config-unity-10.7.0.pom": "51b15c12808b46febb470195a72974ec",
@@ -598,7 +610,9 @@
         "Firebase/m2repository/com/google/firebase/firebase-messaging-unity/10.7.0/firebase-messaging-unity-10.7.0.pom": "a4490d01030747eeb1682e613a656d8e",
         "Firebase/m2repository/com/google/firebase/firebase-messaging-unity/10.7.0/firebase-messaging-unity-10.7.0.srcaar": "9a0ead811b124087af2c7a1d3d475fa5",
         "Firebase/m2repository/com/google/firebase/firebase-storage-unity/10.7.0/firebase-storage-unity-10.7.0.pom": "3921798c85b64ab99dfb10d6a83ae0f4",
-        "Firebase/m2repository/com/google/firebase/firebase-storage-unity/10.7.0/firebase-storage-unity-10.7.0.srcaar": "e9fe5d1c65034cdc8f83eda7dee52264"
+        "Firebase/m2repository/com/google/firebase/firebase-storage-unity/10.7.0/firebase-storage-unity-10.7.0.srcaar": "e9fe5d1c65034cdc8f83eda7dee52264",
+        "Plugins/iOS/Firebase/libFirebaseCppAppCheck.a": "5ba930d6364e431c97591fb429b6f553",
+        "Plugins/tvOS/Firebase/libFirebaseCppAppCheck.a": "adf6c486a27a4acc862f658f7c150dc0"
     },
     "3.0.0": {
         "Firebase/Editor/FirebaseAnalytics_v3.0.0_manifest.txt": "13c9ba8e35174de78ad7ca9a48cba9f0",

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ public System.Threading.Tasks.Task<AppCheckToken> GetTokenAsync() {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`// This is called from the C++ implementation, on the Unity main thread.`
	`66`	`+ [MonoPInvokeCallback(typeof(AppCheckUtil.CompleteBuiltInGetTokenDelegate))]`
`66`	`67`	`private static void CompleteBuiltInGetTokenMethod(int key, System.IntPtr tokenCPtr,`
`67`	`68`	`int error, string errorMessage) {`
`68`	`69`	`TaskCompletionSource<AppCheckToken> tcs;`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,9 @@ set(FIREBASE_ANALYTICS_ANDROID_DEPS`
`25`	`25`	`)`
`26`	`26`
`27`	`27`	`set(FIREBASE_APP_CHECK_ANDROID_DEPS`
`28`		`- "com.google.firebase:firebase-appcheck"`
`29`		`- "com.google.firebase:firebase-appcheck-debug"`
`30`		`- "com.google.firebase:firebase-appcheck-playintegrity"`
	`28`	`+ "com.google.firebase:firebase-appcheck:17.0.0"`
	`29`	`+ "com.google.firebase:firebase-appcheck-debug:17.0.0"`
	`30`	`+ "com.google.firebase:firebase-appcheck-playintegrity:17.0.0"`
`31`	`31`	`"com.google.firebase:firebase-analytics:21.2.1"`
`32`	`32`	`)`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,5 @@`
	`1`	`+� �`
	`2`	+^��E?��m�H��N/�R/�_�6��T^��t~�ki�<t��Q2�@텷��d.�,̅�8�\��f�Bt��>�;��\��S��r@!�I:{��G�i�'��P��<�;�AiD(ι'B?�}�v-vZc{��ח�`��a@�?
	`3`	`+M��*n��D��7��`
	`4`	`+C��"�\|L߀禱��`
	`5`	+�^��m��J��^��U�\|��\|��apgB�5^�v��i(T�OE��TYٱ�p��]+G��75�KN�s�!��1��'��`�f.@k�ٽ{S��'��g'��8�C��i�ֳ=��5#�e+�~�_�i�&[`�Q+F^I��8R��W�5�j��dK�B!��n�檭�ǫ�Nh]{��nUJ��=u�\|w�PVY�q�F6�;N]m�u�s��b��e�ޏ�W��M7��5V��('��<����ork�0�G �Olm��Ød��'��B��}��M�>7HIJ��c��7�ox��Ć��- ^-�
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+� J��G��Z��P�$�ɤ�-g/�Op�+�`
	`2`	`+��,췆;��[��)��F�&D��Q�'�6��w�GE�p��t��m��Q�b^��`