README
1Qt based Cross-Platform YubiKey Personalization Tool
2====================================================
3See the file COPYING for copyright and license statement.
4
5Introduction
6------------
7
8The YubiKey Personalization Tool is a Qt based Cross-Platform utility
9designed to facilitate re-configuration of YubiKeys on Windows, Linux
10and Mac platforms. The tool provides a same simple step-by-step
11approach to make configuration of YubiKeys easy to follow and
12understand, while still being powerful enough to exploit all
13functionality both of the YubiKey 1 and YubiKey 2 generation of
14keys. The tool provides the same functionality and user interface on
15Windows, Linux and Mac platforms.
16
17The Cross-Platform YubiKey Personalization Tool provides the following
18main functions:
19
20 * Programming the YubiKey in "Yubico OTP" mode
21 * Programming the YubiKey in "OATH-HOTP" mode
22 * Programming the YubiKey in "Static Password" mode
23 * Programming the YubiKey in "Challenge-Response" mode
24 * Programming the NDEF feature of the YubiKey NEO
25 * Testing the challenge-response functionality of a YubiKey
26 * Deleting the configuration of a YubiKey
27 * Checking type and firmware version of the YubiKey
28
29
30Building from Git
31-----------------
32
33You may check out the sources using Git with the following command:
34
35-----------
36 $ git clone https://github.com/Yubico/yubikey-personalization-gui.git
37-----------
38
39This will create a directory 'yubikey-personalization-gui'. Enter the
40directory:
41
42-----------
43 $ cd yubikey-personalization-gui
44-----------
45
46
47Dependencies
48------------
49
50yubikey-personalization-gui depends on version 1.14.0 or higher of
51libykpers.
52
53When building on Windows and mac you will need a binary build of
54https://developers.yubico.com/yubikey-personalization[yubikey-personalization],
55the contents should then be places in libs/win32, libs/win64 and libs/macx
56respectively.
57
58For building on linux pkg-config is used to find these dependencies.
59
60-----------
61 $ sudo apt-get install libusb-1.0-0-dev qt4-qmake libykpers-1-dev \
62 libyubikey-dev libqt4-dev
63-----------
64
65Command-line build
66------------------
67
68Run these commands:
69
70-----------
71 $ qmake && make
72-----------
73
74Cross Compiling from Linux
75--------------------------
76
77The project can be cross compiled from linux for OS X and Windows. As
78a first step you need a cross-compiler chain for that OS, for windows
79you want mingw-w64.
80
81Then you need unpacked http://qt-project.org[Qt binaries] for that platform.
82
83You can then do (for Windows):
84TARGET_ARCH=i686-w64-mingw32 QTDIR=<qt location> qmake \
85 -spec win32-g++-4.6 "CONFIG+=cross"
86
87To build installers you can add build_installer to the CONFIG variable
88for qmake. This requires makensis to be in path for windows and
89genisoimage and dmg (from libhfs-dmg) for Mac.
90
91
92Opening the project in Qt designer
93----------------------------------
94
95Locate the qtcreator executable file and click on it to open the Qt
96Designer.
97
98To open the project in Qt Designer, select 'File' > 'Open File or
99Project' from the tool bar, navigate to the project folder, select
100YKPersonalisation.pro file and click on the 'Open' button.
101
102To set the path of the 'Build' diractory select 'Projects' > 'Build
103Settings' Browse project folder path.
104
105
106Building
107--------
108
109To generate the build system, select 'Build' > "Clean Project
110YKPersonalization" option from the tool bar. Then select 'Build' >
111'Run qmake' option from the tool bar.
112
113To build the project, select 'Build' > 'Build Project
114YKPersonalization' option from the tool bar.
115
116Based on your platform, the successful build will create a 'YubiKey
117Personalization Tool' executable file into the respective build
118folder. The build creates a `YKPersonalization.exe` file on Windows,
119`YubiKey Personalization Tool.sh` file on Linux and `YubiKey
120Personalization Tool.app` file on Mac.
121
122Example on Linux:
123To run the YubiKey Personalization Tool, open the command shell and
124execute the following command:
125
126[source, sh]
127-----------
128 $ build/release/yubikey-personalization-gui
129-----------
130
README.adoc
1Qt based Cross-Platform YubiKey Personalization Tool
2====================================================
3See the file COPYING for copyright and license statement.
4
5Introduction
6------------
7
8The YubiKey Personalization Tool is a Qt based Cross-Platform utility
9designed to facilitate re-configuration of YubiKeys on Windows, Linux
10and Mac platforms. The tool provides a same simple step-by-step
11approach to make configuration of YubiKeys easy to follow and
12understand, while still being powerful enough to exploit all
13functionality both of the YubiKey 1 and YubiKey 2 generation of
14keys. The tool provides the same functionality and user interface on
15Windows, Linux and Mac platforms.
16
17The Cross-Platform YubiKey Personalization Tool provides the following
18main functions:
19
20 * Programming the YubiKey in "Yubico OTP" mode
21 * Programming the YubiKey in "OATH-HOTP" mode
22 * Programming the YubiKey in "Static Password" mode
23 * Programming the YubiKey in "Challenge-Response" mode
24 * Programming the NDEF feature of the YubiKey NEO
25 * Testing the challenge-response functionality of a YubiKey
26 * Deleting the configuration of a YubiKey
27 * Checking type and firmware version of the YubiKey
28
29
30Building from Git
31-----------------
32
33You may check out the sources using Git with the following command:
34
35-----------
36 $ git clone https://github.com/Yubico/yubikey-personalization-gui.git
37-----------
38
39This will create a directory 'yubikey-personalization-gui'. Enter the
40directory:
41
42-----------
43 $ cd yubikey-personalization-gui
44-----------
45
46
47Dependencies
48------------
49
50yubikey-personalization-gui depends on version 1.14.0 or higher of
51libykpers.
52
53When building on Windows and mac you will need a binary build of
54https://developers.yubico.com/yubikey-personalization[yubikey-personalization],
55the contents should then be places in libs/win32, libs/win64 and libs/macx
56respectively.
57
58For building on linux pkg-config is used to find these dependencies.
59
60-----------
61 $ sudo apt-get install libusb-1.0-0-dev qt4-qmake libykpers-1-dev \
62 libyubikey-dev libqt4-dev
63-----------
64
65Command-line build
66------------------
67
68Run these commands:
69
70-----------
71 $ qmake && make
72-----------
73
74Cross Compiling from Linux
75--------------------------
76
77The project can be cross compiled from linux for OS X and Windows. As
78a first step you need a cross-compiler chain for that OS, for windows
79you want mingw-w64.
80
81Then you need unpacked http://qt-project.org[Qt binaries] for that platform.
82
83You can then do (for Windows):
84TARGET_ARCH=i686-w64-mingw32 QTDIR=<qt location> qmake \
85 -spec win32-g++-4.6 "CONFIG+=cross"
86
87To build installers you can add build_installer to the CONFIG variable
88for qmake. This requires makensis to be in path for windows and
89genisoimage and dmg (from libhfs-dmg) for Mac.
90
91
92Opening the project in Qt designer
93----------------------------------
94
95Locate the qtcreator executable file and click on it to open the Qt
96Designer.
97
98To open the project in Qt Designer, select 'File' > 'Open File or
99Project' from the tool bar, navigate to the project folder, select
100YKPersonalisation.pro file and click on the 'Open' button.
101
102To set the path of the 'Build' diractory select 'Projects' > 'Build
103Settings' Browse project folder path.
104
105
106Building
107--------
108
109To generate the build system, select 'Build' > "Clean Project
110YKPersonalization" option from the tool bar. Then select 'Build' >
111'Run qmake' option from the tool bar.
112
113To build the project, select 'Build' > 'Build Project
114YKPersonalization' option from the tool bar.
115
116Based on your platform, the successful build will create a 'YubiKey
117Personalization Tool' executable file into the respective build
118folder. The build creates a `YKPersonalization.exe` file on Windows,
119`YubiKey Personalization Tool.sh` file on Linux and `YubiKey
120Personalization Tool.app` file on Mac.
121
122Example on Linux:
123To run the YubiKey Personalization Tool, open the command shell and
124execute the following command:
125
126[source, sh]
127-----------
128 $ build/release/yubikey-personalization-gui
129-----------
130
README.binary_dists
1These are good-to-have qmake invocations for windows and osx binary distributions:
2
3windows cross compiled with installer and signed binaries:
4$ TARGET_ARCH=i686-w64-mingw32 QTDIR=$win_qt_location SPC_FILE=$spc_file PVK_FILE=$pvk_file qmake -spec win32-g++-4.6 "CONFIG+= cross build_installer sign_binaries"
5
6os x native compile with installer and signed binaries:
7$ qmake -spec macx-llvm "CONFIG += build_installer release"
8
9os x cross compiled, just application:
10TARGET_ARCH=x86_64-apple-darwin11 OSX_SDK=$sdk_location QT_LIBDIR=$qt_library_frameworks_location QT_PLUGINDIR=$qt_plugins_location qmake -spec macx-g++42 "CONFIG += cross"
11