darkdimius / yubioath-desktop Goto Github PK

Yubico Authenticator
====================

The Yubico Authenticator is a graphical desktop tool for generating
Open AuTHentication (OATH) event-based HOTP and time-based TOTP
one-time password codes, with the help of a Yubikey NEO that protects
the shared secrets.

License
-------

Yubico Authenticator is licensed under GPLv3+, see COPYING for
details.

Dependencies
------------

To build the Yubico Authenticator you need the following Python
modules: PySide, PBKDF2, pyscard.  To use it, you need a YubiKey NEO
with the OATH applet loaded.

Building Windows binaries
-------------------------

For Windows you will need python, PySide, PyInstaller and Pywin32
installed (32 or 64-bit versions depending on the architecture of the
binary your are building).

Clone the git repository and checkout the desired release tag (or
branch):

  git clone https://github.com/Yubico/yubioath-desktop.git
  cd yubico-authenticator

To sign the executable, copy the pfx file to yubicoauth.pfx and place
it in the root of the project folder. You will need signtool.exe (from
the Windows SDK) either copied into the root as well or in a location
in your PATH.

Run "pyinstaller.exe -w -i yubico.ico yubicoauthenticator.spec" from
the main project folder.


Building Mac OSX binaries
-------------------------

Install PyInstaller via pip

Run "pyinstaller -w -i "yubioath-48.png" yubicoauthenticator.spec" 
from the main project folder.

Codesign the code with:
codesign -s 'Developer ID Application' /path/to/directory/project.app --deep

Build the package with:
http://s.sudre.free.fr/Software/Packages/about.html


Running from Linux / OSX
------------------------

Install Python 2.7.x
	
	cd yubicoauthenticator/
	Run "python yubico_authenticator.py --help"
	Run "python yubico_authenticator.py"

The application will start and sit on the system's systray.

On Ubuntu 14.04 you need the following packages first.
	
	sudo apt-get install pcscd python-pyscard python-pbkdf2 python-pyside.qtgui


No systray mode
--------------

For users without a systrabar or running desktop envinronment with non standard Qt behaviour

	cd yubicoauthenticator/
	Run "python yubico_authenticator.py --disable-systray"



ToDo
----

* .deb packaging