Key Connector

对应的官方页面地址

如果您是 Key Connector 的新手，您应该首先阅读帮助中心文档以了解其工作原理。

要求

• 运行在自托管配置中的本地开发服务器

• 配置了 SSO 的企业组织

• 本地运行的 Web 密码库

• .NET Core 5.0 SDK

macOS

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

Intel

1、安装 Homebrew

2、安装 OpenSSL 软件包：

brew install openssl

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

echo 'DYLD_LIBRARY_PATH="/usr/local/opt/[email protected]/lib"' >> ~/.zshrc

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

ARM

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

1、安装 Rosetta：

softwareupdate --install-rosetta

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

3、安装 Homebrew

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/[email protected]/lib"' >> ~/.zshrc

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

source ~/.zshrc

设置和配置

克隆存储库：

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

配置密钥和用户机密

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

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

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

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

CLI

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

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，现有用户将被提示删除其主密码。