agh1467/plugins

OPNsense plugin collection

About the OPNsense plugins

The plugins collection offers users and developers a way to quickly build additions for OPNsense that can be optionally installed. As soon as they are upstreamed they will become available to everyone through the firmware GUI pages.

Plugins can do the following:

• Modify the menu, access control lists and look and feel (themes)
• Add additional server software and their respective GUI pages
• Create new authentication methods to be used within other subsystems
• Provide other types of devices and interfaces to the firewall
• Pull in additional packages that will update automatically
• Enhance the backend services with additional work tasks
• Allow custom start, stop and early scripts
• Persistent /boot/loader.conf modifications
• Additional themes for the web GUI

Now we need your help to enrich the plugins. Feel free to contact us at project AT opnsense DOT org or open GitHub issue to get in touch.

Stay safe, Your OPNsense team

A list of currently available plugins

benchmarks/iperf -- Connection speed tester
databases/redis -- Redis DB
devel/debug -- Debugging Tools
devel/grid_example -- A sample framework application
devel/helloworld -- A sample framework application
dns/bind -- BIND domain name service
dns/ddclient -- Dynamic DNS client
dns/dnscrypt-proxy -- Flexible DNS proxy supporting DNSCrypt and DoH
dns/dyndns -- Dynamic DNS Support
dns/rfc2136 -- RFC-2136 Support
emulators/qemu-guest-agent -- QEMU Guest Agent for OPNsense
ftp/tftp -- TFTP server
mail/postfix -- SMTP mail relay
mail/rspamd -- Protect your network from spam
misc/theme-cicada -- The cicada theme - dark grey onyx
misc/theme-rebellion -- A suitably dark theme
misc/theme-tukan -- The tukan theme - blue/white
misc/theme-vicuna -- The vicuna theme - blue sapphire
net/chrony -- Chrony time synchronisation
net/firewall -- Firewall API supplemental package
net/freeradius -- RADIUS Authentication, Authorization and Accounting Server
net/frr -- The FRRouting Protocol Suite
net/ftp-proxy -- Control ftp-proxy processes
net/google-cloud-sdk -- Google Cloud SDK
net/haproxy -- Reliable, high performance TCP/HTTP load balancer
net/igmp-proxy -- IGMP-Proxy Service
net/mdns-repeater -- Proxy multicast DNS between networks
net/ntopng -- Traffic Analysis and Flow Collection
net/radsecproxy -- RADIUS proxy provides both RADIUS UDP and TCP/TLS (RadSec) transport
net/realtek-re -- Realtek re(4) vendor driver
net/relayd -- Relayd Load Balancer
net/shadowsocks -- Secure socks5 proxy
net/siproxd -- Siproxd is a proxy daemon for the SIP protocol
net/sslh -- sslh configuration front-end
net/tayga -- Tayga NAT64
net/udpbroadcastrelay -- Control ubpbroadcastrelay processes
net/upnp -- Universal Plug and Play Service
net/vnstat -- Network traffic monitor
net/wireguard -- WireGuard VPN service
net/wol -- Wake on LAN Service
net/zerotier -- Virtual Networks That Just Work
net-mgmt/collectd -- Collect system and application performance metrics periodically
net-mgmt/lldpd -- LLDP allows you to know exactly on which port is a server
net-mgmt/net-snmp -- Net-SNMP is a daemon for the SNMP protocol
net-mgmt/netdata -- Real-time performance monitoring
net-mgmt/nrpe -- Execute nagios plugins
net-mgmt/telegraf -- Agent for collecting metrics and data
net-mgmt/zabbix-agent -- Zabbix monitoring agent
net-mgmt/zabbix-proxy -- Zabbix monitoring proxy
security/acme-client -- ACME Client
security/clamav -- Antivirus engine for detecting malicious threats
security/crowdsec -- Lightweight and collaborative security engine
security/etpro-telemetry -- ET Pro Telemetry Edition
security/intrusion-detection-content-et-open -- IDS Proofpoint ET open ruleset complementary subset for ET Pro Telemetry edition
security/intrusion-detection-content-et-pro -- IDS Proofpoint ET Pro ruleset (needs a valid subscription)
security/intrusion-detection-content-pt-open -- IDS PT Research ruleset (only for non-commercial use)
security/intrusion-detection-content-snort-vrt -- IDS Snort VRT ruleset (needs registration or subscription)
security/maltrail -- Malicious traffic detection system
security/openconnect -- OpenConnect Client
security/softether -- Cross-platform Multi-protocol VPN Program (development only)
security/stunnel -- Stunnel TLS proxy
security/tinc -- Tinc VPN
security/tor -- The Onion Router
sysutils/apcupsd -- APCUPSD - APC UPS daemon
sysutils/api-backup -- Provide the functionality to download the config.xml
sysutils/apuled -- PC Engine APU LED control (development only)
sysutils/dmidecode -- Display hardware information on the dashboard
sysutils/git-backup -- Track config changes using git
sysutils/hw-probe -- Collect hardware diagnostics
sysutils/lcdproc-sdeclcd -- LCDProc for SDEC LCD devices
sysutils/mail-backup -- Send configuration file backup by e-mail
sysutils/munin-node -- Munin monitoring agent
sysutils/nextcloud-backup -- Track config changes using NextCloud
sysutils/node_exporter -- Prometheus exporter for machine metrics
sysutils/nut -- Network UPS Tools
sysutils/puppet-agent -- Manage Puppet Agent
sysutils/smart -- SMART tools
sysutils/virtualbox -- VirtualBox guest additions
sysutils/vmware -- VMware tools
sysutils/xen -- Xen guest utilities
vendor/sunnyvalley -- Vendor Repository for Zenarmor (a.k.a Sensei, Next Generation Firewall Extensions)
www/c-icap -- c-icap connects the web proxy with a virus scanner
www/cache -- Webserver cache
www/nginx -- Nginx HTTP server and reverse proxy
www/web-proxy-sso -- Kerberos authentication module

A brief description of how to use the plugins repository

The workflow of the plugins repository is quite similar to the core repository, although the plugins have one source directory per plugin, while the core can be thought of a lone plugin.

Commits for individual plugins should therefore be split into individual chunks for each src/ directory so that they can be reviewed separately and also be applied remotely.

When an OPNsense release is built, the plugins are automatically added to the final package repository.

The most useful Makefile targets and their purpose is described below.

The make targets for the root directory:

• clean: remove all changes and unknown files
• lint: run syntax checks
• list: print a list of all plugin directories with comments
• style-fix: apply style fixes
• style: run style checks
• sweep: apply whitespace fixes

The make targets for any plugin directory:

• clean: remove all changes and unknown files
• collect: gather updates from target directory
• install: install to target directory
• lint: run syntax checks
• package: creates a package
• upgrade: upgrades existing package
• remove: remove known files from target directory
• style-fix: apply style fixes
• style: run style checks
• sweep: apply whitespace fixes

plugins's Issues

**Version number for config node**

For some reason the version number isn't working as expected. Need to figure out how that works and get it working correctly.

I'm thinking of using the dnscrypt-proxy version to keep the config in lockstep with the application.

It just so happens that the version of dnscrypt-proxy has 3 segments, the same as what is supported in the config nodes.

I'm contemplating including the plugin revision number as a suffix to the version number (e.g. 2.0.45-1), however, the config model is unlikely to change much between versions.

I think it may be reasonable to include it in the case of a model structure change due to new features being developed and implemented within a release. This would allow flexibility and a migration path for existing settings even within the same version of dnscrypt-proxy.

Something also to consider would be the case where the dnscrypt-proxy version number changes, but the settings don't (bug fixes, etc).

dnscrypt-proxy: Manual server configuration doesn't work

Describe the bug
When setting up the plugin for the first time and using manual server selection, dnscrypt-proxy won't start.

To Reproduce
Steps to reproduce the behavior:

1. Install dnscrypt-proxy plugin (i.e. with no prior config)
2. Configure dnscrypt-proxy
3. Check the box for enabling manual server selection
4. No servers display on the list for selection.

Starting dnscrypt-proxy results in a message from dnscrypt-proxy:
[FATAL] No servers configured

Expected behavior
dnscrypt-proxy has servers for selection on the menu.

Screenshots

Environment
2.0.45 r1

How to install this Branch of DNSCrypt-Proxy?

Hello there,

over the past month I've been tinkering and enjoying OPNsense, but when I started messing with DNSCrypt-proxy addon, I read that the master is a bit dated, vs your branch. And followed quite a bit of threads on the matter. So my question is, how exactly can I download this fork of DNSCrypt-proxy since it has a quite a bit of new features, including what I've been looking for: Anonymized DNSCrypt. Am I able to do this at all? maybe through some kind of command with CLI?

I'm still a noob when it comes to figuring out how to edit repositories and the like.

Input disabled_server_names not in dropdown list

Is your feature request related to a problem? Please describe.
Unable to add server names to disable_server_names which are not currently available in the drop down.

Describe the solution you'd like
I'd like to be able to enter server names which may not be currently present in sources, but might appear in the future.

Logs pages no longer show log entries

Important notices
Before you add a new report, we ask you kindly to acknowledge the following:

[X] I have read the contributing guide lines at https://github.com/opnsense/plugins/blob/master/CONTRIBUTING.md

[X] I have searched the existing issues and I'm convinced that mine is new.

[X] The title contains the plugin to which this issue belongs

Describe the bug
All of the log pages show no entries.

To Reproduce
Steps to reproduce the behavior:

1. View the log pages.

Expected behavior
Log entries are displayed.

Additional context
Was working before, it's not working now.

Environment

OPNsense 21.1.7_1-amd64
FreeBSD 12.1-RELEASE-p18-HBSD
OpenSSL 1.1.1k 25 Mar 2021