configure default change
[gnuk/gnuk.git] / README
1 Gnuk - An Implementation of USB Cryptographic Token for GnuPG
2
3                                                           Version 1.1.3
4                                                              2014-04-16
5                                                            Niibe Yutaka
6                                       Free Software Initiative of Japan
7
8 Warning
9 =======
10
11 This is another experimental release of Gnuk, version 1.1.3, which has
12 incompatible changes to Gnuk 1.0.x.  Specifically, it now supports
13 overriding key import, but importing keys (or generating keys) results
14 password reset.  Please update your documentation for Gnuk Token, so
15 that the instruction of importing keys won't cause any confusion.  It
16 has supports of ECDSA (with NIST P256 and secp256k1) and EdDSA with
17 EdDSA, but this feature is pretty much experimental, and it requires
18 development version of GnuPG with newest version of libgcrypt.  You
19 will not able to keep using EdDSA keys, as the key format is subject
20 to change.
21
22
23 What's Gnuk?
24 ============
25
26 Gnuk is an implementation of USB cryptographic token for GNU Privacy
27 Guard.  Gnuk supports OpenPGP card protocol version 2, and it runs on
28 STM32F103 processor.
29
30 I wish that Gnuk will be a developer's soother who uses GnuPG.  I have
31 been nervous of storing secret key(s) on usual secondary storage.
32 There is a solution with OpenPGP card, but it is not the choice for
33 me, as card reader is not common device.  With Gnuk, this issue will
34 be solved by a USB token.
35
36 Please look at the graphics of "gnuk.svg" for the software name.  My
37 son used to be with his NUK(R), always, everywhere.  Now, I am with a
38 USB Cryptographic Token by "Gnuk", always, everywhere.
39
40
41 FAQ
42 ===
43
44 Q0: How Gnuk USB Token is superior than other solutions (OpenPGP
45     card 2.0, GPF Crypto Stick, etc.) ?
46     http://www.g10code.de/p-card.html
47     http://www.privacyfoundation.de/crypto_stick/
48 A0: Good points of Gnuk are:
49     * If you have skill of electronics and like DIY, you can build
50       Gnuk Token cheaper (see Q8-A8).
51     * You can study Gnuk to modify and to enhance.  For example, you
52       can implement your own authentication method with some sensor
53       such as an acceleration sensor.
54     * It is "of Free Software"; Gnuk is distributed under GPLv3+,
55             "by Free Software"; Gnuk development requires only Free Software
56                                 (GNU Toolchain, Python, etc.), 
57             "for Free Software"; Gnuk supports GnuPG.
58
59 Q1: What kind of key algorithm is supported?
60 A1: Gnuk version 1.0 only supports 2048-bit RSA.
61     Development version of Gnuk (1.1.x) supports 256-bit ECDSA and EdDSA.
62
63 Q2: How long does it take for digital signing?
64 A2: It takes a second and a half or so. 
65
66 Q3: What's your recommendation for target board?
67 A3: Orthodox choice is Olimex STM32-H103.
68     FST-01 (Flying Stone Tiny 01) is available for sale, and it is a
69     kind of the best choice, hopefully.
70
71 Q4: What's version of GnuPG are you using?
72 A4: In Debian GNU/Linux system, I use gnupg 1.4.12-7 and gnupg-agent
73     2.0.20-1.
74
75 Q5: What's version of pcscd and libccid are you using?
76 A5: I don't use them, pcscd and libccid are optional, you can use Gnuk
77     without them.
78     I tested pcscd 1.5.5-4 and libccid 1.3.11-2 which were in Debian
79     squeeze.
80
81 Q6: What kinds of hardware is required for development?
82 A6: You need a target board plus a JTAG/SWD debugger.  If you just
83     want to test Gnuk for target boards with DfuSe, JTAG debugger is
84     not the requirement.  Note that for real use, you need JTAG/SWD
85     debugger to enable flash ROM protection.
86
87 Q7: How much does it cost?
88 A7: Olimex STM32-H103 plus ARM-USB-TINY-H cost 70 Euro or so.
89
90 Q8: How much does it cost for DIY version?
91 A8: STM8S Discovery Kit costs 750 JPY (< $10 USD) only.  You can build
92     your own JTAG debugger using FTDI2232 module (1450 JPY), see:
93     http://www.fsij.org/gnuk/jtag_dongle_ftdi2232
94
95 Q9: I got an error like "gpg: selecting openpgp failed: ec=6.108", what's up?
96
97 A9: GnuPG's SCDaemon has problems for handling insertion/removal of
98     card/reader.  When your newly inserted token is not found by
99     GnuPG, try killing scdaemon and let it to be invoked again.  I do:
100
101          $ gpg-connect-agent "SCD KILLSCD" "SCD BYE" /bye
102
103     and confirm scdaemon doesn't exist, then,
104
105          $ gpg-connect-agent learn /bye
106
107 Qa: With GNOME 2, I can't use Gnuk Token for SSH.  How can we use it for SSH?
108 Aa: You need to deactivate seahorse-agent and gnome-keyring, but use
109     gpg-agant for the role of ssh-agent.  For gnome-keyring please do:
110
111       $ gconftool-2 --type bool --set /apps/gnome-keyring/daemon-components/ssh false
112
113 Qb: With GNOME 3, I can't use Gnuk Token at all.  Why?
114 Ab: That's because gnome-keyring-daemon interferes GnuPG.  Type:
115
116       $ gnome-session-properties
117
118     and at the tab of "Startup Programs", disable check buttons for
119     "GPG Password Agent" and "SSH Key Agent".
120
121 Qc: Do you know a good SWD debugger to connect FST-01 or something?
122 Ac: ST-Link/V2 is cheap one.  We have a tool/stlinkv2.py as flash ROM
123     writer program.
124
125
126 Release notes
127 =============
128
129 This is third experimental release in version 1.1 series of Gnuk.
130
131 While it is daily use by its developer, some newly introduced features
132 (including ECDSA/EdDSA, key generation and firmware upgrade) should be
133 considered experimental.  ECDSA/EdDSA is really experimental.  The
134 feature even requires manual edit of Makefile after 'configure'.
135 More, EdDSA is much experimental.  You won't be able to keep using
136 the EdDSA key, as it is subject to change.
137
138 Tested features are:
139
140         * Personalization of the card
141           * Changing Login name, URL, Name, Sex, Language, etc.
142         * Password handling (PW1, RC, PW3)
143         * Key import for three types:
144           * key for digital signing
145           * key for decryption
146           * key for authentication
147         * PSO: Digital Signature
148         * PSO: Decipher
149         * INTERNAL AUTHENTICATE
150         * Changing value of password status bytes (0x00C4): forcesig
151         * Verify with pin pad
152         * Modify with pin pad
153         * Card holder certificate (read)
154         * Removal of keys
155         * Key generation on device side
156         * Overriding key import
157
158 Original features of Gnuk, tested lightly:
159
160         * OpenPGP card serial number setup
161         * Card holder certificate (write by UPDATE BINARY)
162         * Upgrading with "EXTERNAL AUTHENTICATE" by reGNUal
163
164 It is known not-working well:
165
166         * It is known that the combination of libccid 1.4.1 (or newer)
167           with libusb 1.0.8 (or older) has a minor problem.  It is
168           rare but it is possible for USB communication to be failed,
169           because of a bug in libusb implementation.  Use libusbx
170           1.0.9 or newer, or don't use PC/SC, but use internal CCID
171           driver of GnuPG.
172
173
174 Targets
175 =======
176
177 We use Olimex STM32-H103 board and Flying Stone Tiny 01 (FST-01).
178
179 With DfuSe support, STBee is also our targets.  But this target with
180 DfuSe is for experiment only, because it is impossible for DfuSe to
181 disable read from flash.  For real use, please consider killing DfuSe
182 and enabling read protection using JTAG debugger.
183
184 For PIN-pad support, I connect a consumer IR receive module to FST-01, and use controller for TV.  PIN verification
185 is supported by this configuration.  Yes, it is not secure at all,
186 since it is very easy to monitor IR output of the controllers.  It is
187 just an experiment.  Note that hardware needed for this experiment is
188 only a consumer IR receive module which is as cheap as 50 JPY.
189
190 Note that you need pinpad support for GnuPG to use PIN-pad enabled
191 Gnuk.  The pinpad support for GnuPG is only available in version 2.
192
193
194 Souce code
195 ==========
196
197 Gnuk source code is under src/ directory.
198
199 Note that SHA-2 hash function implementation, src/sha256.c, is based
200 on the original implementation by Dr. Brian Gladman.  See:
201
202   http://gladman.plushost.co.uk/oldsite/cryptography_technology/sha/index.php
203
204
205 License
206 =======
207
208 It is distributed under GNU General Public Licence version 3 or later
209 (GPLv3+).  Please see src/COPYING.
210
211 Please note that it is distributed with external source code too.
212 Please read relevant licenses for external source code as well.
213
214 The author(s) of Gnuk expect users of Gnuk will be able to access the
215 source code of Gnuk, so that users can study the code and can modify
216 if needed.  This doesn't mean person who has a Gnuk Token should be
217 able to access everything on the Token, regardless of its protections.
218 Private keys, and other information should be protected properly.
219
220
221 External source code
222 ====================
223
224 Gnuk is distributed with external source code.
225
226 * chopstx/  -- Chopstx 0.03 (+ STBee support)
227
228   We use Chopstx as the kernel for Gnuk.
229
230   Chopstx is distributed under GPLv3+ (with a special exception).
231
232
233 * polarssl/  -- PolarSSL 1.2.10
234
235   Souce code taken from: http://polarssl.org/
236
237   We use PolarSSL for RSA computation, and AES encryption/decryption.
238
239   PolarSSL is distributed under GPLv2+.  We use PolarSSL under GPLv3
240   as our options.
241
242   The file include/polarssl/bn_mul.h is heavily modified for ARM
243   Cortex-M3.
244
245   The function rsa_private in polarssl/library/rsa.c is modified so
246   that it doesn't check T against N.  The function rsa_pkcs1_sign is
247   modified to avoid warnings in case of !POLARSSL_PKCS1_V21.
248
249   The functions rsa_pkcs1_verify and rsa_rsassa_pkcs1_v15_verify in
250   include/polarssl/rsa.h and polarssl/library/rsa.c are modified
251   (fixed) for last argument SIG, as the memory at SIG aren't modified
252   by those routines.
253
254   The constant POLARSSL_MPI_MAX_SIZE in include/polarssl/bignum.h is
255   modified for 2048-bit keys only Gnuk.
256
257   The function mpi_mul_hlp in library/bignum.c is modified for more
258   optimization for ARM Cortex-M3.  Functions mpi_montred, mpi_sub_hlp,
259   mpi_sub_abs, mpi_mul_mpi, mpi_montmul, and mpi_exp_mod are modified
260   to avoid side channel attacks.  Note that we don't use RSA-blinding
261   technique for Gnuk.  Function mpi_gen_prime and mpi_is_prime are
262   modified to use Fouque-Tibouchi method.  Function mpi_exp_mod is
263   modified to use new function mpi_montsqr for speed up.
264
265   The file library/aes.c is modified so that some constants can
266   go to .sys section.
267
268   The file include/polarssl/config.h are modified not to define
269   POLARSSL_HAVE_LONGLONG to avoid linking libgcc, to define
270   POLARSSL_AES_ROM_TABLES to have AES tables, not to define
271   POLARSSL_CIPHER_MODE_CTR, POLARSSL_FS_IO, POLARSSL_PKCS1_V21,
272   POLARSSL_SELF_TEST, and POLARSSL_PADLOCK_C, and only define
273   POLARSSL_GENPRIME when defined KEYGEN_SUPPORT.
274
275
276 USB vendor ID and product ID (USB device ID)
277 ============================================
278
279 When you have a vender ID and assign a product ID for Gnuk, edit the
280 file GNUK_USB_DEVICE_ID and add an entry for yours.  In this case,
281 please contact Niibe, so that it is listed to the file in the official
282 release of the source code.
283
284 When you are modifing Gnuk and installing the binary to device, you
285 should replace the vendor string and serial number to yours (in the
286 file GNUK_USB_DEVICE_ID and SERIALNO of the script of src/configure),
287 so that users can see it's not by original vendor, and it is modified
288 version.
289
290 FSIJ allows you to use USB device ID of FSIJ (234b:0000) for devices
291 with Gnuk under one of following conditions:
292
293   * For everyone for experimental purpose:
294
295     - You must not distribute a binary with FSIJ's USB device ID, but
296       must use the binary by yourself only for your experiment.  Note
297       that "Distributing binary" includes distributing a device which
298       holds the binary.
299
300   * For general individuals:
301
302     - You must use your Gnuk device with a card serial number which is
303       *not* by FSIJ.  Easy one would be a card serial number generated
304       by chip unique ID.
305
306   * For individuals with explicit permission from FSIJ.
307
308     - You should have an assigned card serial number by FSIJ,
309       please use that number for your device.
310       (There a file 'GNUK_SERIAL_NUMBER' in the official release.)
311
312 FSIJ could give companies or business entities "second source
313 manufacturer" license to use USB device ID of FSIJ for devices with
314 unmodified version of Gnuk, provided they support Free Software and
315 respect users' freedom for computing.  Please ask FSIJ for the
316 license.
317
318 Otherwise, companies which want to distribute Gnuk devices, please use
319 your own USB vendor ID and product ID.  Please replace vendor string
320 and possibly product string to yours, when you modify Gnuk.
321
322
323 Host Requirements
324 =================
325
326 For GNU/Linux, PC/SC service is an option, you can use GnuPG's
327 internal CCID driver instead.  If you chose using PC/SC service,
328 libccid version >= 1.3.11 is recommended for GNU/Linux.
329
330
331 How to compile
332 ==============
333
334 You need GNU toolchain and newlib for 'arm-none-eabi' target.
335
336 There is "gcc-arm-embedded" project.  See:
337
338     https://launchpad.net/gcc-arm-embedded/
339
340
341 Change directory to `src':
342
343   $ cd gnuk-VERSION/src
344
345 Then, run `configure':
346
347   $ ./configure --vidpid=<VID:PID>
348
349 Here, you need to specify USB vendor ID and product ID.  For FSIJ's,
350 it's: --vidpid=234b:0000 .  Please read section 'USB vendor ID and
351 product ID' above.
352
353 Type:
354
355   $ make
356
357 Then, we will have "gnuk.elf" under src/build directory.
358
359
360 How to install
361 ==============
362
363 Olimex STM32-H103 board
364 -----------------------
365
366 If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
367
368   $ openocd -f interface/ftdi/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
369
370 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
371
372   $ telnet localhost 4444
373   > reset halt
374   > flash write_image erase gnuk.elf
375   > reset
376   > exit
377   $ 
378
379
380 Flying Stone Tiny 01
381 --------------------
382
383 If you are using Flying Stone Tiny 01, you need a SWD writer.  I am
384 using revision 946 of Simon Qian's Versaloon.
385
386     svn checkout -r 946 http://vsprog.googlecode.com/svn/trunk/
387
388 For OpenOCD, we need unofficial patch.
389
390 See the article of Versaloon Forum:
391
392     http://www.versaloon.com/bbs/viewtopic.php?p=16179
393
394
395 Type following to invoke OpenOCD:
396
397   $ openocd -f interface/vsllink.cfg -c "transport select swd" -c "swd_mode 2" -f target/stm32f1x.cfg
398
399 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
400
401   $ telnet localhost 4444
402   > reset halt
403   > flash write_image erase gnuk.elf
404   > reset
405   > exit
406   $ 
407
408 OpenOCD 0.6.1 now supports ST-Link/V2.  We can use it:
409
410   $ openocd -f interface/stlink-v2.cfg -f target/stm32f1x_stlink.cfg
411
412 But it doesn't support option bytes handling (protection) yet.
413
414
415 STBee
416 -----
417
418 Reset the board with "USER" switch pushed.  Type following to write
419 to flash:
420
421   # cd ../tool
422   # ./dfuse.py ../src/build/gnuk.hex
423
424 Then, reset the board.
425
426
427 How to protect flash ROM
428 ========================
429
430 Invoke your OpenOCD and type:
431
432   $ telnet localhost 4444
433   > reset halt
434   > stm32f1x lock 0
435   > reset
436   > shutdown
437
438 After power-off / power-on sequence, the contents of flash ROM cannot
439 be accessible from JTAG debugger.
440
441 Note that it would be still possible for some implementation of DfuSe
442 to access the contents.  If you want to protect, killing DfuSe and
443 accessing by JTAG debugger is recommended.
444
445
446 How to configure
447 ================
448
449 You need python and pyscard (python-pyscard package in Debian) or
450 PyUSB 0.4.3 (python-usb package in Debian).
451
452 (1) [pyscard] Stop scdaemon
453     [PyUSB] Stop the pcsc daemon.
454
455 If scdaemon is running, please kill it, or you will get "Smartcard
456 Exception" by "Sharing violation".
457
458   $ gpg-connect-agent "SCD KILLSCD" "SCD BYE" /bye
459
460 In case of PyUSB tool, you need to stop pcscd.
461
462   # /etc/init.d/pcscd stop
463
464
465 (2) [Optional] Write fixed serial number
466
467 If you use fixed serial number in the file 'GNUK_SERIAL_NUMBER', you can do:
468
469   $ EMAIL=<YOUR-EMAIL-ADDRESS> ../tool/gnuk_put_binary.py -s ../GNUK_SERIAL_NUMBER
470   Writing serial number
471   ...
472
473 (3) [Optional] Write card holder certificate
474
475 If you have card holder certificate binary file, you can do:
476
477   $ ../tool/gnuk_put_binary.py ../../<YOUR-CERTIFICATE>.bin
478   ../../<YOUR-CERTIFICATE>.bin: <LENGTH-OF-YOUR-CERTIFICATE>
479   Updating card holder certificate
480   ...
481
482
483 How to run
484 ==========
485
486 Debug enabled
487 -------------
488
489 If you compiled with --enable-debug option, Gnuk has two interfaces
490 (one is CCID/ICCD device and another is virtual COM port).  Open
491 virtual COM port by:
492
493   $ cu -l /dev/ttyACM0
494
495 and you will see debug output of Gnuk.
496
497
498 Testing Gnuk
499 ------------
500
501 Type following command to see Gnuk runs:
502
503   $ gpg --card-status
504
505
506 Besides, there is a functionality test under test/ directory.  See
507 test/README.
508
509
510 Personalize the Token, import keys, and change the password
511 -----------------------------------------------------------
512
513 You can personalize the token, putting your information like: Name,
514 Login name, Sex, Languages, URL.  To do so, GnuPG command is:
515
516   $ gpg --card-edit
517
518 Note that the factory setting of user password is "123456" and admin
519 password is "12345678" as the specification.
520
521 It is recommended to create your keys on your computer, and import
522 them to Gnuk Token.  After you create your keys (they must be 2048-bit
523 RSA), you can import them.
524
525 Gnuk supports key generation, but this feature is young and should be
526 considered experimental.
527
528 For detail, please see documentation under doc/.  You can see the HTML
529 version at: http://www.fsij.org/doc-gnuk/
530
531
532 How to debug
533 ============
534
535 We can use GDB.
536
537   $ arm-none-eabi-gdb gnuk.elf
538
539
540 Inside GDB, we can connect OpenOCD by:
541
542   (gdb) target remote localhost:3333
543
544
545 You can see the output of PCSCD:
546
547   # /etc/init.d/pcscd stop
548   # LIBCCID_ifdLogLevel=7 /usr/sbin/pcscd --debug --foreground
549
550
551 You can observe the traffic of USB using "usbmon".  See the file:
552 linux/Documentation/usb/usbmon.txt
553
554
555 Firmware update
556 ===============
557
558 See doc/note/firmware-update.
559
560
561 Git Repositories
562 ================
563
564 Please use: http://gitorious.org/gnuk
565
566 You can get it by:
567  
568     $ git clone git://gitorious.org/gnuk/gnuk.git
569
570 It's also available at: www.gniibe.org
571 You can browse at: http://www.gniibe.org/gitweb?p=gnuk.git;a=summary
572
573 I put Chopstx as a submodule of Git.  Please do this:
574
575   $ git submodule init
576   $ git submodule update
577
578 We have migrated from ChibiOS/RT to Chopstx.  If you have old code of
579 ChibiOS/RT, you need:
580
581     Edit .git/config to remove chibios reference
582     git rm --cached chibios
583
584
585 Information on the Web
586 ======================
587
588 Please visit: http://www.fsij.org/gnuk/
589
590
591 Your Contributions
592 ==================
593
594 FSIJ welcomes your contributions.  Please assign your copyright
595 to FSIJ (if possible).
596
597
598 Foot note
599 ==========
600 * NUK(R) is a registered trademark owend by MAPA GmbH, Germany.
601 --