Make App Check core availability for all supported platforms (#8388)

* Update App Check availability to match Core * AppAttest availability update * Fix watchOS * watchOS * style * fix import * Fix Xcode support before 12.5 * changelog * Comments * Use week linking for DeviceCheck framework * Fix mac catalyts version
firebase · Jul 15, 2021 · 85c42dc · 85c42dc
1 parent 5268705
commit 85c42dc
Show file tree

Hide file tree

Showing 16 changed files with 134 additions and 35 deletions.
diff --git a/FirebaseAppCheck.podspec b/FirebaseAppCheck.podspec
@@ -17,13 +17,15 @@ Pod::Spec.new do |s|
   }
   s.social_media_url = 'https://twitter.com/Firebase'
 
-  ios_deployment_target = '11.0'
-  osx_deployment_target = '10.15'
-  tvos_deployment_target = '11.0'
+  ios_deployment_target = '9.0'
+  osx_deployment_target = '10.12'
+  tvos_deployment_target = '10.0'
+  watchos_deployment_target = '6.0'
 
   s.ios.deployment_target = ios_deployment_target
   s.osx.deployment_target = osx_deployment_target
   s.tvos.deployment_target = tvos_deployment_target
+  s.watchos.deployment_target = watchos_deployment_target
 
   s.cocoapods_version = '>= 1.4.0'
   s.prefix_header_file = false
@@ -36,7 +38,7 @@ Pod::Spec.new do |s|
   ]
   s.public_header_files = base_dir + 'Sources/Public/FirebaseAppCheck/*.h'
 
-  s.framework = 'DeviceCheck'
+  s.weak_framework = 'DeviceCheck'
 
   s.dependency 'FirebaseCore', '~> 8.0'
   s.dependency 'PromisesObjC', '>= 1.2', '< 3.0'

diff --git a/FirebaseAppCheck/CHANGELOG.md b/FirebaseAppCheck/CHANGELOG.md
@@ -1,3 +1,6 @@
+# v8.5.0 -- Unreleased
+- [changed] App Check SDK available for all supported platforms/OS versions, but App Attest and
+DeviceCheck providers availability changed to match underlying platfrom API availability. (#8388)
 # v8.4.0 -- M100
 - [fixed] Bump Promises dependency. (#8365)
 # v8.3.0 -- M99

diff --git a/FirebaseAppCheck/Sources/AppAttestProvider/DCAppAttestService+FIRAppAttestService.h b/FirebaseAppCheck/Sources/AppAttestProvider/DCAppAttestService+FIRAppAttestService.h
@@ -16,21 +16,22 @@
 
 #import <TargetConditionals.h>
 
+#import "FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckAvailability.h"
+
 // Currently DCAppAttestService is available on iOS only.
-#if TARGET_OS_IOS && !TARGET_OS_MACCATALYST  // Catalyst should be possible with Xcode 12.5+
+#if FIR_APP_ATTEST_SUPPORTED_TARGETS
 
 #import <DeviceCheck/DeviceCheck.h>
 
 #import "FirebaseAppCheck/Sources/AppAttestProvider/FIRAppAttestService.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
-API_AVAILABLE(ios(14.0))
-API_UNAVAILABLE(macos, tvos, watchos)
+FIR_APP_ATTEST_PROVIDER_AVAILABILITY
 @interface DCAppAttestService (FIRAppAttestService) <FIRAppAttestService>
 
 @end
 
 NS_ASSUME_NONNULL_END
 
-#endif  // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
+#endif  // FIR_APP_ATTEST_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/AppAttestProvider/DCAppAttestService+FIRAppAttestService.m b/FirebaseAppCheck/Sources/AppAttestProvider/DCAppAttestService+FIRAppAttestService.m
@@ -17,10 +17,10 @@
 #import "FirebaseAppCheck/Sources/AppAttestProvider/DCAppAttestService+FIRAppAttestService.h"
 
 // Currently DCAppAttestService is available on iOS only.
-#if TARGET_OS_IOS && !TARGET_OS_MACCATALYST  // Catalyst should be possible with Xcode 12.5+
+#if FIR_APP_ATTEST_SUPPORTED_TARGETS
 
 @implementation DCAppAttestService (FIRAppAttestService)
 
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // FIR_APP_ATTEST_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/AppAttestProvider/FIRAppAttestProvider.m b/FirebaseAppCheck/Sources/AppAttestProvider/FIRAppAttestProvider.m
@@ -132,7 +132,7 @@ - (instancetype)initWithAppAttestService:(id<FIRAppAttestService>)appAttestServi
 }
 
 - (nullable instancetype)initWithApp:(FIRApp *)app {
-#if TARGET_OS_IOS && !TARGET_OS_MACCATALYST  // Catalyst should be possible with Xcode 12.5+
+#if FIR_APP_ATTEST_SUPPORTED_TARGETS
   NSURLSession *URLSession = [NSURLSession
       sessionWithConfiguration:[NSURLSessionConfiguration ephemeralSessionConfiguration]];
 
@@ -159,9 +159,9 @@ - (nullable instancetype)initWithApp:(FIRApp *)app {
                              APIService:appAttestAPIService
                            keyIDStorage:keyIDStorage
                         artifactStorage:artifactStorage];
-#else   // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
+#else   // FIR_APP_ATTEST_SUPPORTED_TARGETS
   return nil;
-#endif  // TARGET_OS_IOS && !TARGET_OS_MACCATALYST
+#endif  // FIR_APP_ATTEST_SUPPORTED_TARGETS
 }
 
 #pragma mark - FIRAppCheckProvider

diff --git a/FirebaseAppCheck/Sources/DeviceCheckProvider/DCDevice+FIRDeviceCheckTokenGenerator.h b/FirebaseAppCheck/Sources/DeviceCheckProvider/DCDevice+FIRDeviceCheckTokenGenerator.h
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+#import "FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckAvailability.h"
+
+#if FIR_DEVICE_CHECK_SUPPORTED_TARGETS
+
 #import <DeviceCheck/DeviceCheck.h>
 
 #import "FirebaseAppCheck/Sources/DeviceCheckProvider/FIRDeviceCheckTokenGenerator.h"
@@ -25,3 +29,5 @@ NS_ASSUME_NONNULL_BEGIN
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif  // FIR_DEVICE_CHECK_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/DeviceCheckProvider/DCDevice+FIRDeviceCheckTokenGenerator.m b/FirebaseAppCheck/Sources/DeviceCheckProvider/DCDevice+FIRDeviceCheckTokenGenerator.m
@@ -16,6 +16,10 @@
 
 #import "FirebaseAppCheck/Sources/DeviceCheckProvider/DCDevice+FIRDeviceCheckTokenGenerator.h"
 
+#if FIR_DEVICE_CHECK_SUPPORTED_TARGETS
+
 @implementation DCDevice (FIRDeviceCheckTokenGenerator)
 
 @end
+
+#endif  // FIR_DEVICE_CHECK_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/DeviceCheckProvider/FIRDeviceCheckProvider.m b/FirebaseAppCheck/Sources/DeviceCheckProvider/FIRDeviceCheckProvider.m
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+#import "FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckAvailability.h"
+
+#if FIR_DEVICE_CHECK_SUPPORTED_TARGETS
+
 #import <Foundation/Foundation.h>
 
 #if __has_include(<FBLPromises/FBLPromises.h>)
@@ -119,3 +123,5 @@ - (void)getTokenWithCompletion:(void (^)(FIRAppCheckToken *_Nullable token,
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif  // FIR_DEVICE_CHECK_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/DeviceCheckProvider/FIRDeviceCheckProviderFactory.m b/FirebaseAppCheck/Sources/DeviceCheckProvider/FIRDeviceCheckProviderFactory.m
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+#import "FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckAvailability.h"
+
+#if FIR_DEVICE_CHECK_SUPPORTED_TARGETS
+
 #import "FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProviderFactory.h"
 
 #import "FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheck.h"
@@ -30,3 +34,5 @@ + (void)load {
 }
 
 @end
+
+#endif  // FIR_DEVICE_CHECK_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppAttestProvider.h b/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppAttestProvider.h
@@ -18,12 +18,13 @@
 
 #import "FIRAppCheckProvider.h"
 
+#import "FIRAppCheckAvailability.h"
+
 @class FIRApp;
 
 NS_ASSUME_NONNULL_BEGIN
 
-API_AVAILABLE(ios(14.0))
-API_UNAVAILABLE(macos, tvos, watchos)
+FIR_APP_ATTEST_PROVIDER_AVAILABILITY
 NS_SWIFT_NAME(AppAttestProvider)
 @interface FIRAppAttestProvider : NSObject <FIRAppCheckProvider>
 

diff --git a/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckAvailability.h b/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckAvailability.h
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Availability conditions for different App Check SDK components.
+
+#import <TargetConditionals.h>
+
+#pragma mark - DeviceCheck
+
+// Targets where DeviceCheck framework is available to be used in preprocessor conditions.
+#define FIR_DEVICE_CHECK_SUPPORTED_TARGETS TARGET_OS_IOS || TARGET_OS_OSX || TARGET_OS_TV
+
+// `DeviceCheckProvider` availability.
+#define FIR_DEVICE_CHECK_PROVIDER_AVAILABILITY \
+  API_AVAILABLE(ios(11.0), macos(10.15), tvos(11.0)) API_UNAVAILABLE(watchos)
+
+#pragma mark - App Attest
+
+// App Attest availability was extended to macOS and Mac Catalyst in Xcode 12.5.
+#if (defined(__IPHONE_14_5) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_14_5) || \
+    (defined(__MAC_11_3) && __MAC_OS_X_VERSION_MAX_ALLOWED >= __MAC_11_3) ||        \
+    (defined(__TVOS_14_5) && __TV_OS_VERSION_MAX_ALLOWED >= __TVOS_14_5)
+
+// Targets where `DCAppAttestService` is available to be used in preprocessor conditions.
+#define FIR_APP_ATTEST_SUPPORTED_TARGETS TARGET_OS_IOS || TARGET_OS_OSX
+
+// `AppAttestProvider` availability annotations
+#define FIR_APP_ATTEST_PROVIDER_AVAILABILITY \
+  API_AVAILABLE(macos(11.0), ios(14.0)) API_UNAVAILABLE(tvos, watchos)
+
+#else  // (defined(__IPHONE_14_5) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_14_5) || \
+          (defined(__MAC_11_3) && __MAC_OS_X_VERSION_MAX_ALLOWED >= __MAC_11_3) ||        \
+          (defined(__TVOS_14_5) && __TV_OS_VERSION_MAX_ALLOWED >= __TVOS_14_5)
+
+// Targets where `DCAppAttestService` is available to be used in preprocessor conditions.
+#define FIR_APP_ATTEST_SUPPORTED_TARGETS TARGET_OS_IOS && !TARGET_OS_MACCATALYST
+
+// `AppAttestProvider` availability annotations
+#define FIR_APP_ATTEST_PROVIDER_AVAILABILITY \
+  API_AVAILABLE(ios(14.0)) API_UNAVAILABLE(macos, tvos, watchos)
+
+#endif  // (defined(__IPHONE_14_5) && __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_14_5) || \
+          (defined(__MAC_11_3) && __MAC_OS_X_VERSION_MAX_ALLOWED >= __MAC_11_3) ||        \
+          (defined(__TVOS_14_5) && __TV_OS_VERSION_MAX_ALLOWED >= __TVOS_14_5)
diff --git a/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProvider.h b/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProvider.h
@@ -18,6 +18,10 @@
 
 #import "FIRAppCheckProvider.h"
 
+#import "FIRAppCheckAvailability.h"
+
+#if FIR_DEVICE_CHECK_SUPPORTED_TARGETS
+
 @class FIRApp;
 @protocol FIRDeviceCheckAPIServiceProtocol;
 @protocol FIRDeviceCheckTokenGenerator;
@@ -26,8 +30,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Firebase App Check provider that verifies app integrity using the
 /// [DeviceCheck](https://developer.apple.com/documentation/devicecheck) API.
-API_AVAILABLE(ios(11.0), macos(10.15), tvos(11.0))
-API_UNAVAILABLE(watchos)
+FIR_DEVICE_CHECK_PROVIDER_AVAILABILITY
 NS_SWIFT_NAME(DeviceCheckProvider)
 @interface FIRDeviceCheckProvider : NSObject <FIRAppCheckProvider>
 
@@ -42,3 +45,5 @@ NS_SWIFT_NAME(DeviceCheckProvider)
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif  // FIR_DEVICE_CHECK_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProviderFactory.h b/FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProviderFactory.h
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+#import "FIRAppCheckAvailability.h"
+
+#if FIR_DEVICE_CHECK_SUPPORTED_TARGETS
+
 #import <Foundation/Foundation.h>
 
 #import "FIRAppCheckProviderFactory.h"
@@ -24,11 +28,12 @@ NS_ASSUME_NONNULL_BEGIN
 /// `DeviceCheckProvider` for the specified `FirebaseApp` on request. Currently
 /// `DeviceCheckProviderFactory` is the default that will be used by Firebase App Check if no other
 /// provider is specified. See `AppCheck` class for more details.
-API_AVAILABLE(ios(11.0), macos(10.15), tvos(11.0))
-API_UNAVAILABLE(watchos)
+FIR_DEVICE_CHECK_PROVIDER_AVAILABILITY
 NS_SWIFT_NAME(DeviceCheckProviderFactory)
 @interface FIRDeviceCheckProviderFactory : NSObject <FIRAppCheckProviderFactory>
 
 @end
 
 NS_ASSUME_NONNULL_END
+
+#endif  // FIR_DEVICE_CHECK_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Tests/Unit/AppAttestProvider/FIRAppAttestProviderTests.m b/FirebaseAppCheck/Tests/Unit/AppAttestProvider/FIRAppAttestProviderTests.m
@@ -35,18 +35,17 @@
 
 #import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 
-// Currently FIRAppAttestProvider is available only on iOS.
-#if TARGET_OS_IOS
+#if FIR_APP_ATTEST_SUPPORTED_TARGETS
 
-API_AVAILABLE(ios(14.0))
+FIR_APP_ATTEST_PROVIDER_AVAILABILITY
 @interface FIRAppAttestProvider (Tests)
 - (instancetype)initWithAppAttestService:(id<FIRAppAttestService>)appAttestService
                               APIService:(id<FIRAppAttestAPIServiceProtocol>)APIService
                             keyIDStorage:(id<FIRAppAttestKeyIDStorageProtocol>)keyIDStorage
                          artifactStorage:(id<FIRAppAttestArtifactStorageProtocol>)artifactStorage;
 @end
 
-API_AVAILABLE(ios(14.0))
+FIR_APP_ATTEST_PROVIDER_AVAILABILITY
 @interface FIRAppAttestProviderTests : XCTestCase
 
 @property(nonatomic) FIRAppAttestProvider *provider;
@@ -92,7 +91,7 @@ - (void)tearDown {
 
 #pragma mark - Init tests
 
-#if !TARGET_OS_MACCATALYST  // Catalyst should be possible with Xcode 12.5+
+#if !TARGET_OS_MACCATALYST
 // Keychain dependent logic require additional configuration on Catalyst (enabling Keychain
 // sharing). For now, keychain dependent tests are disabled for Catalyst.
 - (void)testInitWithValidApp {
@@ -971,4 +970,4 @@ - (void)expectAttestationReset {
 
 @end
 
-#endif  // TARGET_OS_IOS
+#endif  // FIR_APP_ATTEST_SUPPORTED_TARGETS
diff --git a/FirebaseAppCheck/Tests/Unit/Core/FIRAppCheckIntegrationTests.m b/FirebaseAppCheck/Tests/Unit/Core/FIRAppCheckIntegrationTests.m
@@ -78,8 +78,11 @@ - (void)setUp {
 
 - (void)tearDown {
   [FIRApp resetApps];
-  // Recover default provider factory.
-  [FIRAppCheck setAppCheckProviderFactory:[[FIRDeviceCheckProviderFactory alloc] init]];
+
+  if (@available(iOS 11.0, macOS 10.15, macCatalyst 13.0, tvOS 11.0, *)) {
+    // Recover default provider factory.
+    [FIRAppCheck setAppCheckProviderFactory:[[FIRDeviceCheckProviderFactory alloc] init]];
+  }
 
   [self.mockTokenRefresher stopMocking];
   self.mockTokenRefresher = nil;

diff --git a/FirebaseAppCheck/Tests/Unit/Swift/AppCheckAPITests.swift b/FirebaseAppCheck/Tests/Unit/Swift/AppCheckAPITests.swift
@@ -160,16 +160,17 @@ final class AppCheckAPITests {
     // MARK: - DeviceCheckProvider
 
     // `DeviceCheckProvider` initializer
-    if let app = FirebaseApp.app(), let deviceCheckProvider = DeviceCheckProvider(app: app) {
-      // Get token
-      deviceCheckProvider.getToken { token, error in
-        if let _ /* error */ = error {
-          // ...
-        } else if let _ /* token */ = token {
-          // ...
+    if #available(iOS 11.0, macOS 10.15, macCatalyst 13.0, tvOS 11.0, *) {
+      if let app = FirebaseApp.app(), let deviceCheckProvider = DeviceCheckProvider(app: app) {
+        // Get token
+        deviceCheckProvider.getToken { token, error in
+          if let _ /* error */ = error {
+            // ...
+          } else if let _ /* token */ = token {
+            // ...
+          }
         }
       }
-
       // Get token (async/await)
       #if swift(>=5.5)
         if #available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *) {