Skip to content

Commit 25f6717

Browse files
committed
Updated documentation to discuss supported hardware.
1 parent 2c57b1f commit 25f6717

File tree

1 file changed

+13
-15
lines changed
  • documentation/modules/auxiliary/client/hwbridge

1 file changed

+13
-15
lines changed

documentation/modules/auxiliary/client/hwbridge/connect.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
## Overview
22

33
This module connects to any Hardware device that supports the HWBridge API. For details
4-
on the HWBridge API see [API Reference](http://api.hwbridge.reference.rapid7.com). On successful connection to a HWBridge a
4+
on the HWBridge API see [API Reference](http://opengarages.org/hwbridge). On successful connection to a HWBridge a
55
HWBridge session will be established.
66

77
## Devices
88

9-
Any ELM327 or STN1100 interface will work with the HWBridge. However, the below list of devices was utilized for this testing, and are known goods.
10-
This should **not** be taken as an endorcement for a specific brand/vendor/seller in any way shape or form.
9+
When run on linux you can use the auxiliary/server/local_hwbridge to talk to any device supported by SocketCAN.
10+
It will work with natively supported devices (can), serial devices (slcan) and even virtual devices (vcan). For
11+
a list of supported SocketCAN hardware see the [eLinux website](http://elinux.org/CAN_Bus).
1112

12-
### USB
13+
Any ELM327 or STN1100 interface will work with the HWBridge. If you pick up any device that uses either of
14+
these chipsets can can connect via serial (USB or Bluetooth) it will work. These are popular and inexpensive
15+
devices. They are not as fast as some of the native CAN devices but they are plentiful and cheap.
1316

14-
### Bluetooth (less stable)
15-
16-
1. BAFX Products 34t5: [amazon](https://www.amazon.com/gp/product/B005NLQAHS), [BAFX Site](https://bafxpro.com/products/obdreader)
17-
18-
```
19-
Part Number: 1008
20-
Controller: ELM327
21-
Firmware Revision: 1.5
22-
Band rate: 38400
23-
```
17+
This module was also tested with the [Particle](https://Particle.io) Photon board. To utilize a Particle.io Photon board you
18+
will want to add the spark-msf-relay library to your project. See the library examples for details on
19+
how to extend your project to integrate it with Metasploit. If you are building an automotive project
20+
and you are using the [Carloop](https://carloop.io) then the spark-msf-relay library also includes an example app for carloop
21+
that you can simply flash to the device for full support.
2422

2523
## Bluetooth Adapter Connection
2624

2725
Bluetooth HWBridge adapters, depending on the Operating System, may take several additional steps to establish a connection and communications bus.
2826
The following steps were [recorded during the testing of this module](https://github.com/rapid7/metasploit-framework/pull/7795#issuecomment-274302326)
29-
on setting up the BAFX 34t5 with Kali Linux 2016.2 (rolling).
27+
on setting up the [BAFX 34t5](https://bafxpro.com/products/obdreader) with Kali Linux 2016.2 (rolling).
3028

3129
1. Ensure no locks on the Bluetooth device via: `rfkill list` (and subsequent `unblock` commands)
3230
2. Make sure Bluetooth service is started: `/etc/init.d/bluetooth start`, or `bluetoothd`

0 commit comments

Comments
 (0)