keytar - 系统钥匙串管理Node模块技术文档

keytar - 系统钥匙串管理Node模块技术文档

【免费下载链接】node-keytar Native Password Node Module 【免费下载链接】node-keytar 项目地址: https://gitcode.com/gh_mirrors/no/node-keytar

安装指南

通过npm安装

npm install keytar

在Linux系统上安装依赖

在Linux系统上,keytar模块依赖于libsecret库。根据你的Linux发行版,运行以下命令安装libsecret

  • Debian/Ubuntu: sudo apt-get install libsecret-1-dev
  • Red Hat-based: sudo yum install libsecret-devel
  • Arch Linux: sudo pacman -S libsecret

项目使用说明

keytar是一个用于管理系统钥匙串的Node模块。它可以在macOS、Linux和Windows系统上管理密码。在macOS上,密码由Keychain管理;在Linux上,密码由Secret Service API/libsecret管理;在Windows上,密码由Credential Vault管理。

基本使用

首先,你需要在项目中引入keytar模块:

const keytar = require('keytar');

keytar模块中的每个函数都是异步的,并返回一个Promise。如果操作成功,Promise将被解析为函数的返回值;如果操作失败,Promise将被拒绝并返回错误信息。

项目API使用文档

getPassword(service, account)

获取指定serviceaccount的存储密码。

  • service:字符串,服务名称。
  • account:字符串,账户名称。

返回值:返回一个Promise,解析为存储的密码字符串,如果未找到对应的条目,则返回null

setPassword(service, account, password)

password保存到指定serviceaccount的钥匙串中。如果条目已存在,则更新密码;如果不存在,则创建新条目。

  • service:字符串,服务名称。
  • account:字符串,账户名称。
  • password:字符串,密码。

返回值:返回一个Promise,解析为undefined

deletePassword(service, account)

删除指定serviceaccount的存储密码。

  • service:字符串,服务名称。
  • account:字符串,账户名称。

返回值:返回一个Promise,解析为布尔值。如果密码被删除,返回true;如果未找到对应的条目,返回false

findCredentials(service)

查找指定service的所有账户和密码。

  • service:字符串,服务名称。

返回值:返回一个Promise,解析为一个数组,数组中的每个元素是一个对象,包含accountpassword属性。

findPassword(service)

查找指定service的密码。适用于不需要指定account的场景。

  • service:字符串,服务名称。

返回值:返回一个Promise,解析为密码字符串,如果未找到对应的条目,则返回null

项目安装方式

克隆仓库并构建

  1. 克隆keytar仓库:

    git clone https://github.com/atom/node-keytar.git
    
  2. 进入项目目录并安装依赖:

    cd node-keytar
    npm install
    
  3. 运行测试:

    npm test
    

支持的版本

keytar模块为Node和Electron的受支持版本提供了预构建的二进制文件。请参考NodeElectron的发布文档,了解当前支持的版本。

【免费下载链接】node-keytar Native Password Node Module 【免费下载链接】node-keytar 项目地址: https://gitcode.com/gh_mirrors/no/node-keytar

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值