keepercommander 0.2.7

Keeper Commander for Python 3

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Examples
--------
.. image:: https://raw.github.com/larsjsol/shellpic/master/img/shell8.png
:alt: Lenna displayed with a color depth of 8 bits.

Description: .. figure:: https://raw.githubusercontent.com/Keeper-Security/Commander/master/keepercommander/images/commander_logo_512x205.png
:alt: image

image

--------------

The Password Management SDK for IT Admins & Developers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Keeper Commander is a command-line and SDK interface to `Keeper®
Password Manager <https://keepersecurity.com>`__. Keeper Commander can
be used to interactively access your Keeper Vault via a standard
terminal or SSH console, or it can be used as an SDK for integrating
your back-end into Keeper's zero-knowledge Cloud Security Vault™.

Commander can securely rotate passwords in your Keeper vault and then
automatically synchronize the change to all users with privileged access
to the record. Using our connector
`plugins <https://github.com/Keeper-Security/commander/tree/master/keeper/plugins>`__,
you can then perform the password reset directly on the source (e.g.
database, active directory, unix/pc login, etc...). Using Commander to
rotate passwords, combined with the flexibility of Keeper's secure
record sharing features provides you with the most secure and flexible
way to grant and revoke access to extremely confidential data.

`Here's a Video <https://youtu.be/p50OKRiaxl8>`__ demonstrating
Commander.

Features
~~~~~~~~

- Console access to your Keeper vault
- Login, download and decrypt your vault records
- Search for content with regular expressions
- Display vault record details
- Change logins, passwords and other record data
- Rotate passwords and push changes to connected platforms
- Control record and user permissions
- Automate everything

Keeper Commander provides deep integration of privileged password
management into back-end systems to securely access credentials, elevate
permissions and rotate passwords. With Keeper Commander you can automate
key security features on any platform.

Changes made through Keeper Commander instantly propagate to the users
who have access to that specific record.

When you grant and revoke access or rotate a password, it instantly
updates to users on their mobile and desktop devices. Control access to
highly secure systems by rotating passwords and pushing those
credentials to users - all within the Keeper ecosystem.

Installation
~~~~~~~~~~~~

You can install Keeper Commander with pip (the only requirement for this
type of install is python 3. You can install python3 by going to
`python.org <https://www.python.org>`__ and following the instructions):

::

pip3 install keepercommander

Or, if you would like to make modifications, clone the repository and
follow the instructions in the README within the keepercommander/ and
keepercommander/plugins/ folder.

Logging in
^^^^^^^^^^

.. figure:: https://raw.githubusercontent.com/Keeper-Security/Commander/master/keepercommander/images/screenshot1.png
:alt: image

image

Listing available commands
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.githubusercontent.com/Keeper-Security/Commander/master/keepercommander/images/screenshot2.png
:alt: image

image

Searching for records
^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.githubusercontent.com/Keeper-Security/Commander/master/keepercommander/images/screenshot3.png
:alt: image

image

Getting record details
^^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.githubusercontent.com/Keeper-Security/Commander/master/keepercommander/images/screenshot4.png
:alt: image

image

Rotating a password
^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.githubusercontent.com/Keeper-Security/Commander/master/keepercommander/images/screenshot5.png
:alt: image

image

The above screenshots are using the terminal version. You can make the
necessary hooks in the Commander source code to meet your integration
needs.

Command line usage
~~~~~~~~~~~~~~~~~~

keeper

Optional parameters
~~~~~~~~~~~~~~~~~~~

keeper --email=[e-mail]

Auto-configuration file
~~~~~~~~~~~~~~~~~~~~~~~

To automate the use of Commander, create a file called config.json and
place the file in your install folder. If you don't provide a config
file, Commander will just prompt you for the information.

Here's an example config.json file:

::

{
"server":"https://keeperapp.com/v2/",
"email":"your_email_here",
"password":"your_password_here",
"debug":false,
"commands":[]
}

You can also tell Commander which config file to use. By default, we
look at the config.json file. Example:

keeper --config=foo.json

In this case, Commander will start up using foo.json as the
configuration.

Auto-command execution
~~~~~~~~~~~~~~~~~~~~~~

You can provide Commander a set of commands to run without having to
type them manually. This is the easiest way to automate password resets.

Example:

::

{
"debug":false,
"server":"https://keeperapp.com/v2/",
"email":"[e-mail]",
"password":"somereallystrongpassword",
"commands":["d", "r 3PMqasi9hohmyLWJkgxCWg", "r tlCK0x1chKH8keW8-NOraA"]
}

In this example, we are telling Commander to first download and decrypt
records, then reset 2 passwords. As you can see, each unique password
record in the Keeper system is represented by a unique record UID. Use
the "l" or "s" command in Commander's interactive mode to display the
record UIDs in your account.

Two-Factor Authentication and Device Token
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have Two-Factor Authentication enabled on your Keeper account
(highly recommended), Keeper Commander will prompt you for the one-time
passcode the first time you login. After successfully logging in, you
will be provided a device token. This device token needs to be saved for
subsequent calls. Copy-paste this device token into your config.json
file. For example:

::

{
"debug":false,
"server":"https://keeperapp.com/v2/",
"email":"[e-mail]",
"password":"123456",
"mfa_token":"vFcl44TdjQcgTVfCMlUw0O9DIw8mOg8fJypGOlS_Rw0WfXbCD9iw",
"mfa_type":"device_token",
"commands":["d", "r 3PMqasi9hohmyLWJkgxCWg", "r tlCK0x1chKH8keW8-NOraA"]
}

Plugins
~~~~~~~

Keeper Commander can talk to external systems for the purpose of
resetting a password and synchronizing the change inside the Keeper
Vault. For example, you might want to rotate your MySQL password and
Active Directory password automatically. To support a plugin, simply add
a custom field to the record to specify which plugin Keeper Commander
should use when changing passwords. Example:

::

Name: cmdr:plugin
Value: mysql

::

Name: cmdr:plugin
Value: adpasswd

When a plugin is specified in a record, Commander will search in the
plugins/ folder to load the module based on the name provided (e.g.
mysql.py and active\_directory.py).

Keeper's team is expanding the number of plugins on an ongoing basis. If
you need a particular plugin created, just let us know.

Commands
~~~~~~~~

To see a list of supported commands, simply type '?':

::

Keeper > ?

Commands:

d ... download & decrypt data
l ... list folders and titles
s <regex> ... search with regular expression
g <uid> ... get record details for uid
r <uid> ... rotate password for uid
b <regex> ... rotate password for matches of regular expression
a ... add a new record interactively
c ... clear the screen
h ... show command history
q ... quit

- d (download): Downloads all records from the account, decrypts the
data key, private key, decrypts records and shared folders.

- l (list): Displays the Record UID, Folder and Title for all records.

- s (search): search across all record data and display the Record UID,
Folder and Title for matching records.

- g (get): displays the full record details for a specified Record UID.
The Record UID can be determined by looking at the response from the
"l" or "s" commands.

- r (rotate): rotates the password field of a specified Keeper record.
The new password generated is by default set to a very strong 64-byte
ASCII-based string. The previous password is also backed up and
stored as a custom field in the record, saved with the timestamp of
the change.

- b (batch rotate): search across all record data and rotate the
password for matching records.

Support
~~~~~~~

We're here to help. If you need help integrating Keeper into your
environment, contact us at [e-mail].

About Our Security
~~~~~~~~~~~~~~~~~~

Keeper is a zero-knowledge platform. This means that the server does not
have access to your Keeper Master Password or the crypto keys used to
encrypt and decrypt your data. The cryptography is performed on the
*client device* (e.g. iPhone, Android, Desktop, Commander).

When you create a Keeper account from our `web
app <https://keepersecurity.com/vault>`__ or `mobile/desktop
app <https://keepersecurity.com/download>`__, you are asked to create a
Master Password and a security question. The Keeper app creates your
crypto keys, RSA keys and encryption parameters (iv, salt, iterations).
Your RSA private key is encrypted with your data key, and your data key
is encrypted with your Master Password. The encrypted version of your
data key is stored in Keeper's Cloud Security Vault and provided to you
after successful device authentication.

When you login to Keeper on any device (or on Commander), your Master
Password is used to derive a 256-bit PBKDF2 key. This key is used to
decrypt your data key. The data key is used to decrypt individual record
keys. Finally, your record keys are then used to decrypt your stored
vault information (e.g. your MySQL password).

When storing information to your vault, Keeper stores and synchronizes
the encrypted data.

For added security, you can enable Two-Factor Authentication on your
Keeper account via the `web app <https://keepersecurity.com/vault>`__
settings screen. When logging into Commander with Two-Factor
Authentication turned on, you will be asked for a one time passcode.
After successful authentication, you will be provided with a device
token that can be used for subsequent requests without having to
re-authenticate.

All of this cryptography is packaged and wrapped into a simple and
easy-to-use interface. Commander gives you the power to access, store
and synchronize encrypted vault records with ease.

To learn about Keeper's security, certifications and implementation
details, visit the `Security
Disclosure <https://keepersecurity.com/security.html>`__ page on our
website.

About Keeper
~~~~~~~~~~~~

Keeper is the world's most downloaded password keeper and secure digital
vault for protecting and managing your passwords and other secret
information. Millions of people and companies use Keeper to protect
their most sensitive and private information.

Keeper's Features & Benefits

- Manages all your passwords and secret info
- Protects you against hackers
- Encrypts everything in your vault
- High-strength password generator
- Login to websites with one click
- Store private files, photos and videos
- Take private photos inside vault
- Share records with other Keeper users
- Access on all your devices and computers
- Keeper DNA™ multi-factor authentication
- Login with Fingerprint or Touch ID
- Auto logout timer for theft prevention
- Unlimited backups
- Self-destruct protection
- Customizable fields
- Background themes
- Integrated Apple Watch App
- Instant syncing between devices
- AES-256 encryption
- Zero-Knowledge security architecture
- TRUSTe and SOC-2 Certified

Keeper Website
~~~~~~~~~~~~~~

https://keepersecurity.com

Pricing
~~~~~~~

Keeper is free for local password management on your device. Premium
subscription provides cloud-based features and premium device-specific
features including Sync, Backup & Restore, Secure Sharing, File Storage
and multi-device usage. More info about our consumer and enterprise
pricing plans can be found
`here <https://keepersecurity.com/pricing.html>`__.

Mobile Apps
~~~~~~~~~~~

[iPhone, iPad, iPod]
(https://itunes.apple.com/us/app/keeper-password-manager-digital/id287170072?mt=8)

`Android (Google
Play) <https://play.google.com/store/apps/details?id=com.callpod.android_apps.keeper&hl=en>`__

`Kindle (Amazon App Store) <http://amzn.com/B00NUK3F6S>`__

`BlackBerry
(OS10+) <http://appworld.blackberry.com/webstore/content/33358889/?countrycode=US&lang=en>`__

`Windows Phone
(8+) <http://www.windowsphone.com/en-us/store/app/keeper/8d9e0020-9785-e011-986b-78e7d1fa76f8>`__

`Surface <http://apps.microsoft.com/windows/en-us/app/keeper/07fe8361-f512-4873-91a1-acd0cb4c851d>`__

Desktop Apps (Mac, PC, Linux)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Windows
PC <https://s3.amazonaws.com/keepersecurity/en_US/static/apps/Keeper.exe>`__

`Mac <https://s3.amazonaws.com/keepersecurity/en_US/static/apps/KeeperDesktop.dmg>`__

`Linux <https://s3.amazonaws.com/keepersecurity/en_US/static/apps/KeeperDesktopLinux.zip>`__

`Mac App Store <https://keepersecurity.com/macreview>`__

`Windows
Store <http://apps.microsoft.com/windows/en-us/app/keeper/07fe8361-f512-4873-91a1-acd0cb4c851d>`__

Web-Based Apps and Browser Extensions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Online Vault <https://keepersecurity.com/vault>`__

`FastFill for
Chrome <https://chrome.google.com/webstore/detail/keeper-browser-extension/bfogiafebfohielmmehodmfbbebbbpei>`__

`FastFill for
Firefox <https://addons.mozilla.org/en-us/firefox/addon/keeper-password-manager-digita/>`__

`FastFill for
Safari <https://s3.amazonaws.com/keepersecurity/ext/update/safari/keeper.safariextz>`__

`FastFill for Internet
Explorer <https://s3.amazonaws.com/keepersecurity/en_US/static/apps/SetupKeeperIE.exe>`__

`Enterprise Admin Console <https://keepersecurity.com/console>`__

Keywords: security password
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Security