Add --ssh-jump CLI argument#1986
Open
rolandwalker wants to merge 1 commit into
Open
Conversation
213d8d3 to
864159d
Compare
restoring functionality removed in v2.0.0, under a different interface, and with a different internal implementation. In the new interface, there is a single argument --ssh-jump, which accepts values in the form user@host:port. Cleartext SSH passwords on the CLI are no longer accepted. The user will be prompted for a password if the connection is not otherwise configured. Deprecated arguments such as --ssh-host now refer to --ssh-jump. Remote sockets are accepted. The user should give the MySQL endpoint exactly as it would be accepted from the jump host. A keyring field is added for the ssh-jump value, if any, but the field is not appended unless present, so existing keyring values are not invalidated. The internals of the new implementation are completely different: instead of using complex Python libraries (paramiko/sshtunnel) we simply open a tunnel using the ssh executable in a thread. This is more robust in a few ways: paramiko for example is not capable of reading nontrivial SSH config files. A new [ssh] section is added to myclirc with some recommended CLI arguments to SSH when establishing tunnels.
864159d to
0f22cdf
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add
--ssh-jumpCLI argument, restoring functionality removed in v2.0.0, under a different interface, and with a different internal implementation.In the new interface, there is a single argument
--ssh-jump, which accepts values in the formuser@host:port. Cleartext SSH passwords on the CLI are no longer accepted. The user will be prompted for a password if the connection is not otherwise configured.Deprecated arguments such as
--ssh-hostnow refer to--ssh-jump.Remote sockets are accepted. The user should give the MySQL endpoint exactly as it would be accepted from the jump host.
A keyring field is added for the ssh-jump value, if any, but the field is not appended unless present, so existing keyring values are not invalidated.
The internals of the new implementation are completely different: instead of using complex Python libraries (paramiko/sshtunnel) we simply open a tunnel using the
sshexecutable in a thread. This is more robust in a few ways: paramiko for example is not capable of reading nontrivial SSH config files.A new
[ssh]section is added to myclirc with some recommended CLI arguments to SSH when establishing tunnels.Fixes #1960.
Checklist
changelog.mdfile.AUTHORSfile (or it's already there).