iOS Keychain使用说明

作者: Mr_Lucifer | 来源:发表于2017-06-04 22:08 被阅读2287次

前言

Keychain 在 Mac 上大家都比较熟悉, 主要进行一些敏感信息存储使用如用户名，密码，网络密码，认证令牌, Wi-Fi网络密码，VPN凭证等. iOS 中 Keychain, 也有相同的功能实现 , 保存的信息存储在设备中, 独立于每个App沙盒之外. 作者这篇就简单整理下iOS 中的 Keychain.

特点 :
1 . 更安全. 对比 NSUserDefault 存储一些数据, 会更加安全.
2 . 即便 App 被卸载, 存储的信息依旧存在, 再次安装App, 存储是信息依旧可以使用.
3 . 相同的 Team ID 开发, 可实现多个App 共享数据

一 Keychain 结构说明

Keychain 结构是由 key-value 组成.
多个 key-value 标签的作用 : 表明该钥匙的唯一性.
当我们对 Keychain 进行操作时, 就可以定义一个包含该 key-value 字典, 调用API, 对 Keychain 进行操作

结构说明
图片引用 : http://www.jianshu.com/p/fa87b6879b99

二 Keychain 增 / 删 / 改 / 查

对Keychain 的结构有了简单印象, 那么就可以对其进行操作.

主要API

/** 添加 */
OSStatus SecItemAdd(CFDictionaryRef attributes, CFTypeRef * __nullable CF_RETURNS_RETAINED result);
/** 查询 */
OSStatus SecItemCopyMatching(CFDictionaryRef query, CFTypeRef * __nullable CF_RETURNS_RETAINED result);
/** 更新 */
OSStatus SecItemUpdate(CFDictionaryRef query, CFDictionaryRef attributesToUpdate);
/** 删除 */
OSStatus SecItemDelete(CFDictionaryRef query);

/** 增/改 */
- (IBAction)insertAndUpdate:(id)sender {
    
    /**
     说明：当添加的时候我们一般需要判断一下当前钥匙串里面是否已经存在我们要添加的钥匙。如果已经存在我们就更新好了，不存在再添加，所以这两个操作一般写成一个函数搞定吧。
     
     过程关键：1.检查是否已经存在 构建的查询用的操作字典：kSecAttrService，kSecAttrAccount，kSecClass（标明存储的数据是什么类型，值为kSecClassGenericPassword 就代表一般的密码）
     
     　　　2.添加用的操作字典：　kSecAttrService，kSecAttrAccount，kSecClass，kSecValueData
     
     　　　3.更新用的操作字典1（用于定位需要更改的钥匙）：kSecAttrService，kSecAttrAccount，kSecClass
     
     　　　　　　　　操作字典2（新信息）kSecAttrService，kSecAttrAccount，kSecClass ,kSecValueData
     */
    
    NSLog(@"插入 : %d",  [self addItemWithService:@"com.tencent" account:@"李雷" password:@"911"]);
}

-(BOOL)addItemWithService:(NSString *)service account:(NSString *)account password:(NSString *)password{
    
    //先查查是否已经存在
    //构造一个操作字典用于查询
    
    NSMutableDictionary *queryDic = [NSMutableDictionary dictionary];
    
    [queryDic setObject:service forKey:(__bridge id)kSecAttrService];                         //标签service
    [queryDic setObject:account forKey:(__bridge id)kSecAttrAccount];                         //标签account
    [queryDic setObject:(__bridge id)kSecClassGenericPassword forKey:(__bridge id)kSecClass];//表明存储的是一个密码
    
    OSStatus status = -1;
    CFTypeRef result = NULL;
    
    status = SecItemCopyMatching((__bridge CFDictionaryRef)queryDic, &result);
    
    if (status == errSecItemNotFound) {                                              //没有找到则添加
        
        NSData *passwordData = [password dataUsingEncoding:NSUTF8StringEncoding];    //把password 转换为 NSData
        
        [queryDic setObject:passwordData forKey:(__bridge id)kSecValueData];       //添加密码
        
        status = SecItemAdd((__bridge CFDictionaryRef)queryDic, NULL);             //!!!!!关键的添加API
        
    }else if (status == errSecSuccess){                                              //成功找到，说明钥匙已经存在则进行更新
        
        NSData *passwordData = [password dataUsingEncoding:NSUTF8StringEncoding];    //把password 转换为 NSData
        
        NSMutableDictionary *dict = [[NSMutableDictionary alloc] initWithDictionary:queryDic];
        
        [dict setObject:passwordData forKey:(__bridge id)kSecValueData];             //添加密码
        
        status = SecItemUpdate((__bridge CFDictionaryRef)queryDic, (__bridge CFDictionaryRef)dict);//!!!!关键的更新API
        
    }
    
    return (status == errSecSuccess);
}


/** 查 */
- (IBAction)select:(id)sender {
    
    /**
     过程：
     1.(关键)先配置一个操作字典内容有:
     kSecAttrService(属性),kSecAttrAccount(属性) 这些属性or标签是查找的依据
     kSecReturnData(值为@YES 表明返回类型为data),kSecClass(值为kSecClassGenericPassword 表示重要数据为“一般密码”类型) 这些限制条件是返回结果类型的依据
     
     2.然后用查找的API 得到查找状态和返回数据（密码）
     
     3.最后如果状态成功那么将数据（密码）转换成string 返回
     */
    
    NSLog(@"%@", [self passwordForService:@"com.tencent" account:@"李雷"]);
    
}

//用原生的API 实现查询密码
- (NSString *)passwordForService:(nonnull NSString *)service account:(nonnull NSString *)account{
    
    //生成一个查询用的 可变字典
    NSMutableDictionary *queryDic = [NSMutableDictionary dictionary];
    
    //首先添加获取密码所需的搜索键和类属性：
    [queryDic setObject:(__bridge id)kSecClassGenericPassword forKey:(__bridge id)kSecClass]; //表明为一般密码可能是证书或者其他东西
    [queryDic setObject:(__bridge id)kCFBooleanTrue  forKey:(__bridge id)kSecReturnData];     //返回Data
    
    [queryDic setObject:service forKey:(__bridge id)kSecAttrService];    //输入service
    [queryDic setObject:account forKey:(__bridge id)kSecAttrAccount];  //输入account
    
    //查询
    OSStatus status = -1;
    CFTypeRef result = NULL;
    status = SecItemCopyMatching((__bridge CFDictionaryRef)queryDic,&result);//核心API 查找是否匹配 和返回密码！
    if (status != errSecSuccess) { //判断状态

        return nil;
    }
    //返回数据
//    NSString *password = [[NSString alloc] initWithData:(__bridge_transfer NSData *)result encoding:NSUTF8StringEncoding];//转换成string
    
    //删除kSecReturnData键; 我们不需要它了：
    [queryDic removeObjectForKey:(__bridge id)kSecReturnData];
    //将密码转换为NSString并将其添加到返回字典：
    NSString *password = [[NSString alloc] initWithBytes:[(__bridge_transfer NSData *)result bytes] length:[(__bridge NSData *)result length] encoding:NSUTF8StringEncoding];
    
    [queryDic setObject:password forKey:(__bridge id)kSecValueData];
    
    NSLog(@"查询 : %@", queryDic);
    
    
    return password;
}


/** 删 */
- (IBAction)delete:(id)sender {
    
    NSLog(@"删除 : %d", [self deleteItemWithService:@"com.tencent" account:@"李雷"]);    
}


-(BOOL)deleteItemWithService:(NSString *)service account:(NSString *)account{

    NSMutableDictionary *queryDic = [NSMutableDictionary dictionary];
    
    [queryDic setObject:service forKey:(__bridge id)kSecAttrService];                         //标签service
    [queryDic setObject:account forKey:(__bridge id)kSecAttrAccount];                         //标签account
    [queryDic setObject:(__bridge id)kSecClassGenericPassword forKey:(__bridge id)kSecClass];//表明存储的是一个密码
    
    
    OSStatus status = SecItemDelete((CFDictionaryRef)queryDic);
    
    return (status == errSecSuccess);
}

引用链接 : iOS Keychain，SSKeychain，使用理解原理

三 Keychain 封装

3.1

说明 :
作者查找资料时看到网上多数都是此封装的文章, 对于 该方法出处 作者附上时间最早的链接 : iOS开发——密码存储之keychain的使用

#import "UserInfo.h"

@implementation UserInfo

+ (NSMutableDictionary *)getKeychainQuery:(NSString *)service {
    
    return [NSMutableDictionary dictionaryWithObjectsAndKeys:(id)kSecClassGenericPassword,(id)kSecClass,
                                                             service, (id)kSecAttrService,
                                                             service, (id)kSecAttrAccount,
                                                             (id)kSecAttrAccessibleAfterFirstUnlock,(id)kSecAttrAccessible,
                                                             nil];
    
}

#pragma mark 写入
// 说明: 该封装 添加与更新 为同一方法, 不进行判断, 直接先删除后添加
+ (void)save:(NSString *)service data:(id)data {
    
    //Get search dictionary
    NSMutableDictionary *keychainQuery = [self getKeychainQuery:service];
    //Delete old item before add new item
    SecItemDelete((CFDictionaryRef)keychainQuery);
    //Add new object to search dictionary(Attention:the data format)
    [keychainQuery setObject:[NSKeyedArchiver archivedDataWithRootObject:data] forKey:(id)kSecValueData];
    //Add item to keychain with the search dictionary
    SecItemAdd((CFDictionaryRef)keychainQuery, NULL);
}




#pragma mark 读取
+ (id)load:(NSString *)service {
    
    id ret = nil;
    NSMutableDictionary *keychainQuery = [self getKeychainQuery:service];
    //Configure the search setting
    //Since in our simple case we are expecting only a single attribute to be returned (the password) we can set the attribute kSecReturnData to kCFBooleanTrue
    [keychainQuery setObject:(id)kCFBooleanTrue forKey:(id)kSecReturnData];
    [keychainQuery setObject:(id)kSecMatchLimitOne forKey:(id)kSecMatchLimit];
    CFDataRef keyData = NULL;
    if (SecItemCopyMatching((CFDictionaryRef)keychainQuery, (CFTypeRef *)&keyData) == noErr) {
        @try {
            ret = [NSKeyedUnarchiver unarchiveObjectWithData:(__bridge NSData *)keyData];
        } @catch (NSException *e) {
            NSLog(@"Unarchive of %@ failed: %@", service, e);
        } @finally {
        }
    }
    if (keyData)
        CFRelease(keyData);
    return ret;
}

#pragma mark 删除
+ (void)delete:(NSString *)service {
    
    NSMutableDictionary *keychainQuery = [self getKeychainQuery:service];
    SecItemDelete((CFDictionaryRef)keychainQuery);
}




@end


NSString * const KEY_USERNAME_PASSWORD = @"com.company.app.usernamepassword";
NSString * const KEY_USERNAME = @"com.company.app.username";
NSString * const KEY_PASSWORD = @"com.company.app.password";

// 调用
   NSMutableDictionary *userNamePasswordKVPairs = [NSMutableDictionary dictionary];
    [userNamePasswordKVPairs setObject:@"userName" forKey:KEY_USERNAME];
    [userNamePasswordKVPairs setObject:@"password" forKey:KEY_PASSWORD];
    NSLog(@"%@", userNamePasswordKVPairs); //有KV值
    
    // A、将用户名和密码写入keychain
    [UserInfo save:KEY_USERNAME_PASSWORD data:userNamePasswordKVPairs];
    
    // B、从keychain中读取用户名和密码
    NSMutableDictionary *readUsernamePassword = (NSMutableDictionary *)[UserInfo load:KEY_USERNAME_PASSWORD];
    NSString *userName = [readUsernamePassword objectForKey:KEY_USERNAME];
    NSString *password = [readUsernamePassword objectForKey:KEY_PASSWORD];
    NSLog(@"username = %@", userName);
    NSLog(@"password = %@", password);
    
    // C、将用户名和密码从keychain中删除
    [UserInfo delete:KEY_USERNAME_PASSWORD];

3.2

该封装已提供说明和 demo下载, 作者不赘述, 附上链接

传送门 :iOS中Keychain保存用户名和密码

3.3

苹果官方 demo 说明, 附上链接

传送门 : iOS Keychain Services Tasks

四 Keychain 三方

传送门 : soffes/SAMKeychain

五 Keychain App间共享数据

对于 App间共享数据, 有篇文章已详细介绍了, 作者不再赘述
传送门 :iOS 开发keychain 使用与多个APP之间共享keychain数据的使用

对于该文章说的 开发者ID 为Apple developer中的Membership => Team ID, 或者可以使用 $(AppIdentifierPrefix) 代替, 也可以用代码获取

- (NSString *)bundleSeedID {
    NSDictionary *query = [NSDictionary dictionaryWithObjectsAndKeys:
                           kSecClassGenericPassword, kSecClass,
                           @"bundleSeedID", kSecAttrAccount,
                           @"", kSecAttrService,
                           (id)kCFBooleanTrue, kSecReturnAttributes,
                           nil];
    CFDictionaryRef result = nil;
    OSStatus status = SecItemCopyMatching((CFDictionaryRef)query, (CFTypeRef *)&result);
    if (status == errSecItemNotFound)
        status = SecItemAdd((CFDictionaryRef)query, (CFTypeRef *)&result);
    if (status != errSecSuccess)
        return nil;
    NSString *accessGroup = [(__bridge NSDictionary *)result objectForKey:kSecAttrAccessGroup];
    NSArray *components = [accessGroup componentsSeparatedByString:@"."];
    NSString *bundleSeedID = [[components objectEnumerator] nextObject];
    CFRelease(result);
    return bundleSeedID;
}

六 Keychain 的安全性

Keychain 并不是十分安全，在越狱的设备上，可以通过一些相应的工具很轻松的 dump 所有的 Keychain 数据，比如Keychain-Dumper，通过 ssh 登录设备，下载 keychain_dumper 至 /tmp 目录，然后 chmox +x keychain_dumper
赋予执行权限，直接 ./keychain_dumper > keychain_content.txt
，即可查看到相应的数据

Keychain 数据可以通过 iTunes 备份，iTunes 备份可以让用户选择是否加密备份，不加密的备份可以恢复到任何设备，而加密的备份不能恢复到其它设备。虽然 ThisDeviceOnly 类型的 Item 不会备份，但是 Item 则会备份

iOS 7 之后，Keychain 数据还可以通过 iCloud 同步跨越多个设备。默认情况下不同步，但是可以通过 [query setObject:(id)kCFBooleanTrue forKey:(id)kSecAttrSynchronizable];
来设置同步，即使给 ThisDeviceOnly 设置同步，也不会生效

总而言之，考虑到 iCloud 服务器端、设备越狱等情况、甚至某些 Wi-FI 漏洞攻击，都有可能会泄露 Keychain 数据，最好是加密存储

链接: iOS 安全储存数据（三）：Keychain Services

以上 !

网友评论

f99be83ff259:我想问一下坐着用哪个GSKeyChain这个封装的吗，我现在在用，然后项目被拒了 2.5.2 不知道和这个封装有没有关系
f99be83ff259:@Mr_Lucifer 不是很确定，你项目中有用到吗
Mr_Lucifer:你确定是由于 keychain 而被拒的? GSKeyChain没有看过. 所以不知道内部是怎么的写. 如果只是用增删改查的功能, 自己写一个试试看会不会被拒.
醉醉飘然:作者总结得很好。但是对于原先没有接触过keychain的人而言，看的比较吃力。建议先看一下下面这篇文章：http://blog.51cto.com/13619586/2074256；然后你就会发现作者写的真的很棒
Thebloodelves:你好，保存的信息存储在设备中是什么意思呢
Mr_Lucifer:想表达的是, 该存储信息脱离沙盒. 由设备系统接管, 卸载App, 不会删除存储的信息. 可能描述不准确, 大概是这个意思.

iOS Keychain使用说明

前言

一 Keychain 结构说明

二 Keychain 增 / 删 / 改 / 查

三 Keychain 封装

3.1

3.2

3.3

四 Keychain 三方

五 Keychain App间共享数据

六 Keychain 的安全性

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Swift

实用工具

Object-C

iOS开发技术集锦

iOS第三方资料收集

ios实用开发技巧

加密

IOS