synchronize should handle exotic quotation for rsync's --rsh param correctly #589
Labels
synchronize
Issue and PR for synchronize module
Comments
|
One more thing: sad but true, our (actually) longest {
"ansible_private_key_file": "{{ lookup(\"env\",\"JH6_SSH_PRIVATE_KEY\") }}",
"ansible_ssh_common_args": "-oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\"ssh -i {{ lookup(\"env\",\"JH6_SSH_PRIVATE_KEY\") }} -W %h:%p -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\\\"ssh -i {{ lookup(\"env\",\"JH4_SSH_PRIVATE_KEY\") }} -W {{ jh6_ip }}:{{ jh6_ssh_port }} -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\\\\\\\"ssh -i {{ lookup(\"env\",\"JH1_SSH_PRIVATE_KEY\") }} -W {{ jh4_ip }}:{{ jh4_ssh_port }} -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null {{ jh1_ssh_user }}@{{ jh1_ip }}\\\\\\\" {{ jh4_ssh_user }}@{{ jh4_ip }}\\\" {{ jh6_ssh_user }}@{{ jh6_ip }}\"",
"ansible_ssh_user": "{{ jh6_ssh_user }}"
}Which means, we need to handle at least triple quotes: Welcome again in the escape hell, D'OH! |
|
Any ideas on that? I guess this may be annoying but we need to have synchronize to be that flexible.. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
SUMMARY
According to the man page of rsync (e.g. https://ss64.com/bash/rsync_options.html)
--rsh=COMMANDhas an exotic way to handle quotation. E.g. quotation of the param list like--rsh='/usr/bin/ssh -oProxyCommand="ssh -i -W %h:%p -oProxyCommand=\"ssh -W jumphost2:22 ansible@jumphost1\" ansible@jumphost2"'should instead be escaped like
--rsh='/usr/bin/ssh -oProxyCommand="ssh -i -W %h:%p -oProxyCommand=""ssh -W jumphost2:22 ansible@jumphost1"" ansible@jumphost2"'To be precise: an escaped single or double-quote should written
""instead of\", with single quotes accordingly.Because we use such strings successfully as ansible_ssh_args for jumping we also need to have rsync handle that correctly.
ISSUE TYPE
COMPONENT NAME
synchronize
ANSIBLE VERSION
This is the Ansible distribution in container image ansible/awx-ee:24.5.0
COLLECTION VERSION
CONFIGURATION
OS / ENVIRONMENT
Container: ansible/awx-ee:24.5.0
Executed within AWX 24.5.0
With awx-operator 2.18.0
STEPS TO REPRODUCE
Use group vars like:
{ "ansible_private_key_file": "{{ lookup(\"env\",\"JH3_SSH_PRIVATE_KEY\") }}", "ansible_ssh_common_args": "-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o ProxyCommand=\"ssh -i {{ lookup(\"env\",\"JH3_SSH_PRIVATE_KEY\") }} -W %h:%p -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\\\"ssh -i {{ lookup(\"env\",\"JH1_SSH_PRIVATE_KEY\") }} -W {{ jh3_ip }}:{{ jh3_ssh_port }} -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null {{ jh1_ssh_user }}@{{ jh1_ip }}\\\" {{ jh3_ssh_user }}@{{ jh3_ip }}\"", "ansible_ssh_user": "{{ jh3_ssh_user }}" }With a dest_host1 it works perfectly jumping to it via ssh and all tasks used like
but if we use synchronize like
EXPECTED RESULTS
This is what I get, when I replace the
\"with""in the command. After that, the --rsh parameter looks like the second described in the SUMMARY.ACTUAL RESULTS
with the same config for dest_host1, we get the following AWX output in json format:
{ "rc": 255, "cmd": "/usr/bin/rsync --delay-updates -F --compress --delete-after --checksum --archive --rsh='/usr/bin/ssh -S none -i /runner/env/tmpocuvvus0 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -C -o ControlMaster=auto -o ControlPersist=60s -o ServerAliveInterval=120 -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\"ssh -i /runner/env/tmpocuvvus0 -W %h:%p -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\\\"ssh -i /runner/env/tmp8x61_zwv -W jumphost3.fqdn:22 -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null [email protected]\\\" [email protected]\"' --rsync-path='sudo -u username rsync' --prune-empty-dirs --itemize-changes --no-owner --no-group --no-times --out-format='<<CHANGED>>%i %n%L' /opt/source/path ansible@dest_host1.fqdn:/opt/dest/path/", "msg": "usage: ssh [-46AaCfGgKkMNnqsTtVvXxYy] [-B bind_interface]\n [-b bind_address] [-c cipher_spec] [-D [bind_address:]port]\n [-E log_file] [-e escape_char] [-F configfile] [-I pkcs11]\n [-i identity_file] [-J [user@]host[:port]] [-L address]\n [-l login_name] [-m mac_spec] [-O ctl_cmd] [-o option] [-p port]\n [-Q query_option] [-R address] [-S ctl_path] [-W host:port]\n [-w local_tun[:remote_tun]] destination [command]\nkex_exchange_identification: Connection closed by remote host\r\nConnection closed by UNKNOWN port 65535\r\nrsync: connection unexpectedly closed (0 bytes received so far) [sender]\nrsync error: unexplained error (code 255) at io.c(228) [sender=3.2.3]\n", "invocation": { "module_args": { "src": "/opt/source/path", "dest": "ansible@dest_host1.fqdn:/opt/dest/path/", "recursive": true, "delete": true, "checksum": true, "rsync_opts": [ "--prune-empty-dirs", "--itemize-changes", "--no-owner", "--no-group", "--no-times" ], "ssh_args": "-C -o ControlMaster=auto -o ControlPersist=60s -o ServerAliveInterval=120 -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\"ssh -i /runner/env/tmpocuvvus0 -W %h:%p -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null -oProxyCommand=\\\"ssh -i /runner/env/tmp8x61_zwv -W jumphost3.fqdn:22 -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null [email protected]\\\" [email protected]\"", "_local_rsync_path": "rsync", "private_key": "/runner/env/tmpocuvvus0", "_local_rsync_password": null, "rsync_path": "sudo -u username rsync", "_substitute_controller": false, "archive": true, "compress": true, "existing_only": false, "dirs": false, "copy_links": false, "set_remote_user": true, "rsync_timeout": 0, "ssh_connection_multiplexing": false, "partial": false, "verify_host": false, "delay_updates": true, "mode": "push", "dest_port": null, "links": null, "perms": null, "times": null, "owner": null, "group": null, "link_dest": null } }, "_ansible_no_log": false, "changed": false }The very same output I get, when I reproduce it in our dev environment. On commandline it says:
The text was updated successfully, but these errors were encountered: