implement key generation
[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         * Key generation on device side
139
140 It is known not-working well:
141
142         * For some version of kernel and libccid, --enable-debug can't
143           work well.  Please make sure to disable DEBUG option if it
144           doesn't work well.
145
146
147 Targets
148 =======
149
150 We use Olimex STM32-H103 board and Flying Stone Tiny 01 (FST-01).  We
151 also use STM32 part of STM8S Discovery Kit.
152
153 With DfuSe support, CQ STARM, STBee, and STBee Mini are also our
154 targets.  But those targets with DfuSe are basically not for normal
155 use but for experiments, because it would be impossible for DfuSe to
156 disable read from flash.  For real use, please consider killing DfuSe
157 and enabling read protection using JTAG debugger.
158
159 I think that it could run on Olimex STM32-P103, or other boards with
160 STM32F103.  Besides, we are porting it to STM32 Primer 2.
161
162 For PIN-pad support, I connect a consumer IR receive module to STBee
163 Mini and STM8S Discovery Kit, and use controller for TV.  PIN
164 verification is supported by this configuration.  Yes, it is not
165 secure at all, since it is very easy to monitor IR output of the
166 controllers.  It is just an experiment.  Note that hardware needed for
167 this experiment is only a consumer IR receive module which is as cheap
168 as 50 JPY.
169
170 Another PIN-pad support is connecting rotary encoder, push switch and
171 7-segment LED display.  Both of PIN verification and PIN modification
172 are supported for this circuit extension.
173
174 Also, there is "DnDpinentry" support.  This is using usual file
175 manager for pinentry.  User does "drag and drop" folders and it will
176 be pin entry.  This feature doesn't require any additional hardware.
177 See doc/settings-for-DnDpinentry for your desktop configuration.
178 However, this will be removed in future version, as it found it's
179 not that useful.
180
181 Note that you need pinpad support for GnuPG to use PIN-pad enabled
182 Gnuk.  The pinpad support for GnuPG is currently in the master branch
183 of GnuPG git repository at git.gnupg.org, and it's under evaluation.
184 When it will be considered stable, it will be put onto stable branch.
185
186
187 Souce code
188 ==========
189
190 Gnuk source code is under src/ directory.
191
192
193 License
194 =======
195
196 It is distributed under GNU General Public Licence version 3 or later
197 (GPLv3+).  Please see src/COPYING.
198
199 Please note that it is distributed with external source code too.
200 Please read relevant licenses for external source code, too.
201
202 The author(s) of Gnuk expect users of Gnuk will be able to access the
203 source code of Gnuk, so that users can study the code and can modify
204 if needed.  This doesn't mean person who has a USB Token by Gnuk
205 should be able to access everything on the Token, regardless of its
206 protections.  Private keys, and other information should be protected
207 properly.
208
209
210 External source code
211 ====================
212
213 Gnuk is distributed with external source code.
214
215 * ChibiOS_2.0.8/  -- ChibiOS/RT 2.0.8
216
217   Taken from http://chibios.sourceforge.net/
218   Note that CRLF is converted to LF in this repository.
219   We use ChibiOS/RT as the kernel for Gnuk.
220
221 * polarssl-0.14.0/  -- PolarSSL 0.14.0
222
223   Taken from http://polarssl.org/
224   We use PolarSSL for RSA computation, AES encryption/decryption
225   and SHA-1 computation.
226
227   The file include/polarssl/bn_mul.h is heavily modified for ARM
228   Cortex-M3.
229
230   The files include/polarssl/rsa.h, library/rsa.c,
231   include/polarssl/bignum.h, and library/bignum.c are modified so that
232   f_rng function returns unsigned char.
233
234   The file library/rsa.c is modified so that it only computes things
235   needed for Gnuk.
236
237   The file library/aes.c is modified so that some constants can
238   go to .sys section.
239
240
241 USB vendor ID and product ID (USB device ID)
242 ============================================
243
244 When you have a vender ID and assign a product ID for Gnuk, edit the
245 file GNUK_USB_DEVICE_ID and add an entry for yours.  In this case,
246 please contact Niibe, so that it is listed to the file in the official
247 release of the source code.
248
249 When you are modifing Gnuk and installing the binary to device, you
250 should replace "FSIJ" in the string gnukStringSerial (usb_desc.c) to
251 yours, so that the device will say it's modified version by device
252 serial number.
253
254 FSIJ allows you to use USB device ID of FSIJ (234b:0000) for devices
255 with Gnuk under one of following conditions:
256
257   * For everyone for experimental purpose:
258
259     - You must not distribute a binary with FSIJ's USB device ID, but
260       must use the binary by yourself only for your experiment.  Note
261       that "Distributing binary" includes distributing a device which
262       holds the binary.
263
264   * For general individuals:
265
266     - You must use your Gnuk device with a card serial number which is
267       *not* by FSIJ.  Easy one would be a card serial number generated
268       by chip unique ID.
269
270   * For individuals with explicit permission from FSIJ.
271
272     - You should have an assigned card serial number by FSIJ,
273       please use that number for your device.
274       (There a file 'GNUK_SERIAL_NUMBER' in the official release.)
275
276 FSIJ could give companies or business entities "second source
277 manufacturer" license to use USB device ID of FSIJ for devices with
278 unmodified version of Gnuk, provided they support Free Software and
279 respect users' freedom for computing.  Please ask FSIJ for the
280 license.
281
282 Otherwise, companies which want to distribute Gnuk devices, please use
283 your own USB vendor ID and product ID.  Note that please replace
284 "FSIJ" in the string gnukStringSerial (usb_desc.c) to yours, when you
285 modify Gnuk.
286
287
288 Host Requirements
289 =================
290
291 For GNU/Linux, libccid version >= 1.3.11 is recommended.
292
293 I think that it should not be requirment but the kernel version of my use is:
294 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
295
296 Linux 2.6.30 is known *NOT* working well with DEBUG option.
297 Linux 2.6.24 is known working well with DEBUG option.
298
299
300 How to compile
301 ==============
302
303 You need GNU toolchain and newlib for 'arm-none-eabi' target.
304
305 See http://github.com/esden/summon-arm-toolchain/ (which includes fix
306 of binutils-2.21.1) for preparation of GNU Toolchain for
307 'arm-none-eabi' target.
308
309 # Note that we need to link correct C library (for string functions).
310 # For this purpose, Makefile.in contains following line:
311
312 #       MCFLAGS= -mcpu=$(MCU) -mfix-cortex-m3-ldrd
313
314 # This should not be needed (as -mcpu=cortex-m3 means
315 # -mfix-cortex-m3-ldrd), but in practice it is needed for 
316 # the configuration of patch-gcc-config-arm-t-arm-elf.diff in
317 # summon-arm-toolchain.
318
319 # In ChibiOS_2.0.8/os/ports/GCC/ARM/rules.mk, it specifies
320 # -mno-thumb-interwork option.  This means that you should not
321 # link C library which contains ARM (not Thumb) code.
322
323
324 Change directory to `src':
325
326   $ cd gnuk-VERSION/src
327
328 Then, run `configure':
329
330   $ ./configure --vidpid=<VID:PID>
331
332 Here, you need to specify USB vendor ID and product ID.  For FSIJ's,
333 it's: --vidpid=234b:0000 .  Please read section 'USB vendor ID and
334 product ID' above.
335
336 Type:
337
338   $ make
339
340 Then, we will have "gnuk.elf".
341
342
343 How to install
344 ==============
345
346 Olimex STM32-H103 board
347 -----------------------
348
349 If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
350
351   $ openocd -f interface/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
352
353 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
354
355   $ telnet localhost 4444
356   > reset halt
357   > flash write_image erase gnuk.elf
358   > reset
359   > exit
360   $ 
361
362
363 Flying Stone Tiny 01
364 --------------------
365
366 If you are using Flying Stone Tiny 01, you need a SWD writer.  I am
367 using revision 946 of Simon Qian's Versaloon.
368
369     svn checkout -r 946 http://vsprog.googlecode.com/svn/trunk/
370
371 For OpenOCD, we need unofficial patch.
372
373 See the article of Versaloon Forum:
374
375     http://www.versaloon.com/bbs/viewtopic.php?p=16179
376
377
378 Type following to invoke OpenOCD:
379
380   $ openocd -f interface/vsllink.cfg -c "transport select swd" -c "swd_mode 2" -f target/stm32f1x.cfg
381
382 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
383
384   $ telnet localhost 4444
385   > reset halt
386   > flash write_image erase gnuk.elf
387   > reset
388   > exit
389   $ 
390
391
392
393 STM8S Discovery Kit
394 -------------------
395
396 If you are using FTDI-2232D module and the connection is standard, type:
397
398   $ openocd -f interface/openocd-usb.cfg -f target/stm32.cfg
399
400 Initially, the flash ROM of the chip is protected.  you need to do:
401
402   $ telnet localhost 4444
403   > reset halt
404   > stm32x unlock 0
405   > reset
406   > shutdown
407   $ 
408
409 and re-connect the board.  Note that power-off / power-on sequence is
410 required to reset flash ROM.
411
412 Then, invoke OpenOCD again and telnet to connect OpenCD and write
413 image as above example of Olimex STM32-H103.
414
415
416 CQ STARM
417 --------
418
419 Put jumper for J6 to enable DfuSe.  Connecting the board, and type:
420
421   # cd ../tool
422   # ./dfuse.py ../src/gnuk.hex
423
424 Then, remove the jumper and reset the board.
425
426
427 STBee and STBee Mini
428 --------------------
429
430 Reset the board with "USER" switch pushed.  Type following to write
431 to flash:
432
433   # cd ../tool
434   # ./dfuse.py ../src/gnuk.hex
435
436 Then, reset the board.
437
438
439 How to protect flash ROM
440 ========================
441
442 Invoke your OpenOCD and type:
443
444   $ telnet localhost 4444
445   > reset halt
446   > stm32x lock 0
447   > reset
448   > shutdown
449
450 After power-off / power-on sequence, the contents of flash ROM cannot
451 be accessible from JTAG debugger.
452
453 Note that it would be still possible for some implementation of DfuSe
454 to access the contents.  If you want to protect, killing DfuSe and
455 accessing by JTAG debugger is recommended.
456
457
458 How to configure
459 ================
460
461 You need python and pyscard (python-pyscard package in Debian) or
462 PyUSB (python-usb package in Debian).
463
464 (1) [pyscard] Stop scdaemon
465     [PyUSB] Stop the pcsc daemon.
466
467 If scdaemon is running, please kill it, or you will get "Smartcard
468 Exception" by "Sharing violation".
469
470   $ killall -9 scdaemon
471
472 In case of PyUSB tool, you need to stop pcscd.
473
474   # /etc/init.d/pcscd stop
475
476
477 (2) [Optional] Write fixed serial number
478
479 If you use fixed serial number in the file 'GNUK_SERIAL_NUMBER', you can do:
480
481   $ EMAIL=<YOUR-EMAIL-ADDRESS> ../tool/gnuk_put_binary.py -s ../GNUK_SERIAL_NUMBER
482   Writing serial number
483   ...
484
485 (3) [Optional] Write card holder certificate
486
487 If you have card holder certificate binary file, you can do:
488
489   $ ../tool/gnuk_put_binary.py ../../<YOUR-CERTIFICATE>.bin
490   ../../<YOUR-CERTIFICATE>.bin: <LENGTH-OF-YOUR-CERTIFICATE>
491   Updating card holder certificate
492   ...
493
494
495 How to run
496 ==========
497
498 Debug enabled
499 -------------
500
501 If you compiled with --enable-debug option, Gnuk has two interfaces
502 (one is CCID/ICCD device and another is virtual COM port).  Open
503 virtual COM port by:
504
505   $ cu -l /dev/ttyACM0
506
507 and you will see debug output of Gnuk.
508
509
510 Libccid fix needed
511 ------------------
512
513 For libccid (< 1.4.1), we need following change:
514
515 --- /etc/libccid_Info.plist.dpkg-dist   2009-07-29 06:50:20.000000000 +0900
516 +++ /etc/libccid_Info.plist     2010-09-05 09:09:49.000000000 +0900
517 @@ -104,6 +104,7 @@
518  
519         <key>ifdVendorID</key>
520         <array>
521 +               <string>0x234B</string>
522                 <string>0x08E6</string>
523                 <string>0x08E6</string>
524                 <string>0x08E6</string>
525 @@ -237,6 +238,7 @@
526  
527         <key>ifdProductID</key>
528         <array>
529 +               <string>0x0000</string>
530                 <string>0x2202</string>
531                 <string>0x3437</string>
532                 <string>0x3438</string>
533 @@ -370,6 +372,7 @@
534  
535         <key>ifdFriendlyName</key>
536         <array>
537 +               <string>FSIJ USB Token</string>
538                 <string>Gemplus Gem e-Seal Pro</string>
539                 <string>Gemplus GemPC Twin</string>
540                 <string>Gemplus GemPC Key</string>
541 ------------------
542
543 This entry has been added into libccid 1.4.1 already ([r5425]).
544
545
546 Testing Gnuk
547 ------------
548
549 Try following to see Gnuk runs:
550
551   $ gpg --card-status
552
553
554 Personalize the Token and import keys
555 -------------------------------------
556
557 You can personalize the token, putting your information like: Name,
558 Login name, Sex, Languages, URL, etc., and password.  To do so, GnuPG
559 command is:
560
561   $ gpg --card-edit
562
563 Note that the factory setting of user password is "123456" and admin
564 password is "12345678" as the specification.
565
566 It is recommended to create your keys on your computer, and import
567 them to Gnuk Token.  After you create your keys (they must be 2048-bit
568 RSA), you can import them.
569
570 Gnuk supports key generation, but this feature is young and should be
571 considered experimental.
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 on your computer 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 --