blob: 9e53909d04c2893602f15f57e9ade96ee1da4327 [file] [log] [blame]
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -03001==============================================================
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -07002Authorizing (or not) your USB devices to connect to the system
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -03003==============================================================
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -07004
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -03005Copyright (C) 2007 Inaky Perez-Gonzalez <inaky@linux.intel.com> Intel Corporation
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -07006
7This feature allows you to control if a USB device can be used (or
8not) in a system. This feature will allow you to implement a lock-down
9of USB devices, fully controlled by user space.
10
11As of now, when a USB device is connected it is configured and
Matt LaPlanted9195882008-07-25 19:45:33 -070012its interfaces are immediately made available to the users. With this
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070013modification, only if root authorizes the device to be configured will
14then it be possible to use it.
15
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030016Usage
17=====
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070018
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030019Authorize a device to connect::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070020
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030021 $ echo 1 > /sys/bus/usb/devices/DEVICE/authorized
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070022
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030023De-authorize a device::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070024
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030025 $ echo 0 > /sys/bus/usb/devices/DEVICE/authorized
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070026
27Set new devices connected to hostX to be deauthorized by default (ie:
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030028lock down)::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070029
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030030 $ echo 0 > /sys/bus/usb/devices/usbX/authorized_default
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070031
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030032Remove the lock down::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070033
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030034 $ echo 1 > /sys/bus/usb/devices/usbX/authorized_default
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070035
36By default, Wired USB devices are authorized by default to
37connect. Wireless USB hosts deauthorize by default all new connected
38devices (this is so because we need to do an authentication phase
Dmitry Torokhov7bae0432019-02-16 23:21:51 -080039before authorizing). Writing "2" to the authorized_default attribute
40causes kernel to only authorize by default devices connected to internal
41USB ports.
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070042
43
44Example system lockdown (lame)
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030045------------------------------
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070046
47Imagine you want to implement a lockdown so only devices of type XYZ
48can be connected (for example, it is a kiosk machine with a visible
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030049USB port)::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070050
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030051 boot up
52 rc.local ->
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070053
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030054 for host in /sys/bus/usb/devices/usb*
55 do
56 echo 0 > $host/authorized_default
57 done
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070058
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030059Hookup an script to udev, for new USB devices::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070060
61 if device_is_my_type $DEV
62 then
63 echo 1 > $device_path/authorized
64 done
65
66
67Now, device_is_my_type() is where the juice for a lockdown is. Just
68checking if the class, type and protocol match something is the worse
69security verification you can make (or the best, for someone willing
70to break it). If you need something secure, use crypto and Certificate
71Authentication or stuff like that. Something simple for an storage key
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030072could be::
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070073
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030074 function device_is_my_type()
75 {
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070076 echo 1 > authorized # temporarily authorize it
77 # FIXME: make sure none can mount it
78 mount DEVICENODE /mntpoint
79 sum=$(md5sum /mntpoint/.signature)
80 if [ $sum = $(cat /etc/lockdown/keysum) ]
81 then
82 echo "We are good, connected"
83 umount /mntpoint
84 # Other stuff so others can use it
85 else
86 echo 0 > authorized
87 fi
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -030088 }
Inaky Perez-Gonzalez732bb9e2007-07-31 20:34:08 -070089
90
91Of course, this is lame, you'd want to do a real certificate
92verification stuff with PKI, so you don't depend on a shared secret,
93etc, but you get the idea. Anybody with access to a device gadget kit
94can fake descriptors and device info. Don't trust that. You are
95welcome.
96
Stefan Koch7f59c152015-08-25 21:10:10 +020097
98Interface authorization
99-----------------------
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -0300100
Stefan Koch7f59c152015-08-25 21:10:10 +0200101There is a similar approach to allow or deny specific USB interfaces.
102That allows to block only a subset of an USB device.
103
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -0300104Authorize an interface::
Stefan Koch7f59c152015-08-25 21:10:10 +0200105
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -0300106 $ echo 1 > /sys/bus/usb/devices/INTERFACE/authorized
107
108Deauthorize an interface::
109
110 $ echo 0 > /sys/bus/usb/devices/INTERFACE/authorized
Stefan Koch7f59c152015-08-25 21:10:10 +0200111
112The default value for new interfaces
113on a particular USB bus can be changed, too.
114
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -0300115Allow interfaces per default::
Stefan Koch7f59c152015-08-25 21:10:10 +0200116
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -0300117 $ echo 1 > /sys/bus/usb/devices/usbX/interface_authorized_default
118
119Deny interfaces per default::
120
121 $ echo 0 > /sys/bus/usb/devices/usbX/interface_authorized_default
Stefan Koch7f59c152015-08-25 21:10:10 +0200122
123Per default the interface_authorized_default bit is 1.
124So all interfaces would authorized per default.
125
126Note:
Mauro Carvalho Chehabd80b5002019-04-15 23:56:01 -0300127 If a deauthorized interface will be authorized so the driver probing must
128 be triggered manually by writing INTERFACE to /sys/bus/usb/drivers_probe
Stefan Koch7f59c152015-08-25 21:10:10 +0200129
130For drivers that need multiple interfaces all needed interfaces should be
ThiƩbaud Weksteen77df6d82018-11-26 15:49:26 +0100131authorized first. After that the drivers should be probed.
Stefan Koch7f59c152015-08-25 21:10:10 +0200132This avoids side effects.