Feature Request: siproxd integration

[NicholasRush]

Bezogen auf Forenthread: https://forum.opnsense.org/index.php?topic=5799

Dokumentation zur Integration von Siproxd in OPNsense.pdf

Ich hoffe ich habe das gut genug erklärt.

[mimugmail]

Tomorrow I'll start with the basic layout.
Thanks for the excellent explanation! 👍

[fichtner]

@NicholasRush Very good spec, thank you!

[mimugmail]

@NicholasRush I'm quite busy with a multi wan issue here, only little time for creating the model.
Is it ok to start testing mid of next week?

[NicholasRush]

@mimugmail No problem, because i am currently ill. And i think i need about two weeks to be healthy again.

[mimugmail]

pkg install git
opnsense-code -a mimugmail plugins
cd /usr/plugins
git checkout siproxd
cd net/siproxd
make package
pkg install work/pkg/o*

It's missing some stuff.
Is siproxd able to handle multiple outbound_domain_name at once? So can multiple be enabled?
If no I'd add jsut a single form field, if yes then a new tab with dialog fields.

[NicholasRush]

@mimugmail Oh that´s very fast. Yes siproxd definitivly can handle multiple options of these entrys:

outbound_domain_name = freenet.de
outbound_domain_host = proxy.for.domain.freende.de
outbound_domain_port = 5060

[mimugmail]

Ok, then we need two new tabs for users and outbound_domains, use_rport dropdown, ACLs and the plugins.

How about registered devices? Is it just looking at the content of registration_file ?

[NicholasRush]

For the registered-devices file, there just have to be a protected text area Box or a scrollable <div> with the content of the registration_file.

[mimugmail]

Regarding plugins, we only need the stuff "Essential for OPNsense"?

It's getting quite complex to make all of the useable/configureable like in you doc, esp. regexp and shortcall.

[fichtner]

a minimum viable plugin is a great start to wait and reassess later on

[mimugmail]

I'm only asking because I don't know which ones are essential to run the plugin at all since I have never used siproxd :)

[mimugmail]

@NicholasRush Can you show me an example output of registrations?

ATM my output looks like this:

[NicholasRush]

@mimugmail
Yes the output is right, because my looks the same. If clients have to authenticate at siproxd, then there should be more detailed output in the file. But i don´t use the authentication feature and than there will be nothing more like this.

The siproxd webgui plugin does not need to be "as fast as possible" ready to use. It is better to have more configuration features from the beginning, than a plugin which you have, but you cannot use it how you need it. I already know that my requirements, how the form should work, are not easy to develop.
When it´s possible it would be better to put all configuration options in an XML file, and in that file you change things like, enable users, add outbound proxies etc. And if you save your configuration, than it first writes everything to the XML file, and from that it generates a minimal siproxd configuration with all currently enabled options. Like an helper file.

[mimugmail]

Plugins are missing and "Current registrations" need some newlines, then it's finished :)

[NicholasRush]

@mimugmail Wow, this looks very very nice! I will test it soon.

[mimugmail]

@NicholasRush with the latest update you can install the plugin via CLI:

pkg install siproxd os-siproxd-devel

Would be cool if you find the time to test it, it wont go stable without your OK :)

[fichtner]

PS. siproxd installs automatically

[NicholasRush]

I will test the plugin completely at the weekend.

[NicholasRush]

@mimugmail There are currently too many bugs in it, to make the plugin public available. First there are small bugs like the interface settings, which are not set.

The rport option sets a variable.

The RTP input and output dejitter cannot be set.

---

Without this option the user auth. cannot work.

---

Thats what i have currently found out.

If i find more bugs i will post them here.

[fichtner]

“Option3” is a new core feature that is missing from your install (development version)

Siproxd is still in development mode... we can take as many iterations as necessary before it is shipped as 1.0 in an actual opnsense release. 😊

[NicholasRush]

The Bugs, that i have described, are all that i could find. If they are fixed to the end of next weekend, i will test it again.

[mimugmail]

Thanks for testing! I'll fix them the next days and give you a note :)

[mimugmail]

Hi @NicholasRush, patches are in but not as a pkg yet.

If you want to test:

rm -rf /usr/plugins/
opnsense-code -a opnsense plugins
cd /usr/plugins/net/siproxd
make package
pkg install work/pkg/o*

[fichtner]

This is enough... ;)

# opnsense-code -f plugins
# cd /usr/plugins/net/siproxd
# make upgrade

[mimugmail]

again what learned :D

[NicholasRush]

The authentication and the inbound and outbound interface settings are working now. Whats not working, is the in- output dejitter. Because i cannot change the setting. The "Remote ports in VIA-Header"-Option is also not working currently.

And maybe, but that´s is an option that could be added when the bugs are fixed, is a reminder that is showing up when a user add, remove, activate or disable a user in the users-tab or change something in the outbound proxy tab. The reminder could be the same that is showing up when you change in the firewall settings a rule. I think that is useful, because nobody knows that he has to save the config on the "general"-tab to activate the changed settings in these tabs.

[mimugmail]

Which browser are you using? For me dejitter stuff is working fine.
The Option setting will only work when you add some patches, these will be included soon, so not a real bug.

I can add an additional save button in the users tab, no problem :)

[NicholasRush]

@mimugmail I use Google Chrome for browsing and testing. With the dejitter stuff i only mean, that i cannot set the value, how much milliseconds delayed should.
In the siproxd.conf itself the dejitter value is set but the value is always the same, that´s what i mean.

When you add an additional save button to the users tab, you should also add a save button to the outbound proxy tab. Then i am happy. :)

[mimugmail]

Oh, I thought this is 0 for disable and 1 for enable :) I'll fix this!

[fichtner]

motivational post: @mimugmail @NicholasRush thank you both for the work!

[mimugmail]

Show must go on :)

@NicholasRush

If you want the option thing fixed:

opnsense-patch c7c1c55
opnsense-patch ecb0f41
opnsense-patch 60b0b26

And the other things just to again:

opnsense-code -f plugins
cd /usr/plugins/net/siproxd
make upgrade

[fichtner]

the "option thing" has been shipped in OPNsense 17.7.4 ;)

https://github.com/opnsense/changelog/blob/master/doc/17.7/17.7.4#L24

[mimugmail]

Whoopsie .. so forget about this one :)

[NicholasRush]

@mimugmail Now everything is working fine. Great work.

I think it could be now released to the public.

[fichtner]

ok, if @mimugmail agrees I'll change it to 1.0 and remove the development lock so that it will show up in 17.7.6. :)

[mimugmail]

@EugenMayer have tested it yet? Would be cool to have a second beta tester before going stable :)

[EugenMayer]

@mimugmail i would love to, still waiting for the answer in the forum ( https://forum.opnsense.org/index.php?topic=5799.msg25578#msg25578 ) to be actually sure i am falling into that case.. before i test and the result is "still not working" .. but the reason is, its just not for my case.

Does not help here, if i add FUD to the issue :)

[fichtner]

@mimugmail release? :D

[mimugmail]

Release, but dont be mad when there is some trouble in the beginning ;)

[fichtner]

never! thanks to you all!

[NicholasRush]

The trouble in the beginning should not be a big problem. If anyone have trouble with it, he or she should write in this Forum topic: https://forum.opnsense.org/index.php?topic=6112.0
And if there is a problem with the help inside the Plugin, i will change the help text and that can be pulled as patch from my Github account then.