@tokamakdev/plugin-secure-storage 0.1.0-beta.83 → 0.1.0-beta.85

package/README.md

@@ -57,6 +57,7 @@ the platform's default prompt is shown.
 | `NotSupportedError` | The platform, build or device cannot enforce the options |
 | `InvalidStateError` | The requested authentication is not set up on the device |
 | `NotAllowedError` | The user cancelled or failed authentication, or the device is locked |
+| `NeedsUIError` | Reading a value saved with `authentication` while the app is off screen on iOS or Android, where the system cannot show its prompt |
 | `NotReadableError` | A stored value can no longer be decrypted |
 | `TypeError` | An argument is missing or has an unsupported value |
 | `OperationError` | The platform reported another failure |

package/apple/SecureStoragePlugin.swift

@@ -2,14 +2,21 @@ import Foundation
 import LocalAuthentication
 import Security
 
+#if os(iOS)
+  import UIKit
+#endif
+
 final class TokamakSecureStoragePlugin: TokamakPlugin {
   let id = "secure-storage"
 
   private let service = "tokamak.secure-storage"
   /// Keychain calls block while the system authentication prompt is shown.
   private let queue = DispatchQueue(label: "tokamak.secure-storage")
+  private let host: TokamakHost
 
-  init(host: TokamakHost) {}
+  init(host: TokamakHost) {
+    self.host = host
+  }
 
   private static let teamSigningRequired = TokamakPluginError.notSupported(
     "Secure storage requires a team-signed build"
@@ -31,14 +38,33 @@ final class TokamakSecureStoragePlugin: TokamakPlugin {
     reply: @escaping TokamakPluginReply
   ) {
     let arguments = arguments as? [String: Any] ?? [:]
+    let prompting =
+      isUnlocked ? Result { () throws(TokamakPluginError) in try host.requireUI() } : nil
     queue.async {
-      reply(Result { () throws(TokamakPluginError) in try self.perform(method, arguments) })
+      reply(
+        Result { () throws(TokamakPluginError) in
+          try self.perform(method, arguments, prompting: prompting)
+        })
     }
   }
 
+  /// Whether the device's protected data is available, which it is not while
+  /// an iPhone is locked. Read it on the main thread.
+  private var isUnlocked: Bool {
+    #if os(iOS)
+      UIApplication.shared.isProtectedDataAvailable
+    #else
+      true
+    #endif
+  }
+
+  /// `prompting` is whether a read that needs authentication may show the
+  /// system prompt, decided on the main thread as the call arrives: nil while
+  /// the device is locked, where such a read fails without UI anyway.
   private func perform(
     _ method: String,
-    _ arguments: [String: Any]
+    _ arguments: [String: Any],
+    prompting: Result<Void, TokamakPluginError>?
   ) throws(TokamakPluginError) -> Any? {
     #if os(macOS)
       // Unentitled reads report errSecItemNotFound rather than a missing entitlement.
@@ -59,7 +85,8 @@ final class TokamakSecureStoragePlugin: TokamakPlugin {
     case "get":
       return try get(
         requiredString(arguments, "name"),
-        prompt: optionalString(arguments, "prompt")
+        prompt: optionalString(arguments, "prompt"),
+        prompting: prompting
       )
     case "delete":
       try deleteItems(query(requiredString(arguments, "name")))
@@ -97,16 +124,28 @@ final class TokamakSecureStoragePlugin: TokamakPlugin {
     try check(status)
   }
 
-  private func get(_ name: String, prompt: String?) throws(TokamakPluginError) -> String? {
+  /// Reads without UI first, so only a value saved with authentication needs
+  /// the app able to show the system prompt.
+  private func get(
+    _ name: String,
+    prompt: String?,
+    prompting: Result<Void, TokamakPluginError>?
+  ) throws(TokamakPluginError) -> String? {
     var item = query(name)
     item[kSecReturnData] = true
-    if let prompt, !prompt.isEmpty {
-      let context = LAContext()
-      context.localizedReason = prompt
-      item[kSecUseAuthenticationContext] = context
-    }
+    item[kSecUseAuthenticationContext] = Self.contextWithoutUI()
     var data: CFTypeRef?
-    let status = SecItemCopyMatching(item as CFDictionary, &data)
+    var status = SecItemCopyMatching(item as CFDictionary, &data)
+    if status == errSecInteractionNotAllowed, let prompting {
+      try prompting.get()
+      item[kSecUseAuthenticationContext] = prompt.flatMap { prompt -> LAContext? in
+        guard !prompt.isEmpty else { return nil }
+        let context = LAContext()
+        context.localizedReason = prompt
+        return context
+      }
+      status = SecItemCopyMatching(item as CFDictionary, &data)
+    }
     if status == errSecItemNotFound {
       guard try exists(name) else { return nil }
       throw TokamakPluginError(
@@ -154,13 +193,21 @@ final class TokamakSecureStoragePlugin: TokamakPlugin {
 
   /// `query` reading attributes only, which needs no authentication.
   private func attributesQuery(_ query: [CFString: Any]) -> [CFString: Any] {
-    let context = LAContext()
-    context.interactionNotAllowed = true
-    return query.merging([kSecReturnAttributes: true, kSecUseAuthenticationContext: context]) {
+    query.merging([
+      kSecReturnAttributes: true, kSecUseAuthenticationContext: Self.contextWithoutUI(),
+    ]) {
       _, attribute in attribute
     }
   }
 
+  /// A context in which reads that need authentication fail with
+  /// `errSecInteractionNotAllowed` rather than show the system prompt.
+  private static func contextWithoutUI() -> LAContext {
+    let context = LAContext()
+    context.interactionNotAllowed = true
+    return context
+  }
+
   /// All of the plugin's items. The data protection keychain is the only
   /// keychain on iOS; macOS needs a team-signed build to use it.
   private func serviceQuery() -> [CFString: Any] {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokamakdev/plugin-secure-storage",
-  "version": "0.1.0-beta.83",
+  "version": "0.1.0-beta.85",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mantty/tokamak.git",
@@ -11,7 +11,7 @@
     ".": "./src/index.ts"
   },
   "peerDependencies": {
-    "@tokamakdev/plugin": "0.1.0-beta.83"
+    "@tokamakdev/plugin": "0.1.0-beta.85"
   },
   "files": [
     "android",

package/src/index.ts

@@ -1,4 +1,4 @@
-import { FrontendPlugin } from "@tokamakdev/plugin";
+import { Plugin } from "@tokamakdev/plugin";
 
 /** When a stored value can be read. */
 export type Readable = "whenUnlocked" | "afterFirstUnlock";
@@ -22,7 +22,7 @@ export interface GetOptions {
   readonly prompt?: string;
 }
 
-class SecureStorage extends FrontendPlugin {
+class SecureStorage extends Plugin {
   constructor() {
     super("secure-storage");
   }