forked from PlayCover/PlayTools
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PlayChain keychain emulation support (PlayCover#65)
* feat: Apple Keychain Emulation (beta) * feat: Make PlayChain optional * fix: Store Keychains in PlayCover directories * fix: remove more logging when debug isn't enabled * fix: trailing space after keychainFolder * fix: cleanup logging functions * fix: use debugLogger from PlayKeychain instead of redefining it * fix: correctly return NotFound for non supported types * fix: Nicer keychainFolder * Revert "fix: Nicer keychainFolder" This reverts commit 992e860 due to it storing the keychain inside the app container instead of PlayCover's * fix: team IDs and logging * fix: indentations * fix: tighter checks for Update operations * fix: remove Package.resolved
- Loading branch information
1 parent
0a264d6
commit 10e48d5
Showing
4 changed files
with
255 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| // | ||
| // PlayWeRuinedIt.swift | ||
| // PlayTools | ||
| // | ||
| // Created by Venti on 16/01/2023. | ||
| // | ||
|
|
||
| import Foundation | ||
| import Security | ||
|
|
||
| // Implementation for PlayKeychain | ||
| // World's Most Advanced Keychain Replacement Solution:tm: | ||
| // This is a joke, don't take it seriously | ||
|
|
||
| public class PlayKeychain: NSObject { | ||
| static let shared = PlayKeychain() | ||
|
|
||
| private static func getKeychainDirectory() -> URL? { | ||
| let bundleID = Bundle.main.infoDictionary?["CFBundleIdentifier"] as? String ?? "" | ||
| let keychainFolder = URL(fileURLWithPath: "/Users/\(NSUserName())/Library/Containers/io.playcover.PlayCover") | ||
| .appendingPathComponent("PlayChain") | ||
| .appendingPathComponent(bundleID) | ||
|
|
||
| // Create the keychain folder if it doesn't exist | ||
| if !FileManager.default.fileExists(atPath: keychainFolder.path) { | ||
| do { | ||
| try FileManager.default.createDirectory(at: keychainFolder, | ||
| withIntermediateDirectories: true, | ||
| attributes: nil) | ||
| } catch { | ||
| debugLogger("Failed to create keychain folder") | ||
| } | ||
| } | ||
|
|
||
| return keychainFolder | ||
| } | ||
|
|
||
| private static func keychainPath(_ attributes: NSDictionary) -> URL { | ||
| let keychainFolder = getKeychainDirectory() | ||
| // Generate a key path based on the key attributes | ||
| let accountName = attributes[kSecAttrAccount as String] as? String ?? "" | ||
| let serviceName = attributes[kSecAttrService as String] as? String ?? "" | ||
| let classType = attributes[kSecClass as String] as? String ?? "" | ||
| return keychainFolder! | ||
| .appendingPathComponent("\(serviceName)-\(accountName)-\(classType).plist") | ||
| } | ||
|
|
||
| @objc public static func debugLogger(_ logContent: String) { | ||
| if PlaySettings.shared.settingsData.playChainDebugging { | ||
| NSLog("PC-DEBUG: \(logContent)") | ||
| } | ||
| } | ||
| // Emulates SecItemAdd, SecItemUpdate, SecItemDelete and SecItemCopyMatching | ||
| // Store the entire dictionary as a plist | ||
| // SecItemAdd(CFDictionaryRef attributes, CFTypeRef *result) | ||
| @objc static public func add(_ attributes: NSDictionary, result: UnsafeMutablePointer<CFTypeRef?>?) -> OSStatus { | ||
| let keychainPath = keychainPath(attributes) | ||
| // Check if the keychain file already exists | ||
| if FileManager.default.fileExists(atPath: keychainPath.path) { | ||
| debugLogger("Keychain file already exists") | ||
| return errSecDuplicateItem | ||
| } | ||
| // Write the dictionary to the keychain file | ||
| do { | ||
| try attributes.write(to: keychainPath) | ||
| debugLogger("Wrote keychain file to \(keychainPath)") | ||
| } catch { | ||
| debugLogger("Failed to write keychain file") | ||
| return errSecIO | ||
| } | ||
| // Place v_data in the result | ||
| if let v_data = attributes["v_data"] { | ||
| result?.pointee = v_data as CFTypeRef | ||
| } | ||
| return errSecSuccess | ||
| } | ||
|
|
||
| // SecItemUpdate(CFDictionaryRef query, CFDictionaryRef attributesToUpdate) | ||
| @objc static public func update(_ query: NSDictionary, attributesToUpdate: NSDictionary) -> OSStatus { | ||
| // Get the path to the keychain file | ||
| let keychainPath = keychainPath(query) | ||
| // Read the dictionary from the keychain file | ||
| let keychainDict = NSDictionary(contentsOf: keychainPath) | ||
| debugLogger("Read keychain file from \(keychainPath)") | ||
| // Check if the file exist | ||
| if keychainDict == nil { | ||
| debugLogger("Keychain file not found at \(keychainPath)") | ||
| return errSecItemNotFound | ||
| } | ||
| // Reconstruct the dictionary (subscripting won't work as assignment is not allowed) | ||
| let newKeychainDict = NSMutableDictionary() | ||
| for (key, value) in keychainDict! { | ||
| newKeychainDict.setValue(value, forKey: key as! String) // swiftlint:disable:this force_cast | ||
| } | ||
| // Update the dictionary | ||
| for (key, value) in attributesToUpdate { | ||
| newKeychainDict.setValue(value, forKey: key as! String) // swiftlint:disable:this force_cast | ||
| } | ||
| // Write the dictionary to the keychain file | ||
| do { | ||
| try newKeychainDict.write(to: keychainPath) | ||
| debugLogger("Wrote keychain file to \(keychainPath)") | ||
| } catch { | ||
| debugLogger("Failed to write keychain file") | ||
| return errSecIO | ||
| } | ||
|
|
||
| return errSecSuccess | ||
| } | ||
|
|
||
| // SecItemDelete(CFDictionaryRef query) | ||
| @objc static public func delete(_ query: NSDictionary) -> OSStatus { | ||
| // Get the path to the keychain file | ||
| let keychainPath = keychainPath(query) | ||
| // Delete the keychain file | ||
| do { | ||
| try FileManager.default.removeItem(at: keychainPath) | ||
| debugLogger("Deleted keychain file at \(keychainPath)") | ||
| } catch { | ||
| debugLogger("Failed to delete keychain file") | ||
| return errSecIO | ||
| } | ||
| return errSecSuccess | ||
| } | ||
|
|
||
| // SecItemCopyMatching(CFDictionaryRef query, CFTypeRef *result) | ||
| @objc static public func copyMatching(_ query: NSDictionary, result: UnsafeMutablePointer<CFTypeRef?>?) | ||
| -> OSStatus { | ||
| // Get the path to the keychain file | ||
| let keychainPath = keychainPath(query) | ||
| // Read the dictionary from the keychain file | ||
| let keychainDict = NSDictionary(contentsOf: keychainPath) | ||
| // Check the `r_Attributes` key. If it is set to 1 in the query | ||
| // DROP, NOT IMPLEMENTED | ||
| let classType = query[kSecClass as String] as? String ?? "" | ||
| if query["r_Attributes"] as? Int == 1 { | ||
| return errSecItemNotFound | ||
| } | ||
| // If the keychain file doesn't exist, return errSecItemNotFound | ||
| if keychainDict == nil { | ||
| debugLogger("Keychain file not found at \(keychainPath)") | ||
| return errSecItemNotFound | ||
| } | ||
| // Return v_Data if it exists | ||
| if let vData = keychainDict!["v_Data"] { | ||
| debugLogger("Read keychain file from \(keychainPath)") | ||
| // Check the class type, if it is a key we need to return the data | ||
| // as SecKeyRef, otherwise we can return it as a CFTypeRef | ||
| if classType == "keys" { | ||
| // kSecAttrKeyType is stored as `type` in the dictionary | ||
| // kSecAttrKeyClass is stored as `kcls` in the dictionary | ||
| let keyAttributes = [ | ||
| kSecAttrKeyType: keychainDict!["type"] as! CFString, // swiftlint:disable:this force_cast | ||
| kSecAttrKeyClass: keychainDict!["kcls"] as! CFString // swiftlint:disable:this force_cast | ||
| ] | ||
| let keyData = vData as! Data // swiftlint:disable:this force_cast | ||
| let key = SecKeyCreateWithData(keyData as CFData, keyAttributes as CFDictionary, nil) | ||
| result?.pointee = key | ||
| return errSecSuccess | ||
| } | ||
| result?.pointee = vData as CFTypeRef | ||
| return errSecSuccess | ||
| } | ||
|
|
||
| return errSecItemNotFound | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters