Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 要求​
  • 设置说明​
  • 构建 SDK​
  • 链接 SDK 到客户端​
  • 网页客户端​
  • 移动端​
  1. 入门
  2. SDK

内部 SDK

上一页SDK下一页Secrets Manager

最后更新于1个月前

对应的

有关更深入的文档,请查阅 和内部 SDK 项目的 。

要求

  • 最新稳定版本 -(建议通过 安装)

  • NodeJS 和 NPM。

更多信息请参阅页面。

设置说明

  1. 克隆存储库:

    git clone https://github.com/bitwarden/sdk-internal.git
    cd sdk
  2. 安装依赖:

    npm ci

构建 SDK

SDK 为不同的平台构建,每个平台都有自己的构建说明。有关如何为特定平台构建的更多信息,请参阅不同 crate 的 readme:

  • Web :

  • iOS:

  • Android :

请注意,每个平台都有自己的依赖项,它们需要在构建之前安装。如果遇到任何问题,请务必再次检查 readme。

在修改 SDK 之后,测试客户端应用程序中的更改可能是有益的。为此,您需要更新客户端应用程序中的 SDK 引用。

这些说明假设您有一个类似以下目录结构:

sdk/
clients/
ios/
android/
npm link ../sdk-internal/crates/bitwarden-wasm-internal/npm

运行 npm ci 或 npm install 将使用已发布的版本替换链接的包。

Android

  1. 在本地 Maven 仓库中构建和发布 SDK:

    ../sdk-internal/crates/bitwarden-uniffi/kotlin/publish-local.sh
  2. 在 user.properties 文件中设置用户属性 localSdk=true。

使用设置为 true 的 LOCAL_SDK 环境变量运行 bootstrap 脚本,以使用本地 SDK 构建:

LOCAL_SDK=true ./Scripts/bootstrap.sh

链接 SDK 到客户端

网页客户端

网页客户端使用 NPM 将 SDK 作为依赖项安装。NPM 提供了专门的 命令,用于将软件包临时替换为本地版本。

移动端

iOS

官方页面地址
SDK 架构
README
​
Rust
rustup
工具和库
​
​
crates/bitwarden-wasm-internal
crates/bitwarden-uniffi/swift
crates/bitwarden-uniffi/kotlin
​
​
link
​
​