钥匙串模块

钥匙串模块 - keychain

限制

• 此模块仅支持 iOS 15 及以上版本。
• 此模块中的所有函数均不能在屏幕锁定状态下使用。

导出钥匙串 (keychain.export)

声明

钥匙串内容 = keychain.export([超时秒])

参数及返回值

• 超时秒，数值型，可选，默认为 3.0
• 钥匙串内容，关联表，大致包含如下内容：
  • genp 顺序表，一般密码
  • inet 顺序表，网络密码
  • cert 顺序表，证书（公钥）
  • keys 顺序表，密钥（私钥）

说明

导出钥匙串中的所有可备份条目。导出的钥匙串内容可被安全地保存到 属性表（Property List） 中，以便后续导入。

导入钥匙串 (keychain.import)

声明

操作成败, 错误信息 = keychain.import(钥匙串内容[, 导入前清除, 超时秒])

参数及返回值

• 钥匙串内容，关联表
• 导入前清除
  • 布尔型，可选，执行导入操作前是否清空钥匙串中原有的非系统预留条目。默认为 false
• 超时秒，数值型，可选，默认为 3.0
• 操作成败，布尔型
• 错误信息，文本型

说明

导入条目到钥匙串中。

清空钥匙串 (keychain.clear)

声明

操作成败, 错误信息 = keychain.clear([超时秒])

参数及返回值

• 超时秒，数值型，可选，默认为 3.0
• 操作成败，布尔型
• 错误信息，文本型

说明

清空钥匙串中的所有非系统预留条目。

删除钥匙串条目 (keychain.remove)

声明

操作成败, 错误信息 = keychain.remove(标识符, [超时秒])

参数及返回值

• 标识符
  • 文本型，App 标识符 或钥匙串访问组标识符（Keychain Access Group，KAG）
  • 文本型顺序表，一组 App 标识符 或 KAG
• 超时秒，数值型，可选，默认为 3.0
• 操作成败，布尔型
• 错误信息，文本型

说明

删除钥匙串中，指定 App 可访问的条目。

钥匙串条目计数 (keychain.count)

声明

条目计数 = keychain.count(钥匙串内容)

参数及返回值

• 钥匙串内容，关联表
• 条目计数，数值型，上述关联表中各类型条目的总数

说明

计算 钥匙串内容 中各类型条目的总数。

搜索钥匙串条目 (keychain.filter)

声明

匹配条目, 错误信息 = keychain.filter(标识符[, 超时秒])

参数及返回值

• 标识符
  • 文本型，App 标识符 或钥匙串访问组标识符（Keychain Access Group，KAG）
  • 文本型顺序表，一组 App 标识符 或 KAG
• 超时秒，数值型，可选，默认为 3.0
• 匹配条目，关联表，匹配的 钥匙串内容
• 错误信息，文本型

说明

搜索并导出钥匙串中，指定 App 可访问的条目。