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 提供支持
在本页
  • 要求
  • macOS
  • 设置和配置
  • 配置密钥和用户机密
  • 配置组织
  • 运行和调试
  1. 入门
  2. 业务 App

Key Connector

上一页OpenLDAP Docker 服务器下一页Splunk App

最后更新于1个月前

对应的

如果您是 Key Connector 的新手,您应该首先阅读以了解其工作原理。

要求

  • 运行在自托管配置中的

  • 配置了 SSO 的企业组织

  • 本地运行的

macOS

macOS 需要更新 SSL 库,否则您将收到「No usable version of libssl was found」的错误。

1、安装

2、安装 OpenSSL 软件包:

brew install openssl

3、将所需的环境变量设置为指向 OpenSSL 库:

echo 'DYLD_LIBRARY_PATH="/usr/local/opt/openssl@1.1/lib"' >> ~/.zshrc

4、如果您是从终端运行的 Key Connector,请重新启动终端以确保更新的 .zshrc 设置被应用

鉴于 Key Connector 项目基于 NET 5,那么我们需要使用 x86_64 版本的 OpenSSL,从而使用 Homebrew 安装 x86_64 软件包(可以在找到包含多种方法的指南)。

1、安装 Rosetta:

softwareupdate --install-rosetta

2、将终端设置为使用 Rosetta 打开(创建终端应用程序的副本 -> 转到「获取信息」 -> 选中「使用 Rosetta 打开」)。

3、安装

4、使用 x86_64 Homebrew 安装 OpenSSL 包:

arch -x86_64 /usr/local/homebrew/bin/brew install openssl

5、设置所需的环境变量以指向 OpenSSL 库:

echo 'export DYLD_LIBRARY_PATH="/usr/local/opt/openssl@1.1/lib"' >> ~/.zshrc

6、如果您从终端运行 Key Connector,请重新启动终端以确保应用或运行已更新的 .zshrc 设置:

source ~/.zshrc

设置和配置

克隆存储库:

git clone https://github.com/bitwarden/key-connector.git

配置密钥和用户机密

1、打开终端并导航到本地 Key Connector 存储库中的 dev 文件夹

2、生成一个新的 RSA 密钥对(如果它们位于 dev 文件夹中,git 将忽略它们):

openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout bwkc.key -out bwkc.crt -subj "/CN=Bitwarden Key Connector" -days 36500

openssl pkcs12 -export -out ./bwkc.pfx -inkey bwkc.key -in bwkc.crt -passout pass:{Password}}

3、创建您自己的示例用户机密副本:

cp secrets.json.example secrets.json

4、编辑 secrets.json 并插入缺失的信息,包括本地存储库的路径和数据库文件的密码。

5、(可选)默认情况下,Key Connector 将使用本地自托管端点 - https://localhost:8081 用于 Web 密码库,http://localhost:33657 用于身份验证。如果您遵循本文档,则无需进行任何更改。但是,如果您的设置需要不同的端点,您可以在您的用户机密中设置它们,如下所示:

  "keyConnectorSettings": {
    "webVaultUri": "https://localhost:8081",
    "identityServerUri": "http://localhost:33657"
  }

6、保存并应用用户机密:

pwsh setup_secrets.ps1

配置组织

打开您的本地 Web 密码库并将您的企业组织配置为使用以下设置:

  • 策略:单一组织和单一登录身份验证

  • 单点登录:

    • 成员解密选项:Key Connector

    • Key Connector URL:http://localhost:5000

运行和调试

您现在已准备好开始在您的开发环境中使用 Key Connector 了!

使用 Visual Studio 打开解决方案文件 (bitwarden-key-connector.sln),然后点击「Play」按钮。

启动 Key Connector 后,使用非管理员或所有者的账户使用 SSO 登录。新用户将自动加入 Key Connector,现有用户将被提示删除其主密码。

从存储库根目录运行以下命令:

dotnet run --project src/KeyConnector --configuration Development

如果在基于 ARM 的 Mac 上运行,您可能需要使用 /usr/local/share/dotnet/x64/dotnet

/usr/local/share/dotnet/x64/dotnet run --project src/KeyConnector --configuration Development

macOS 需要 --configuration 标志才能使用正确的 SSL 库。

启动 Key Connector 后,使用非管理员或所有者的帐户使用 SSO 登录。新用户将自动加入 Key Connector,现有用户将被提示删除其主密码。

这些是推荐的开发设置,不适合生产使用。如果需要, 中提供了更多配置选项。

如果您在设置用户机密时需要帮助,请参阅。

官方页面地址
帮助中心文档
本地开发服务器
Web 密码库
.NET Core 5.0 SDK
Homebrew
此处
Homebrew
README
用户机密参考