mcpField
K
keeper-setup

keeper-setup

github.com/keeper-security安全12114 次安装20 周前更新
代码仓库

关于 keeper-setup

用于配置 Keeper 的 KSM CLI 和 Commander,适合需要访问机密或管理保管库的用户。内容包括安装来源、令牌设置安全、区域信息和常见故障排查。

主要功能

  1. 01安装 KSM CLI 和 Commander
  2. 02基于令牌初始化 KSM
  3. 03安全凭据处理指南
  4. 04Keeper 区域参考
  5. 05排查常见配置问题

适用场景

  1. 01在工作站配置 KSM CLI
  2. 02为 CI 或容器配置机密访问
  3. 03启动 Commander 保管库会话
  4. 04解决身份验证或密钥环错误

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/keeper-security/keeper-agent-kit --skill keeper-setup

安装后在 Claude Code 中输入/keeper-setup确认已加载。

详细介绍

Keeper CLI 安装与配置

官方文档

  • Secrets Manager (KSM) - 概念、KSM CLI 安装,以及应用/设备设置
  • Commander CLI - 概念、安装,以及交互式 shell
  • Keeper notation - ksm exec 和 ksm interpolate 使用的 keeper:// URI(用法请参阅 keeper-secrets 技能)

Keeper 提供两种 CLI 工具。按需安装:

工具软件包用途
KSM CLI (ksm)keeper-secrets-manager-cli获取和注入机器密钥
Commander (keeper)keepercommander管理、保险库管理、PAM、会话

安装安全

  • 优先使用 PyPI(pip install …),以便使用已发布的软件包,并在自己的依赖文件中固定版本。这是这些工具的默认安装方式。
  • 仅使用官方来源:发布的二进制文件和源代码均托管在 GitHub 上的 Keeper-Security 组织下。运行任何安装程序,或从克隆的仓库执行 pip install 前,请确认远程 URL 和发布者与 Keeper 官方文档一致;如需额外保障,请使用发布页面上提供的发布标签或校验和。
  • Agent 不得在聊天或生成的脚本中编造或复述一次性令牌、主密码或保险库字段值。请引导用户仅在自己的安全终端或密钥存储中粘贴或注入密钥。

快速安装

KSM CLI
# With OS-native keyring (recommended for workstations)
pip install keeper-secrets-manager-cli[keyring]

# Without keyring (for containers, CI/CD, headless)
pip install keeper-secrets-manager-cli

# Verify
ksm version

二进制安装程序(无需 Python)已发布在官方 Keeper-Security/secrets-manager GitHub Releases 页面上,该页面链接自 Secrets Manager CLI 文档,适用于 Windows、macOS 和 Linux。仅从该发布页面下载;如果发布版本提供校验和或签名,请进行验证。

Commander
pip install keepercommander

# Optional: install from a local clone of the official repository (verify remote and use a tagged release)
git clone https://github.com/Keeper-Security/Commander.git
cd Commander
git checkout <release-tag>
python -m venv venv && source venv/bin/activate
pip install -r requirements.txt && pip install -e .

# Verify
keeper version

首次设置

KSM CLI 设置

你需要从 KSM 应用获取一次性访问令牌。如果你还没有, Keeper 管理员可以通过保险库 UI 或 Commander 创建该令牌 (请参阅 keeper-admin 技能)。

请通过环境变量提供令牌,避免将其作为 --token 参数传递(因为它可能出现在 shell 历史记录和进程列表中)。官方文档: Profile command / init。

# Prerequisite: export KSM_CLI_TOKEN in this shell from Vault or Commander output (see Keeper profile docs). Never paste token values into chat or committed files.
ksm profile init
# Optional: unset KSM_CLI_TOKEN when finished in this shell.

ksm secret list  # Verify access

在 CI 或密钥管理器中,请注入同一变量,不要将其值放在命令行上。对于容器,请参阅 Keeper Secrets Manager CLI 文档中关于 KSM_TOKEN / KSM_INI_DIR 的行为说明。

Commander 设置
keeper shell
# Enter your email, master password, and 2FA code
# Then enable persistent login:
My Vault> this-device register
My Vault> this-device persistent-login ON

Keeper 区域

区域主机令牌前缀
USkeepersecurity.comUS:
EUkeepersecurity.euEU:
AUkeepersecurity.com.auAU:
JPkeepersecurity.jpJP:
CAkeepersecurity.caCA:
US Govgovcloud.keepersecurity.usGOV:

故障排除

问题解决方法
"Not authenticated"设置 KSM_CLI_TOKEN,使用新的 Client Device 令牌,然后重新运行 ksm profile init
"Token expired"在 Commander 或 Vault UI 中生成新的 Client Device
IP 锁定错误创建客户端时使用 --unlock-ip,或从被锁定的 IP 执行 init
Keyring 不可用使用 [keyring] extra 安装,或使用 --ini-file 标志
Python 版本错误KSM CLI 需要 Python 3.10+,Commander 需要 3.10+
keeper.ini 权限被拒绝文件权限应为 0600;使用 ls -la keeper.ini 检查

接下来

  • 要获取和注入密钥(包括 Keeper notation):请参阅 keeper-secrets 技能
  • 要管理企业、用户和 PAM:请参阅 keeper-admin 技能

评论

支持 Markdown