Our new documentation site is alive!
You can view our latest documents here.
Sensei can be deployed in three different deployment modes:
- Passive Mode (Reporting only, no blocking)
- Routed Mode (L3 Mode, Reporting and Blocking available)
- With native netmap driver
- With emulated netmap driver
- Bridge Mode (L2 Mode, Reporting and Blocking available)
Default mode is the second option: Routed (L3 Mode) and with native netmap driver. If you don't know what you're doing; or do not understand the stuff here, we suggest you leave it on the default option.
See below for the detailed explanations for each of the deployment modes.
1. Passive Mode (Reporting only mode)
Passive mode is like Suricata's IDS mode. Sensei grabs a copy of packets from the configured interfaces and provides you with a wealth of information through its reporting.
In this mode, it's not possible to do blocking.
If you're having trouble with the netmap subsystem and still want to make use of Sensei's advanced reporting capabilities, this is the best option.
2. Routed Mode (L3 Mode, Reporting + Blocking)
Routed Mode is the option where you deploy Sensei on top of the firewall and you still make use of firewall's other services like L3/L4 filtering, routing, VPN and other plug-ins that are available.
In this mode, you can both do reporting and enjoy all of the filtering functionalities of the software.
This mode utilizes netmap(4), the underlying packet processing subsystem of the FreeBSD operating system. You have two options:
a. With native netmap driver
Being the default deployment option, this option allows you to be able to make use of native netmap performance with regard to Ethernet drivers.
Netmap can be picky when it comes to driver compatibility. If you suspect that your ethernet drivers does not play well with netmap, than your best bet is using L3 mode with the Emulated/Generic netmap driver. See below for details.
b. With Emulated/Generic netmap driver
As discussed above, if you suspect your Ethernet driver does not play well with netmap, you can use this option to be able to continue using Sensei with all of the functionality.
Be noted that emulated driver is not as performant as the Native netmap driver.
3. Bridge Mode (L2 Bridge Mode, Reporting + Blocking)
This experimental deployment mode allows you to be able to deploy Sensei like an Inline Web Secure Gateway.
In this mode, it's not possible to make use of other existing OPNsense functionality like firewalling, VPN and other plug-ins; since Sensei will bypass the Operating System and your device will act like a transparent filtering appliance.
This mode supports Hardware Assisted Bypass technologies. Currently only Silicom Bypass Adapters are supported.
With Hardware Assistent Bypass adapters, your device can act like a simple cable when there's a sofrware/hardware problem, when Sensei is shut down or even when the machine is powered off.