Page MenuHomeVyOS Platform
Create Task
Maniphest T1001

show config commands - breaks when using backslashes in values
Closed, ResolvedPublicBUG
Actions

Description

Consider the following:

Set a node value with a backslash character, eg on the interface:

set interfaces ethernet eth0 description "Testing\ Hello\ World"
commit; exit

Description works ok:

vyos@vyos:~$ show interfaces
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
Interface        IP Address                        S/L  Description
---------        ----------                        ---  -----------
eth0             172.16.16.134/24                  u/u  Testing\ Hello\ World 
lo               127.0.0.1/8                       u/u  
                 ::1/128

Breakage when dumping config commands:

vyos@vyos:~$ show config commands
Could not parse the config file: Failed to parse config: Illegal string character: \

Details

Version
1.2.0-rc7

Revisions and Commits

rVYOSONEX vyos-1x
rVYOSONEXaa88d5192338 T1397: escape backslashes in output passed to configtree

Related Objects

Event Timeline

yun created this task.Nov 13 2018, 1:02 AM
yun updated the task description. (Show Details)
syncer triaged this task as Low priority.Nov 13 2018, 3:49 AM
syncer edited projects, added VyOS 1.2 Crux (VyOS 1.2.0-rc8); removed VyOS 1.2 Crux.
syncer edited projects, added VyOS 1.2 Crux (VyOS 1.2.0-rc9); removed VyOS 1.2 Crux (VyOS 1.2.0-rc8).Nov 20 2018, 12:44 PM
arne subscribed.Nov 26 2018, 2:33 PM

Is there any need to have backslashes in descriptions? Or, more generally: Is there any need to have non-ASCII characters in descriptions?

I am asking because we could either handle this in the setting part of the code (which could clear the backslashes and all other kinds of potentially unwanted special characters) or we handle this in the config printing code.

yun added a comment.EditedNov 26 2018, 2:53 PM
In T1001#26863, @arne wrote:

Is there any need to have backslashes in descriptions? Or, more generally: Is there any need to have non-ASCII characters in descriptions?

I am asking because we could either handle this in the setting part of the code (which could clear the backslashes and all other kinds of potentially unwanted special characters) or we handle this in the config printing code.

I gave this just as an example on how to reproduce it in an easy way. Setting it in the "description" field was maybe not the best example to showcase the real world issues with it.

I have a need for it when passing CLI arguments to OpenVPN (or maybe some other processes in the future?), via the openvpn-option fields:

set interfaces openvpn vtun1 openvpn-option '--pkcs11-id SafeNet,\ Inc./eToken/012345/SafeNet\ eToken\ 5110/ABCDEF'

so above works good but the only thing is that it breaks on v1.2.x with show config commands. It worked fine on 1.1.8.

I tried quoting the command as follows, but it's not allowed:

vyos@vyos# set interfaces openvpn vtun1 openvpn-option '--pkcs11-id "SafeNet, Inc./eToken/012345/SafeNet eToken 5110/ABCDEF"'

  Cannot use the double quote (") character in a value string
  Value validation failed
  Set failed

Or single quotes:

vyos@vyos# set interfaces openvpn vtun1 openvpn-option "--pkcs11-id 'SafeNet, Inc./eToken/012345/SafeNet eToken 5110/ABCDEF'"

  Cannot use the single quote (') character in a value string
  Value validation failed
  Set failed

If I don't escape the spaces, it will pass only the first word to openvpn as the argument, breaking the commandline.

syncer edited projects, added VyOS 1.2 Crux (VyOS 1.2.0-rc10); removed VyOS 1.2 Crux (VyOS 1.2.0-rc9).Nov 27 2018, 12:03 AM
arne added a comment.Nov 28 2018, 11:05 PM

The problem is fixed by the following pull request: https://github.com/vyos/vyos-1x/pull/60
Detailed description is added to the pull request.

Diffusion mentioned this in rVYOSONEXbf55a3a40f1e: T1001: Bugfix: Handle backslashes in values with "show configuration commands".Nov 28 2018, 11:05 PM
dmbaturin mentioned this in rVYOSONEX51d5bc278e6c: Merge pull request #60 from arnehaak/current.Nov 29 2018, 12:08 AM
dmbaturin mentioned this in rVYOSONEXe2aca14130f3: T1001: Bugfix: Handle backslashes in values with "show configuration commands".Nov 29 2018, 12:51 AM
dmbaturin mentioned this in rVYOSONEX354c20aa8046: T1001: escape backslashes in the input in the commands pipe as well..
dmbaturin mentioned this in rVYOSONEX652c626644d0: T1001: escape backslashes in the input in the commands pipe as well..
dmbaturin closed this task as Resolved.Nov 29 2018, 12:56 AM
dmbaturin claimed this task.
dmbaturin subscribed.

@arne I think it's a sensible workaround. It's an interesting design question whether we should escape backslashes in config output.

I've added the same fix to the commands pipe script. Another thing that, ahem, escaped me is that escape was also needed in the code that converts a config tree to commands. Should be also fixed now.

One possible issue is that if someone is using special characters in options that pass custom config lines to DHCPD etc. they may be affected, but I believe the possibility is theoretical. If anyone complains, we may try to find a way to escape backslashes only if they are not a part of a valid special character escape (\n, \t etc.).

syncer moved this task from Needs Triage to Finished on the VyOS 1.2 Crux (VyOS 1.2.0-rc10) board.Dec 5 2018, 11:59 PM
syncer added a project: VyOS-1.2.0-GA.Jan 25 2019, 2:38 PM
yun added a comment.Feb 11 2019, 12:32 PM

Just to add extra info to this ticket, I had a openvpn-option that i wanted to add but it contained a single quote. I was not able to do this (in version 1.8.x this worked).

As a workaround I did the following:

openvpn-option '--config /config/auth/vpn/openvpn.conf'

And in /config/auth/vpn/openvpn.conf I added the configuration option containing the single quote:

pkcs11-id "SafeNet, Inc./eToken/012345/Yun's Token/ABCDEF"

Hope someone finds this information helpful incase they run into the same issue :)

jestabro mentioned this in T1787: Failed config migration from V1.2.3 to 1.2-rolling-201911030217.Nov 8 2019, 3:09 PM
jestabro added a commit: rVYOSONEXaa88d5192338: T1397: escape backslashes in output passed to configtree.Nov 19 2019, 6:15 PM