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 提供支持
在本页
  • 要求
  • 构建说明
  • 环境设置
  • Using managedEnvironment
  • 手动设置自定义环境 URL
  • 测试和调试
  • Chrome 和基于 Chromium 的浏览器
  • Firefox
  • Safari
  1. 入门
  2. 网页客户端

浏览器端

上一页WebAuthn下一页生物识别解锁

最后更新于2个月前

对应的

要求

在开始之前,您必须先完成。

构建说明

1、构建并运行扩展:

cd apps/browser
npm run build:watch

2、使用下一节中的说明在浏览器中加载已解压的浏览器扩展。

环境设置

默认情况下,浏览器扩展将运行指向生产服务器的端点。要覆盖此设置以进行本地开发和测试,有多种选项。

Using managedEnvironment

浏览器扩展具有「代管式环境」的概念,它是存储在 devFlags 对象内的 中的 JSON 配置。

managedEnvironment 设置允许贡献者覆盖服务器的任何或所有 URL。 managedEnvironment 在 中被读取,并为任何提供的 URL 覆盖默认的(生产)设置。

有两种使用 managedEnvironment 的方法,具体取决于您是否同时运行 Web Vault。

运行 Web Vault 的 managedEnvironment

如果您还同时运行 Web Vault,则只需在 managedEnvironment 中设置 base URL:

{
   "devFlags":{
      "managedEnvironment":{
         "base":"https://localhost:8080"
      }
      ...
   }
   ...
}
  "dev": {
    "proxyApi": "http://localhost:4000",
    "proxyIdentity": "http://localhost:33656",
    "proxyEvents": "http://localhost:46273",
    "proxyNotifications": "http://localhost:61840"
  },

这意味着当 Web Vault 运行时,浏览器 managedEnvironment 无需逐个覆盖每一个 URL。浏览器会将每个 URL 格式化为 {base}/{endpoint},例如 http://localhost:8080/api,但 webpack DevServer 会将该 URL 代理到正确的端口,例如 http://localhost:4000。

未运行 Web Vault 的 managedEnvironment

如果您在没有运行 Web Vault 的情况下测试浏览器扩展,您将无法利用 webpack DevServer 来代理 URL。这意味着您的 managedEnvironment 设置必须显式覆盖您要在本地进行通信的所有 URL。

{
    "devFlags": {
        "managedEnvironment": {
            "webVault": "http://localhost:8080",
            "api": "http://localhost:4000",
            "identity": "http://localhost:33656",
            "notifications": "http://localhost:61840",
            "icons": "http://localhost:50024"
        }
        ...
    }
    ...
}

手动设置自定义环境 URL

配置完成后,您的本地自定义环境看上去应该像这样:

测试和调试

Chrome 和基于 Chromium 的浏览器

要加载浏览器扩展构建:

  1. 在地址栏中导航到 chrome://extensions,这将打开扩展页面

  2. 开启「开发者模式」(切换开关)

  3. 点击「加载已解压的扩展程序」按钮

  4. 打开您本地存储库的 build 文件夹然后确认您的选择

现在您已拥有了已安装的浏览器扩展程序的本地构建。

您可以通过点击 chrome://extensions 中 Bitwarden 标题下方的「background.html」来调试浏览器扩展的背景页面。您可以在弹出窗口打开时右键点击它并点击「检查」来调试它。

Firefox

要加载浏览器扩展构建:

  1. 在地址栏中导航到 about:debugging,这将打开附加组件页面

  2. 点击「此 Firefox」

  3. 点击「载入临时附加组件」

  4. 打开您本地存储库的 build 文件夹然后打开 manifest.json 文件

现在您已拥有了已安装的浏览器扩展程序的本地构建。

临时附加组件仅安装在当前会话中。如果您关闭然后重新打开 Firefox,您必须再次加载临时附加组件。

您可以通过点击临时附加组件页面中 Bitwarden 标题旁边的「检查」按钮来调试浏览器扩展的背景页面。要调试弹出窗口:

  1. 使用上面的说明检查背景页面

  2. 点击调试器右上角的「三点」,然后点击「禁用弹出式自动隐藏」

  3. 打开扩展弹出窗口

  4. 点击「iframe」按钮(「三点」旁边)然后选择「/popup/index.html」

Safari

Safari WebExtensions 必须通过 Mac App Store 分发,并与常规 Mac App Store 应用程序捆绑在一起。因此,与其他浏览器相比,构建和调试过程略有不同。

卸载以前的版本

如果您已构建、已安装或运行过桌面客户端(包括官方版本),Safari 很可能会继续加载官方浏览器扩展,而不是加载从源代码构建的版本。

要避免这种情况,请按照以下说明卸载 Safari 扩展:

  1. 打开 Safari

  2. 点击「设置」,然后点击「扩展程序」选项卡

  3. 点击 Bitwarden 扩展旁边的「卸载」

  4. 使用扩展删除此应用程序

  5. 重新打开 Safari 并检查「设置」以确认没有安装 Bitwarden 浏览器扩展。如果仍有 Bitwarden 扩展,请重复步骤 3-4

  6. 退出并完全关闭 Safari 浏览器

如果您要从不同来源加载浏览器扩展(例如,在本地构建和官方版本之间切换),您可能需要定期执行此操作。

在 Xcode 中开发

开发扩展的最简单方法是使用 Xcode 构建和调试它。

1、构建扩展:

npm run build

2、编辑 build/manifest.json。将 nativeMessaging 权限从 optional_permissions 部分移至 permissions 部分。

3、编辑 build/index.html 文件,将 <html class="__BROWSER__"> 替换为 <html class="browser_safari">。

3、在 Xcode 中打开 src/safari/desktop.xcodeproj

4、运行「桌面」目标。

每当对源文件进行任何更改时,请记住通过 Xcode 重新运行它。它不会自动重新加载。

生产构建

另一种方法是通过 gulp 使用「正确的」构建流程。这种方法不需要对输出进行任何手动处理,因为 gulp 会为我们完成这些工作。不过,我们必须为每次更改完全重建扩展,这会比较慢。

要构建并加载浏览器扩展:

1、为 Safari 构建扩展

npm run dist:safari:dmg

2、打开 Safari 并检「设置」以确认扩展已安装且已启用

要启用调试:

  1. 点击「设置」,然后点击「高级」选项卡

  2. 启用「在菜单栏中显示开发菜单」

您可以通过点击 Develop -> Web Extension Background Pages,然后选择 Bitwarden 来调试浏览器扩展的背景页面。您可以在弹出窗口打开时右键点击它并点击「检查元素」来调试它。

对于大多数调试和测试来说,这应该足够了,除非您使用的是本机代码。

这是因为 Web Vault 在其 中包含了 webpack-dev-server 软件包。当它运行时,它根据自己的 配置文件中的配置设置代理每一个端点:

加载扩展后,您可能需要调整服务器 URL 以指向本地服务器,而不是在 managedEnvironment 中覆盖它们。您可以通过浏览器设置更改。有关如何配置 URL 的说明,请点击。

您可能需要。

官方页面地址
客户端存储库设置说明
development.json
BrowserEnvironmentService
webpack.config.js
development.json
此处
在 macOS 中配置 Safari 以运行未签名的扩展