Skip to content

communicator: add note to docs on protocol/Windows#146

Merged
lbajolet-hashicorp merged 1 commit intomainfrom
ssh_protocol_note_windows
Jan 11, 2023
Merged

communicator: add note to docs on protocol/Windows#146
lbajolet-hashicorp merged 1 commit intomainfrom
ssh_protocol_note_windows

Conversation

@lbajolet-hashicorp
Copy link
Copy Markdown
Contributor

Recently, an update to Windows's default SSH implementation added an extra check for the mark-of-the-web to their code, which if in verbose mode, ends-up producing an error log, and terminates the process with a non-zero error code, even if the transfer is successful.

Because of this, scp transfers fail all the time in such an environment, and the recommended workaround for now is to set sftp as the transfer protocol, as this one sets the mark-of-the-web successfully, and therefore ends with a 0 error code.

Since this is surprising behaviour to users, we add a paragraph to the docs, so they know about this workaround.

@lbajolet-hashicorp lbajolet-hashicorp requested a review from a team as a code owner January 10, 2023 15:38
@lbajolet-hashicorp lbajolet-hashicorp force-pushed the ssh_protocol_note_windows branch from 1cbca78 to f7fbef7 Compare January 10, 2023 15:39
Copy link
Copy Markdown
Contributor

@nywilken nywilken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small suggestion but otherwise good.

Comment thread communicator/config.go Outdated
Recently, an update to Windows's default SSH implementation added an
extra check for the mark-of-the-web to their code, which if in verbose
mode, ends-up producing an error log, and terminates the process with a
non-zero error code, even if the transfer is successful.

Because of this, scp transfers fail all the time in such an environment,
and the recommended workaround for now is to set sftp as the transfer
protocol, as this one sets the mark-of-the-web successfully, and
therefore ends with a 0 error code.

Since this is surprising behaviour to users, we add a paragraph to the
docs, so they know about this workaround.
@lbajolet-hashicorp lbajolet-hashicorp force-pushed the ssh_protocol_note_windows branch from 110e0bc to 1239bb4 Compare January 11, 2023 21:08
@lbajolet-hashicorp lbajolet-hashicorp merged commit 1f4d6a9 into main Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants