git-secret: some commands fail when the current directory's path includes spaces

Some commands, specifically at least git secret init and git secret reveal, encounter errors when the current directory’s path contains any spaces. I personally avoid using spaces in directory names, but I am attempting to set up git-secret with our CI server and must work around the existing structure there.

What are the steps to reproduce this issue?

In place of the suggested sections, I will provide two full examples which I hope will show the issue clearly.

Note: both of these examples take place on a machine on which I am able to use git-secret without issue when the path does not contain a space

Example 1 - Initializing to a directory which contains a space

Here is the base case where I try to set up git-secret from scratch in a directory which already contains a space in the path screen shot 2018-03-14 at 10 17 04 am

Example 2 - Calling git secret reveal from a directory which contains a space

Here, I first initialize git-secret and encrypt a file successfully in a directory with no spaces in the path so that I can get further along in the process. I then rename the directory to contain a space and try to call git secret reveal screen shot 2018-03-14 at 10 19 47 am

Any other comments?

I inserted some logging and played with the code a bit, and I believe the issue is stemming from lines of the form

$($gpg_local ......)

A little research pointed me towards the use of eval for better interpretation of commands formed by concatenating strings, but I am not sure of the security implications around that command.

What versions of software are you using?

Operating system: macOS 10.13.3

Darwin -- 17.4.0 Darwin Kernel Version 17.4.0: Sun Dec 17 09:19:54 PST 2017; root:xnu-4570.41.2~1/RELEASE_X86_64 x86_64

git-secret path: /usr/local/bin/git-secret

git-secret version: 0.2.2

git version: 2.11.1

Shell type and version: zsh 5.3 (x86_64-apple-darwin17.0)

gpg version: 2.2.5

About this issue

  • Original URL
  • State: open
  • Created 6 years ago
  • Comments: 20 (4 by maintainers)

Most upvoted comments

Relevant:

http://mywiki.wooledge.org/Quotes

http://mywiki.wooledge.org/BashFAQ/050#I_only_want_to_pass_options_if_the_runtime_data_needs_them

  • “You can use the ${var:+…} parameter expansion” (to build options at runtime)

I’m pretty sure this is extra important:

"rewrite the _get_gpg_local function to put those default arguments 
or whatever into an array instead. the way it is now it'll never work."- person on IRC

https://github.com/anordal/shellharden/blob/master/how_to_do_things_safely_in_bash.md

https://google.github.io/styleguide/shell.xml

Even though I closed this ticket some time ago, I don’t think this actually was ever fixed for the case of spaces in parent directories (we did fix the case of spaces in filenames and directories in the git-secret repo).

I’m not sure how to fix the underlying problem which is an issue with quoting in the gawk code

confirmed regression on current master branch. current automated testing asserts that using spaces with files works, but we don’t test the case when a parent directory contains spaces.

@joshrabinowitz thank you for your hard work! I know this was a challenging one. Awesome, that we got this fixed!

This is fixed by PR #224, which should be in the next release

I think we should release 0.2.4 without this fix (since we don’t have the fix yet).