详解 Keychain 和 App 之间数据共享

Keychain Services

Keychain 介绍

Keychain Services 是 macOS 和 iOS 都提供一种安全地存储敏感信息的工具,比如:”网络密码:用于保存访问服务器或者网站,通用密码:用来保存应用程序或者数据库密码“。与此同时,用于认证的证书、密钥和身份信息,也可以存储在 Keychain 中。Keychain Services 的安全机制保证了存储这些敏感信息不会被窃取。简单说来,Keychain 就是一个安全容器。另附 Keychain Services - Apple Developer Documentation

PS: 在 iOS 中 Keychian 依赖用于签名的 provisioning profile 描述文件,确保发布不同版本的时候,使用同一个 provisioning profile 文件。

Keychain Access FTP Server Flow

Keychain 的结构

Keychain 可以包含任意数量的 Keychain Item。每一个 Keychain Item 包含数据和一组属性。对于一个需要保护的 Keychain Item,比如密码或者私钥(用于加密或者解密的 String 字节)数据是加密的,会被 Keychain 保护起来的;对于无需保护的 Keychain Item,例如: ”证书,数据未被加密“。

跟 Keychain Item 有关系的取决于 Item 的类型;应用程序中最常用的是网络密码(Internet passwrods)和普通的密码。正如你所想的,网络密码像安全域(security domain)、协议和路径等一些属性。在 macOS 中,当 Keychain 被锁的时候,加密的 Item 没办法访问,如果你想要该问被锁的 Item,就会弹出一个对话框,需要你输入对应 Keychain 的密码。当然,未有密码的 Keychain 你可以随时访问。但在 iOS 中,你只可以访问你自已的 Keychain Items。

Keychain 的特点

  • 数据并不存放在 App 的 Sanbox 中,即使删除了 App,资料依然保存在 Keychain 中。如果重新安装了 App,还可以从 Keychain 获取数据。

  • Keychain 的数据可以用过 Group 方式,让数据可以在 App 间共享。不过得要相同 TeamID

  • Keychain 的数据是经过加密的。

Keychain 的使用

大多数应用需要用到 Keychain, 都用来添加一个密码,修改一个已存在 Keychain Item 或者取回密码。

Keychain 提供了以下的操作:

  • SecItemAdd 添加一个 Item
  • SecItemUpdate 更新已存在的 Item
  • SecItemCopyMatching 搜索一个已存在的 Item
  • SecItemDelete 删除一个 Item

推荐 Swift 开源库 DYFSwiftKeychain,另外,附上 (Objective-C) 版 DYFKeychain

写入数据

Putting data into a keychain
  • 写入字符串
let keychain = DYFSwiftKeychain()
keychain.set("User Account Passcode", forKey: "kUserAccPasscode")
  • 写入字节序列
let keychain = DYFSwiftKeychain()
keychain.set(data, forKey: "kCommSecureCode")
  • 写入布尔值
let keychain = DYFSwiftKeychain()
keychain.set(true, forKey: "kFirstInstalledAndLaunched")

读取数据

  • 读取字符串
let keychain = DYFSwiftKeychain()
let passcode = keychain.get("kUserAccPasscode")
  • 读取字节序列
let keychain = DYFSwiftKeychain()
let data = keychain.getData("kCommSecureCode")
  • 读取布尔值
let keychain = DYFSwiftKeychain()
keychain.getBool("kFirstInstalledAndLaunched")

删除数据

let keychain = DYFSwiftKeychain()
let _ = keychain.delete("kFirstInstalledAndLaunched") // Remove single key.
let _ = keychain.clear() // Delete everything from app's Keychain. Does not work on macOS.

高级选项

1. 钥匙串Item访问选项

let keychain = DYFSwiftKeychain()
keychain.set("xxx", forKey:"Key1", withAccess: .accessibleWhenUnlocked)

查看所有可用访问选项的列表。

2. 与其他设备同步钥匙串Item

请注意,您不需要在应用程序的目标中启用 iCloud 或 Keychain 共享功能,使此功能工作。

// The first device
let keychain = DYFSwiftKeychain()
keychain.synchronizable = true
keychain.set("See you tomorrow!", forKey: "key12")

// The second device
let keychain = DYFSwiftKeychain()
keychain.synchronizable = true
let s = keychain.get("key12") // Returns "See you tomorrow!"

我们无法在 macOS 上进行钥匙串同步工作。

3. 与其他应用程序共享钥匙串Item

使用accessGroup属性访问共享钥匙串Item。在下面的示例中,我们指定一个访问组9ZU3R2F3D4.com.omg.myapp.KeychainGroup,它将用于设置、获取和删除key1项。

let keychain = DYFSwiftKeychain()
keychain.accessGroup = "9ZU3R2F3D4.com.omg.myapp.KeychainGroup" // Use your own access group.

keychain.set("hello world", forKey: "key1")
keychain.get("key1")
keychain.delete("key1")
keychain.clear()

:watchOS 2.0与其配对设备之间无法共享钥匙串item:https://forums.developer.apple.com/thread/5938

3. 数据引用返回

使用asReference:true参数将数据作为引用返回,这是 NEVPNProtocol 协议所需的。

let keychain = DYFSwiftKeychain()
keychain.set(data, forKey: "key1")
keychain.getData("key1", asReference: true)

共享 Keychain 数据

关于共享 Keychain 数据,你可以通过 Group 的方式让资料可以在 App 间共享,Google 系列的 App (Gmail、Google+、日历……) 就是通过这样的方式来记录使用者登入信息,只要使用者在其中一个 App 中完成登入了,其他的 App 也可以读取到相同的数据进行登入。

进入 Capabilities,打开 Keychain Sharing 功能

Keychain Sharing

开启 Keychain Sharing 后,会自动新增一个 Keychain Group,使用的是 Bundle Identifier,同时也会自动新增一个 entitlements 文件,里面也会有一个 Access Group,名为 $(AppIdentifierPrefix)+Your Bundle Identifier

Keychain Group Entitlements

AppIdentifierPrefix 是开发者的账号需要登录才会有,也就是开发者证书后小括号内的英文数字组合。使用 $(AppIdentifierPrefix) 只能被同一个开发者账号的 App 来存取,以防被有心人盗取。

Xcode Signing

若其他的 App 也要存取当前 Keychain 的数据,就必需在 Keychain Sharing 开启后,新增相同的 Keychain Group (Access Group 会根据 Keychain Group 自动新增)。

PS: 需要 Info.plist 新增一个键值对 Key: AppIdentifierPrefix,Value: $(AppIdentifierPrefix),方便取得 Identifier Prefix

总结:写的有不好的地方,希望大家指出,我会更正,大家有什么看不明白的,可以在评论里面提问,我会尽力解答。另附 Apple 官方 GenericKeychain

最后,想了解更多详情,请查看我的 Demo,记得给个 Star,😝😝

Demo ( Objective-C ):戳这里
Demo ( Swift ):戳这里


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351