diff --git a/doc/analyzing-a-capture.md b/doc/analyzing-a-capture.md index c7a38f7..d2069a6 100644 --- a/doc/analyzing-a-capture.md +++ b/doc/analyzing-a-capture.md @@ -1,3 +1,3 @@ # How we analyze a capture -Teams of highly trained squirrles. Video coming soon! \ No newline at end of file +Teams of highly trained squirrels. Video coming soon! \ No newline at end of file diff --git a/doc/configuration.md b/doc/configuration.md index f71670f..9b6386a 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -12,7 +12,7 @@ Through web UI you can set: - *EFF logo*, which shows EFF logo and *and* colored line. - **Device Input Mode**, which defines behaviour of built-in power button of the device. *Device Input Mode* could be: - *Disable button control*: built-in power button of the device is not used by Rayhunter; - - *Double-tap power button to start/stop recording*: double clicking on a built-in power button of the device stops and immediatelly restarts the recording. This could be useful if Rayhunter's heuristichs is triggered and you get the red line, and you want to "reset" the past warnings. Normally you can do that through web UI, but sometimes it is easier to double tap on power button. + - *Double-tap power button to start/stop recording*: double clicking on a built-in power button of the device stops and immediately restarts the recording. This could be useful if Rayhunter's heuristichs is triggered and you get the red line, and you want to "reset" the past warnings. Normally you can do that through web UI, but sometimes it is easier to double tap on power button. - **ntfy URL for Sending Notifications**, which allows setting a [ntfy](https://ntfy.sh/) URL to which notifications of new detections will be sent. The topic should be unique to your device, e.g., `https://ntfy.sh/rayhunter_notifications_ba9di7ie` or `https://myserver.example.com/rayhunter_notifications_ba9di7ie`. The ntfy Android and iOS apps can then be used to receive notifications. More information can be found in the [ntfy docs](https://docs.ntfy.sh/). - **Colorblind Mode** enables color blind mode (blue line is shown instead of green line, red line remains red). Please note that this does not cover all types of color blindness, but switching green to blue should be about enough to differentiate the color change for most types of color blindness. - With **Analyzer Heuristic Settings** you can switch on or off built-in [Rayhunter heuristics](heuristics.md). Some heuristics are experimental or can trigger a lot of false positive warnings in some networks (our tests have shown that some heuristics have different behaviour in US or European networks). In that case you can decide whether you would like to have the heuristics that trigger a lot of false positives on or off. Please note that we are constantly improving and adding new heuristics, so new release may reduce false positives in existing heuristics as well. diff --git a/doc/faq.md b/doc/faq.md index 9c6913c..bd37d7f 100644 --- a/doc/faq.md +++ b/doc/faq.md @@ -5,7 +5,7 @@ **It Depends**. Operation of Rayhunter does require the insertion of a SIM card into the device, but that sim card does not have to be actively registered with a service plan. If you want to use the device as a hotspot in addition to a research device, or get [notifications](./configuration.md), an active plan would of course be necessary. ### How can I test that my device is working? -You can enable the `Test Heuristic` under `Analyzer Heuristic Settings` in the config section on your web dashboard. This will cause an alert to trigger every time your device sees a cell tower, you might need to reboot your device or move around a bit to get this one to trigger, but it will be very noisey once it does. People have also tested it by building IMSI catchers at home, but we don't reccomend that, since it violates FCC regulations and will probably upset your neighbors. +You can enable the `Test Heuristic` under `Analyzer Heuristic Settings` in the config section on your web dashboard. This will cause an alert to trigger every time your device sees a cell tower, you might need to reboot your device or move around a bit to get this one to trigger, but it will be very noisey once it does. People have also tested it by building IMSI catchers at home, but we don't recommend that, since it violates FCC regulations and will probably upset your neighbors. diff --git a/doc/heuristics.md b/doc/heuristics.md index a131f7b..4de689d 100644 --- a/doc/heuristics.md +++ b/doc/heuristics.md @@ -6,7 +6,7 @@ Rayhunter includes several analyzers to detect potential IMSI catcher activity. ### IMSI Requested (v3) -This analyser tests whether the eNodeB sends an IMSI or IMEI Identity Request NAS message under suspicous . +This analyser tests whether the eNodeB sends an IMSI or IMEI Identity Request NAS message under suspicious . Mobile networks primarily request IMSI or IMEI from a mobile device during initial network attachment or when the network cannot identify the mobile device by its temporary identification (TMSI - *Temporary Mobile Subscriber Identity* or GUTI - *Globally Unique Temporary Identifier* in 4G/5G terminology). @@ -75,4 +75,4 @@ On its own this might just be a misconfigured base station (though we have only ### Test Analyzer -This analyzer is great for testing if your Rayhunter installation works. It will alert every time a new tower is seen (specifically every time a tower broadcasts a SIB1 message.) It is designed to be very noisey so we do not reccomend leaving it on but if this alerts it means your Rayhunter device is working! +This analyzer is great for testing if your Rayhunter installation works. It will alert every time a new tower is seen (specifically every time a tower broadcasts a SIB1 message.) It is designed to be very noisey so we do not recommend leaving it on but if this alerts it means your Rayhunter device is working! diff --git a/doc/installing-from-release-windows.md b/doc/installing-from-release-windows.md index e93a218..5bf9d80 100644 --- a/doc/installing-from-release-windows.md +++ b/doc/installing-from-release-windows.md @@ -14,7 +14,7 @@ Windows support in Rayhunter's installer is a work-in-progress. Depending on the
-[The Windows USB installer is known to be buggy](https://github.com/EFForg/rayhunter/issues/366). We strongly reccomend using the [Network-based installer](./orbic.md#the-network-installer). +[The Windows USB installer is known to be buggy](https://github.com/EFForg/rayhunter/issues/366). We strongly recommend using the [Network-based installer](./orbic.md#the-network-installer).
diff --git a/doc/installing-from-release.md b/doc/installing-from-release.md index b0a9e2e..9768740 100644 --- a/doc/installing-from-release.md +++ b/doc/installing-from-release.md @@ -21,7 +21,7 @@ Make sure you've got one of Rayhunter's [supported devices](./supported-devices. 4. Turn on your device by holding the power button on the front. * For the Orbic, connect the device using a USB-C cable. - * Or connect to the network if using the network based installer, this is especially reccomended on Windows. + * Or connect to the network if using the network based installer, this is especially recommended on Windows. * For TP-Link, connect to its network using either WiFi or USB Tethering. 5. Run the installer: diff --git a/doc/tplink-m7350.md b/doc/tplink-m7350.md index 95a70f6..ea40c10 100644 --- a/doc/tplink-m7350.md +++ b/doc/tplink-m7350.md @@ -52,7 +52,7 @@ If your device has a one-bit (black-and-white) display, Rayhunter will instead s ## Power-saving mode/sleep By default the device will go to sleep after N minutes of no devices being connected. In that mode it will also turn off connections to cell phone towers. -In order for Rayhunter to record continuously, you have to turn off this sleep mode in TP-Link's admin panel (go to **Advanced** - **Power Saving**) or keep e.g. your phone connectd on the TP-Link's WiFi. +In order for Rayhunter to record continuously, you have to turn off this sleep mode in TP-Link's admin panel (go to **Advanced** - **Power Saving**) or keep e.g. your phone connected on the TP-Link's WiFi. ## Port triggers diff --git a/doc/using-rayhunter.md b/doc/using-rayhunter.md index 12a24b1..0ac71f1 100644 --- a/doc/using-rayhunter.md +++ b/doc/using-rayhunter.md @@ -28,4 +28,4 @@ You can access this UI in one of two ways: ## Key shortcuts -As of Rayhunter verion 0.3.3, you can start a new recording by double-tapping the power button. Any current recording will be stopped and a new recording will be started, resetting the red line as well. This feature is disabled by default since Rayhunter version 0.4.0 and needs to be enabled through [configuration](./configuration.md). +As of Rayhunter version 0.3.3, you can start a new recording by double-tapping the power button. Any current recording will be stopped and a new recording will be started, resetting the red line as well. This feature is disabled by default since Rayhunter version 0.4.0 and needs to be enabled through [configuration](./configuration.md).