目录连接器 CLI

对应的官方文档地址

目录连接器 CLI 适合在无法使用桌面 GUI 的环境中工作,或者如果您想要使用操作系统提供的工具(定时作业、计划任务等)对目录同步操作进行脚本编程时使用。目录连接器 CLI 可以在 Windows、macOS 和 Linux 发行版上跨平台使用。

入门

完成以下步骤,开始使用 Bitwarden 目录连接器 CLI:

1、从以下链接之一下载 CLI:

2、解压缩 .zip 并将其文件(bwdckeytar.node)移动到 /usr/local/bin 或您的 $PATH 中的其他目录。请注意,keytar.node 必须与主 bwdc 可执行文件位于同一目录中。

对于 Linux:如果尚未安装,请使用您的软件包管理器安装 libsecret

apt-get install libsecret-1-0
brew install libsecret

对于 Windows:Windows 用户可以bwdc.exe 添加到当前用户的 PATH 中

3、运行下面的命令来验证 bwdc 命令在您的终端上是否可以正常工作:

bwdc --help

4、使用 bwdc config <setting> <value> 命令(参阅命令参考)将目录连接器 CLI 连接到您的目录。

5、通过编辑 data.json 文件(更多信息请参阅目录连接器文件存储)来配置同步选项。使用 bwdc data-file 命令获取 data.json 文件的绝对路径。

可用的同步选项取决于使用的目录类型,因此请参考以下文章之一,以获取可供您使用的选项列表:

6、运行 bwdc test 命令以检查您的配置是否将同步预期结果。

7、当正确配置了目录和同步选项,并且 bwdc test 产生了预期的结果,请运行 bwdc sync 命令以启动实时同步操作。

命令参考

login

login 命令用于使用您的 Bitwarden 账户登录到目录连接器。您必须是您组织的管理员或所有者才能使用目录连接器(更多信息请参阅用户类型和访问控制)。

bwdc login [options] [email] [password]

可用的选项包括:

  • --method:使用此选项指定要使用的两步登录方式

    • 0 = Authenticator App

    • 1 = Email

    • 3 = YubiKey

  • --code:使用此选项为指定的 method 指定两步登录代码。

  • --sso:使用此选项以使用 SSO 登录。选择此选项将在您的 Web 浏览器中打开 SSO 登录流程。有关更多信息,请参阅使用 SSO 访问密码库

示例:

与下面的例子相反,一般不建议在行内输入密码,因为这会把密码保存到 shell 的历史记录中。在初始命令中不输入密码,Bitwarden 将会提示您输入密码,这样就不会保存密码了。

bwdc login [email protected].com mystrongpassword --method 0 --code 204678

logout

logout 命令用于登出目录连接器 CLI。

bwdc logout

help

Bitwarden 目录连接器 CLI 是自带文档的,每条命令都有 --help 内容和示例。使用全局 --help 选项列出所有可用命令:

bwdc --help

在某一具体命令上使用 --help 选项以了解该命令的更多信息:

bwdc test --help
bwdc config --help

test

test 命令用于查询您的目录并打印 JSON 格式的群组和用户数组,每当您运行真正的同步操作时,这些群组和用户将被同步到您的 Bitwarden 组织。

bwdc test

使用 --last 选项仅测试自上次成功同步以来的更改。

bwdc test --last

sync

sync 命令用于运行实时的同步操作,并将数据推送到您的 Bitwarden 组织。

bwdc sync

同步的用户和群组将立即在您的 Bitwarden 组织中可用。新增加的用户将收到一封邀请加入您组织的电子邮件。

last-sync

last-sync 命令用于返回上一次对用户或群组执行同步操作的 ISO 8601 时间戳。您必须将 <object> 指定为 usersgroups 才能运行此命令:

bwdc last-sync <object>

如果指定的对象未执行任何同步,则返回一个空响应。

config

config 命令用于指定您的目录的设置。

bwdc config <setting> <value>

可用的选项包括:

  • server <server-url>

  • directory <directory-type>

  • ldap.password <password>

  • azure.key <key>

  • gsuite.key <key>

  • okta.token <token>

  • onelogin.secret <secret>

ldap.passwordazure.keygsuite.keyokta.token 以及 onelogin.secret 只能使用 CLI 的 bwdc 命令修改,或者使用桌面版应用程序

data-file

data-file 命令用于返回目录连接器 CLI 所使用的 data.json 配置文件的绝对路径:

bwdc data-file

通过直接在您喜欢的文本编辑器中编辑 data.json 配置文件,来修改目录连接器 CLI 的配置设置项。

clean-cache

clear-cache 命令用于清除在执行同步操作时应用程序存储的缓存数据。更多信息请参阅清除同步缓存

bwdc clear-cache

update

update 命令用于检查目录连接器 CLI 是否是最新版本:

bwdc update

如果发现新版本,此命令将返回新版本的下载 URL 地址。目录连接器 CLI 不会自动更新。您需要使用此 URL 手动下载新版本。

如果您同时使用 CLI 和桌面版应用程序,确保它俩的版本是匹配的,这非常重要。运行两个不同版本的目录连接器,可能会导致意外问题。

使用全局选项 --version 查看目录连接器 CLI 的版本。

故障排除

如果收到有关 libsecret 共享库的错误消息Error: libsecret-1.so.0: cannot open shared object file: No such file or directory,则需要你安装 libsecret,这是将内容安全地存储在主机上所必需的。