Skip to content

fix(auth): add protected data unavailable error #3990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(auth): add protected data unavailable error #3990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee8fec2
fix(auth): add protected data unavailable error
harsh62 May 6, 2025
479cfb8
shorten the message
harsh62 May 6, 2025
c26eebb
add ios check
harsh62 May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/AWSCognitoAuthPlugin+Configure.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ import AWSClientRuntime
@_spi(InternalHttpEngineProxy) import AWSPluginsCore
import SmithyRetriesAPI
import SmithyRetries
#if os(iOS) && canImport(UIKit)
import UIKit
#endif

extension AWSCognitoAuthPlugin {

Expand All @@ -38,6 +41,15 @@ extension AWSCognitoAuthPlugin {
AuthPluginErrorConstants.decodeConfigurationError.recoverySuggestion)
}

#if os(iOS) && canImport(UIKit)
guard UIApplication.shared.isProtectedDataAvailable else {
throw PluginError.pluginConfigurationError(
AuthPluginErrorConstants.protectedDataUnavailableError.errorDescription,
AuthPluginErrorConstants.protectedDataUnavailableError.recoverySuggestion,
AWSCognitoAuthError.protectedDataUnavailable)
}
#endif

let credentialStoreResolver = CredentialStoreState.Resolver().eraseToAnyResolver()
let credentialEnvironment = credentialStoreEnvironment(authConfiguration: authConfiguration)
let credentialStoreMachine = StateMachine(resolver: credentialStoreResolver,
Expand Down
5 changes: 5 additions & 0 deletions AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Models/Errors/AWSCognitoAuthError.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ public enum AWSCognitoAuthError: Error {

/// The WebAuthn configuration is missing or incomplete
case webAuthnConfigurationMissing

/// Protected data is not yet available (iOS prewarming or locked state)
case protectedDataUnavailable
}

extension AWSCognitoAuthError: LocalizedError {
Expand Down Expand Up @@ -185,6 +188,8 @@ extension AWSCognitoAuthError: LocalizedError {
message = "The relying party ID doesn't match."
case .webAuthnConfigurationMissing:
message = "The WebAuthn configuration is missing or incomplete."
case .protectedDataUnavailable:
message = "Protected data is not yet available."
}
return "\(String(describing: Self.self)).\(self): \(message)"
}
Expand Down
5 changes: 5 additions & 0 deletions ...lugins/Auth/Sources/AWSCognitoAuthPlugin/Support/Constants/AuthPluginErrorConstants.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ typealias AuthPluginValidationErrorString = (field: Field,

enum AuthPluginErrorConstants {

static let protectedDataUnavailableError: AuthPluginErrorString = (
"Protected data is not yet available",
"Delay Amplify calls until `UIApplication.shared.isProtectedDataAvailable` returns true"
)

static let decodeConfigurationError: AuthPluginErrorString = (
"Unable to decode configuration",
"Make sure the plugin configuration is JSONValue")
Expand Down
12 changes: 12 additions & 0 deletions AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/Protocols/AmplifyAuthTask.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
import Foundation
import Amplify

#if os(iOS) && canImport(UIKit)
import UIKit
#endif

protocol AmplifyAuthTask {

associatedtype Success
Expand All @@ -30,6 +34,14 @@ extension AmplifyAuthTask where Self: DefaultLogger {
get async throws {
do {
log.info("Starting execution for \(eventName)")
#if os(iOS) && canImport(UIKit)
guard await UIApplication.shared.isProtectedDataAvailable else {
throw AuthError.configuration(
AuthPluginErrorConstants.protectedDataUnavailableError.errorDescription,
AuthPluginErrorConstants.protectedDataUnavailableError.recoverySuggestion,
AWSCognitoAuthError.protectedDataUnavailable)
}
#endif
let valueReturned = try await execute()
log.info("Successfully completed execution for \(eventName) with result:\n\(valueReturned)")
dispatch(result: .success(valueReturned))
Expand Down
Loading