Rename tests.
[gnuk/gnuk.git] / doc / udev-rules.rst
1 ===============================================
2 Device Configuration for Gnuk Token with libusb
3 ===============================================
4
5 In order to use Gnuk Token with libusb, configuration of device is
6 needed for permissions.  Note that this is not needed for the case of
7 PC/SC Lite, as it has its own device configuration.
8
9
10 udev rules for Gnuk Token
11 =========================
12
13 In case of Debian, there is a file /lib/udev/rules.d/60-gnupg.rules
14 (or /lib/udev/rules.d/60-scdamon.rules for newer version),
15 when you install "gnupg" package (or "scdaemon" package).
16 This is the place we need to
17 change, if your installation is older than jessie.  Newer "gnupg"
18 package (1.4.15-1 or later) or "scdaemon" package has already
19 supported Gnuk Token.
20
21 If needed, please add lines for Gnuk Token to give a desktop user the
22 permission to use the device.  We specify USB ID of Gnuk Token (by
23 FSIJ)::
24
25     --- /lib/udev/rules.d/60-gnupg.rules.orig   2012-06-24 21:51:26.000000000 +0900
26     +++ /lib/udev/rules.d/60-gnupg.rules        2012-07-13 17:18:55.149587687 +0900
27     @@ -10,4 +10,7 @@
28      ATTR{idVendor}=="04e6", ATTR{idProduct}=="5115", ENV{ID_SMARTCARD_READER}="1", ENV{ID_SMARTCARD_READER_DRIVER}="gnupg"
29      ATTR{idVendor}=="20a0", ATTR{idProduct}=="4107", ENV{ID_SMARTCARD_READER}="1", ENV{ID_SMARTCARD_READER_DRIVER}="gnupg"
30      
31     +# Gnuk
32     +ATTR{idVendor}=="234b", ATTR{idProduct}=="0000", ENV{ID_SMARTCARD_READER}="1", ENV{ID_SMARTCARD_READER_DRIVER}="gnupg"
33     +
34      LABEL="gnupg_rules_end"
35
36 When we only install "gnupg2" package for 2.0 (with no "gnupg" package),
37 there will be no udev rules (there is a bug report #543217 for this issue).
38 In this case, we need something like this in /etc/udev/rules.d/60-gnuk.rules::
39
40     SUBSYSTEMS=="usb", ATTRS{idVendor}=="234b", ATTRS{idProduct}=="0000",   \
41     ENV{ID_SMARTCARD_READER}="1", ENV{ID_SMARTCARD_READER_DRIVER}="gnupg"
42
43 Usually, udev daemon automatically handles for the changes of configuration
44 files.  If not, please let the daemon reload rules::
45
46   # udevadm control --reload-rules
47
48
49
50
51 udev rules for ST-Link/V2
52 =========================
53
54 For development of Gnuk, we use ST-Link/V2 as JTAG/SWD debugger.
55 We need to have a udev rule for ST-Link/V2.  It's like::
56
57     ACTION=="add", SUBSYSTEM=="usb", ATTR{idVendor}=="0483", ATTR{idProduct}=="3748", GROUP="tape", MODE="664", SYMLINK+="stlink"
58
59 I have this in the file /etc/udev/rules.d/10-stlink.rules.