Vh*sUddlmZdZdZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z mZmZddlmZmZddlmZmZmZddlmZmZdd lmZdd lmZdd lmZdd l m!Z!dd l"m#Z#ddl$m%Z%ddl&m'Z'e jPrerddlm)Z)ddl*m+Z+ddl,m-Z-ne.Z)de/d<e.Z+de/d<e.Z-de/d<e!Z0ddZ1Gdde)Z2GddeZ3y)) annotationsa+ author: Rui Lopes (@rgl) name: wsl short_description: Run tasks in WSL distribution using wsl.exe CLI via SSH requirements: - paramiko description: - Run commands or put/fetch files to an existing WSL distribution using wsl.exe CLI via SSH. - Uses the Python SSH implementation (Paramiko) to connect to the WSL host. version_added: "10.6.0" options: remote_addr: description: - Address of the remote target. default: inventory_hostname type: string vars: - name: inventory_hostname - name: ansible_host - name: ansible_ssh_host - name: ansible_paramiko_host port: description: Remote port to connect to. type: int default: 22 ini: - section: defaults key: remote_port - section: paramiko_connection key: remote_port env: - name: ANSIBLE_REMOTE_PORT - name: ANSIBLE_REMOTE_PARAMIKO_PORT vars: - name: ansible_port - name: ansible_ssh_port - name: ansible_paramiko_port keyword: - name: port remote_user: description: - User to login/authenticate as. - Can be set from the CLI via the C(--user) or C(-u) options. type: string vars: - name: ansible_user - name: ansible_ssh_user - name: ansible_paramiko_user env: - name: ANSIBLE_REMOTE_USER - name: ANSIBLE_PARAMIKO_REMOTE_USER ini: - section: defaults key: remote_user - section: paramiko_connection key: remote_user keyword: - name: remote_user password: description: - Secret used to either login the SSH server or as a passphrase for SSH keys that require it. - Can be set from the CLI via the C(--ask-pass) option. type: string vars: - name: ansible_password - name: ansible_ssh_pass - name: ansible_ssh_password - name: ansible_paramiko_pass - name: ansible_paramiko_password use_rsa_sha2_algorithms: description: - Whether or not to enable RSA SHA2 algorithms for pubkeys and hostkeys. - On paramiko versions older than 2.9, this only affects hostkeys. - For behavior matching paramiko<2.9 set this to V(false). vars: - name: ansible_paramiko_use_rsa_sha2_algorithms ini: - {key: use_rsa_sha2_algorithms, section: paramiko_connection} env: - {name: ANSIBLE_PARAMIKO_USE_RSA_SHA2_ALGORITHMS} default: true type: boolean host_key_auto_add: description: "Automatically add host keys to C(~/.ssh/known_hosts)." env: - name: ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD ini: - key: host_key_auto_add section: paramiko_connection type: boolean look_for_keys: default: true description: "Set to V(false) to disable searching for private key files in C(~/.ssh/)." env: - name: ANSIBLE_PARAMIKO_LOOK_FOR_KEYS ini: - {key: look_for_keys, section: paramiko_connection} type: boolean proxy_command: default: "" description: - Proxy information for running the connection via a jumphost. - This option is supported by paramiko version 1.9.0 or newer. type: string env: - name: ANSIBLE_PARAMIKO_PROXY_COMMAND ini: - {key: proxy_command, section: paramiko_connection} vars: - name: ansible_paramiko_proxy_command record_host_keys: default: true description: "Save the host keys to a file." env: - name: ANSIBLE_PARAMIKO_RECORD_HOST_KEYS ini: - section: paramiko_connection key: record_host_keys type: boolean host_key_checking: description: "Set this to V(false) if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host." type: boolean default: true env: - name: ANSIBLE_HOST_KEY_CHECKING - name: ANSIBLE_SSH_HOST_KEY_CHECKING - name: ANSIBLE_PARAMIKO_HOST_KEY_CHECKING ini: - section: defaults key: host_key_checking - section: paramiko_connection key: host_key_checking vars: - name: ansible_host_key_checking - name: ansible_ssh_host_key_checking - name: ansible_paramiko_host_key_checking use_persistent_connections: description: "Toggles the use of persistence for connections." type: boolean default: false env: - name: ANSIBLE_USE_PERSISTENT_CONNECTIONS ini: - section: defaults key: use_persistent_connections banner_timeout: type: float default: 30 description: - Configures, in seconds, the amount of time to wait for the SSH banner to be presented. - This option is supported by paramiko version 1.15.0 or newer. ini: - section: paramiko_connection key: banner_timeout env: - name: ANSIBLE_PARAMIKO_BANNER_TIMEOUT timeout: type: int default: 10 description: - Number of seconds until the plugin gives up on failing to establish a TCP connection. - This option is supported by paramiko version 2.2.0 or newer. ini: - section: defaults key: timeout - section: ssh_connection key: timeout - section: paramiko_connection key: timeout env: - name: ANSIBLE_TIMEOUT - name: ANSIBLE_SSH_TIMEOUT - name: ANSIBLE_PARAMIKO_TIMEOUT vars: - name: ansible_ssh_timeout - name: ansible_paramiko_timeout cli: - name: timeout lock_file_timeout: type: int default: 60 description: Number of seconds until the plugin gives up on trying to write a lock file when writing SSH known host keys. vars: - name: ansible_lock_file_timeout env: - name: ANSIBLE_LOCK_FILE_TIMEOUT private_key_file: description: - Path to private key file to use for authentication. type: path ini: - section: defaults key: private_key_file - section: paramiko_connection key: private_key_file env: - name: ANSIBLE_PRIVATE_KEY_FILE - name: ANSIBLE_PARAMIKO_PRIVATE_KEY_FILE vars: - name: ansible_private_key_file - name: ansible_ssh_private_key_file - name: ansible_paramiko_private_key_file cli: - name: private_key_file option: "--private-key" user_known_hosts_file: description: - Path to the user known hosts file. - Used to verify the ssh hosts keys. type: path default: ~/.ssh/known_hosts ini: - section: paramiko_connection key: user_known_hosts_file vars: - name: ansible_paramiko_user_known_hosts_file wsl_distribution: description: - WSL distribution name type: string required: true vars: - name: wsl_distribution wsl_user: description: - WSL distribution user type: string vars: - name: wsl_user become_user: description: - WSL distribution user type: string default: root vars: - name: become_user - name: ansible_become_user become: description: - whether to use the user defined by ansible_become_user. type: bool default: false vars: - name: become - name: ansible_become aP # ------------------------ # Inventory: inventory.yml # ------------------------ --- all: children: wsl: hosts: example-wsl-ubuntu: ansible_host: 10.0.0.10 wsl_distribution: ubuntu wsl_user: ubuntu vars: ansible_connection: community.general.wsl ansible_user: vagrant # ---------------------- # Playbook: playbook.yml # ---------------------- --- - name: WSL Example hosts: wsl gather_facts: true become: true tasks: - name: Ping ansible.builtin.ping: - name: Id (with become false) become: false changed_when: false args: executable: /bin/bash ansible.builtin.shell: | exec 2>&1 set -x echo "$0" pwd id - name: Id (with become true) changed_when: false args: executable: /bin/bash ansible.builtin.shell: | exec 2>&1 set -x echo "$0" pwd id - name: Reboot ansible.builtin.reboot: boot_time_command: systemctl show -p ActiveEnterTimestamp init.scope N)AnsibleAuthenticationFailureAnsibleConnectionFailure AnsibleError)FileLock LockTimeout)to_bytes to_nativeto_text)PARAMIKO_IMPORT_ERRparamiko) LooseVersion) PlayContext)ConnectionBase)Display) makedirs_safe)hexlify) list2cmdline)MissingHostKeyPolicy) SSHClient)PKeytyperrrcd|d|d|d}|S)Nz) paramiko: The authenticity of host 'z ' can't be established. The z key fingerprint is zA. Are you sure you want to continue connecting (yes/no)? )hostnamektype fingerprintmsgs l/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/connection/wsl.pyauthenticity_msgr ^s0))1 3 #K=1 C Jc eZdZdZddZddZy) MyAddPolicya  Based on AutoAddPolicy in paramiko so we can determine when keys are added and also prompt for input. Policy for automatically adding the hostname and new host key to the local L{HostKeys} object, and saving it. This is used by L{SSHClient}. c4||_|j|_yN) connection_options)selfr&s r__init__zMyAddPolicy.__init__qs$"++ r!c bt|jjd|jjd frt|j }|j }|jjds|jj rtt|||ddttjt|||dd }|jd vr td d |_ |jj||j |y) Nhost_key_checkinghost_key_auto_adduse_persistent_connections\F)privatesurrogate_or_stricterrors)yesyz host connection rejected by userT)allr& get_optionrget_fingerprintget_nameforce_persistencerr r display prompt_untillower_added_by_ansible_this_time _host_keysadd)r(clientrkeyrrinps rmissing_host_keyzMyAddPolicy.missing_host_keyus **+>?T__E_E_`sEtAtu v!#"5"5"78KLLNE))*FG4??KlKl##3He[#QRSTV#WXX$$%5h{%S]b$c,C yy{"22"#EFF*.' h j@$r&}t-d"t|jBd}~wtj>jD$r}d#|} tG| d}~wtH$ri}t|} d$| vr td%d&| vr;d'|j dd(|jKdd)|d*| d+z} t-| t-| d}~wwxYw),z! activates the connection object Nzparamiko is not installed: rgz,ESTABLISH PARAMIKO SSH CONNECTION FOR USER: r]z on PORT  TO r\r__preferred_pubkeysr_preferred_keysuse_rsa_sha2_algorithmsc3*K|] }d|vs| ywzrsa-sha2Nr.0as r z&Connection._connect..s6pQ`jno`oq6p pubkeysc3*K|] }d|vs| ywrrrrss rrvz&Connection._connect..s3n!^hlm^mA3nrwkeysuser_known_hosts_filer+z/etc/ssh/ssh_known_hostsz/etc/openssh/ssh_known_hostsInvalid host key: passwordTFprivate_key_filez2.2.0timeout auth_timeoutz1.15.0banner_timeout look_for_keys)username allow_agentr key_filenamer}rrgdisabled_algorithmszhost key mismatch for zFailed to authenticate: zPID check failedzNparamiko version issue, please upgrade paramiko on the machine running ansiblezPrivate key file is encryptedzssh @:z : z3 To connect as a different user, use -u .)(r rr r r8r<rdr rgetattr TransporttuplerOset_log_channelospath expanduserkeyfileload_system_host_keysIOErrorhostkeysInvalidHostKeyrlinerkset_missing_host_key_policyr#r __version__connectr> ssh_exceptionBadHostKeyExceptionrAuthenticationExceptionr Exception get_optionsssh _connected)r(rgrparamiko_preferred_pubkeysparamiko_preferred_hostkeysrprssh_known_hostsessh_connect_kwargs conn_passwordrrrs r_connectzConnection._connects  !&)166pB\6p1p#I.*.33n?Z3n.n#F+    (    1 1 2ww))$//:Q*RS ??. /$>@^`d`l`l#m [[--o> [ W))+"66t< '' D(9: 3   $K' 4L12!ww11$//BT2UV H001\'5JJ59__Y5O">2H001\(5KK7;GW7X"#34 CKK .446 7'"ooo>)& 2$7 % 6 w((77[25GPQPVPVGX3YZZ[$$33 W.1CGAFFOCT/UVV WH%%99 [*-CGAJJDWCX+YZ Z%%== 4,QC0C.s3 3 4!*C"c)"#stt1S8T__];N>N}>]=^^_`d_eehieOPQ.s33.s33 4shL%)M6*oom4 k"Hz2H+-=>  KK8, - TF EKK$% 99O P::d# #D!!r!c$|j|}tt||||d} |jj j d|jj j}tjd||jd t|d }d } d } d } |j||j r`|j j#rEd } d } | s| stj%d|j'|}tj%dt||s8d| vr3t|j jd}t)d|dn^| |z } | j+dD]@}|j j-|rd} n!|j j/|s>d} n| s| s| rR|j r;|j jd}|j1t|dzd nt)d| | z } | | z } |rCt3dt5||D]}|j7||||z|j9n|d k(r|j9d j?|jAd|}d j?|jCd|}|jE}d|jGdvr&t)dt|jd|| |z| |zfS#t$r0}t|}d}|r|d|z }tt|d}~wwxYw#t:j<$rt)dt| zwxYw)z, run a command on inside a WSL distribution in_datasudoableizFailed to open sessionz: NzEXEC r\r_r1r2r!Fz&Waiting for Privilege Escalation inputz chunk is: s unknown userrzuser z does not existT become_passrz,A password is required but none was suppliedrz0ssh timed out waiting for privilege escalation. rbz'wsl.exe' is not recognizedutf-8z#wsl.exe not found in path of host: )$rrQrF exec_commandr get_transport set_keepalive open_sessionrr rr r<rdr8r r expect_promptdebugrecvr splitlines check_successcheck_password_promptsendallrangelensendshutdown_writesocketrrmakefilemakefile_stderrrecv_exit_statusdecode)r(rrrbufsizechanrtext_er no_prompt_out no_prompt_err become_outputpassword_promptbecome_successchunk n_become_userrristdoutstderr returncoderVs rrzConnection.exec_commandIsh%%c* j$,S'H,U ; HH " " $ 2 21 588))+88:D  eC5M (F Gs#89   / m   c "{{t{{88:"'!&)_MM"JK IIg.EMMJwu~.>"?@ *m;,5dkk6L6L]6[,\M".}o_/U"VV!!U*M!. 8 8 >";;44T:-1N!![[>>tD.2O! "!*_0#{{&*kk&<&<]&K  XkD.@I^%_`*+YZZ!]2M!]2Mq#g,86AIIgaG 456##%C##% $--g67$..tW=>**, )FMM',B B5gdoom>\6]5^_a aMF2MF4JKKW ;QZF*CF8}$*9S>: :  ;z~~ mRU\]jUkkl l ms2AL(:DM$ M$B8M$( M!1+MM!$+Nc tjd|d||jd t|d5}|j }|j dj |jjd|jjd|g|d \}}}d d d d k7r[d jdvr&tdt|jdttdt|y #1swYjxYw#t$r"}td|d|dt|d }~wwxYw)z& transfer a file from local to remote zPUT rmr\r_rr-czcat > FrNrcat: not foundr+cat not found in path of WSL distribution: rrz'error occurred while putting file from  to ! )r<rdr8rreadrr_shell executablequoterrr r) r(in_pathout_pathrdatarrrrs rput_filezConnection.put_filesi  d7)4z29W X bgt$ $vvx-1->->HH .. ))F8**=>@A!" .?.$* FF $Q#v}}W'==&Egdoo^pNqFrEstvv"v'r'&/):;==  $ $ b9'$xjPST[\]T^S_`b b bs0 DA+D%A(DDD E#EEc tjd|d||jd |jdj |j j d|j jd|gd \}}}|d k7r[d |jd vr&td t|jdtt|dt|t|d5}|j|dddy#1swYyxYw#t$r"}td|d|dt|d}~wwxYw)z* save a remote file to the specified path zFETCH rmr\r_rrzcat F)rrrrrrrwbNz(error occurred while fetching file from rr)r<rdr8rrrrrrrr rrr)r(rrrrrrrs r fetch_filezConnection.fetch_files]  fWIT(44??=;Y Z c)-):):KK**DKK%%WI&679: *;* &J Q#v}}W'==&Egdoo^pNqFrEstvv"v'r'&/):;==h%     c:7)4zQTU\]^U_T`ac c cs6CD3DDDDD E#EEc^|jsy|j|jy)z reset the connection N)rcloser)r(s rresetzConnection.resets    r!c |jdr~|jdrl|jr[tjj |j }tjj |j }t|d} tj|||jd5|jj|jjj|jjtjj |j }tjj|j rGtj |j }|j"dz}|j$}|j&}n*d}tj(}tj*}t-j.|d5} | j0}tj2||tj4||||j7|dddtj8||j ddd|&tMjN|jQd |jjSd|_*y#1swY{xYw#1swY_xYw#t:$r,t=d |j d |jdd t>j@jB$r} tEd | jFd} ~ wtH$r} t=d tK| d} ~ wwxYw#|&tMjN|jQdwwxYw)z terminate the connection r+record_host_keysNlock_file_timeoutiiF)dirdeletezwriting lock file for z ran in to the timeout of sr|z,error occurred while writing SSH host keys! T) missing_ok)+r8rrrbasenamerdirnamerr lock_filerrr@update_system_host_keysexistsstatst_modest_uidst_gidgetuidgetgidtempfileNamedTemporaryFilerXchmodchownrrenamerrr rrrrrr pathlibPathunlinkrr) r(lockfilertmp_keyfile_namekey_dirkey_statmodeuidgid tmp_keyfilers rrzConnection.closes ??. /DOODV4W\`\p\p\r ww'' 5Hggoodll3G ' "# , KZ))(GT__M`=ab>HH224HH''..txx/I/IJ !ggoodll;Gww~~dll3#%774<<#8'//%7&oo&oo$ iik iik "44OCS^+6+;+;(!148!13<001AB C II. ==>T$/LL!1299T9J -CC1>>> ~",T\\N:TUYUdUdexUyTzz{|~~$$33 N.1CAFF8/LMM R#CGAJ<PRR R $/LL!1299T9J0sc*K D.J?.A J39(J?!K 3J< 8J??KK AML33 M?MMM*Nr%)rRrrSzio.TextIOWrapper | NonerTt.AnyrUr#)rXrIrGrH))rgintrGzdict[str, t.Any])rGrF)rGbool)rrIrGrH)rrIrGrI)NT)rrIrz bytes | Nonerr&rGztuple[int, bytes, bytes])rrIrrIrGrH)rGrH)rJrKrLrM transportrO__annotations__r)rYrkrrrrrrrrr __classcell__)rVs@rrFrFsZ3'I#L*#S!,_BN4""WLrb.c,; r!rF)rrIrrIrrIrGrI)4 __future__r DOCUMENTATIONEXAMPLESiorrrrrtypingtansible.errorsrrrDansible_collections.community.general.plugins.module_utils._filelockrr+ansible.module_utils.common.text.convertersr r r $ansible.module_utils.compat.paramikor r #ansible.module_utils.compat.versionransible.playbook.play_contextransible.plugins.connectionransible.utils.displayransible.utils.pathrbinasciir subprocessr TYPE_CHECKINGrparamiko.clientr paramiko.pkeyrobjectr(r<r r#rFrr!rr?s#v p3 j   gTTN<55),#??x-)"!'$'ItD$ )%=&%=V@ @ r!