跨平台使用UICKeyChainStore：iOS、watchOS、tvOS和macOS的完整支持

跨平台使用UICKeyChainStore：iOS、watchOS、tvOS和macOS的完整支持

【免费下载链接】UICKeyChainStoreUICKeyChainStore is a simple wrapper for Keychain on iOS, watchOS, tvOS and macOS. Makes using Keychain APIs as easy as NSUserDefaults.项目地址: https://gitcode.com/gh_mirrors/ui/UICKeyChainStore

UICKeyChainStore是一个简单的Keychain包装器，适用于iOS、watchOS、tvOS和macOS平台，让开发者使用Keychain API就像使用NSUserDefaults一样简单。它提供了统一的接口来管理跨苹果生态系统的安全凭证存储，无需为不同平台编写特定代码。

为什么选择UICKeyChainStore？

Keychain是苹果生态系统中安全存储敏感信息的核心组件，但原生API使用复杂且容易出错。UICKeyChainStore通过以下特性解决了这些问题：

• 跨平台兼容性：一套代码同时支持iOS、watchOS、tvOS和macOS
• 简单API：类似NSUserDefaults的键值对操作方式
• 安全特性：支持Touch ID/Face ID认证、访问控制和iCloud同步
• 完整功能：支持通用密码、互联网密码、共享Web凭据等多种Keychain项目类型

快速开始：安装与基础配置

安装方式

UICKeyChainStore提供多种安装选项，满足不同项目需求：

Swift Package Manager

在Xcode中选择File > Swift Packages > Add Package Dependency...，输入仓库地址：

https://gitcode.com/gh_mirrors/ui/UICKeyChainStore

CocoaPods

在Podfile中添加：

pod 'UICKeyChainStore'

手动安装

1. 将Lib/UICKeyChainStore/UICKeyChainStore.h和Lib/UICKeyChainStore/UICKeyChainStore.m文件添加到项目
2. 确保项目已链接Security.framework

基础使用示例

存储和读取凭证就像使用字典一样简单：

// 创建Keychain实例 UICKeyChainStore *keychain = [UICKeyChainStore keyChainStoreWithService:@"com.example.app"]; // 存储凭证 keychain[@"user_token"] = @"your_secure_token_here"; // 读取凭证 NSString *token = keychain[@"user_token"]; // 删除凭证 keychain[@"user_token"] = nil;

平台特定功能与最佳实践

iOS平台高级特性

iOS平台提供了最丰富的功能集，包括：

• 生物认证集成：使用Touch ID或Face ID保护敏感数据
• 共享Web凭据：与Safari共享登录信息
• 密码自动生成：创建符合安全标准的随机密码

示例：使用Touch ID保护敏感数据

UICKeyChainStore *keychain = [UICKeyChainStore keyChainStoreWithService:@"com.example.banking"]; // 在后台线程执行需要认证的操作 dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0), ^{ // 设置访问控制策略 [keychain setAccessibility:UICKeyChainStoreAccessibilityWhenPasscodeSetThisDeviceOnly authenticationPolicy:UICKeyChainStoreAuthenticationPolicyUserPresence]; keychain.authenticationPrompt = @"验证身份以访问银行信息"; // 存储敏感数据 keychain[@"account_balance"] = @"$1,234.56"; });

macOS平台适配

macOS上的Keychain集成提供了与系统钥匙串的深度整合：

// 创建适用于macOS的Keychain实例 UICKeyChainStore *keychain = [UICKeyChainStore keyChainStoreWithService:@"com.example.macapp" accessGroup:@"TEAMID.com.example.shared"]; // 存储互联网密码 [keychain setString:@"P@ssw0rd!" forKey:@"user@example.com" label:@"Example Service" comment:@"Main account password"];

watchOS与tvOS支持

对于watchOS和tvOS应用，UICKeyChainStore提供了简化的API，专注于核心功能：

// watchOS上存储健身数据访问令牌 UICKeyChainStore *keychain = [UICKeyChainStore keyChainStoreWithService:@"com.example.watchfit"]; keychain.synchronizable = YES; // 启用iCloud同步 keychain[@"fitness_token"] = @"sync_token_123";

高级功能详解

iCloud同步配置

通过简单设置即可实现Keychain项目的跨设备同步：

UICKeyChainStore *keychain = [UICKeyChainStore keyChainStoreWithService:@"com.example.sync"]; keychain.synchronizable = YES; // 启用iCloud同步 // 存储将在所有设备上可用的数据 keychain[@"user_preferences"] = @"sync_enabled=true;notifications=on";

访问控制与安全级别

UICKeyChainStore提供细粒度的访问控制选项：

// 设置不同的安全级别 typedef NS_ENUM(NSInteger, UICKeyChainStoreAccessibility) { UICKeyChainStoreAccessibilityWhenUnlocked, // 设备解锁时可访问 UICKeyChainStoreAccessibilityAfterFirstUnlock, // 首次解锁后可访问 UICKeyChainStoreAccessibilityAlways, // 始终可访问 UICKeyChainStoreAccessibilityWhenPasscodeSetThisDeviceOnly // 仅在设置密码的设备上可访问 }; // 示例：设置高安全性存储 keychain.accessibility = UICKeyChainStoreAccessibilityWhenUnlockedThisDeviceOnly;

错误处理最佳实践

UICKeyChainStore提供全面的错误处理机制：

NSError *error; NSString *token = [keychain stringForKey:@"user_token" error:&error]; if (error) { NSLog(@"Keychain操作失败: %@", error.localizedDescription); // 根据错误类型执行恢复操作 if (error.code == UICKeyChainStoreErrorInvalidArguments) { // 处理无效参数错误 } }

实际应用场景示例

1. 应用内用户认证

使用UICKeyChainStore安全存储用户认证令牌：

// 登录成功后存储令牌 [UICKeyChainStore setString:authToken forKey:@"auth_token" service:@"com.example.auth"]; // 应用启动时检查令牌 NSString *savedToken = [UICKeyChainStore stringForKey:@"auth_token" service:@"com.example.auth"]; if (savedToken) { // 使用令牌自动登录 [self performAutoLoginWithToken:savedToken]; } else { // 显示登录界面 [self showLoginScreen]; }

2. 共享Web凭据集成

与Safari共享登录信息，提升用户体验：

// 请求共享凭据 [UICKeyChainStore requestSharedWebCredentialForDomain:@"example.com" account:nil completion:^(NSArray *credentials, NSError *error) { if (credentials.count > 0) { NSDictionary *credential = credentials[0]; NSString *username = credential[@"acct"]; NSString *password = credential[@"pswd"]; // 使用获取的凭据自动填充登录表单 [self loginWithUsername:username password:password]; } }];

项目结构与资源

UICKeyChainStore的核心代码位于Lib/UICKeyChainStore/目录，包含：

• UICKeyChainStore.h：头文件，定义公共API
• UICKeyChainStore.m：实现文件，包含所有核心功能

示例项目位于Examples/Example-iOS/目录，展示了完整的集成方式。测试代码位于Lib/UICKeyChainStoreTests/，包含单元测试和兼容性测试。

常见问题与解决方案

Q: 如何在不同应用间共享Keychain数据？

A: 使用访问组(access group)功能，需要在Xcode项目设置中配置相同的App Group，并在初始化时指定：

UICKeyChainStore *keychain = [UICKeyChainStore keyChainStoreWithService:@"com.example.shared" accessGroup:@"TEAMID.com.example.shared"];

Q: 如何处理Keychain操作的并发问题？

A: 所有Keychain操作应在后台线程执行，避免阻塞UI：

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{ // 执行Keychain操作 NSString *token = keychain[@"user_token"]; // 回到主线程更新UI dispatch_async(dispatch_get_main_queue(), ^{ self.tokenLabel.text = token; }); });

Q: 如何确保存储的数据在应用卸载后不被保留？

A: 使用UICKeyChainStoreAccessibilityWhenUnlockedThisDeviceOnly访问级别，并避免启用iCloud同步。

总结

UICKeyChainStore为跨平台苹果开发提供了简单而强大的Keychain访问解决方案。通过统一的API、丰富的安全特性和完整的平台支持，它极大简化了敏感数据管理的复杂性。无论是开发iOS应用、macOS工具，还是watchOS扩展，UICKeyChainStore都能提供一致且安全的凭据存储体验。

要开始使用UICKeyChainStore，只需克隆仓库并按照安装指南集成到项目中：

git clone https://gitcode.com/gh_mirrors/ui/UICKeyChainStore

通过UICKeyChainStore，开发者可以专注于构建优秀的用户体验，而不必担心安全存储的底层实现细节。

【免费下载链接】UICKeyChainStoreUICKeyChainStore is a simple wrapper for Keychain on iOS, watchOS, tvOS and macOS. Makes using Keychain APIs as easy as NSUserDefaults.项目地址: https://gitcode.com/gh_mirrors/ui/UICKeyChainStore