`docker/entrypoint.sh` line endings can be implicitly converted to CRLF by Git, breaking execution in Alpine.

[alilleybrinker]

Prerequisites

• Put an X between the brackets on this line if you have done all of the following:
  • Checked the FAQs on the message board for common solutions: (TBD)
  • Checked that your issue isn't already filed.

Description

The docker/entrypoint.sh script gets run in an Alpine Linux container, where it is expected to have Linux line endings (just a line-feed). It will produce an error about incorrect syntax when /bin/sh tries to run it if the line endings are Windows line-endings.

Unfortunately, Git can be (and commonly is) configured to "correct" line endings in checked out files to those used by the local system (in my case, Windows). When I checked out this repo, the entrypoint.sh script had its line endings changed to Windows' CRLF (carriage-return and line-feed), giving me syntax errors when Alpine tries to run the script (which gets copied into the container as defined by the dev Dockerfile).

Steps to Reproduce

The quickest response will be spurred by providing a Postman json file with the exact request or progression of requests that cause the issue.

If a Postman file cannot be provided:

1. Be on Windows
2. Have a Git install configured to change line endings to CRLF
3. Clone the `cve-services` repository
4. Follow the docker/README.md instructions for instantiating a local dev instance of cve-services
5. Observe a /bin/sh syntax error (my apologies, I didn't capture the exact error message before fixing it myself locally).

Expected behavior:

Be able to run entrypoint.sh in Alpine without syntax errors.

Actual behavior:

/bin/sh in Alpine reports syntax errors for entrypoint.sh, causing container startup to fail.

Reproduces how often:

100% of the time on Windows when the repository was checked out with a Git config that replaces line endings with Windows line endings.

Versions

I've only tried to current instance of the repo.

Additional Information

You can use Git attributes to fix this, by specifying with them that the entrypoint.sh file should never have its line endings changed during Git checkout. See the Git docs for more info: https://git-scm.com/docs/gitattributes#_eol

[david-rocca]

Hey @alilleybrinker, Did you see this on the test branch?

We have a pr merged (that has not made it into prod yet) that fixes this from a few months ago: #1090

[alilleybrinker]

Strange, I saw this on the dev branch. Now I'm wondering if something else changed my line endings (VS Code maybe?). At any rate, I think this can be closed!

[M-nj]

this is often caused by \r\n existing inside the docker/entrypoint.sh file.

Follow these steps when on windows to fix this issue:

• clone cve-services
  • git clone https://github.com/CVEProject/cve-services.git
• go inside cve-services
  • cd cve-services
• if on windows, this step is required so that the docker entrypoint.sh can work properly (\r\n breaks things)
  • git config core.autocrlf false
• go to proper branch to build from
  • git switch dev
• restore so that it fixes any \r\n from the initial clone
  • git restore .
• ensure git status shows no modified files
  • git status
• build docker containers
  • cd docker
  • docker compose build --no-cache --build-arg CVE_PREFLIGHT="wget -q -O - --no-check-certificate https://gitlab.mitre.org/mitre-scripts/mitre-pki/raw/master/os_scripts/install_certs.sh | sh"
  • docker compose up
• if this is your first time running docker you will need to expect permissions to share files (select yes to file sharing where needed)