github.com/hugh712/snapd@v0.0.0-20200910133618-1a99902bd583/interfaces/builtin/hidraw_test.go (about) 1 // -*- Mode: Go; indent-tabs-mode: t -*- 2 3 /* 4 * Copyright (C) 2016 Canonical Ltd 5 * 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 3 as 8 * published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * 18 */ 19 20 package builtin_test 21 22 import ( 23 . "gopkg.in/check.v1" 24 25 "github.com/snapcore/snapd/interfaces" 26 "github.com/snapcore/snapd/interfaces/apparmor" 27 "github.com/snapcore/snapd/interfaces/builtin" 28 "github.com/snapcore/snapd/interfaces/udev" 29 "github.com/snapcore/snapd/snap" 30 "github.com/snapcore/snapd/snap/snaptest" 31 "github.com/snapcore/snapd/testutil" 32 ) 33 34 type HidrawInterfaceSuite struct { 35 testutil.BaseTest 36 iface interfaces.Interface 37 38 // OS Snap 39 testSlot1 *interfaces.ConnectedSlot 40 testSlot1Info *snap.SlotInfo 41 testSlot2 *interfaces.ConnectedSlot 42 testSlot2Info *snap.SlotInfo 43 testSlotCleaned *interfaces.ConnectedSlot 44 testSlotCleanedInfo *snap.SlotInfo 45 missingPathSlot *interfaces.ConnectedSlot 46 missingPathSlotInfo *snap.SlotInfo 47 badPathSlot1 *interfaces.ConnectedSlot 48 badPathSlot1Info *snap.SlotInfo 49 badPathSlot2 *interfaces.ConnectedSlot 50 badPathSlot2Info *snap.SlotInfo 51 badPathSlot3 *interfaces.ConnectedSlot 52 badPathSlot3Info *snap.SlotInfo 53 badInterfaceSlot *interfaces.ConnectedSlot 54 badInterfaceSlotInfo *snap.SlotInfo 55 56 // Gadget Snap 57 testUDev1 *interfaces.ConnectedSlot 58 testUDev1Info *snap.SlotInfo 59 testUDev2 *interfaces.ConnectedSlot 60 testUDev2Info *snap.SlotInfo 61 testUDevBadValue1 *interfaces.ConnectedSlot 62 testUDevBadValue1Info *snap.SlotInfo 63 testUDevBadValue2 *interfaces.ConnectedSlot 64 testUDevBadValue2Info *snap.SlotInfo 65 testUDevBadValue3 *interfaces.ConnectedSlot 66 testUDevBadValue3Info *snap.SlotInfo 67 68 // Consuming Snap 69 testPlugPort1 *interfaces.ConnectedPlug 70 testPlugPort1Info *snap.PlugInfo 71 testPlugPort2 *interfaces.ConnectedPlug 72 testPlugPort2Info *snap.PlugInfo 73 testPlugPort3 *interfaces.ConnectedPlug 74 testPlugPort3Info *snap.PlugInfo 75 } 76 77 var _ = Suite(&HidrawInterfaceSuite{ 78 iface: builtin.MustInterface("hidraw"), 79 }) 80 81 func (s *HidrawInterfaceSuite) SetUpTest(c *C) { 82 osSnapInfo := snaptest.MockInfo(c, ` 83 name: ubuntu-core 84 version: 0 85 type: os 86 slots: 87 test-port-1: 88 interface: hidraw 89 path: /dev/hidraw0 90 test-port-2: 91 interface: hidraw 92 path: /dev/hidraw987 93 test-port-unclean: 94 interface: hidraw 95 path: /dev/./././hidraw876 96 missing-path: hidraw 97 bad-path-1: 98 interface: hidraw 99 path: path 100 bad-path-2: 101 interface: hidraw 102 path: /dev/hid0 103 bad-path-3: 104 interface: hidraw 105 path: /dev/hidraw9271 106 bad-interface: other-interface 107 `, nil) 108 s.testSlot1Info = osSnapInfo.Slots["test-port-1"] 109 s.testSlot1 = interfaces.NewConnectedSlot(s.testSlot1Info, nil, nil) 110 s.testSlot2Info = osSnapInfo.Slots["test-port-2"] 111 s.testSlot2 = interfaces.NewConnectedSlot(s.testSlot2Info, nil, nil) 112 s.testSlotCleanedInfo = osSnapInfo.Slots["test-port-unclean"] 113 s.testSlotCleaned = interfaces.NewConnectedSlot(s.testSlotCleanedInfo, nil, nil) 114 s.missingPathSlotInfo = osSnapInfo.Slots["missing-path"] 115 s.missingPathSlot = interfaces.NewConnectedSlot(s.missingPathSlotInfo, nil, nil) 116 s.badPathSlot1Info = osSnapInfo.Slots["bad-path-1"] 117 s.badPathSlot1 = interfaces.NewConnectedSlot(s.badPathSlot1Info, nil, nil) 118 s.badPathSlot2Info = osSnapInfo.Slots["bad-path-2"] 119 s.badPathSlot2 = interfaces.NewConnectedSlot(s.badPathSlot2Info, nil, nil) 120 s.badPathSlot3Info = osSnapInfo.Slots["bad-path-3"] 121 s.badPathSlot3 = interfaces.NewConnectedSlot(s.badPathSlot3Info, nil, nil) 122 s.badInterfaceSlotInfo = osSnapInfo.Slots["bad-interface"] 123 s.badInterfaceSlot = interfaces.NewConnectedSlot(s.badInterfaceSlotInfo, nil, nil) 124 125 gadgetSnapInfo := snaptest.MockInfo(c, ` 126 name: some-device 127 version: 0 128 type: gadget 129 slots: 130 test-udev-1: 131 interface: hidraw 132 usb-vendor: 0x0001 133 usb-product: 0x0001 134 path: /dev/hidraw-canbus 135 test-udev-2: 136 interface: hidraw 137 usb-vendor: 0xffff 138 usb-product: 0xffff 139 path: /dev/hidraw-mydevice 140 test-udev-bad-value-1: 141 interface: hidraw 142 usb-vendor: -1 143 usb-product: 0xffff 144 path: /dev/hidraw-mydevice 145 test-udev-bad-value-2: 146 interface: hidraw 147 usb-vendor: 0x1234 148 usb-product: 0x10000 149 path: /dev/hidraw-mydevice 150 test-udev-bad-value-3: 151 interface: hidraw 152 usb-vendor: 0x789a 153 usb-product: 0x4321 154 path: /dev/my-device 155 `, nil) 156 s.testUDev1Info = gadgetSnapInfo.Slots["test-udev-1"] 157 s.testUDev1 = interfaces.NewConnectedSlot(s.testUDev1Info, nil, nil) 158 s.testUDev2Info = gadgetSnapInfo.Slots["test-udev-2"] 159 s.testUDev2 = interfaces.NewConnectedSlot(s.testUDev2Info, nil, nil) 160 s.testUDevBadValue1Info = gadgetSnapInfo.Slots["test-udev-bad-value-1"] 161 s.testUDevBadValue1 = interfaces.NewConnectedSlot(s.testUDevBadValue1Info, nil, nil) 162 s.testUDevBadValue2Info = gadgetSnapInfo.Slots["test-udev-bad-value-2"] 163 s.testUDevBadValue2 = interfaces.NewConnectedSlot(s.testUDevBadValue2Info, nil, nil) 164 s.testUDevBadValue3Info = gadgetSnapInfo.Slots["test-udev-bad-value-3"] 165 s.testUDevBadValue3 = interfaces.NewConnectedSlot(s.testUDevBadValue3Info, nil, nil) 166 167 consumingSnapInfo := snaptest.MockInfo(c, ` 168 name: client-snap 169 version: 0 170 plugs: 171 plug-for-device-1: 172 interface: hidraw 173 plug-for-device-2: 174 interface: hidraw 175 plug-for-device-3: 176 interface: hidraw 177 178 apps: 179 app-accessing-1-device: 180 command: foo 181 plugs: [hidraw] 182 app-accessing-2-devices: 183 command: bar 184 plugs: [plug-for-device-1, plug-for-device-2] 185 app-accessing-3rd-device: 186 command: baz 187 plugs: [plug-for-device-3] 188 `, nil) 189 s.testPlugPort1Info = consumingSnapInfo.Plugs["plug-for-device-1"] 190 s.testPlugPort1 = interfaces.NewConnectedPlug(s.testPlugPort1Info, nil, nil) 191 s.testPlugPort2Info = consumingSnapInfo.Plugs["plug-for-device-2"] 192 s.testPlugPort2 = interfaces.NewConnectedPlug(s.testPlugPort2Info, nil, nil) 193 s.testPlugPort3Info = consumingSnapInfo.Plugs["plug-for-device-3"] 194 s.testPlugPort3 = interfaces.NewConnectedPlug(s.testPlugPort3Info, nil, nil) 195 } 196 197 func (s *HidrawInterfaceSuite) TestName(c *C) { 198 c.Assert(s.iface.Name(), Equals, "hidraw") 199 } 200 201 func (s *HidrawInterfaceSuite) TestSanitizeCoreSnapSlots(c *C) { 202 for _, slot := range []*snap.SlotInfo{s.testSlot1Info, s.testSlot2Info} { 203 c.Assert(interfaces.BeforePrepareSlot(s.iface, slot), IsNil) 204 } 205 // Verify historically filepath.Clean()d paths are still valid 206 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testSlotCleanedInfo), IsNil) 207 } 208 209 func (s *HidrawInterfaceSuite) TestSanitizeBadCoreSnapSlots(c *C) { 210 // Slots without the "path" attribute are rejected. 211 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.missingPathSlotInfo), ErrorMatches, 212 `hidraw slots must have a path attribute`) 213 214 // Slots with incorrect value of the "path" attribute are rejected. 215 for _, slot := range []*snap.SlotInfo{s.badPathSlot1Info, s.badPathSlot2Info, s.badPathSlot3Info} { 216 c.Assert(interfaces.BeforePrepareSlot(s.iface, slot), ErrorMatches, "hidraw path attribute must be a valid device node") 217 } 218 } 219 220 func (s *HidrawInterfaceSuite) TestSanitizeGadgetSnapSlots(c *C) { 221 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDev1Info), IsNil) 222 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDev2Info), IsNil) 223 } 224 225 func (s *HidrawInterfaceSuite) TestSanitizeBadGadgetSnapSlots(c *C) { 226 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue1Info), ErrorMatches, "hidraw usb-vendor attribute not valid: -1") 227 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue2Info), ErrorMatches, "hidraw usb-product attribute not valid: 65536") 228 c.Assert(interfaces.BeforePrepareSlot(s.iface, s.testUDevBadValue3Info), ErrorMatches, "hidraw path attribute specifies invalid symlink location") 229 } 230 231 func (s *HidrawInterfaceSuite) TestPermanentSlotUDevSnippets(c *C) { 232 spec := &udev.Specification{} 233 for _, slot := range []*snap.SlotInfo{s.testSlot1Info, s.testSlot2Info} { 234 c.Assert(spec.AddPermanentSlot(s.iface, slot), IsNil) 235 c.Assert(spec.Snippets(), HasLen, 0) 236 } 237 238 expectedSnippet1 := `# hidraw 239 IMPORT{builtin}="usb_id" 240 SUBSYSTEM=="hidraw", SUBSYSTEMS=="usb", ATTRS{idVendor}=="0001", ATTRS{idProduct}=="0001", SYMLINK+="hidraw-canbus"` 241 c.Assert(spec.AddPermanentSlot(s.iface, s.testUDev1Info), IsNil) 242 c.Assert(spec.Snippets(), HasLen, 1) 243 snippet := spec.Snippets()[0] 244 c.Assert(snippet, Equals, expectedSnippet1) 245 246 expectedSnippet2 := `# hidraw 247 IMPORT{builtin}="usb_id" 248 SUBSYSTEM=="hidraw", SUBSYSTEMS=="usb", ATTRS{idVendor}=="ffff", ATTRS{idProduct}=="ffff", SYMLINK+="hidraw-mydevice"` 249 spec = &udev.Specification{} 250 c.Assert(spec.AddPermanentSlot(s.iface, s.testUDev2Info), IsNil) 251 c.Assert(spec.Snippets(), HasLen, 1) 252 snippet = spec.Snippets()[0] 253 c.Assert(snippet, Equals, expectedSnippet2) 254 } 255 256 func (s *HidrawInterfaceSuite) TestConnectedPlugUDevSnippets(c *C) { 257 // add the plug for the slot with just path 258 spec := &udev.Specification{} 259 c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testSlot1), IsNil) 260 c.Assert(spec.Snippets(), HasLen, 2) 261 snippet := spec.Snippets()[0] 262 expectedSnippet1 := `# hidraw 263 SUBSYSTEM=="hidraw", KERNEL=="hidraw0", TAG+="snap_client-snap_app-accessing-2-devices"` 264 c.Assert(snippet, Equals, expectedSnippet1) 265 extraSnippet := spec.Snippets()[1] 266 expectedExtraSnippet1 := `TAG=="snap_client-snap_app-accessing-2-devices", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-2-devices $devpath $major:$minor"` 267 c.Assert(extraSnippet, Equals, expectedExtraSnippet1) 268 269 // add the plug for the first slot with vendor and product ids 270 spec = &udev.Specification{} 271 c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev1), IsNil) 272 c.Assert(spec.Snippets(), HasLen, 2) 273 snippet = spec.Snippets()[0] 274 expectedSnippet2 := `# hidraw 275 IMPORT{builtin}="usb_id" 276 SUBSYSTEM=="hidraw", SUBSYSTEMS=="usb", ATTRS{idVendor}=="0001", ATTRS{idProduct}=="0001", TAG+="snap_client-snap_app-accessing-2-devices"` 277 c.Assert(snippet, Equals, expectedSnippet2) 278 extraSnippet = spec.Snippets()[1] 279 expectedExtraSnippet2 := `TAG=="snap_client-snap_app-accessing-2-devices", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-2-devices $devpath $major:$minor"` 280 c.Assert(extraSnippet, Equals, expectedExtraSnippet2) 281 282 // add the plug for the second slot with vendor and product ids 283 spec = &udev.Specification{} 284 c.Assert(spec.AddConnectedPlug(s.iface, s.testPlugPort2, s.testUDev2), IsNil) 285 c.Assert(spec.Snippets(), HasLen, 2) 286 snippet = spec.Snippets()[0] 287 expectedSnippet3 := `# hidraw 288 IMPORT{builtin}="usb_id" 289 SUBSYSTEM=="hidraw", SUBSYSTEMS=="usb", ATTRS{idVendor}=="ffff", ATTRS{idProduct}=="ffff", TAG+="snap_client-snap_app-accessing-2-devices"` 290 c.Assert(snippet, Equals, expectedSnippet3) 291 extraSnippet = spec.Snippets()[1] 292 expectedExtraSnippet3 := `TAG=="snap_client-snap_app-accessing-2-devices", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-2-devices $devpath $major:$minor"` 293 c.Assert(extraSnippet, Equals, expectedExtraSnippet3) 294 } 295 296 func (s *HidrawInterfaceSuite) TestConnectedPlugAppArmorSnippets(c *C) { 297 expectedSnippet1 := `/dev/hidraw0 rw,` 298 apparmorSpec := &apparmor.Specification{} 299 err := apparmorSpec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testSlot1) 300 c.Assert(err, IsNil) 301 c.Assert(apparmorSpec.SecurityTags(), DeepEquals, []string{"snap.client-snap.app-accessing-2-devices"}) 302 snippet := apparmorSpec.SnippetForTag("snap.client-snap.app-accessing-2-devices") 303 c.Assert(snippet, DeepEquals, expectedSnippet1) 304 305 expectedSnippet2 := `/dev/hidraw[0-9]{,[0-9],[0-9][0-9]} rw,` 306 apparmorSpec = &apparmor.Specification{} 307 err = apparmorSpec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev1) 308 c.Assert(err, IsNil) 309 c.Assert(apparmorSpec.SecurityTags(), DeepEquals, []string{"snap.client-snap.app-accessing-2-devices"}) 310 snippet = apparmorSpec.SnippetForTag("snap.client-snap.app-accessing-2-devices") 311 c.Assert(snippet, DeepEquals, expectedSnippet2) 312 313 expectedSnippet3 := `/dev/hidraw[0-9]{,[0-9],[0-9][0-9]} rw,` 314 apparmorSpec = &apparmor.Specification{} 315 err = apparmorSpec.AddConnectedPlug(s.iface, s.testPlugPort2, s.testUDev2) 316 c.Assert(err, IsNil) 317 c.Assert(apparmorSpec.SecurityTags(), DeepEquals, []string{"snap.client-snap.app-accessing-2-devices"}) 318 snippet = apparmorSpec.SnippetForTag("snap.client-snap.app-accessing-2-devices") 319 c.Assert(snippet, DeepEquals, expectedSnippet3) 320 } 321 322 func (s *HidrawInterfaceSuite) TestConnectedPlugUDevSnippetsForPath(c *C) { 323 expectedSnippet1 := `# hidraw 324 SUBSYSTEM=="hidraw", KERNEL=="hidraw0", TAG+="snap_client-snap_app-accessing-2-devices"` 325 expectedExtraSnippet1 := `TAG=="snap_client-snap_app-accessing-2-devices", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-2-devices $devpath $major:$minor"` 326 udevSpec := &udev.Specification{} 327 err := udevSpec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testSlot1) 328 c.Assert(err, IsNil) 329 c.Assert(udevSpec.Snippets(), HasLen, 2) 330 snippet := udevSpec.Snippets()[0] 331 c.Assert(snippet, Equals, expectedSnippet1) 332 extraSnippet := udevSpec.Snippets()[1] 333 c.Assert(extraSnippet, Equals, expectedExtraSnippet1) 334 335 expectedSnippet2 := `# hidraw 336 IMPORT{builtin}="usb_id" 337 SUBSYSTEM=="hidraw", SUBSYSTEMS=="usb", ATTRS{idVendor}=="0001", ATTRS{idProduct}=="0001", TAG+="snap_client-snap_app-accessing-2-devices"` 338 expectedExtraSnippet2 := `TAG=="snap_client-snap_app-accessing-2-devices", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-2-devices $devpath $major:$minor"` 339 udevSpec = &udev.Specification{} 340 err = udevSpec.AddConnectedPlug(s.iface, s.testPlugPort1, s.testUDev1) 341 c.Assert(err, IsNil) 342 c.Assert(udevSpec.Snippets(), HasLen, 2) 343 snippet = udevSpec.Snippets()[0] 344 c.Assert(snippet, Equals, expectedSnippet2) 345 extraSnippet = udevSpec.Snippets()[1] 346 c.Assert(extraSnippet, Equals, expectedExtraSnippet2) 347 348 expectedSnippet3 := `# hidraw 349 IMPORT{builtin}="usb_id" 350 SUBSYSTEM=="hidraw", SUBSYSTEMS=="usb", ATTRS{idVendor}=="ffff", ATTRS{idProduct}=="ffff", TAG+="snap_client-snap_app-accessing-2-devices"` 351 expectedExtraSnippet3 := `TAG=="snap_client-snap_app-accessing-2-devices", RUN+="/usr/lib/snapd/snap-device-helper $env{ACTION} snap_client-snap_app-accessing-2-devices $devpath $major:$minor"` 352 udevSpec = &udev.Specification{} 353 err = udevSpec.AddConnectedPlug(s.iface, s.testPlugPort2, s.testUDev2) 354 c.Assert(err, IsNil) 355 c.Assert(udevSpec.Snippets(), HasLen, 2) 356 snippet = udevSpec.Snippets()[0] 357 c.Assert(snippet, Equals, expectedSnippet3) 358 extraSnippet = udevSpec.Snippets()[1] 359 c.Assert(extraSnippet, Equals, expectedExtraSnippet3) 360 } 361 362 func (s *HidrawInterfaceSuite) TestInterfaces(c *C) { 363 c.Check(builtin.Interfaces(), testutil.DeepContains, s.iface) 364 }