version 0.17
[gnuk/gnuk.git] / README
1 Gnuk - software for GnuPG USB Token
2
3                                                            Version 0.17
4                                                              2012-02-02
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 While I want to work at different places, but it is not the choice for
18 me 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.  There is no ready-to-use out-of-box product.
34     (It is welcome for me that some vendor will manufacture Gnuk USB
35      Token.  Even I can help design of hardware, if needed.)
36     Good points are:
37     * If you have skill of electronics and like DIY, you can build
38       Gnuk Token cheaper (see Q8-A8).
39     * You can study Gnuk to modify and to enhance.  For example, you
40       can implement your own authentication method with some sensor
41       such as acceleration sensor.
42     * It is "of Free Software"; Gnuk is distributed under GPLv3+,
43             "by Free Software"; Gnuk development requires only Free Software
44                                 (GNU Toolchain, Python, etc.), 
45             "for Free Software"; Gnuk supports GnuPG.
46
47 Q1: What kind of key algorithm is supported?
48 A1: Gnuk only supports 2048-bit RSA.
49
50 Q2: How long does it take for digital signing?
51 A2: It takes a second and a half or so. 
52
53 Q3: What's your recommendation for target board?
54 A3: Orthodox choice is Olimex STM32-H103.
55     If you have skill of electronics and like DIY, STM32 part of STM8S
56     Discovery Kit might be the best choice.
57     Currently FST-01 (Flying Stone Tiny 01) is under development,
58     it will be the best choice, hopefully.
59
60 Q4: What's version of GnuPG are you using?
61 A4: In Debian GNU/Linux system, I use gnupg 1.4.11-3 and gnupg-agent
62     2.0.14-2 (in sid).  With older versions, you can only sign with SHA1.
63     See: http://www.fsij.org/gnuk/gnupg2-fixes-needed
64
65 Q5: What's version of pcscd and libccid are you using?
66 A5: In Debian GNU/Linux system, I use pcscd 1.5.5-4 and libccid 1.3.11-2,
67     which is in squeeze.  Note that you need to edit /etc/libccid_Info.plist
68     when using libccid (< 1.4.1).
69
70 Q6: What kinds of hardware is required for development?
71 A6: You need a target board plus a JTAG debugger.  If you just want to
72     test Gnuk for target boards with DfuSe, JTAG debugger is not
73     the requirement.  Note that for real use, you need JTAG debugger
74     to enable flash ROM protection.
75
76 Q7: How much does it cost?
77 A7: Olimex STM32-H103 plus ARM-USB-TINY-H cost 70 Euro or so.
78
79 Q8: How much does it cost for DIY version?
80 A8: STM8S Discovery Kit costs 750 JPY (< $10 USD) only.  You can build
81     your own JTAG debugger using FTDI2232 module (1450 JPY), see:
82     http://www.fsij.org/gnuk/jtag_dongle_ftdi2232
83
84 Q9: I got an error like "gpg: selecting openpgp failed: ec=6.108", what's up?
85 A9: GnuPG's SCDaemon has problems for handling insertion/removal of
86     card/reader (problems are fixed in trunk).  When your newly
87     inserted token is not found by GnuPG, try killing scdaemon and let
88     it to be invoked again.  I do:
89       $ killall -9 scdaemon
90     and confirm scdaemon doesn't exist, then,
91       $ gpg-connect-agent learn /bye
92
93 Qa: With GNOME, I can't use Gnuk Token for SSH.  How can we use it for SSH?
94 Aa: You need to deactivate seahorse-agent and gnome-keyring, but use
95     gpg-agant for the role of ssh-agent.  For gnome-keyring please do:
96
97       $ gconftool-2 --type bool --set /apps/gnome-keyring/daemon-components/ssh false
98
99 Qb: With GNOME 3, I can't use Gnuk Token at all.  Why?
100 Ab: That's because gnome-keyring-daemon interferes GnuPG.  Type:
101
102       $ gnome-session-properties
103
104     and at the tab of "Startup Programs", disable check buttons for
105     "GPG Password Agent" and "SSH Key Agent".
106
107 Qc: Do you know a good SWD debugger to connect FST-01 or something?
108 Ac: Perhaps, you can use a part of STM32F4 Discovery Kit as SWD
109     debugger.  It seems that there is a free software tool for that.
110
111
112 Release notes
113 =============
114
115 This is eighteenth release of Gnuk.  While it works well for specific
116 usages and it is considered stable, it is still somewhat experimental.
117
118 Tested features are:
119
120         * Personalization of the card
121           * Changing Login name, URL, Name, Sex, Language, etc.
122         * Password handling (PW1, RC, PW3)
123         * Key import for three types:
124           * key for digital signing
125           * key for decryption
126           * key for authentication
127         * PSO: Digital Signature
128         * PSO: Decipher
129         * INTERNAL AUTHENTICATE
130         * Changing value of password status bytes (0x00C4): forcesig
131         * Verify with pin pad
132         * Modify with pin pad
133         * Card holder certificate
134
135 It is known not-working well:
136
137         * For some version of kernel and libccid, --enable-debug can't
138           work well.  Please make sure to disable DEBUG option if it
139           doesn't work well.
140
141 Not supported feature(s):
142
143         * Overriding key import.  You need to remove all keys first.
144         * Key generation on device side
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 enable 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 Recently, "DnDpinentry" support is added.  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
179 Note that you need pinpad support for GnuPG, it's currently in the
180 master branch of GnuPG git repository at git.gnupg.org, and it's under
181 evaluation.  When it will be considered stable, it will be put onto
182 stable branch.
183
184
185 Souce code
186 ==========
187
188 Gnuk source code is under src/ directory.
189
190
191 License
192 =======
193
194 It is distributed under GNU General Public Licence version 3 or later
195 (GPLv3+).  Please see src/COPYING.
196
197 Please note that it is distributed with external source code too.
198 Please read relevant licenses for external source code, too.
199
200 The author(s) of Gnuk expect users of Gnuk will be able to access the
201 source code of Gnuk, so that users can study the code and can modify
202 if needed.  This doesn't mean person who has a USB Token by Gnuk
203 should be able to acess everything on the Token, regardless of its
204 protections.  Private keys, and other information should be protected
205 properly.
206
207
208 External source code
209 ====================
210
211 Gnuk is distributed with external source code.
212
213 * ChibiOS_2.0.8/  -- ChibiOS/RT 2.0.8
214
215   Taken from http://chibios.sourceforge.net/
216   Note that CRLF is converted to LF in this repository.
217   We use ChibiOS/RT as the kernel for Gnuk.
218
219 * polarssl-0.14.0/  -- PolarSSL 0.14.0
220
221   Taken from http://polarssl.org/
222   We use PolarSSL for RSA computation, AES encryption/decryption
223   and SHA-1 computation.
224
225   The file include/polarssl/bn_mul.h is heavily modified for ARM
226   Cortex-M3.
227
228 * STM32_USB-FS-Device_Driver/ -- a part of USB-FS-Device_Lib
229 * Virtual_COM_Port/ -- a part of USB-FS-Device_Lib
230
231   STM32F10x USB Full Speed Device Library (USB-FS-Device_Lib)
232   is a STM32F10x library for USB functionality.
233
234   I took Libraries/STM32_USB-FS-Device_Driver and 
235   Project/Virtual_COM_Port in STM32_USB-FS-Device_Lib distribution.
236   See http://www.st.com/ for detail.
237
238
239 Host Requirements
240 =================
241
242 For GNU/Linux, libccid version >= 1.3.11 is recommended.
243
244 I think that it should not be requirment but the kernel version of my use is:
245 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
246
247 Linux 2.6.30 is known *NOT* working well with DEBUG option.
248 Linux 2.6.24 is known working well with DEBUG option.
249
250
251 How to compile
252 ==============
253
254 You need GNU toolchain and newlib for 'arm-none-eabi' target.
255
256 See http://github.com/esden/summon-arm-toolchain/ (which includes fix
257 of binutils-2.21.1) for preparation of GNU Toolchain for
258 'arm-none-eabi' target.
259
260 # Note that we need to link correct C library (for string functions).
261 # For this purpose, Makefile.in contains following line:
262
263 #       MCFLAGS= -mcpu=$(MCU) -mfix-cortex-m3-ldrd
264
265 # This should not be needed (as -mcpu=cortex-m3 means
266 # -mfix-cortex-m3-ldrd), but in practice it is needed for 
267 # the configuration of patch-gcc-config-arm-t-arm-elf.diff in
268 # summon-arm-toolchain.
269
270 # In ChibiOS_2.0.8/os/ports/GCC/ARM/rules.mk, it specifies
271 # -mno-thumb-interwork option.  This means that you should not
272 # link C library which contains ARM (not Thumb) code.
273
274
275 Change directory to `src':
276
277   $ cd gnuk-VERSION/src
278
279 Then, run `configure':
280
281   $ ./configure
282
283 Type:
284
285   $ make
286
287 Then, we will have "gnuk.elf".
288
289
290 How to install
291 ==============
292
293 Olimex STM32-H103 board
294 -----------------------
295
296 If you are using Olimex JTAG-Tiny, type following to invoke OpenOCD:
297
298   $ openocd -f interface/olimex-jtag-tiny.cfg -f board/olimex_stm32_h103.cfg
299
300 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
301
302   $ telnet localhost 4444
303   > reset halt
304   > flash write_image erase gnuk.elf
305   > reset
306   > exit
307   $ 
308
309
310 Flying Stone Tiny 01
311 --------------------
312
313 If you are using Flying Stone Tiny 01, you need a SWD writer.  I am
314 using revision 946 of Simon Qian's Versaloon.
315
316     svn checkout -r 946 http://vsprog.googlecode.com/svn/trunk/
317
318 For OpenOCD, we need unofficial patch.
319
320 See the article of Versaloon Forum:
321
322     http://www.versaloon.com/bbs/viewtopic.php?p=16179
323
324
325 Type following to invoke OpenOCD:
326
327   $ openocd -f interface/vsllink.cfg -c "transport select swd" -c "swd_mode 2" -f target/stm32f1x.cfg
328
329 Then, with another terminal, type following to write "gnuk.elf" to Flash ROM:
330
331   $ telnet localhost 4444
332   > reset halt
333   > flash write_image erase gnuk.elf
334   > reset
335   > exit
336   $ 
337
338
339
340 STM8S Discovery Kit
341 -------------------
342
343 If you are using FTDI-2232D module and the connection is standard, type:
344
345   $ openocd -f interface/openocd-usb.cfg -f target/stm32.cfg
346
347 Initially, the flash ROM of the chip is protected.  you need to do:
348
349   $ telnet localhost 4444
350   > reset halt
351   > stm32x unlock 0
352   > reset
353   > shutdown
354   $ 
355
356 and re-connect the board.  Note that power-off / power-on sequence is
357 required to reset flash ROM.
358
359 Then, invoke OpenOCD again and telnet to connect OpenCD and write
360 image as above example of Olimex STM32-H103.
361
362
363 CQ STARM
364 --------
365
366 Put jumper for J6 to enable DfuSe.  Connecting the board, and type:
367
368   # cd ../tool
369   # ./dfuse.py ../src/gnuk.hex
370
371 Then, remove the jumper and reset the board.
372
373
374 STBee and STBee Mini
375 --------------------
376
377 Reset the board with "USER" switch pushed.  Type following to write
378 to flash:
379
380   # cd ../tool
381   # ./dfuse.py ../src/gnuk.hex
382
383 Then, reset the board.
384
385
386 How to protect flash ROM
387 ========================
388
389 Invoke your OpenOCD and type:
390
391   $ telnet localhost 4444
392   > reset halt
393   > stm32x lock 0
394   > reset
395   > shutdown
396
397 After power-off / power-on sequence, the contents of flash ROM cannot
398 be accessible from JTAG debugger.
399
400 Note that it would be still possible for some implementation of DfuSe
401 to access the contents.  If you want to protect, killing DfuSe and
402 accessing by JTAG debugger is recommended.
403
404
405 How to configure
406 ================
407
408 You need python and pyscard (python-pyscard package in Debian) or
409 PyUSB (python-usb package in Debian).
410
411 (1) [pyscard] Stop scdaemon
412     [PyUSB] Stop the pcsc daemon.
413
414 If scdaemon is running, please kill it, or you will get "Smartcard
415 Exception" by "Sharing violation".
416
417   $ killall -9 scdaemon
418
419 In case of PyUSB tool, you need to stop pcscd.
420
421   # /etc/init.d/pcscd stop
422
423
424 (2) [Optional] Write fixed serial number
425
426 If you use fixed serial number in the file 'GNUK_SERIAL_NUMBER', you can do:
427
428   $ EMAIL=<YOUR-EMAIL-ADDRESS> ../tool/gnuk_put_binary.py -s ../GNUK_SERIAL_NUMBER
429   Writing serial number
430   ...
431
432 (3) [Optional] Write card holder certificate
433
434 If you have card holder certificate binary file, you can do:
435
436   $ ../tool/gnuk_put_binary.py ../../<YOUR-CERTIFICATE>.bin
437   ../../<YOUR-CERTIFICATE>.bin: <LENGTH-OF-YOUR-CERTIFICATE>
438   Updating card holder certificate
439   ...
440
441
442 How to run
443 ==========
444
445 Debug enabled
446 -------------
447
448 If you compiled with --enable-debug option, Gnuk has two interfaces
449 (one is CCID/ICCD device and another is virtual COM port).  Open
450 virtual COM port by:
451
452   $ cu -l /dev/ttyACM0
453
454 and you will see debug output of Gnuk.
455
456
457 Libccid fix needed
458 ------------------
459
460 For libccid (< 1.4.1), we need following change:
461
462 --- /etc/libccid_Info.plist.dpkg-dist   2009-07-29 06:50:20.000000000 +0900
463 +++ /etc/libccid_Info.plist     2010-09-05 09:09:49.000000000 +0900
464 @@ -104,6 +104,7 @@
465  
466         <key>ifdVendorID</key>
467         <array>
468 +               <string>0x234B</string>
469                 <string>0x08E6</string>
470                 <string>0x08E6</string>
471                 <string>0x08E6</string>
472 @@ -237,6 +238,7 @@
473  
474         <key>ifdProductID</key>
475         <array>
476 +               <string>0x0000</string>
477                 <string>0x2202</string>
478                 <string>0x3437</string>
479                 <string>0x3438</string>
480 @@ -370,6 +372,7 @@
481  
482         <key>ifdFriendlyName</key>
483         <array>
484 +               <string>FSIJ USB Token</string>
485                 <string>Gemplus Gem e-Seal Pro</string>
486                 <string>Gemplus GemPC Twin</string>
487                 <string>Gemplus GemPC Key</string>
488 ------------------
489
490 This entry has been added into libccid 1.4.1 already ([r5425]).
491
492
493 Testing Gnuk
494 ------------
495
496 Try following to see Gnuk runs:
497
498   $ gpg --card-status
499
500
501 Personalize the Token and import keys
502 -------------------------------------
503
504 You can personalize the token, putting your information like: Name,
505 Login name, Sex, Languages, URL, etc., and password.  To do so, GnuPG
506 command is:
507
508   $ gpg --card-edit
509
510 Note that the factory setting of user password is "123456" and admin
511 password is "12345678" as the specification.
512
513 No, Gnuk doesn't support key generation.  You need to create your
514 keys on your computer, and import them to Gnuk Token.  After you create
515 your keys (they must be 2048-bit RSA), you can import them.
516
517 For detail, please see doc/DEMO and doc/DEMO-2.
518
519 Note that it make sense to preserve your keys on your computer so that
520 you can import the keys (again) to (possibly another) Gnuk Token.  In
521 this case, you can use GnuPG's option to specify the home directory by
522 --homedir.
523
524 After creating keys by:
525
526   $ gpg --gen-key
527   ...
528
529 Copy directory which contains your secret keys to new directory named
530 <gpgdir-with-your-secret-keys>:
531
532   $ cp -pa $HOME/.gnupg <gpgdir-with-your-secret-keys>
533
534 Then, import keys by:
535
536   $ gpg --edit-key <YOUR-KEYID>
537
538 While your $HOME/.gnupg now doesn't have your secret keys after
539 import, <gpgdir-with-your-secret-keys> still has them.  You can again
540 import them by:
541
542   $ gpg --homedir=<gpgdir-with-your-secret-keys> --edit-key <YOUR-KEYID>
543
544 Note that you *should not* save changes this time to preserve keys
545 on your computer.  The session goes like this:
546
547   gpg> quit
548   Save changes? (y/N) n
549   Quit without saving? (y/N) y
550
551
552
553 How to debug
554 ============
555
556 We can use GDB.
557
558   $ arm-none-eabi-gdb gnuk.elf
559
560
561 Inside GDB, we can connect OpenOCD by:
562
563   (gdb) target remote localhost:3333
564
565
566 You can see the output of PCSCD:
567
568   # /etc/init.d/pcscd stop
569   # LIBCCID_ifdLogLevel=7 /usr/sbin/pcscd --debug --foreground
570
571
572 You can observe the traffic of USB using "usbmon".  See the file:
573 linux/Documentation/usb/usbmon.txt
574
575
576 Read-only Git Repository
577 ========================
578
579 You can browse at http://www.gniibe.org/gitweb?p=gnuk.git;a=summary
580
581 You can get it by:
582
583   $ git clone git://www.gniibe.org/gnuk.git/
584
585 or
586
587   $ git clone http://www.gniibe.org/git/gnuk.git/
588
589
590
591 Information on the Web
592 ======================
593
594 Please visit: http://www.fsij.org/gnuk/
595
596
597 Your Contributions
598 ==================
599
600 FSIJ welcomes your contributions.  Please assign your copyright
601 to FSIJ (if possible).
602
603
604 Foot note
605 ==========
606 * NUK(R) is a registered trademark owend by MAPA GmbH, Germany.
607 --