practicality of read-only config.xml API endpoint

[fichtner]

To be discussed, see https://forum.opnsense.org/index.php?topic=9707.0

[ccesario]

+1

[AdSchellevis]

I'm not against an endpoint for config retrieval, although I believe it should be part of a rewrite for diag_backup.php, since it's overlapping functionality. It's not very high on my list of things to work on to be honest.

Building a plugin that only serves a download config isn't much work, for consistency reasons probably won't be offered by us (certainly not in core, without replacing the old backup solution).

[fichtner]

I was thinking such a temporary spot could maybe reside in the firmware API?

[AdSchellevis]

It could, but eventually the backup api should probably have a different endpoint to better control access (people able to upgrade might not be granted access to everything that's stored in the box).

Another short term solution could be to add the download action to diag_backup.php which makes it the responsibility of whoever is going to replace this code in the future (which isn't a big issue given the functionality should be in the new api as well).

[fichtner]

The issue with diag_backup.php or any other static page is that it's not API-key enabled. Otherwise that'd be working already...

[AdSchellevis]

sorry, my mistake, moving the download to a new spot at a different namespace and using it in the legacy page could also be an option (kind of a hybrid approach), but the risk stays that eventually nobody is willing to invest into the real elephant in the room (moving the functionality), creating an indefinite hybrid component....

Adding a plugin with only a download action is easy to build and doesn't taint our support status (could stay at community support level) and can use it's own access control (lower risk of leaking sensitive data).

[fichtner]

Now that you mention it... great idea to go forward indeed. :) That satisfies requirements from all sides and does not create roadblocks. Shall I move this to plugins then with a concrete plan?

[AdSchellevis]

sure, if anyone is planning to work on it, I would even offer help if needed (just don't want to own the plugin).

[fabianfrz]

Without encryption other data support, it would be an API endpoint with around less than 10 lines of code to download the current configuration.

[fichtner]

@fabianfrz is that a "I'll take it"? :)

moving over to opnsense/plugins#865