mirror of
https://github.com/yattee/yattee.git
synced 2026-05-14 11:25:02 +00:00
Generalize Yattee Server credentials manager to BasicAuthCredentialsManager
Renames YatteeServerCredentialsManager → BasicAuthCredentialsManager so the same Keychain-backed username/password storage can be reused for any instance type that sits behind a reverse proxy requiring HTTP Basic Auth. Adds a one-time migration that moves existing items from the legacy 'com.yattee.yatteeserver' Keychain service to 'com.yattee.basicauth', preserving the iCloud-sync attribute. No behavior change for end users.
This commit is contained in:
325
Yattee/Services/Credentials/BasicAuthCredentialsManager.swift
Normal file
325
Yattee/Services/Credentials/BasicAuthCredentialsManager.swift
Normal file
@@ -0,0 +1,325 @@
|
||||
//
|
||||
// BasicAuthCredentialsManager.swift
|
||||
// Yattee
|
||||
//
|
||||
// Manages HTTP Basic Auth credentials (username/password) stored securely in the Keychain.
|
||||
// Works for any instance type (Invidious, Piped, PeerTube, Yattee Server) — used when an
|
||||
// instance sits behind a reverse proxy that requires HTTP Basic Auth.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
import Security
|
||||
|
||||
/// Credential structure for HTTP Basic authentication.
|
||||
struct BasicAuthCredential: Codable {
|
||||
let username: String
|
||||
let password: String
|
||||
}
|
||||
|
||||
/// Manages HTTP Basic Auth credentials stored securely in the Keychain.
|
||||
@MainActor
|
||||
@Observable
|
||||
final class BasicAuthCredentialsManager: InstanceCredentialsManager {
|
||||
private let keychainServiceName = "com.yattee.basicauth"
|
||||
|
||||
/// Legacy Keychain service name from when basic auth was Yattee-Server-only.
|
||||
/// We migrate items from this service to `keychainServiceName` on init.
|
||||
private let legacyKeychainServiceName = "com.yattee.yatteeserver"
|
||||
|
||||
/// Tracks which instances have stored credentials (for reactive UI updates)
|
||||
private(set) var loggedInInstanceIDs: Set<UUID> = []
|
||||
|
||||
/// Reference to settings manager for iCloud sync decisions
|
||||
weak var settingsManager: SettingsManager?
|
||||
|
||||
/// Whether credentials should sync to iCloud Keychain (when iCloud sync is enabled for instances).
|
||||
private var shouldSyncToiCloud: Bool {
|
||||
settingsManager?.iCloudSyncEnabled == true && settingsManager?.syncInstances == true
|
||||
}
|
||||
|
||||
init() {
|
||||
migrateLegacyKeychainItems()
|
||||
}
|
||||
|
||||
// MARK: - Public API
|
||||
|
||||
/// Stores credentials for an instance.
|
||||
/// Credentials sync to iCloud Keychain when iCloud sync is enabled for instances.
|
||||
/// - Parameters:
|
||||
/// - username: The username for basic auth
|
||||
/// - password: The password for basic auth
|
||||
/// - instance: The instance
|
||||
func setCredentials(username: String, password: String, for instance: Instance) {
|
||||
let account = instance.id.uuidString
|
||||
let credential = BasicAuthCredential(username: username, password: password)
|
||||
|
||||
guard let data = try? JSONEncoder().encode(credential) else {
|
||||
LoggingService.shared.error("Failed to encode basic auth credentials", category: .keychain)
|
||||
return
|
||||
}
|
||||
|
||||
let syncEnabled = shouldSyncToiCloud
|
||||
|
||||
// First, delete any existing item (both synced and non-synced) to avoid duplicates
|
||||
let deleteQuery: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: keychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: kSecAttrSynchronizableAny
|
||||
]
|
||||
SecItemDelete(deleteQuery as CFDictionary)
|
||||
|
||||
// Create new item with current sync preference
|
||||
let addQuery: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: keychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: syncEnabled,
|
||||
kSecValueData as String: data
|
||||
]
|
||||
|
||||
let status = SecItemAdd(addQuery as CFDictionary, nil)
|
||||
|
||||
if status == errSecSuccess {
|
||||
LoggingService.shared.info(
|
||||
"Stored basic auth credentials for instance",
|
||||
category: .keychain,
|
||||
details: "instanceID=\(instance.id), iCloudSync=\(syncEnabled)"
|
||||
)
|
||||
// Update tracked set for reactive UI
|
||||
loggedInInstanceIDs.insert(instance.id)
|
||||
} else {
|
||||
LoggingService.shared.error(
|
||||
"Failed to store basic auth credentials for instance",
|
||||
category: .keychain,
|
||||
details: "instanceID=\(instance.id), status=\(status)"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/// Retrieves credentials for an instance.
|
||||
/// Searches both synced and non-synced items.
|
||||
/// - Parameter instance: The instance
|
||||
/// - Returns: The credentials if stored, nil otherwise
|
||||
func credentials(for instance: Instance) -> BasicAuthCredential? {
|
||||
let account = instance.id.uuidString
|
||||
|
||||
let query: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: keychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: kSecAttrSynchronizableAny,
|
||||
kSecReturnData as String: true,
|
||||
kSecMatchLimit as String: kSecMatchLimitOne
|
||||
]
|
||||
|
||||
var result: AnyObject?
|
||||
let status = SecItemCopyMatching(query as CFDictionary, &result)
|
||||
|
||||
guard status == errSecSuccess,
|
||||
let data = result as? Data,
|
||||
let credential = try? JSONDecoder().decode(BasicAuthCredential.self, from: data) else {
|
||||
LoggingService.shared.debug(
|
||||
"No basic auth credentials found for instance",
|
||||
category: .keychain,
|
||||
details: "instanceID=\(instance.id), status=\(status)"
|
||||
)
|
||||
return nil
|
||||
}
|
||||
|
||||
return credential
|
||||
}
|
||||
|
||||
/// Deletes credentials for an instance.
|
||||
/// Deletes both synced and non-synced items.
|
||||
/// - Parameter instance: The instance
|
||||
func deleteCredentials(for instance: Instance) {
|
||||
let account = instance.id.uuidString
|
||||
|
||||
let query: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: keychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: kSecAttrSynchronizableAny
|
||||
]
|
||||
|
||||
let status = SecItemDelete(query as CFDictionary)
|
||||
|
||||
if status == errSecSuccess || status == errSecItemNotFound {
|
||||
LoggingService.shared.info(
|
||||
"Deleted basic auth credentials for instance",
|
||||
category: .keychain,
|
||||
details: "instanceID=\(instance.id)"
|
||||
)
|
||||
} else {
|
||||
LoggingService.shared.error(
|
||||
"Failed to delete basic auth credentials for instance",
|
||||
category: .keychain,
|
||||
details: "instanceID=\(instance.id), status=\(status)"
|
||||
)
|
||||
}
|
||||
|
||||
// Update tracked set for reactive UI
|
||||
loggedInInstanceIDs.remove(instance.id)
|
||||
}
|
||||
|
||||
/// Checks if an instance has stored credentials.
|
||||
/// - Parameter instance: The instance
|
||||
/// - Returns: true if credentials exist, false otherwise
|
||||
func hasCredentials(for instance: Instance) -> Bool {
|
||||
// Check tracked set first for performance
|
||||
if loggedInInstanceIDs.contains(instance.id) {
|
||||
return true
|
||||
}
|
||||
// Fall back to Keychain check
|
||||
let hasCreds = credentials(for: instance) != nil
|
||||
if hasCreds {
|
||||
loggedInInstanceIDs.insert(instance.id)
|
||||
}
|
||||
return hasCreds
|
||||
}
|
||||
|
||||
/// Refreshes the logged-in status for an instance.
|
||||
/// Call this when the view appears to ensure UI is in sync.
|
||||
func refreshLoginStatus(for instance: Instance) {
|
||||
if credentials(for: instance) != nil {
|
||||
loggedInInstanceIDs.insert(instance.id)
|
||||
} else {
|
||||
loggedInInstanceIDs.remove(instance.id)
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - InstanceCredentialsManager Protocol
|
||||
|
||||
/// Stores a credential for an instance (protocol conformance).
|
||||
/// The credential is expected to be a JSON-encoded BasicAuthCredential.
|
||||
/// - Parameters:
|
||||
/// - credential: JSON string containing {"username": "...", "password": "..."}
|
||||
/// - instance: The instance to associate the credential with
|
||||
func setCredential(_ credential: String, for instance: Instance) {
|
||||
guard let data = credential.data(using: .utf8),
|
||||
let creds = try? JSONDecoder().decode(BasicAuthCredential.self, from: data) else {
|
||||
LoggingService.shared.error(
|
||||
"Failed to decode basic auth credential string",
|
||||
category: .keychain
|
||||
)
|
||||
return
|
||||
}
|
||||
setCredentials(username: creds.username, password: creds.password, for: instance)
|
||||
}
|
||||
|
||||
/// Retrieves the stored credential for an instance (protocol conformance).
|
||||
/// Returns a JSON-encoded string of the username/password.
|
||||
/// - Parameter instance: The instance to retrieve the credential for
|
||||
/// - Returns: JSON string of the credential, or nil if not logged in
|
||||
func credential(for instance: Instance) -> String? {
|
||||
guard let creds = credentials(for: instance),
|
||||
let data = try? JSONEncoder().encode(creds),
|
||||
let jsonString = String(data: data, encoding: .utf8) else {
|
||||
return nil
|
||||
}
|
||||
return jsonString
|
||||
}
|
||||
|
||||
/// Deletes the stored credential for an instance (protocol conformance).
|
||||
/// - Parameter instance: The instance to log out from
|
||||
func deleteCredential(for instance: Instance) {
|
||||
deleteCredentials(for: instance)
|
||||
}
|
||||
|
||||
/// Checks if an instance has a stored credential (protocol conformance).
|
||||
/// - Parameter instance: The instance to check
|
||||
/// - Returns: true if logged in, false otherwise
|
||||
func isLoggedIn(for instance: Instance) -> Bool {
|
||||
hasCredentials(for: instance)
|
||||
}
|
||||
|
||||
// MARK: - Basic Auth Header Generation
|
||||
|
||||
/// Generates the HTTP Basic Auth header value for an instance.
|
||||
/// - Parameter instance: The instance
|
||||
/// - Returns: The Authorization header value (e.g., "Basic dXNlcjpwYXNz") or nil if no credentials
|
||||
func basicAuthHeader(for instance: Instance) -> String? {
|
||||
guard let creds = credentials(for: instance) else { return nil }
|
||||
let credentials = "\(creds.username):\(creds.password)"
|
||||
guard let data = credentials.data(using: .utf8) else { return nil }
|
||||
return "Basic \(data.base64EncodedString())"
|
||||
}
|
||||
|
||||
// MARK: - Legacy Migration
|
||||
|
||||
/// One-time migration of credentials from the legacy Yattee-Server-only Keychain service
|
||||
/// (`com.yattee.yatteeserver`) to the generic basic-auth service (`com.yattee.basicauth`).
|
||||
/// Items are copied (preserving sync attribute) and then deleted from the legacy service.
|
||||
private func migrateLegacyKeychainItems() {
|
||||
let query: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: legacyKeychainServiceName,
|
||||
kSecAttrSynchronizable as String: kSecAttrSynchronizableAny,
|
||||
kSecReturnAttributes as String: true,
|
||||
kSecReturnData as String: true,
|
||||
kSecMatchLimit as String: kSecMatchLimitAll
|
||||
]
|
||||
|
||||
var result: AnyObject?
|
||||
let status = SecItemCopyMatching(query as CFDictionary, &result)
|
||||
|
||||
guard status == errSecSuccess, let items = result as? [[String: Any]], !items.isEmpty else {
|
||||
return
|
||||
}
|
||||
|
||||
var migrated = 0
|
||||
for item in items {
|
||||
guard let account = item[kSecAttrAccount as String] as? String,
|
||||
let data = item[kSecValueData as String] as? Data else {
|
||||
continue
|
||||
}
|
||||
let synchronizable = (item[kSecAttrSynchronizable as String] as? Bool) ?? false
|
||||
|
||||
// Skip add if a new-style item already exists for this account.
|
||||
let existsQuery: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: keychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: kSecAttrSynchronizableAny,
|
||||
kSecMatchLimit as String: kSecMatchLimitOne
|
||||
]
|
||||
if SecItemCopyMatching(existsQuery as CFDictionary, nil) != errSecSuccess {
|
||||
let addQuery: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: keychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: synchronizable,
|
||||
kSecValueData as String: data
|
||||
]
|
||||
let addStatus = SecItemAdd(addQuery as CFDictionary, nil)
|
||||
if addStatus != errSecSuccess {
|
||||
LoggingService.shared.error(
|
||||
"Failed to migrate legacy basic auth credential",
|
||||
category: .keychain,
|
||||
details: "account=\(account), status=\(addStatus)"
|
||||
)
|
||||
continue
|
||||
}
|
||||
migrated += 1
|
||||
}
|
||||
|
||||
// Delete the legacy item for this account
|
||||
let deleteQuery: [String: Any] = [
|
||||
kSecClass as String: kSecClassGenericPassword,
|
||||
kSecAttrService as String: legacyKeychainServiceName,
|
||||
kSecAttrAccount as String: account,
|
||||
kSecAttrSynchronizable as String: kSecAttrSynchronizableAny
|
||||
]
|
||||
SecItemDelete(deleteQuery as CFDictionary)
|
||||
}
|
||||
|
||||
if migrated > 0 {
|
||||
LoggingService.shared.info(
|
||||
"Migrated legacy basic auth credentials to generic Keychain service",
|
||||
category: .keychain,
|
||||
details: "count=\(migrated)"
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user