From bbcdff6f67bdf821d0fb39d5cb348e5224c898e5 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Sat, 27 Jun 2020 00:19:16 +0200
Subject: [PATCH] Update the udev rules to tag devices as uaccess and seat

In order to be able to access the devices as the at-seat user, without having to
fiddle with distro-specific permissions and groups, we need to tag it both
`uaccess` and `seat`, and have the rule sorted before the one that applies
permissions based on these tags. As such, the file had to be renamed as well.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 bin/find-device-port-linux-udev |  3 +--
 docs/setup_toolchain.md         | 22 +++++++++++-----------
 etc/60-kaleidoscope.rules       | 16 ++++++++++++++++
 etc/99-kaleidoscope.rules       |  4 ----
 4 files changed, 28 insertions(+), 17 deletions(-)
 create mode 100644 etc/60-kaleidoscope.rules
 delete mode 100644 etc/99-kaleidoscope.rules

diff --git a/bin/find-device-port-linux-udev b/bin/find-device-port-linux-udev
index e74c1a8c..5d00c7a6 100644
--- a/bin/find-device-port-linux-udev
+++ b/bin/find-device-port-linux-udev
@@ -70,7 +70,7 @@ for my $path (@paths) {
     }
 
     if ( $devices{$path}{'ID_MM_CANDIDATE'}) {
-      my $rules = "$Bin/../etc/99-kaleidoscope.rules";
+      my $rules = "$Bin/../etc/60-kaleidoscope.rules";
       print_warning <<EOWARN
 
 WARNING: your udev rules are currently configured to suggest
@@ -90,4 +90,3 @@ EOWARN
 
 #debug("ERROR: I couldn't find a USB device matching the keyboard's USB Vendor and Device IDs\n");
 #print_warning(join("\n",@log));
-
diff --git a/docs/setup_toolchain.md b/docs/setup_toolchain.md
index a53d9056..fd70b57e 100644
--- a/docs/setup_toolchain.md
+++ b/docs/setup_toolchain.md
@@ -1,13 +1,13 @@
 # Setting up your development environment
 
-If you'd like to customize your keyboard's layout or functionality, the most robust and flexible option is to use the Arduino IDE. 
+If you'd like to customize your keyboard's layout or functionality, the most robust and flexible option is to use the Arduino IDE.
 
-Arduino is one of the world's most widely used (and user friendly) platforms for programming "embedded" devices like the chip inside your keyboard. 
+Arduino is one of the world's most widely used (and user friendly) platforms for programming "embedded" devices like the chip inside your keyboard.
 
 
 # Set up the Arduino IDE
 
-Arduino's designers made it to be accessible to people at all skill levels, and Kaleidoscope is built on top of the Arduino platform because we share that goal. The easiest way to customize your keyboard's firmware is to use the Arduino IDE. Even if you expect to use the command line to compile your firmware, you'll still need to install Arduino, as they provide the compilers and libraries Kaleidoscope needs to work. 
+Arduino's designers made it to be accessible to people at all skill levels, and Kaleidoscope is built on top of the Arduino platform because we share that goal. The easiest way to customize your keyboard's firmware is to use the Arduino IDE. Even if you expect to use the command line to compile your firmware, you'll still need to install Arduino, as they provide the compilers and libraries Kaleidoscope needs to work.
 
 Using the IDE is is the easiest process for folks who are new to Arduino, or to programming generally. If you follow the instructions below step by step you should be fine. :-)
 
@@ -28,7 +28,7 @@ The right way to install Arduino is a little bit different depending on what ope
 
 As of this writing, the latest version is v1.8.13, which you can download from https://www.arduino.cc/download_handler.php?f=/arduino-1.8.13-macosx.zip
 
-2. Double-click "arduino-1.8.13-macos.zip" to uncompress the Arduino IDE. 
+2. Double-click "arduino-1.8.13-macos.zip" to uncompress the Arduino IDE.
 
 3. Move Arduino.app from your `Downloads` folder to your Applications folder.
 
@@ -53,8 +53,8 @@ Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
 3. On Ubuntu, you will have to prevent ModemManager from attempting to grab the keyboard virtual serial port when it goes into bootloader mode:
 
     ```sh
-    $ wget https://raw.githubusercontent.com/keyboardio/Kaleidoscope/master/etc/99-kaleidoscope.rules
-    $ sudo cp 99-kaleidoscope.rules /etc/udev/rules.d
+    $ wget https://raw.githubusercontent.com/keyboardio/Kaleidoscope/master/etc/60-kaleidoscope.rules
+    $ sudo cp 60-kaleidoscope.rules /etc/udev/rules.d
     $ sudo /etc/init.d/udev reload
     ```
 
@@ -65,7 +65,7 @@ Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
     From a shell:
 
     ```sh
-    $ groups 
+    $ groups
     ```
 
     If you see dialout in the list, you're good to go. If you don't, you'll have to add yourself and then get Linux to recognize the change in your current shell:
@@ -156,9 +156,9 @@ Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
 
 # Add keyboard support to Arduino
 
-1. Open the Arduino IDE. It will open an empty "sketch" window. 
+1. Open the Arduino IDE. It will open an empty "sketch" window.
 
-2. On Windows or Linux: Open the "File" menu, and click on "Preferences." 
+2. On Windows or Linux: Open the "File" menu, and click on "Preferences."
    On a Mac: Open the "Arduino" menu, and click on "Preferences."
 
 ![](images/arduino-setup/open-preferences.png)
@@ -175,11 +175,11 @@ Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
 
 ![](images/arduino-setup/open-boards-manager.png)
 
-6. Type ‘Keyboardio’ into the search box. 
+6. Type ‘Keyboardio’ into the search box.
 
 ![](images/arduino-setup/pick-keyboardio-from-boards-manager.png)
 
-7. You will see an entry that says "keyboardio by Keyboardio" click on it to select it, and then click ‘Install’. 
+7. You will see an entry that says "keyboardio by Keyboardio" click on it to select it, and then click ‘Install’.
 
 ![](images/arduino-setup/boards-manager-install.png)
 
diff --git a/etc/60-kaleidoscope.rules b/etc/60-kaleidoscope.rules
new file mode 100644
index 00000000..6462d5aa
--- /dev/null
+++ b/etc/60-kaleidoscope.rules
@@ -0,0 +1,16 @@
+## This file sets up a few things for selected Kaleidoscope-powered keyboards:
+## - We first symlink the device to a more friendly name, based on the product
+##   name.
+## - We then ask ModemManager to ignore the serial ports on the device, and not
+##   consider them a candidate.
+## - We also tell systemd to grant access to the device (via ACLs) to the user
+##   at-seat.
+##
+## For more information about the access part, see the following resources:
+##  - https://github.com/systemd/systemd/issues/4288
+##  - https://www.freedesktop.org/software/systemd/man/sd-login.html
+
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2300", SYMLINK+="model01", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0", TAG+="uaccess", TAG+="seat"
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2301", SYMLINK+="model01", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0", TAG+="uaccess", TAG+="seat"
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2302", SYMLINK+="Atreus2", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0", TAG+="uaccess", TAG+="seat"
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2303", SYMLINK+="Atreus2", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0", TAG+="uaccess", TAG+="seat"
diff --git a/etc/99-kaleidoscope.rules b/etc/99-kaleidoscope.rules
deleted file mode 100644
index 89ddcd2f..00000000
--- a/etc/99-kaleidoscope.rules
+++ /dev/null
@@ -1,4 +0,0 @@
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2300", SYMLINK+="model01", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0"
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2301", SYMLINK+="model01", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0"
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2302", SYMLINK+="Atreus2", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0"
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="2303", SYMLINK+="Atreus2", ENV{ID_MM_DEVICE_IGNORE}:="1", ENV{ID_MM_CANDIDATE}:="0"