8ff59250a54b23a9768a992ce925643824c670a5
[gnuk/gnuk.git] / README
1 Gnuk - software for GnuPG USB Token
2
3                                                            Version 0.19
4                                                              2012-06-06
5                                                            Niibe Yutaka
6                                       Free Software Initiative of Japan
7
8 What's Gnuk?
9 ============
10
11 Gnuk is software implementation of a USB token for GNU Privacy Guard.
12 Gnuk supports OpenPGP card protocol version 2, and it runs on
13 STM32F103 processor.
14
15 I wish that Gnuk will be a developer's soother who uses GnuPG.  I have
16 been nervous of storing secret key(s) on usual secondary storage.
17 There is a solution with OpenPGP card, but it is not the choice for me
18 to bring a card reader all the time.  With Gnuk, this issue will be
19 solved by a USB token which is small enough.
20
21 Please look at the graphics of "gnuk.svg" for the software name.  My
22 son used to be with his NUK(R), always, everywhere.  I am with a USB
23 Token by "Gnuk", always, everywhere.
24
25
26 FAQ
27 ===
28
29 Q0: How Gnuk USB Token is superior than other solutions (OpenPGP
30     card 2.0, GPF Crypto Stick, etc.) ?
31     http://www.g10code.de/p-card.html
32     http://www.privacyfoundation.de/crypto_stick/
33 A0: IMRHO, not quite, since there is no ready-to-use out-of-box Gnuk
34     product yet.  (It is welcome for me that some vendor will
35     manufacture Gnuk USB Token.  Even I can help design of hardware,
36     if needed.)
37     Good points for Gnuk are:
38     * If you have skill of electronics and like DIY, you can build
39       Gnuk Token cheaper (see Q8-A8).
40     * You can study Gnuk to modify and to enhance.  For example, you
41       can implement your own authentication method with some sensor
42       such as acceleration sensor.
43     * It is "of Free Software"; Gnuk is distributed under GPLv3+,
44             "by Free Software"; Gnuk development requires only Free Software
45                                 (GNU Toolchain, Python, etc.), 
46             "for Free Software"; Gnuk supports GnuPG.
47
48 Q1: What kind of key algorithm is supported?
49 A1: Gnuk only supports 2048-bit RSA.
50
51 Q2: How long does it take for digital signing?
52 A2: It takes a second and a half or so. 
53
54 Q3: What's your recommendation for target board?
55 A3: Orthodox choice is Olimex STM32-H103.
56     If you have skill of electronics and like DIY, STM32 part of STM8S
57     Discovery Kit might be the best choice.
58     Currently FST-01 (Flying Stone Tiny 01) is under development,
59     it will be the best choice, hopefully.
60
61 Q4: What's version of GnuPG are you using?
62 A4: In Debian GNU/Linux system, I use gnupg 1.4.11-3 and gnupg-agent
63     2.0.14-2 (in sid).  With older versions, you can only sign with SHA1.
64     See: http://www.fsij.org/gnuk/gnupg2-fixes-needed
65
66 Q5: What's version of pcscd and libccid are you using?
67 A5: In Debian GNU/Linux system, I use pcscd 1.5.5-4 and libccid 1.3.11-2,
68     which is in squeeze.  Note that you need to edit /etc/libccid_Info.plist
69     when using libccid (< 1.4.1).
70
71 Q6: What kinds of hardware is required for development?
72 A6: You need a target board plus a JTAG debugger.  If you just want to
73     test Gnuk for target boards with DfuSe, JTAG debugger is not
74     the requirement.  Note that for real use, you need JTAG debugger
75     to enable flash ROM protection.
76
77 Q7: How much does it cost?
78 A7: Olimex STM32-H103 plus ARM-USB-TINY-H cost 70 Euro or so.
79
80 Q8: How much does it cost for DIY version?
81 A8: STM8S Discovery Kit costs 750 JPY (< $10 USD) only.  You can build
82     your own JTAG debugger using FTDI2232 module (1450 JPY), see:
83     http://www.fsij.org/gnuk/jtag_dongle_ftdi2232
84
85 Q9: I got an error like "gpg: selecting openpgp failed: ec=6.108", what's up?
86 A9: GnuPG's SCDaemon has problems for handling insertion/removal of
87     card/reader (problems are fixed in trunk).  When your newly
88     inserted token is not found by GnuPG, try killing scdaemon and let
89     it to be invoked again.  I do:
90       $ killall -9 scdaemon
91     and confirm scdaemon doesn't exist, then,
92       $ gpg-connect-agent learn /bye
93
94 Qa: With GNOME 2, I can't use Gnuk Token for SSH.  How can we use it for SSH?
95 Aa: You need to deactivate seahorse-agent and gnome-keyring, but use
96     gpg-agant for the role of ssh-agent.  For gnome-keyring please do:
97
98       $ gconftool-2 --type bool --set /apps/gnome-keyring/daemon-components/ssh false
99
100 Qb: With GNOME 3, I can't use Gnuk Token at all.  Why?
101 Ab: That's because gnome-keyring-daemon interferes GnuPG.  Type:
102
103       $ gnome-session-properties
104
105     and at the tab of "Startup Programs", disable check buttons for
106     "GPG Password Agent" and "SSH Key Agent".
107
108 Qc: Do you know a good SWD debugger to connect FST-01 or something?
109 Ac: STLink v2 is cheap one.  See http://code.google.com/p/arm-utilities/
110     for a control program.
111
112
113 Release notes
114 =============
115
116 This is twentieth release of Gnuk.  In this release, firmware upgrade
117 feature is added.  While it is daily use, some features (including
118 firmware upgrade) are still considered experimental.
119
120 Tested features are:
121
122         * Personalization of the card
123           * Changing Login name, URL, Name, Sex, Language, etc.
124         * Password handling (PW1, RC, PW3)
125         * Key import for three types:
126           * key for digital signing
127           * key for decryption
128           * key for authentication
129         * PSO: Digital Signature
130         * PSO: Decipher
131         * INTERNAL AUTHENTICATE
132         * Changing value of password status bytes (0x00C4): forcesig
133         * Verify with pin pad
134         * Modify with pin pad
135         * Card holder certificate
136         * Removal of keys (Overriding key import is not supported,
137           but you can remove all keys to import again).
138
139 It is known not-working well:
140
141         * For some version of kernel and libccid, --enable-debug can't
142           work well.  Please make sure to disable DEBUG option if it
143           doesn't work well.
144
145 Not supported feature(s):
146
147         * Key generation on device side
148
149
150 Targets
151 =======
152
153 We use Olimex STM32-H103 board and Flying Stone Tiny 01 (FST-01).  We
154 also use STM32 part of STM8S Discovery Kit.
155
156 With DfuSe support, CQ STARM, STBee, and STBee Mini are also our
157 targets.  But those targets with DfuSe are basically not for normal
158 use but for experiments, because it would be impossible for DfuSe to
159 disable read from flash.  For real use, please consider killing DfuSe
160 and enabling read protection using JTAG debugger.
161
162 I think that it could run on Olimex STM32-P103, or other boards with
163 STM32F103.  Besides, we are porting it to STM32 Primer 2.
164
165 For PIN-pad support, I connect a consumer IR receive module to STBee
166 Mini and STM8S Discovery Kit, and use controller for TV.  PIN
167 verification is supported by this configuration.  Yes, it is not
168 secure at all, since it is very easy to monitor IR output of the
169 controllers.  It is just an experiment.  Note that hardware needed for
170 this experiment is only a consumer IR receive module which is as cheap
171 as 50 JPY.
172
173 Another PIN-pad support is connecting rotary encoder, push switch and
174 7-segment LED display.  Both of PIN verification and PIN modification
175 are supported for this circuit extension.
176
177 Also, there is "DnDpinentry" support.  This is using usual file
178 manager for pinentry.  User does "drag and drop" folders and it will
179 be pin entry.  This feature doesn't require any additional hardware.
180 See doc/settings-for-DnDpinentry for your desktop configuration.
181 However, this will be removed in future version, as it found it's
182 not that useful.
183
184 Note that you need pinpad support for GnuPG to use PIN-pad enabled
185 Gnuk.  The pinpad support for GnuPG is currently in the master branch
186 of GnuPG git repository at git.gnupg.org, and it's under evaluation.
187 When it will be considered stable, it will be put onto stable branch.
188
189
190 Souce code
191 ==========
192
193 Gnuk source code is under src/ directory.
194
195
196 License
197 =======
198
199 It is distributed under GNU General Public Licence version 3 or later
200 (GPLv3+).  Please see src/COPYING.
201
202 Please note that it is distributed with external source code too.
203 Please read relevant licenses for external source code, too.
204
205 The author(s) of Gnuk expect users of Gnuk will be able to access the
206 source code of Gnuk, so that users can study the code and can modify
207 if needed.  This doesn't mean person who has a USB Token by Gnuk
208 should be able to access everything on the Token, regardless of its
209 protections.  Private keys, and other information should be protected
210 properly.
211
212
213 External source code
214 ====================
215
216 Gnuk is distributed with external source code.
217
218 * ChibiOS_2.0.8/  -- ChibiOS/RT 2.0.8
219
220   Taken from http://chibios.sourceforge.net/
221   Note that CRLF is converted to LF in this repository.
222   We use ChibiOS/RT as the kernel for Gnuk.
223
224 * polarssl-0.14.0/  -- PolarSSL 0.14.0
225
226   Taken from http://polarssl.org/
227   We use PolarSSL for RSA computation, AES encryption/decryption
228   and SHA-1 computation.
229
230   The file include/polarssl/bn_mul.h is heavily modified for ARM
231   Cortex-M3.
232
233   The files include/polarssl/rsa.h, library/rsa.c,
234   include/polarssl/bignum.h, and library/bignum.c are modified so that
235   f_rng function returns unsigned char.
236
237   The file library/rsa.c is modified so that it only computes things
238   needed for Gnuk.
239
240   The file library/aes.c is modified so that some constants can
241   go to .sys section.
242
243
244 USB vendor ID and product ID (USB device ID)
245 ============================================
246
247 When you have a vender ID and assign a product ID for Gnuk, edit the
248 file GNUK_USB_DEVICE_ID and add an entry for yours.  In this case,
249 please contact Niibe, so that it is listed to the file in the official
250 release of the source code.
251
252 When you are modifing Gnuk and installing the binary to device, you
253 should replace "FSIJ" in the string gnukStringSerial (usb_desc.c) to
254 yours, so that the device will say it's modified version by device
255 serial number.
256
257 FSIJ allows you to use USB device ID of FSIJ (234b:0000) for devices
258 with Gnuk under one of following conditions:
259
260   * For everyone for experimental purpose:
261
262     - You must not distribute a binary with FSIJ's USB device ID, but
263       must use the binary by yourself only for your experiment.  Note
264       that "Distributing binary" includes distributing a device which
265       holds the binary.
266
267   * For general individuals:
268
269     - You must use your Gnuk device with a card serial number which is
270       *not* by FSIJ.  Easy one would be a card serial number generated
271       by chip unique ID.
272
273   * For individuals with explicit permission from FSIJ.
274
275     - You should have an assigned card serial number by FSIJ,
276       please use that number for your device.
277       (There a file 'GNUK_SERIAL_NUMBER' in the official release.)
278
279 FSIJ could give companies or business entities "second source
280 manufacturer" license to use USB device ID of FSIJ for devices with
281 unmodified version of Gnuk, provided they support Free Software and
282 respect users' freedom for computing.  Please ask FSIJ for the
283 license.
284
285 Otherwise, companies which want to distribute Gnuk devices, please use
286 your own USB vendor ID and product ID.  Note that please replace
287 "FSIJ" in the string gnukStringSerial (usb_desc.c) to yours, when you
288 modify Gnuk.
289
290
291 Host Requirements
292 =================
293
294 For GNU/Linux, libccid version >= 1.3.11 is recommended.
295
296 I think that it should not be requirment but the kernel version of my use is:
297 Linux version 2.6.32-5-686 (Debian 2.6.32-18) (ben@decadent.org.uk) (gcc version 4.3.5 (Debian 4.3.5-2) ) #1 SMP Sat Jul 24 02:27:10 UTC 2010
298
299 Linux 2.6.30 is known *NOT* working well with DEBUG option.
300 Linux 2.6.24 is known working well with DEBUG option.
301
302
303 How to compile
304 ==============
305
306 You need GNU toolchain and newlib for 'arm-none-eabi' target.
307
308 See http://github.com/esden/summon-arm-toolchain/ (which includes fix
309 of binutils-2.21.1) for preparation of GNU Toolchain for
310 'arm-none-eabi' target.
311
312 # Note that we need to link correct C library (for string functions).
313 # For this purpose, Makefile.in contains following line:
314
315 #       MCFLAGS= -mcpu=$(MCU) -mfix-cortex-m3-ldrd
316
317 # This should not be needed (as -mcpu=cortex-m3 means
318 # -mfix-cortex-m3-ldrd), but in practice it is needed for 
319 # the configuration of patch-gcc-config-arm-t-arm-elf.diff in
320 # summon-arm-toolchain.
321
322 # In ChibiOS_2.0.8/os/ports/GCC/ARM/rules.mk, it specifies
323 # -mno-thumb-interwork option.  This means that you should not
324 # link C library which contains ARM (not Thumb) code.
325
326
327 Change directory to `src':
328
329   $ cd gnuk-VERSION/src
330
331 Then, run `configure':
332
333   $ ./configure --vidpid=<VID:PID>
334
335 Here, you need to specify USB vendor ID and product ID.  For FSIJ's,
336 it's: --vidpid=234b:0000 .  Please read section 'USB vendor ID and
337 product ID' above.
338
339 Type:
340
341   $ make
342
343 Then, we will have "gnuk.elf".
344
345
346 How to install
347 ==============
348
349 Olimex STM32-H103 board
350 -----------------------
351
352 If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
353
354   $ openocd -f interface/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
355
356 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
357
358   $ telnet localhost 4444
359   > reset halt
360   > flash write_image erase gnuk.elf
361   > reset
362   > exit
363   $ 
364
365
366 Flying Stone Tiny 01
367 --------------------
368
369 If you are using Flying Stone Tiny 01, you need a SWD writer.  I am
370 using revision 946 of Simon Qian's Versaloon.
371
372     svn checkout -r 946 http://vsprog.googlecode.com/svn/trunk/
373
374 For OpenOCD, we need unofficial patch.
375
376 See the article of Versaloon Forum:
377
378     http://www.versaloon.com/bbs/viewtopic.php?p=16179
379
380
381 Type following to invoke OpenOCD:
382
383   $ openocd -f interface/vsllink.cfg -c "transport select swd" -c "swd_mode 2" -f target/stm32f1x.cfg
384
385 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
386
387   $ telnet localhost 4444
388   > reset halt
389   > flash write_image erase gnuk.elf
390   > reset
391   > exit
392   $ 
393
394
395
396 STM8S Discovery Kit
397 -------------------
398
399 If you are using FTDI-2232D module and the connection is standard, type:
400
401   $ openocd -f interface/openocd-usb.cfg -f target/stm32.cfg
402
403 Initially, the flash ROM of the chip is protected.  you need to do:
404
405   $ telnet localhost 4444
406   > reset halt
407   > stm32x unlock 0
408   > reset
409   > shutdown
410   $ 
411
412 and re-connect the board.  Note that power-off / power-on sequence is
413 required to reset flash ROM.
414
415 Then, invoke OpenOCD again and telnet to connect OpenCD and write
416 image as above example of Olimex STM32-H103.
417
418
419 CQ STARM
420 --------
421
422 Put jumper for J6 to enable DfuSe.  Connecting the board, and type:
423
424   # cd ../tool
425   # ./dfuse.py ../src/gnuk.hex
426
427 Then, remove the jumper and reset the board.
428
429
430 STBee and STBee Mini
431 --------------------
432
433 Reset the board with "USER" switch pushed.  Type following to write
434 to flash:
435
436   # cd ../tool
437   # ./dfuse.py ../src/gnuk.hex
438
439 Then, reset the board.
440
441
442 How to protect flash ROM
443 ========================
444
445 Invoke your OpenOCD and type:
446
447   $ telnet localhost 4444
448   > reset halt
449   > stm32x lock 0
450   > reset
451   > shutdown
452
453 After power-off / power-on sequence, the contents of flash ROM cannot
454 be accessible from JTAG debugger.
455
456 Note that it would be still possible for some implementation of DfuSe
457 to access the contents.  If you want to protect, killing DfuSe and
458 accessing by JTAG debugger is recommended.
459
460
461 How to configure
462 ================
463
464 You need python and pyscard (python-pyscard package in Debian) or
465 PyUSB (python-usb package in Debian).
466
467 (1) [pyscard] Stop scdaemon
468     [PyUSB] Stop the pcsc daemon.
469
470 If scdaemon is running, please kill it, or you will get "Smartcard
471 Exception" by "Sharing violation".
472
473   $ killall -9 scdaemon
474
475 In case of PyUSB tool, you need to stop pcscd.
476
477   # /etc/init.d/pcscd stop
478
479
480 (2) [Optional] Write fixed serial number
481
482 If you use fixed serial number in the file 'GNUK_SERIAL_NUMBER', you can do:
483
484   $ EMAIL=<YOUR-EMAIL-ADDRESS> ../tool/gnuk_put_binary.py -s ../GNUK_SERIAL_NUMBER
485   Writing serial number
486   ...
487
488 (3) [Optional] Write card holder certificate
489
490 If you have card holder certificate binary file, you can do:
491
492   $ ../tool/gnuk_put_binary.py ../../<YOUR-CERTIFICATE>.bin
493   ../../<YOUR-CERTIFICATE>.bin: <LENGTH-OF-YOUR-CERTIFICATE>
494   Updating card holder certificate
495   ...
496
497
498 How to run
499 ==========
500
501 Debug enabled
502 -------------
503
504 If you compiled with --enable-debug option, Gnuk has two interfaces
505 (one is CCID/ICCD device and another is virtual COM port).  Open
506 virtual COM port by:
507
508   $ cu -l /dev/ttyACM0
509
510 and you will see debug output of Gnuk.
511
512
513 Libccid fix needed
514 ------------------
515
516 For libccid (< 1.4.1), we need following change:
517
518 --- /etc/libccid_Info.plist.dpkg-dist   2009-07-29 06:50:20.000000000 +0900
519 +++ /etc/libccid_Info.plist     2010-09-05 09:09:49.000000000 +0900
520 @@ -104,6 +104,7 @@
521  
522         <key>ifdVendorID</key>
523         <array>
524 +               <string>0x234B</string>
525                 <string>0x08E6</string>
526                 <string>0x08E6</string>
527                 <string>0x08E6</string>
528 @@ -237,6 +238,7 @@
529  
530         <key>ifdProductID</key>
531         <array>
532 +               <string>0x0000</string>
533                 <string>0x2202</string>
534                 <string>0x3437</string>
535                 <string>0x3438</string>
536 @@ -370,6 +372,7 @@
537  
538         <key>ifdFriendlyName</key>
539         <array>
540 +               <string>FSIJ USB Token</string>
541                 <string>Gemplus Gem e-Seal Pro</string>
542                 <string>Gemplus GemPC Twin</string>
543                 <string>Gemplus GemPC Key</string>
544 ------------------
545
546 This entry has been added into libccid 1.4.1 already ([r5425]).
547
548
549 Testing Gnuk
550 ------------
551
552 Try following to see Gnuk runs:
553
554   $ gpg --card-status
555
556
557 Personalize the Token and import keys
558 -------------------------------------
559
560 You can personalize the token, putting your information like: Name,
561 Login name, Sex, Languages, URL, etc., and password.  To do so, GnuPG
562 command is:
563
564   $ gpg --card-edit
565
566 Note that the factory setting of user password is "123456" and admin
567 password is "12345678" as the specification.
568
569 No, Gnuk doesn't support key generation.  You need to create your
570 keys on your computer, and import them to Gnuk Token.  After you create
571 your keys (they must be 2048-bit RSA), you can import them.
572
573 For detail, please see doc/DEMO and doc/DEMO-2.
574
575 Note that it make sense to preserve your keys on your computer so that
576 you can import the keys (again) to (possibly another) Gnuk Token.  In
577 this case, you can use GnuPG's option to specify the home directory by
578 --homedir.
579
580 After creating keys by:
581
582   $ gpg --gen-key
583   ...
584
585 Copy directory which contains your secret keys to new directory named
586 <gpgdir-with-your-secret-keys>:
587
588   $ cp -pa $HOME/.gnupg <gpgdir-with-your-secret-keys>
589
590 Then, import keys by:
591
592   $ gpg --edit-key <YOUR-KEYID>
593
594 While your $HOME/.gnupg now doesn't have your secret keys after
595 import, <gpgdir-with-your-secret-keys> still has them.  You can again
596 import them by:
597
598   $ gpg --homedir=<gpgdir-with-your-secret-keys> --edit-key <YOUR-KEYID>
599
600 Note that you *should not* save changes this time to preserve keys
601 on your computer.  The session goes like this:
602
603   gpg> quit
604   Save changes? (y/N) n
605   Quit without saving? (y/N) y
606
607
608
609 How to debug
610 ============
611
612 We can use GDB.
613
614   $ arm-none-eabi-gdb gnuk.elf
615
616
617 Inside GDB, we can connect OpenOCD by:
618
619   (gdb) target remote localhost:3333
620
621
622 You can see the output of PCSCD:
623
624   # /etc/init.d/pcscd stop
625   # LIBCCID_ifdLogLevel=7 /usr/sbin/pcscd --debug --foreground
626
627
628 You can observe the traffic of USB using "usbmon".  See the file:
629 linux/Documentation/usb/usbmon.txt
630
631
632 Firmware update
633 ===============
634
635 See doc/firmware-update.
636
637
638 Read-only Git Repository
639 ========================
640
641 You can browse at http://www.gniibe.org/gitweb?p=gnuk.git;a=summary
642
643 You can get it by:
644
645   $ git clone git://www.gniibe.org/gnuk.git/
646
647 or
648
649   $ git clone http://www.gniibe.org/git/gnuk.git/
650
651
652
653 Information on the Web
654 ======================
655
656 Please visit: http://www.fsij.org/gnuk/
657
658
659 Your Contributions
660 ==================
661
662 FSIJ welcomes your contributions.  Please assign your copyright
663 to FSIJ (if possible).
664
665
666 Foot note
667 ==========
668 * NUK(R) is a registered trademark owend by MAPA GmbH, Germany.
669 --