https://github.com/korniichuk/fbi
The password encryption utility
https://github.com/korniichuk/fbi
fbi pass passwd password
Last synced: about 2 months ago
JSON representation
The password encryption utility
- Host: GitHub
- URL: https://github.com/korniichuk/fbi
- Owner: korniichuk
- License: unlicense
- Created: 2017-01-22T17:06:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-22T18:02:44.000Z (over 8 years ago)
- Last Synced: 2024-12-17T02:42:04.333Z (10 months ago)
- Topics: fbi, pass, passwd, password
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
.. contents:: Table of contents
Introduction
============
The passwords encryption utility. Do not save your passwords as plaintext!
Installation
============
Install the fbi utility from PyPI
---------------------------------
::
$ sudo pip install fbi
Install the fbi utility from GitHub
-----------------------------------
::
$ sudo pip install git+git://github.com/korniichuk/fbi#egg=fbi
Upgrade the fbi utility from PyPI
---------------------------------
::
$ sudo pip install -U fbi
or::
$ sudo pip install --upgrade fbi
Uninstall the fbi utility
-------------------------
::
$ sudo pip uninstall fbi
Development installation
========================
::
$ git clone git://github.com/korniichuk/fbi.git
$ cd fbi
$ sudo pip install .
Quickstart
==========
**First**, init the fbi utility::
$ fbi init
**Second**, encode password in a file::
$ fbi encode PATH
Example::
$ fbi encode ~/.key/netezza.enc
**Third**, decode password from a file::
>>> from fbi import getpassword
>>> path = "~/.key/netezza.enc"
>>> passwd = getpassword(path)
CLI client
==========
A command line interface for managing an encoded password files.
Help
----
The standard output for –help::
$ fbi -h
or::
$ fbi --help
For information on using subcommand "SUBCOMMAND", do::
$ fbi SUBCOMMAND -h
or::
$ fbi SUBCOMMAND --help
Example::
$ fbi init -h
Version
-------
The standard output for –version::
$ fbi -v
or::
$ fbi --version
Init the fbi utility
--------------------
::
$ fbi init
Encode password in a file
-------------------------
::
$ fbi encode PATH
Where:
* ``PATH`` -- destination path.
Example::
$ fbi encode /home/titan/.key/netezza.enc
or::
$ fbi encode ~/.key/netezza.enc
Decode password from a file
---------------------------
::
$ fbi decode PATH
Where:
* ``PATH`` -- source path.
Example::
$ fbi decode /home/titan/.key/netezza.enc
or::
$ fbi decode ~/.key/netezza.enc
.. note:: Do not use ``$ fbi decode PATH`` for your automation scripting.
Client library
==============
A Python client for managing an encoded password files.
Get password from an encoded file
---------------------------------
::
>>> from fbi import getpassword
>>> getpassword(path)
Where:
* ``path`` -- source path.
Example::
>>> from fbi import getpassword
>>> path = "/home/titan/.key/netezza.enc"
>>> passwd = getpassword(path)
or::
>>> from fbi import getpassword
>>> path = "~/.key/netezza.enc"
>>> passwd = getpassword(path)