capacitor-secure-storage-plugin 0.11.0 → 0.12.0

package/CapacitorSecureStoragePlugin.podspec

@@ -10,7 +10,7 @@ Pod::Spec.new do |s|
   s.homepage = package['repository']['url']
   s.author = package['author']
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
-  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '14.0'
   s.dependency 'Capacitor'
   s.dependency 'SwiftKeychainWrapper'

package/Package.swift

@@ -0,0 +1,30 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapacitorSecureStoragePlugin",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapacitorSecureStoragePlugin",
+            targets: ["SecureStoragePlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
+        .package(url: "https://github.com/jrendel/SwiftKeychainWrapper.git", from: "4.0.0")
+    ],
+    targets: [
+        .target(
+            name: "SecureStoragePlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                .product(name: "SwiftKeychainWrapper", package: "SwiftKeychainWrapper")
+            ],
+            path: "ios/Sources/SecureStoragePlugin"),
+        .testTarget(
+            name: "SecureStoragePluginTests",
+            dependencies: ["SecureStoragePlugin"],
+            path: "ios/Tests/SecureStoragePluginTests")
+    ]
+)

package/README.md

@@ -1,3 +1,5 @@
+[![npm version](https://badge.fury.io/js/capacitor-secure-storage-plugin.svg)](https://badge.fury.io/js/capacitor-secure-storage-plugin)
+
 # capacitor-secure-storage-plugin
 
 Capacitor plugin for storing string values securly on iOS and Android.

package/ios/{Plugin/SecureStoragePluginPlugin.swift → Sources/SecureStoragePlugin/SecureStoragePlugin.swift}

@@ -7,7 +7,17 @@ import SwiftKeychainWrapper
  * here: https://capacitor.ionicframework.com/docs/plugins/ios
  */
 @objc(SecureStoragePlugin)
-public class SecureStoragePlugin: CAPPlugin {
+public class SecureStoragePlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "SecureStoragePlugin" 
+    public let jsName = "SecureStoragePlugin" 
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "set", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "get", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "keys", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "remove", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "clear", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getPlatform", returnType: CAPPluginReturnPromise),
+    ] 
     var keychainwrapper: KeychainWrapper = KeychainWrapper.init(serviceName: "cap_sec")
     
     @objc func set(_ call: CAPPluginCall) {

package/ios/Tests/SecureStoragePluginTests/SecureStoragePluginTests.swift

@@ -0,0 +1,247 @@
+import XCTest
+import Capacitor
+import SwiftKeychainWrapper
+
+@testable import Plugin
+
+class PluginTests: XCTestCase {
+    
+    func setupDedicatedWrapper() -> KeychainWrapper {
+        let wrapper = KeychainWrapper.init(serviceName: "cap_sec")
+        wrapper.removeAllKeys()
+        return wrapper
+    }
+    
+    func testSet() {
+        let key = "key"
+        let value = "Hello, World!"
+        let valueModified = "Modified"
+        let keychainwrapper = setupDedicatedWrapper()
+        KeychainWrapper.standard.set(value, forKey: key)
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key,
+            "value": valueModified
+            ], success: { (result, call) in
+                let resultValue = result!.data?["value"] as? Bool
+                XCTAssertTrue(resultValue ?? false)
+                // dedicated keychain wrapper
+                let dedicatedValue = keychainwrapper.string(forKey: key)
+                XCTAssertEqual(valueModified, dedicatedValue)
+                // standard keychain wrapper should not be modified
+                let standardValue = KeychainWrapper.standard.string(forKey: key)
+                XCTAssertEqual(value, standardValue)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.set(call!)
+    }
+    
+    func testGet() {
+        let key = "key"
+        let value = "Hello, World!"
+        let keychainwrapper = setupDedicatedWrapper()
+        keychainwrapper.set(value, forKey: key)
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+            ], success: { (result, call) in
+                let resultValue = result!.data?["value"] as? String
+                XCTAssertEqual(value, resultValue)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.get(call!)
+    }
+    
+    func testGetCopy() {
+        let key = "key"
+        let value = "Hello, World!"
+        let keychainwrapper = setupDedicatedWrapper()
+        
+        KeychainWrapper.standard.set(value, forKey: key)
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+            ], success: { (result, call) in
+                let resultValue = result!.data?["value"] as? String
+                XCTAssertEqual(value, resultValue)
+                let dedicatedValue = keychainwrapper.string(forKey: key)
+                XCTAssertEqual(value, dedicatedValue)
+                let standardValue = KeychainWrapper.standard.string(forKey: key)
+                XCTAssertNil(standardValue)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.get(call!)
+    }
+    
+    func testKeys() {
+        let key = "key"
+        let key2 = "key2"
+        let value = "value"
+
+        let plugin = SecureStoragePlugin()
+
+        let keychainwrapper = setupDedicatedWrapper()
+        keychainwrapper.set(value, forKey: key)
+        keychainwrapper.set(value, forKey: key2)
+
+
+        let callOne = CAPPluginCall(callbackId: "test", options: [:],
+                                    success: { (result, call) in
+                let resultValue = result!.data?["value"] as? Array<String>
+                XCTAssertEqual(2, resultValue!.count)
+            XCTAssertTrue(resultValue!.contains(key))
+            XCTAssertTrue(resultValue!.contains(key2))
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        plugin.keys(callOne!)
+    }
+    
+    func testNonExistingGet() {
+        let key = "keyNonExisting"
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+            ], success: { (result, call) in
+                XCTFail("Error shouldn't have been called")
+        }, error: { (err) in
+            XCTAssertNotNil(err)
+        })
+        
+        plugin.get(call!)
+    }
+    
+    func testNonExistingRemoveBoth() {
+        let key = "keyNonExisting"
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+        ], success: { (result, call) in
+            XCTFail("Error shouldn't have been called")
+        }, error: { (err) in
+            XCTAssertNotNil(err)
+        })
+        
+        plugin.remove(call!)
+    }
+    
+    func testRemoveBoth() {
+        let key = "key"
+        let value = "Hello, World!"
+        // prefill dedicated keychain wrapper
+        let keychainwrapper = setupDedicatedWrapper()
+        keychainwrapper.set(value, forKey: key)
+        // prefill standard keychain wrapper
+        KeychainWrapper.standard.set(value, forKey: key)
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+            ], success: { (result, call) in
+                let resultValue = result!.data?["value"] as? Bool
+                XCTAssertTrue(resultValue ?? false)
+                // dedicated keychain wrapper
+                let dedicatedValue = keychainwrapper.string(forKey: key)
+                XCTAssertNil(dedicatedValue)
+                // standard keychain wrapper
+                let standardValueRemoved = KeychainWrapper.standard.string(forKey: key)
+                XCTAssertNil(standardValueRemoved)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.remove(call!)
+    }
+    
+    // same as testRemoveBoth, but don't prefill standard wrapper
+    func testRemove() {
+        let key = "key"
+        let value = "Hello, World!"
+        // prefill dedicated keychain wrapper
+        let keychainwrapper = setupDedicatedWrapper()
+        keychainwrapper.set(value, forKey: key)
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+            ], success: { (result, call) in
+                let resultValue = result!.data?["value"] as? Bool
+                XCTAssertTrue(resultValue ?? false)
+                // dedicated keychain wrapper
+                let dedicatedValue = keychainwrapper.string(forKey: key)
+                XCTAssertNil(dedicatedValue)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.remove(call!)
+    }
+    
+    func testClear() {
+        let key = "key"
+        let value = "Hello, World!"
+        let standardOnlyKey = "standard key"
+        let standardOnlyValue = "standard value"
+        // prefill dedicated keychain wrapper
+        let keychainwrapper = setupDedicatedWrapper()
+        keychainwrapper.set(value, forKey: key)
+        keychainwrapper.set(value + "2", forKey: key + "2")
+        // prefill standard keychain wrapper
+        KeychainWrapper.standard.set(value, forKey: key)
+        KeychainWrapper.standard.set(standardOnlyValue, forKey: standardOnlyKey)
+        
+        let plugin = SecureStoragePlugin()
+        
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "key": key
+            ], success: { (result, call) in
+                let resultValue = result!.data?["value"] as? Bool
+                XCTAssertTrue(resultValue ?? false)
+                // key present in dedicated and standard wrapper removed
+                let dedicatedValue = keychainwrapper.string(forKey: key)
+                XCTAssertNil(dedicatedValue)
+                let dedicatedValue2 = keychainwrapper.string(forKey: key + "2")
+                XCTAssertNil(dedicatedValue2)
+                let standardValue = KeychainWrapper.standard.string(forKey: key)
+                XCTAssertNil(standardValue)
+                // key only defined in standard wrapper still present
+                let standardValue2 = KeychainWrapper.standard.string(forKey: standardOnlyKey)
+                XCTAssertEqual(standardOnlyValue, standardValue2)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.clear(call!)
+    }
+    
+    func testGetPlatform() {
+        let plugin = SecureStoragePlugin()
+        let call = CAPPluginCall(callbackId: "test",
+                                 success: { (result, call) in
+                let resultValue = result!.data?["value"] as? String
+                XCTAssertEqual("ios", resultValue)
+        }, error: { (err) in
+            XCTFail("Error shouldn't have been called")
+        })
+        
+        plugin.getPlatform(call!)
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-secure-storage-plugin",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Securely store secrets such as usernames, passwords, tokens, certificates or other sensitive information (strings) on iOS & Android",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -10,7 +10,9 @@
     "android/src/main/",
     "android/build.gradle",
     "dist/",
-    "ios/Plugin/",
+    "ios/Sources",
+    "ios/Tests",
+    "Package.swift",
     "CapacitorSecureStoragePlugin.podspec"
   ],
   "author": "martinkasa",
@@ -29,7 +31,7 @@
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
-    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:ios" : "xcodebuild -scheme CapacitorSecureStoragePlugin -destination generic/platform=iOS",
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "npm run build",
     "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",

package/ios/Plugin/Info.plist

@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>$(DEVELOPMENT_LANGUAGE)</string>
-	<key>CFBundleExecutable</key>
-	<string>$(EXECUTABLE_NAME)</string>
-	<key>CFBundleIdentifier</key>
-	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>$(PRODUCT_NAME)</string>
-	<key>CFBundlePackageType</key>
-	<string>FMWK</string>
-	<key>CFBundleShortVersionString</key>
-	<string>1.0</string>
-	<key>CFBundleVersion</key>
-	<string>$(CURRENT_PROJECT_VERSION)</string>
-	<key>NSPrincipalClass</key>
-	<string></string>
-</dict>
-</plist>

package/ios/Plugin/SecureStoragePluginPlugin.h

@@ -1,10 +0,0 @@
-#import <UIKit/UIKit.h>
-
-//! Project version number for Plugin.
-FOUNDATION_EXPORT double PluginVersionNumber;
-
-//! Project version string for Plugin.
-FOUNDATION_EXPORT const unsigned char PluginVersionString[];
-
-// In this header, you should import all the public headers of your framework using statements like #import <Plugin/PublicHeader.h>
-

package/ios/Plugin/SecureStoragePluginPlugin.m

@@ -1,13 +0,0 @@
-#import <Foundation/Foundation.h>
-#import <Capacitor/Capacitor.h>
-
-// Define the plugin using the CAP_PLUGIN Macro, and
-// each method the plugin supports using the CAP_PLUGIN_METHOD macro.
-CAP_PLUGIN(SecureStoragePlugin, "SecureStoragePlugin",
-           CAP_PLUGIN_METHOD(set, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(get, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(keys, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(remove, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(clear, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(getPlatform, CAPPluginReturnPromise);
-)