Skip to content
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

Jump to bottom

fix(Auth): Add keychain logging for better debugging #3669

Merged
merged 4 commits into from
May 2, 2024
Merged

fix(Auth): Add keychain logging for better debugging #3669

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c33dea1
fix(Auth): Add keychain logging for better debugging
harsh62 May 2, 2024
f6eb2f5
Update AmplifyPlugins/Core/AWSPluginsCore/Keychain/KeychainStore.swift
harsh62 May 2, 2024
dde9dbb
Update AmplifyPlugins/Core/AWSPluginsCore/Keychain/KeychainStore.swift
harsh62 May 2, 2024
8988c27
Update AmplifyPlugins/Core/AWSPluginsCore/Keychain/KeychainStore.swift
harsh62 May 2, 2024
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
40 changes: 37 additions & 3 deletions AmplifyPlugins/Core/AWSPluginsCore/Keychain/KeychainStore.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import Foundation
import Security
import Amplify

// swiftlint:disable identifier_name
public protocol KeychainStoreBehavior {
Expand Down Expand Up @@ -76,6 +77,7 @@ public struct KeychainStore: KeychainStoreBehavior {
var attributes = KeychainStoreAttributes(service: service)
attributes.accessGroup = accessGroup
self.init(attributes: attributes)
log.verbose("[KeychainStore] Initialized keychain with service=\(service), attributes=\(attributes), accessGroup=\(accessGroup ?? "")")
}

@_spi(KeychainStore)
Expand All @@ -84,12 +86,13 @@ public struct KeychainStore: KeychainStoreBehavior {
/// - Parameter key: A String key use to look up the value in the Keychain
/// - Returns: A string value
public func _getString(_ key: String) throws -> String {

log.verbose("[KeychainStore] Started retrieving `String` from the store with key=\(key)")
let data = try _getData(key)

guard let string = String(data: data, encoding: .utf8) else {
log.error("[KeychainStore] Unable to create String from Data retrieved")
throw KeychainStoreError.conversionError("Unable to create String from Data retrieved")
}
log.verbose("[KeychainStore] Successfully retrieved string from the store")
return string

}
Expand All @@ -100,6 +103,7 @@ public struct KeychainStore: KeychainStoreBehavior {
/// - Parameter key: A String key use to look up the value in the Keychain
/// - Returns: A data value
public func _getData(_ key: String) throws -> Data {
log.verbose("[KeychainStore] Started retrieving `Data` from the store with key=\(key)")
var query = attributes.defaultGetQuery()

query[Constants.MatchLimit] = Constants.MatchLimitOne
Expand All @@ -113,12 +117,16 @@ public struct KeychainStore: KeychainStoreBehavior {
switch status {
case errSecSuccess:
guard let data = result as? Data else {
log.error("[KeychainStore] The keychain item retrieved is not the correct type")
throw KeychainStoreError.unknown("The keychain item retrieved is not the correct type")
}
log.verbose("[KeychainStore] Successfully retrieved `Data` from the store with key=\(key)")
return data
case errSecItemNotFound:
log.verbose("[KeychainStore] No Keychain item found for key=\(key)")
throw KeychainStoreError.itemNotFound
default:
log.error("[KeychainStore] Error of status=\(status) occurred when attempting to retrieve a Keychain item for key=\(key)")
throw KeychainStoreError.securityError(status)
}
}
Expand All @@ -130,10 +138,13 @@ public struct KeychainStore: KeychainStoreBehavior {
/// - value: A string value to store in Keychain
/// - key: A String key for the value to store in the Keychain
public func _set(_ value: String, key: String) throws {
log.verbose("[KeychainStore] Started setting `String` for key=\(key)")
guard let data = value.data(using: .utf8, allowLossyConversion: false) else {
log.error("[KeychainStore] Unable to create Data from String retrieved for key=\(key)")
throw KeychainStoreError.conversionError("Unable to create Data from String retrieved")
}
try _set(data, key: key)
log.verbose("[KeychainStore] Successfully added `String` for key=\(key)")
}

@_spi(KeychainStore)
Expand All @@ -143,34 +154,43 @@ public struct KeychainStore: KeychainStoreBehavior {
/// - value: A data value to store in Keychain
/// - key: A String key for the value to store in the Keychain
public func _set(_ value: Data, key: String) throws {
log.verbose("[KeychainStore] Started setting `Data` for key=\(key)")
var getQuery = attributes.defaultGetQuery()
getQuery[Constants.AttributeAccount] = key

log.verbose("[KeychainStore] Initialized fetching to decide whether update or add")
let fetchStatus = SecItemCopyMatching(getQuery as CFDictionary, nil)
switch fetchStatus {
case errSecSuccess:
#if os(macOS)
log.verbose("[KeychainStore] Deleting item on MacOS to add an item.")
SecItemDelete(getQuery as CFDictionary)
fallthrough
#else
log.verbose("[KeychainStore] Found existing item, updating")
var attributesToUpdate = [String: Any]()
attributesToUpdate[Constants.ValueData] = value

let updateStatus = SecItemUpdate(getQuery as CFDictionary, attributesToUpdate as CFDictionary)
if updateStatus != errSecSuccess {
log.error("[KeychainStore] Error updating item to keychain with status=\(updateStatus)")
throw KeychainStoreError.securityError(updateStatus)
}
log.verbose("[KeychainStore] Successfully updated `String` in keychain for key=\(key)")
#endif
case errSecItemNotFound:
log.verbose("[KeychainStore] Unable to find an existing item, creating new item")
var attributesToSet = attributes.defaultSetQuery()
attributesToSet[Constants.AttributeAccount] = key
attributesToSet[Constants.ValueData] = value

let addStatus = SecItemAdd(attributesToSet as CFDictionary, nil)
if addStatus != errSecSuccess {
log.error("[KeychainStore] Error adding item to keychain with status=\(addStatus)")
throw KeychainStoreError.securityError(addStatus)
}
log.verbose("[KeychainStore] Successfully added `String` in keychain for key=\(key)")
default:
log.error("[KeychainStore] Error occurred while retrieving data from keychain when deciding to update or add with status=\(fetchStatus)")
throw KeychainStoreError.securityError(fetchStatus)
}
}
Expand All @@ -180,28 +200,34 @@ public struct KeychainStore: KeychainStoreBehavior {
/// This System Programming Interface (SPI) may have breaking changes in future updates.
/// - Parameter key: A String key to delete the key-value pair
public func _remove(_ key: String) throws {
log.verbose("[KeychainStore] Starting to remove item from keychain with key=\(key)")
var query = attributes.defaultGetQuery()
query[Constants.AttributeAccount] = key

let status = SecItemDelete(query as CFDictionary)
if status != errSecSuccess && status != errSecItemNotFound {
log.error("[KeychainStore] Error removing itms from keychain with status=\(status)")
throw KeychainStoreError.securityError(status)
}
log.verbose("[KeychainStore] Successfully removed item from keychain")
}

@_spi(KeychainStore)
/// Removes all key-value pair in the Keychain.
/// This System Programming Interface (SPI) may have breaking changes in future updates.
public func _removeAll() throws {
log.verbose("[KeychainStore] Starting to remove all items from keychain")
var query = attributes.defaultGetQuery()
#if !os(iOS) && !os(watchOS) && !os(tvOS)
query[Constants.MatchLimit] = Constants.MatchLimitAll
#endif

let status = SecItemDelete(query as CFDictionary)
if status != errSecSuccess && status != errSecItemNotFound {
log.error("[KeychainStore] Error removing all items from keychain with status=\(status)")
throw KeychainStoreError.securityError(status)
}
log.verbose("[KeychainStore] Successfully removed all items from keychain")
}

}
Expand Down Expand Up @@ -241,3 +267,11 @@ extension KeychainStore {
}
}
// swiftlint:enable identifier_name

extension KeychainStore: DefaultLogger {
public static var log: Logger {
Amplify.Logging.logger(forNamespace: String(describing: self))
}

public nonisolated var log: Logger { Self.log }
}
Loading