Improve quoting of values in set_key
#330
Conversation
The value of `quote_mode` must now be one of `auto`, `never` or `always`, to ensure that users aren't accidentally relying on any other value for their scripts to work. Surrounding quotes are no longer stripped. This makes it possible for the user to control exactly what goes in the .env file. Note that when doing `dotenv set foo 'bar'` in Bash, the shell will have already removed the quotes. Single quotes are used instead of double quotes. This avoids accidentally having values interpreted by the parser or Bash (e.g. if you set a password with `dotenv set password 'af$rb0'`. Previously, the `auto` mode of quoting had the same effect as `always`. This commit restores the functionality of `auto` by not quoting alphanumeric values (which don't need quotes). Plenty of other kinds of values also don't need quotes but it's hard to know which ones without actually parsing them, so we just omit quotes for alphanumeric values, at least for now.
| if quote_mode == "always": | ||
| value_out = '"{}"'.format(value_to_set.replace('"', '\\"')) | ||
| if quote: | ||
| value_out = "'{}'".format(value_to_set.replace("'", "\\'")) |
There was a problem hiding this comment.
Just so you know, this is not the correct way to escape strings surrounded by single quotes when it comes to shells like Bash (this is the way).
I don't know if this project has a goal of making .env files compatible with Bash, if it does, than this code will fail in this edge-case. These commands in the Bash command-line will demonstrate my point:
$ printf %s 'one'"'"'two'
one'two
$ printf %s 'one\'two'
>
(The last command doesn't run after pressing enter, but waits for a terminating single quote.)
There was a problem hiding this comment.
That's a very good point. I had actually forgotten about that rule. I'll see if we can do better with regards to matching Bash's behavior but I'm not sure it's worth it.
There was a problem hiding this comment.
@bbc2 I believe we are facing this bug. We have single quotes inside value, it is being [wrongly] escaped as \' (which is not the right way) and source .env of resulting file fails
3 participants
The value of
quote_modemust now be one ofauto,neveroralways, to ensure that users aren't accidentally relying on any other value for their scripts to work.Surrounding quotes are no longer stripped. This makes it possible for the user to control exactly what goes in the .env file. Note that when doing
dotenv set foo 'bar'in Bash, the shell will have already removed the quotes.Single quotes are used instead of double quotes. This avoids accidentally having values interpreted by the parser or Bash (e.g. if you set a password with
dotenv set password 'af$rb0'.Previously, the
automode of quoting had the same effect asalways. This commit restores the functionality ofautoby not quoting alphanumeric values (which don't need quotes). Plenty of other kinds of values also don't need quotes but it's hard to know which ones without actually parsing them, so we just omit quotes for alphanumeric values, at least for now.