Setup

This section introduces the necessary settings required to use CanoKey.

1. Windows

It can be used without configuration.

2. macOS

2.1 Big Sur and earlier

Please compile and install the latest version of the ccid driver.

2.2 Monterey and Ventura

It can be used without configuration.

2.3 Sonoma and later

CanoKey Pigeon users need to compile and install the latest version of the ccid driver.

CanoKey Canary users can use it without configuration.

2.4 pcsc-tools

pcsc-tools provides the pcsc_scan command for quickly troubleshooting PC/SC driver issues.

brew install pcsc-lite

3. Linux

Linux users can perform the following configuration for easier use.

3.1 udev

The aim of udev rules are to allow users without root privileges to use it. Please create /etc/udev/rules.d/69-canokeys.rules and fill in the following content.

# GnuPG/pcsclite
SUBSYSTEM!="usb", GOTO="canokeys_rules_end"
ACTION!="add|change", GOTO="canokeys_rules_end"
ATTRS{idVendor}=="20a0", ATTRS{idProduct}=="42d4", ENV{ID_SMARTCARD_READER}="1"
LABEL="canokeys_rules_end"

# FIDO2
# note that if you find this line in 70-fido.rules, you can ignore it
KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="20a0", ATTRS{idProduct}=="42d4", TAG+="uaccess", GROUP="plugdev", MODE="0660"

# make this usb device accessible for users, used in WebUSB
# change the mode so unprivileged users can access it, insecure rule, though
SUBSYSTEMS=="usb", ATTR{idVendor}=="20a0", ATTR{idProduct}=="42d4", MODE:="0666"
# if the above works for WebUSB (web console), you may change into a more secure way
# choose one of the following rules
# note if you use "plugdev", make sure you have this group and the wanted user is in that group
#SUBSYSTEMS=="usb", ATTR{idVendor}=="20a0", ATTR{idProduct}=="42d4", GROUP="plugdev", MODE="0660"
#SUBSYSTEMS=="usb", ATTR{idVendor}=="20a0", ATTR{idProduct}=="42d4", TAG+="uaccess"

TAG+="uaccess" is more inclined to systemd, while GROUP="plugdev", MODE="0660" is more traditional. You can choose either solution.

After adding this file, run the following command to apply the changes.

udevadm control --reload-rules && udevadm trigger

3.2 CCID

Please use ccid version 1.4.34 or later.

3.3 pcsc-tools

pcsc-tools provides the pcsc_scan command for quickly troubleshooting PC/SC driver issues.