Skip to main content

Google Authentication command line tools

Project description

gacli
=====

``gacli`` was created for used with google-authenticator_. Thankfully, TOTP_ is
an open standard so ``gacli`` may have additional applications.

The ``ga`` command line utility provides convenient access to TOTP verification
codes: ::

usage: ga [-h] [-d] [-f FILE]

Copy newline terminated TOTP verification code to Mac OS X clipboard.

optional arguments:
-h, --help show this help message and exit
-d, --debug print debug information
-f FILE, --file FILE Secret file

The debug option continually prints verification codes instead of copying a
single code to the clipboard.

.. _google-authenticator: https://code.google.com/p/google-authenticator/
.. _TOTP: http://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm


Security
========

This application assumes you have secured your local computer disk or filesystem
encryption. ``gacli`` is only safe **with encryption**:

- `OS X: About FileVault 2`_
- `EncryptedFilesystems - Community Ubuntu Documentation`_

.. _`OS X: About FileVault 2`: https://support.apple.com/kb/ht4790
.. _`EncryptedFilesystems - Community Ubuntu Documentation`:
https://help.ubuntu.com/community/EncryptedFilesystems


Install
=======

Choose *either* of the following installation methods:

1. `Simple Global`_
2. `VirtualEnv and User Bin`_ (recommended)

Simple Global
-------------

1. Install the pip python module, if you have not already done so.

- `Installation -- pip documentation`_

2. Install the gacli python module: ::

sudo pip install gacli

VirtualEnv and User Bin
-----------------------

This installation method has the following requirements:

- Your ``PATH`` includes ``~/bin``
- virtualenv_ Python module is installed
- virtualenvwrapper_ Python module is installed

Installation:

1. Create a new gacli virtualenv and install the gacli python module: ::

mkvirtualenv -i gacli gacli

2. Symlink ``ga`` to home bin: ::

ln -s $(which ga) ~/bin/

.. _`Installation -- pip documentation`: http://www.pip-installer.org/en/latest/installing.html
.. _virtualenv: http://www.virtualenv.org/
.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/


Configuration
=============

1. See `Security`_
2. Copy the secret key from the first line of your ``.google_authenticator``
and put in ``~/.ga``
3. ``chmod 0400 ~/.ga``


Related
=======

* mac-ssh-confirm_: Protect against SSH Agent Hijacking on Mac OS X with the
ability to confirm agent identities prior to each use

.. _mac-ssh-confirm: https://github.com/TimZehta/mac-ssh-confirm


Requirements
============

- Linux or Mac OS X

- Linux utilizes ``xclip`` or ``xsel``.
- Mac OS X utilizes ``pbcopy``

- onetimepass_

.. _onetimepass: https://github.com/tadeck/onetimepass


License
=======

- `LICENSE.txt`_ (`MIT License`_)

.. _`LICENSE.txt`:
https://github.com/ClockworkNet/gacli/blob/master/LICENSE.txt
.. _`MIT License`: http://www.opensource.org/licenses/MIT

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

gacli-1.0.1.tar.gz (4.7 kB view details)

Uploaded Source

File details

Details for the file gacli-1.0.1.tar.gz.

File metadata

  • Download URL: gacli-1.0.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gacli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8dbd83e7ed1a27adf611e9bd05b0cddc1dc4fe40b04cc3fdba256eab6a5ebd5b
MD5 ec4205908068a52b2fdd5b20a084567b
BLAKE2b-256 6bc1904ba84cf769e7af87ac76dc41a46a8d870c066e3c8582c8823656bdc80b

See more details on using hashes here.

Supported by

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