更新记录

0.5.0（2025-02-21）

首次发布

平台兼容性

bsx-keystore 一款UTS API插件，实现APP端安全的存储KEY-VAL

开发文档

UTS API插件

安全的存储key-value，Android端使用了tink加密库和keystore的安全存储方案。

App客户端的key安全存储与访问至关重要。安全实现，涉及较多方面。本API仅完成了KEY-VALUE在客户端存储时的一种通用处理方案， 即使用系统的keystore加密存储。

参考Android keystore

安全存储的VAL常见于一些对于安全性要求较高，但又需要存储在APP客户端的场景。例如，三方SDK的ACCESS TOKEN、一些涉及重要资产的 VAL值等。有存储安全，并不代表就万无一失；没有绝对的安全！

你还可以结合其他手段保护本地重要数字资产，包括不限于：

1. 混淆加密
2. 动态KEY
3. APP加固
4. 运行时安检（阻止调试、签名验证等）

使用本API前，你须知：

1. 密钥启用了应用包验证和设备属性签名验证！API最低要求Android api 26 (Android 8)
2. 代码纯正，仅为JAVA相关实现的Kotlin 封装，并实现UTS的接口
3. 未知异常造成损失，请自行承担

如何使用

步骤一 初始化

// 导入bsx keystore
import { bsxKSinit } from '@/uni_modules/bsx-keystore'

onLaunch: function () {
    console.log('App Launch')
    // 初始化bsxKS
    bsxKSinit()
},

步骤二 存储和访问KEY-VAL

// 导入bsx keystore
import { bsxKSaction,bsxKSget,bsxKSclearKey } from '@/uni_modules/bsx-keystore'

// 设置key-val
bsxKSset('your key str', 'val str')

// 获取key ret type: string
let value:string = bsxKSget('your key str')

API验证

API在Android12 正常使用！