Skip to main content

Command line tool for Keeper Secrets Manager

Project description

Keeper Secrets Manager CLI

Overview

The Keeper Secrets Manager command line interface, ksm, is a tool to:

  • View and update secret records.
  • Replace environmental variable, and inline parameters, used by an application or script.
  • Manage access to multiple applications.

The full documentation can be found on GitBook.

Quick Start

Install, or update, the module.

$ pip install -U keeper-secrets-manager-cli

Create a configuration file for your application.

$ ksm profile init --token XXXXXXXXXXXX
Added profile _default to INI config file located at /home/my_home/keeper.ini

List your secrets.

$ ksm secret list
 UID                      Record Type           Title
 ======================== ===================== ===================
 w5cQhGjMzeZOc_x9i4BcmA   login                 My Website
 Atu8tVgMxpB-iO4xT-Vu3Q   bankCard              Save Smart Bank
 A_7YpGBUgRTeDEQLhVRo0Q   file                  Passport Scan
 EG6KdJaaLG7esRZbMnfbFA   databaseCredentials   Main DB Server

Look at one of your secret records.

$ ksm secret get -u w5cQhGjMzeZOc_x9i4BcmA
Record: w5cQhGjMzeZOc_x9i4BcmA
 Title:       My Website
 Record type: login

  Field         Value
 ============= ==============
  login         foo
  password      bar
  url           https://localhost
  fileRef
  oneTimeCode

Look at the same record however this time as JSON.

$ ksm secret get -u w5cQhGjMzeZOc_x9i4BcmA --json
{
    "uid": "w5cQhGjMzeZOc_x9i4BcmA",
    "title": "My Website",
    "type": "login",
    "fields": [
        {
            "type": "login",
            "value": [
                "foo"
            ]
        },
        {
            "type": "password",
            "value": [
                "bar"
            ]
        },
        ...
    ],
    "custom_fields": [],
    "files": []
}

Launch an application/script with environment variable replacement.

$ cat << EOF > my_script.sh
#!/bin/sh
echo "Login = \${MY_LOGIN}"
echo "Password = \${MY_PASSWORD}"
EOF
$ chmod u+x my_script.sh

$ export MY_LOGIN="keeper://w5cQhGjMzeZOc_x9i4BcmA/field/login"
$ export MY_PASSWORD="keeper://w5cQhGjMzeZOc_x9i4BcmA/field/password"
$ ksm exec -- ./my_script.sh
Login = foo
Password = bar

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keeper-secrets-manager-cli-0.0.34.tar.gz (21.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page