sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

closer to working, but not right

Browse Source
This commit is contained in:
Kyle Brown
2020-10-21 15:26:51 -07:00
parent 56732930c5
commit 9972e8d23d
4 changed files with 188 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

205
kmk/hid.py
View File

@@ -1,46 +1,48 @@
import usb_hid
from micropython import const
from kmk.keys import FIRST_KMK_INTERNAL_KEY, ConsumerKey, ModifierKey
from mycropython import const
class HIDModes:
NOOP = const(0) # currently unused; for testing?
USB = const(1)
BLE = const(2) # currently unused; for bluetooth
NOOP = 0 # currently unused; for testing?
USB = 1
BLE = 2 # currently unused; for bluetooth
ALL_MODES = (NOOP, USB, BLE)
class HIDReportTypes:
KEYBOARD = const(1)
MOUSE = const(2)
CONSUMER = const(3)
SYSCONTROL = const(4)
KEYBOARD = 1
MOUSE = 2
CONSUMER = 3
SYSCONTROL = 4
class HIDUsage:
KEYBOARD = const(0x06)
MOUSE = const(0x02)
CONSUMER = const(0x01)
SYSCONTROL = const(0x80)
KEYBOARD = 0x06
MOUSE = 0x02
CONSUMER = 0x01
SYSCONTROL = 0x80
class HIDUsagePage:
CONSUMER = const(0x0C)
KEYBOARD = MOUSE = SYSCONTROL = const(0x01)
CONSUMER = 0x0C
KEYBOARD = MOUSE = SYSCONTROL = 0x01
HID_REPORT_SIZES = {
HIDReportTypes.KEYBOARD: const(8),
HIDReportTypes.MOUSE: const(4),
HIDReportTypes.CONSUMER: const(2),
HIDReportTypes.SYSCONTROL: const(8), # TODO find the correct value for this
HIDReportTypes.KEYBOARD: 8,
HIDReportTypes.MOUSE: 4,
HIDReportTypes.CONSUMER: 2,
HIDReportTypes.SYSCONTROL: 8, # TODO find the correct value for this
}
class AbstractHID:
REPORT_BYTES = const(8)
REPORT_BYTES = 8
def __init__(self, **kwargs):
def __init__(self):
self._evt = bytearray(self.REPORT_BYTES)
self.report_device = memoryview(self._evt)[0:1]
self.report_device[0] = HIDReportTypes.KEYBOARD
@@ -54,7 +56,7 @@ class AbstractHID:
self.report_mods = memoryview(self._evt)[1:2]
self.report_non_mods = memoryview(self._evt)[3:]
self.post_init(**kwargs)
self.post_init()
def __repr__(self):
return '{}(REPORT_BYTES={})'.format(self.__class__.__name__, self.REPORT_BYTES)
@@ -188,14 +190,12 @@ class AbstractHID:
class USBHID(AbstractHID):
import usb_hid
REPORT_BYTES = 9
REPORT_BYTES = const(9)
def post_init(self, **kwargs):
def post_init(self):
self.devices = {}
for device in self.usb_hid.devices:
for device in usb_hid.devices:
us = device.usage
up = device.usage_page
@@ -225,101 +225,106 @@ class USBHID(AbstractHID):
class BLEHID(AbstractHID):
from adafruit_ble import BLERadio
from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
from adafruit_ble.services.standard.hid import HIDService
try:
# TODO FIXME This is wrapped in a try block to prevent crashes on M4 devices
from adafruit_ble import BLERadio
from adafruit_ble.advertising.standard import ProvideServicesAdvertisement
from adafruit_ble.services.standard.hid import HIDService
BLE_APPEARANCE_HID_KEYBOARD = const(961)
# Hardcoded in CPy
MAX_CONNECTIONS = const(2)
BLE_APPEARANCE_HID_KEYBOARD = const(961)
# Hardcoded in CPy
MAX_CONNECTIONS = const(2)
def post_init(self, ble_name='KMK Keyboard', **kwargs):
self.conn_id = -1
def post_init(self, ble_name='KMK Keyboard', **kwargs):
self.conn_id = -1
self.ble = self.BLERadio()
self.ble.name = ble_name
self.hid = self.HIDService()
self.hid.protocol_mode = 0 # Boot protocol
self.ble = self.BLERadio()
self.ble.name = ble_name
self.hid = self.HIDService()
self.hid.protocol_mode = 0 # Boot protocol
# Security-wise this is not right. While you're away someone turns
# on your keyboard and they can pair with it nice and clean and then
# listen to keystrokes.
# On the other hand we don't have LESC so it's like shouting your
# keystrokes in the air
if not self.ble.connected or not self.hid.devices:
self.start_advertising()
# Security-wise this is not right. While you're away someone turns
# on your keyboard and they can pair with it nice and clean and then
# listen to keystrokes.
# On the other hand we don't have LESC so it's like shouting your
# keystrokes in the air
if not self.ble.connected or not self.hid.devices:
self.start_advertising()
self.conn_id = 0
self.conn_id = 0
@property
def devices(self):
'''Search through the provided list of devices to find the ones with the
send_report attribute.'''
if not self.ble.connected:
return []
@property
def devices(self):
'''Search through the provided list of devices to find the ones with the
send_report attribute.'''
if not self.ble.connected:
return []
result = []
# Security issue:
# This introduces a race condition. Let's say you have 2 active
# connections: Alice and Bob - Alice is connection 1 and Bob 2.
# Now Chuck who has already paired with the device in the past
# (this assumption is needed only in the case of LESC)
# wants to gather the keystrokes you send to Alice. You have
# selected right now to talk to Alice (1) and you're typing a secret.
# If Chuck kicks Alice off and is quick enough to connect to you,
# which means quicker than the running interval of this function,
# he'll be earlier in the `self.hid.devices` so will take over the
# selected 1 position in the resulted array.
# If no LESC is in place, Chuck can sniff the keystrokes anyway
for device in self.hid.devices:
if hasattr(device, 'send_report'):
result.append(device)
result = []
# Security issue:
# This introduces a race condition. Let's say you have 2 active
# connections: Alice and Bob - Alice is connection 1 and Bob 2.
# Now Chuck who has already paired with the device in the past
# (this assumption is needed only in the case of LESC)
# wants to gather the keystrokes you send to Alice. You have
# selected right now to talk to Alice (1) and you're typing a secret.
# If Chuck kicks Alice off and is quick enough to connect to you,
# which means quicker than the running interval of this function,
# he'll be earlier in the `self.hid.devices` so will take over the
# selected 1 position in the resulted array.
# If no LESC is in place, Chuck can sniff the keystrokes anyway
for device in self.hid.devices:
if hasattr(device, 'send_report'):
result.append(device)
return result
return result
def _check_connection(self):
devices = self.devices
if not devices:
return False
def _check_connection(self):
devices = self.devices
if not devices:
return False
if self.conn_id >= len(devices):
self.conn_id = len(devices) - 1
if self.conn_id >= len(devices):
self.conn_id = len(devices) - 1
if self.conn_id < 0:
return False
if self.conn_id < 0:
return False
if not devices[self.conn_id]:
return False
if not devices[self.conn_id]:
return False
return True
return True
def hid_send(self, evt):
if not self._check_connection():
return
def hid_send(self, evt):
if not self._check_connection():
return
device = self.devices[self.conn_id]
device = self.devices[self.conn_id]
while len(evt) < len(device._characteristic.value) + 1:
evt.append(0)
while len(evt) < len(device._characteristic.value) + 1:
evt.append(0)
return device.send_report(evt[1:])
return device.send_report(evt[1:])
def clear_bonds(self):
import _bleio
def clear_bonds(self):
import _bleio
_bleio.adapter.erase_bonding()
_bleio.adapter.erase_bonding()
def next_connection(self):
self.conn_id = (self.conn_id + 1) % len(self.devices)
def next_connection(self):
self.conn_id = (self.conn_id + 1) % len(self.devices)
def previous_connection(self):
self.conn_id = (self.conn_id - 1) % len(self.devices)
def previous_connection(self):
self.conn_id = (self.conn_id - 1) % len(self.devices)
def start_advertising(self):
advertisement = self.ProvideServicesAdvertisement(self.hid)
advertisement.appearance = self.BLE_APPEARANCE_HID_KEYBOARD
def start_advertising(self):
advertisement = self.ProvideServicesAdvertisement(self.hid)
advertisement.appearance = self.BLE_APPEARANCE_HID_KEYBOARD
self.ble.start_advertising(advertisement)
self.ble.start_advertising(advertisement)
def stop_advertising(self):
self.ble.stop_advertising()
def stop_advertising(self):
self.ble.stop_advertising()
except ImportError:
pass