Plus (+) in hostnames causes non working URLs

[jjaritsch]

• I have read and understood docs/Issues.md.

Describe the bug
Plus (+) in hostnames are causing some URL crash.

To Reproduce
Steps to reproduce the behavior:

1. add device with + in hostname (like hostname+routername+(test123+))
2. Try to open /node/version?node_full=default/hostname+routername+(test123+)

Expected behavior
Get to the configs overview.

Fix
After some testing, I identified these files:
lib/oxidized/web/views/diffs.haml
lib/oxidized/web/views/nodes.haml
lib/oxidized/web/views/node.haml

Maybe there are more, but the relevant part in these files is @data[:full_name], which is not URL encoded. After changing it from @data[:full_name] to CGI.escape(@data[:full_name]) all the URLs for devices with + in the names are working.
I am pretty sure this is an super ugly fix, but one of you will for sure know the best location to implement this and provide a patch :). Please don't grill me, I am not an dev :).

Thank you!

best regards
JJ

[jjaritsch]

First fail: looks like this should be moved to https://github.com/ytti/oxidized-web/issues - can someone please move it?
thank you!

[robertcheramy]

Note: "+" is not allowed in hostnames, see https://www.rfc-editor.org/rfc/rfc952

Moving the issue to oxidized-web.

[jjaritsch]

Note: "+" is not allowed in hostnames, see https://www.rfc-editor.org/rfc/rfc952

Moving the issue to oxidized-web.

I want to share some more details - maybe I failed and have overseen something:

I do source my device list from librenms. In librenms devices are created first with the IP only and afterwards we set the "display name", which is a combination of the devicename, location and device typ.

Schema: deviceID.type.sitename (Vendor xxx)
Examples:

• n01.oob.siteid.city.country (CRS326-24G-2S+)
• n11.5506.vie.at (Juniper MX204)

And this is where the fun starts: we do use the device name as ultimate identifier cause some devices can have dynamic IPs. But updating the IP will result in a broken history in Oxidized. In librenms the field "IP" and "hostname" per device is always only filled with the IP of the device.

For this reason I did apply the following changes, to be able to use the displayname as hostname in Oxidized:
/opt/librenms/includes/html/api_functions.inc.php

Line 1699:
Original query:

             ->select(['devices.device_id', 'hostname', 'sysName', 'sysDescr', 'sysObjectID', 'hardware', 'os', 'ip', 'location_id', 'purpose', 'notes', 'poller_group'])

Patched query:

             ->select(['devices.device_id', 'hostname', 'sysName', 'sysDescr', 'display', 'sysObjectID', 'hardware', 'os', 'ip', 'location_id', 'purpose', 'notes', 'poller_group'])

Line 1705:
Origianl code:

            'hostname' => $device->hostname,

Patched code:

            'hostname' => $device->display,

This is my Oxidized config:

source:
  default: http
  debug: false
  http:
    url: https://librenms.domain.com/api/v0/oxidized
    map:
      name: hostname
      ip: ip
      model: os
      group: group
      vars:
        ssh-port: ssh-port
    headers:
      X-Auth-Token: deadbeef

And this is the result in Oxidizied-web:

Is there any other way to get the displayname in Oxidized ?

Thank you!

br, JJ

[robertcheramy]

Oxidized use the "name" as its identifier for nodes. If provided with an IP-Address, it won't make a DNS resolution, so your case is valid.
The node probably has to be url-encoded in

oxidized-web/lib/oxidized/web/views/nodes.haml

Lines 36 to 41 in 02ef7d6

	%a{href: url_for("/node/show/#{node[:name]}")} #{node[:name]}
	%td= node[:ip]
	%td
	%a{href: url_for("/nodes/model/#{node[:model]}")} #{node[:model]}
	%td
	%a{href: url_for("/nodes/group/#{node[:group]}")} #{node[:group]}

[jjaritsch]

If provided with an IP-Address, it won't make a DNS resolution

This is also something I've recognized. For that reason I've set:

resolve_dns: false

[jjaritsch]

probably has to be url-encoded in

oxidized-web/lib/oxidized/web/views/nodes.haml

Lines 36 to 41 in 02ef7d6

	%a{href: url_for("/node/show/#{node[:name]}")} #{node[:name]}
	%td= node[:ip]
	%td
	%a{href: url_for("/nodes/model/#{node[:model]}")} #{node[:model]}
	%td
	%a{href: url_for("/nodes/group/#{node[:group]}")} #{node[:group]}

Hm, I would say this is only the description table and not the URLs? I guess it's more about

oxidized-web/lib/oxidized/web/views/nodes.haml

Lines 49 to 57 in 02ef7d6

	href: url_for("/node/fetch/#{node[:full_name]}")}
	%i.bi.bi-cloud-download
	  
	%a.link-body-emphasis.link-underline-opacity-0{title: 'Versions',
	href: url_for("/node/version?node_full=#{node[:full_name]}")}
	%i.bi.bi-stack
	  
	%a.link-body-emphasis.link-underline-opacity-0{title: 'Update configuration',
	href: url_for("/node/next/#{node[:full_name]}")}

For me all other URLs worked with no problems, but the link to the versions did not.

[github-actions]

This issue is stale because it has been open 90 days with no activity.