net/wol: make UDP port configurable (default 9) by touzenesmy · Pull Request #5448 · opnsense/plugins

touzenesmy · 2026-05-15T18:07:50Z

Important notices

Before you submit a pull request, we ask you kindly to acknowledge the following:

I have read the contributing guidelines at https://github.com/opnsense/plugins/blob/master/CONTRIBUTING.md
I opened an issue first for non-trivial changes and linked it below. (Not me, this is for other's issue that I also met myself)
AI tools were used to create at least part of the code submitted herewith.

If AI was used, please disclose:

Model used: Claude
Extent of AI involvement: Find the releavant files to modify. The modification is small so the AI involvment was quasi-inexistent (proof read that no typos where added).

Describe the problem

The actual WoL implementation of the plugin doesn't allow for port configuration and default to the 40000 BSOD default value. There is no way to configure the WoL port.

Describe the proposed solution

Add a field port that defaults to 9, users can just use it when they have a specific need as seen previously. I've edited the script to take in that parameter as well.
EDIT: Already modified locally and verified to work on correct ports with packet capture.

Related issue

If this pull request relates to an issue, link it here.
#2967, #4079, #1648

sopex

My suggestions for improvement:

You have to create a simple migration file for the saved WOL hosts to keep the already used port when users update.
The saved hosts shall also show the port in the table.
Make this a <br> instead of and <hr>

plugins/net/wol/src/opnsense/mvc/app/views/OPNsense/Wol/index.volt

Line 101 in 3e46afb

<hr />
Add a <br> here:

plugins/net/wol/src/opnsense/mvc/app/views/OPNsense/Wol/index.volt

Line 105 in 3e46afb

Also, some minor things.

sopex · 2026-05-17T21:25:29Z

                <Default>00:00:00:00:00:00</Default>
                <ValidationMessage>Should be 6 groups of 2 hex characters (a-fA-F0-9) separated by ':'.</ValidationMessage>
            </mac>
+            <port type="IntegerField">


Give PortField a try here https://docs.opnsense.org/development/frontend/models_fieldtypes.html#portfield

Done, will be in next commit. Thanks for the input !

Suggest by sopex: Cleaner update Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

sopex suggestion merge 2 Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

Changed Integerfield to PortField in WoL.xml Modified index.volt to include port Added migration script

touzenesmy · 2026-05-18T17:53:51Z

Thanks @sopex ! All your suggestions were added.

sopex

I will test it later, but it looks good to me and pretty useful!

sopex · 2026-05-18T18:07:18Z

+<?php
+
+/*
+ * Copyright (C) 2026 <your name>


Probably add something here :)

sopex · 2026-05-18T18:15:24Z

+    /**
+     * Existing WoL hosts predate the configurable port and were always
+     * sent to UDP port 40000 (the previous hard-coded value). Preserve
+     * that behaviour on upgrade so existing hosts keep working; only new
+     * hosts get the sane default of 9.
+     * @param $model
+     */


Suggested change

/**

* Existing WoL hosts predate the configurable port and were always

* sent to UDP port 40000 (the previous hard-coded value). Preserve

* that behaviour on upgrade so existing hosts keep working; only new

* hosts get the sane default of 9.

* @param $model

*/

/**

* Migrates from hardcoded port

* @param $model

*/

Changed function for autofill 40000 for migration by default. Port will be 9 as default for new installs.

sopex · 2026-05-18T18:59:43Z

Are you sure about removing the if statement? Have you tested the migration? I am not sure, just asking

touzenesmy · 2026-05-18T19:35:09Z

Are you sure about removing the if statement? Have you tested the migration? I am not sure, just asking

Yes, the if would have added a condition if people already did it themselves but I would rather have a proper update that would treat the previous version as untouched.
I will test when I have a moment and I'll let you know

touzenesmy · 2026-05-18T19:47:54Z

Alright, I tested the latest changes locally and it seems to work (tested the migration as well, port is put at 40000). New ports are pre filled at 9, packet capture confirms it works as intended.

Thank you so much for your support

sopex · 2026-05-18T22:36:27Z

@fichtner If you have a moment, I believe it's ready for prime time.
With the exception of a missing new line :)

Thanks!

Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

sopex

More like this

Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

touzenesmy · 2026-05-19T14:30:28Z

More like this

Just applied, do you mind explaining ?
EDIT: I understand now 👍 Thanks !

sopex · 2026-06-03T12:21:05Z

I know things are busy, but there is no plugin maintainer here. FWIW: I have tested it, and it works great.

fichtner · 2026-06-03T12:57:29Z

-        $result['status'] = trim($backend->configdRun("wol wake {$broadcast_ip} " . escapeshellarg((string)$wolent->mac)));
+        $port = escapeshellarg((string)$wolent->port);
+        $mac = escapeshellarg((string)$wolent->mac);
+        $result['status'] = trim($backend->configdRun("wol wake {$port} {$broadcast_ip} {$mac}"));


this needs to be rewritten for configdpRun() second argument is the array with all unescaped values.. ideally from getValue() and not string cast

fichtner · 2026-06-03T13:00:08Z

                <ValidationMessage>Should be 6 groups of 2 hex characters (a-fA-F0-9) separated by ':'.</ValidationMessage>
            </mac>
+            <port type="PortField">
+                <Required>Y</Required>


the issue with requiring this is now the user needs to input it or else validation fails. "9" isn't added automatically and the migration uses '4000' which would be automatic if we used that default ;)

Oh, in my testing 9 is prefilled automatically. Are you sure about that ?
EDIT: Just tested and it does prefill correctly

fichtner · 2026-06-03T13:03:10Z

@sopex I guess you meant me ;)

@touzenesmy It's not bad but the assumptions for 4000 vs. 9 derails this. An optional port field would be more user friendly (even hide under advanced and we don't really need it in the grid). While I don't have strong opinions about which value is more correct trying to appease both is not going to work.

sopex · 2026-06-03T13:08:40Z

@fichtner Absolutely :)
In my experience, port 9 is more frequently used. (ubuntu, windows and rhel)

touzenesmy · 2026-06-03T17:00:22Z

@sopex I guess you meant me ;)

@touzenesmy It's not bad but the assumptions for 4000 vs. 9 derails this. An optional port field would be more user friendly (even hide under advanced and we don't really need it in the grid). While I don't have strong opinions about which value is more correct trying to appease both is not going to work.

The 40000 is for those who already preconfigured their firewall to allow the request on port 40000 in the previous version (I think its UNIX default). Port 9 is prefilled in directly without user input but can be changed by the user if needed (Most systems today and also most tutorials I've checked for WoL assume port 9 is used)

net/wol: make UDP port configurable (default 9)

26b3484

sopex reviewed May 17, 2026

View reviewed changes

touzenesmy and others added 3 commits May 18, 2026 13:11

Update net/wol/Makefile

7d154ec

Suggest by sopex: Cleaner update Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

Apply suggestions from code review

24a3de4

sopex suggestion merge 2 Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

sopox suggestions commit

42f587c

Changed Integerfield to PortField in WoL.xml Modified index.volt to include port Added migration script

sopex reviewed May 18, 2026

View reviewed changes

Removed if statement for migration

6d4f941

Changed function for autofill 40000 for migration by default. Port will be 9 as default for new installs.

Apply suggestion from @sopex

fa0ebfe

Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

sopex reviewed May 19, 2026

View reviewed changes

Comment thread net/wol/src/opnsense/mvc/app/models/OPNsense/Wol/Migrations/M1_0_1.php Outdated

Comment thread net/wol/src/opnsense/mvc/app/views/OPNsense/Wol/index.volt

Apply suggestions from code review

e2ad246

Co-authored-by: Konstantinos Spartalis <scoon405@gmail.com>

fichtner reviewed Jun 3, 2026

View reviewed changes

Conversation

touzenesmy commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sopex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

touzenesmy commented May 18, 2026

Uh oh!

sopex left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sopex commented May 18, 2026

Uh oh!

touzenesmy commented May 18, 2026

Uh oh!

touzenesmy commented May 18, 2026

Uh oh!

sopex commented May 18, 2026

Uh oh!

sopex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

touzenesmy commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sopex commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

touzenesmy Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fichtner commented Jun 3, 2026

Uh oh!

sopex commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

touzenesmy commented Jun 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

touzenesmy commented May 15, 2026 •

edited

Loading

touzenesmy commented May 19, 2026 •

edited

Loading

sopex commented Jun 3, 2026 •

edited

Loading

touzenesmy Jun 3, 2026 •

edited

Loading

sopex commented Jun 3, 2026 •

edited

Loading