o 3gQ;@sddlmZddlZddlZddlZddlmZddlmZm Z ddl m Z ddl m Z ddlmZddlmZdd lmZdd lmZd d ZGd ddZGdddeZGdddeZdS)) annotationsN)closing)ProcessExecutionErrorshquote)IS_WIN32)local)BaseRemoteMachine) ShellSession) LocalPath) RemotePathcCsJt}t||d|dWdS1swYdS)zAttempts to find a free port.) localhostrN)socketrbind getsockname)srT/home/garg/my-data/venv/lib/python3.10/site-packages/plumbum/machines/ssh_machine.py_get_free_ports    $rc@sdeZdZdZgdZddZddZddZd d Zd d Z e d dZ e ddZ e ddZ dS) SshTunnelz{An object representing an SSH tunnel (created by :func:`SshMachine.tunnel `))_session_lport_dport_reverse __weakref__cCst||_||_||_||_|r2t|dkr4|jdur6tdtj}| |jd}|r8| d|_dSdSdSdSdS)N0z/^Allocated port (\d+) for remote forward to .+$r ) rrrrstr_startup_resultrecompile MULTILINEsearchgroup)selfsessionlportdportreverseregexmatchrrr__init__s zSshTunnel.__init__cCs"|jr |jjnd}d|dS)Nz (defunct)z )raliveproc)r$tunnelrrr__repr__-s zSshTunnel.__repr__cCs|SNrr$rrr __enter__1szSshTunnel.__enter__cCs |dSr1)close)r$tvtbrrr__exit__4 zSshTunnel.__exit__cCs|jdS)zCloses(terminates) the tunnelN)rr4r2rrrr47szSshTunnel.closecC|jS)z-Tunneled port or socket on the local machine.)rr2rrrr&;zSshTunnel.lportcCr:)z.Tunneled port or socket on the remote machine.)rr2rrrr'@r;zSshTunnel.dportcCr:)z-Represents if the tunnel is a reverse tunnel.)rr2rrrr(Er;zSshTunnel.reverseN)__name__ __module__ __qualname____doc__ __slots__r+r0r3r8r4propertyr&r'r(rrrrrs  rc@seZdZdZ           dddZd d Zd d d Zd dZd!ddZd"ddZ    d#ddZ e ddZ ddZ ddZdS)$ SshMachinea; An implementation of :class:`remote machine ` over SSH. Invoking a remote command translates to invoking it over SSH :: with SshMachine("yourhostname") as rem: r_ls = rem["ls"] # r_ls is the remote `ls` # executing r_ls() translates to `ssh yourhostname ls` :param host: the host name to connect to (SSH server) :param user: the user to connect as (if ``None``, the default will be used) :param port: the server's port (if ``None``, the default will be used) :param keyfile: the path to the identity file (if ``None``, the default will be used) :param ssh_command: the ``ssh`` command to use; this has to be a ``Command`` object; if ``None``, the default ssh client will be used. :param scp_command: the ``scp`` command to use; this has to be a ``Command`` object; if ``None``, the default scp program will be used. :param ssh_opts: any additional options for ``ssh`` (a list of strings) :param scp_opts: any additional options for ``scp`` (a list of strings) :param password: the password to use; requires ``sshpass`` be installed. Cannot be used in conjunction with ``ssh_command`` or ``scp_command`` (will be ignored). NOTE: THIS IS A SECURITY RISK! :param encoding: the remote machine's encoding (defaults to UTF8) :param connect_timeout: specify a connection timeout (the time until shell prompt is seen). The default is 10 seconds. Set to ``None`` to disable :param new_session: whether or not to start the background session as a new session leader (setsid). This will prevent it from being killed on Ctrl+C (SIGINT) Nrutf8 Fc Cs"|dur| durtdd| df}ntd}|dur,| dur(tdd| df}ntd}g} g}||_|r>|d||_n||_|rU|dt|g| dt|g|ri|dt|g| dt|g| d||| ||t||_|t| |_t j || | | d dS) Nsshpassz-psshscp@-Pz-iz-r)encodingconnect_timeout new_session) rhost_fqhostextendrappendtuple _ssh_command _scp_commandrr+)r$rMuserportkeyfile ssh_command scp_commandssh_optsscp_optspasswordrJrKrLscp_argsssh_argsrrrr+us>    zSshMachine.__init__cC d|jS)Nzssh://rNr2rrr__str__r9zSshMachine.__str__cKsg}||||j|r`i}t|dr||j|r%|||dur/t|dd}|r;|dt|dg|rN|d|dd| Dt |t t fr[||n|||j t |jdi|S)Nenvcwdcd&&css&|]\}}|dt|VqdS)=N)r).0kr6rrr s$z#SshMachine.popen..r)rOrPrNhasattrupdateragetdeltagetattrritems isinstancerQlistrRpopen)r$argsrYrarbkwargscmdlineenvdeltarrrrps(        zSshMachine.popencCs(tjdtdd|j|ddddddS)z Runs the given command using ``nohup`` and redirects std handles, allowing the command to run "detached" from its controlling TTY or parent. Does not return anything. Depreciated (use command.nohup or daemonic_popen). z0Use .nohup on the command or use daemonic_popen)r) stacklevel.NF)rbstdoutstderrrP)warningswarn FutureWarningdaemonic_popen)r$commandrrrnohups zSshMachine.nohuprvTc Cs |durd}|dur d}t|dkrgndt|dg}|d||||r-dnd t|d |r;|dkr;dnd t|d g|j|d gd }|}z#|dkrct|||j|j W|j |j |j dS|j |j |j w)z Runs the given command using ``nohup`` and redirects std handles, allowing the command to run "detached" from its controlling TTY or parent. Does not return anything. .. versionadded:: 1.6.0 Nz /dev/nullz&1rvrcrdr~z>>r,2z ` object can be used as a *context-manager*. The more conventional use case is the following:: +---------+ +---------+ | Your | | Remote | | Machine | | Machine | +----o----+ +---- ----+ | ^ | | lport dport | | \______SSH TUNNEL____/ (secure) Here, you wish to communicate safely between port ``lport`` of your machine and port ``dport`` of the remote machine. Communication is tunneled over SSH, so the connection is authenticated and encrypted. The more general case is shown below (where ``dport != "localhost"``):: +---------+ +-------------+ +-------------+ | Your | | Remote | | Destination | | Machine | | Machine | | Machine | +----o----+ +---- ----o---+ +---- --------+ | ^ | ^ | | | | lhost:lport | | dhost:dport | | | | \_____SSH TUNNEL_____/ \_____SOCKET____/ (secure) (not secure) Usage:: rem = SshMachine("megazord") with rem.tunnel(1234, "/var/lib/mysql/mysql.sock", dhost=None): sock = socket.socket() sock.connect(("localhost", 1234)) # sock is now tunneled to the MySQL socket on megazord N[z]:rz-L:z-RrT)rYrL)rK)rrrprr rrK) r$r&r'lhostdhostrKr(formatted_lhostformatted_dhostrYr.rrrr/s,:   zSshMachine.tunnelcCs,t|}d|vrd|ddddS|S)Nr/r\)rreplace)pathrrr_translate_drive_letterQsz"SshMachine._translate_drive_lettercCst|tr td|t|tr|j|krtd|dt|tr*td|tr6||}||}||jdt ||dS)Nzsrc of download cannot be zsrc % points to a different remote machinezdst of download cannot be r) rnr TypeErrorr remoterrrSrNrr$srcdstrrrdownloadYs     zSshMachine.downloadcCst|tr td|t|trtd|t|tr*|j|kr*td|dtr6||}||}|||jdt |dS)Nzsrc of upload cannot be zdst of upload cannot be zdst rr) rnr rr rrrrSrNrrrrruploades     zSshMachine.upload) NNNNNrrNrCrDF)rNN)rvNNTFF)r r rF)r<r=r>r?r+r`rpr~r|r%r/ staticmethodrrrrrrrrBKs8, 3  $ S  rBc@sHeZdZdZ          dddZd d Zd d Zdd dZdS) PuttyMachinea PuTTY-flavored SSH connection. The programs ``plink`` and ``pscp`` are expected to be in the path (or you may provide your own ``ssh_command`` and ``scp_command``) Arguments are the same as for :class:`plumbum.machines.remote.SshMachine` NrrCrDFc Cs|durtd}|durtd}|sdg}|durtjj}|dur8|dt|ggt|dt|}d}tj|||||||||| | | d dS)Nplinkpscpz-sshrI)rVrWrXrYrZrJrKrL)rrarTrOrrorBr+) r$rMrTrUrVrWrXrYrZrJrKrLrrrr+zs4 zPuttyMachine.__init__cCr^)Nz putty-ssh://r_r2rrrr`r9zPuttyMachine.__str__cCs|Sr1r)r$rrrrrsz$PuttyMachine._translate_drive_lettercCs*t|jd|r dgndg|d|j||jS)Nrz-trr)r rprrKrrrrr%s zPuttyMachine.session) NNNNNrrrCrDFr)r<r=r>r?r+r`rr%rrrrrrs   )r) __future__rrrry contextlibrplumbum.commandsrr plumbum.librplumbum.machines.localrplumbum.machines.remoterplumbum.machines.sessionr plumbum.path.localr plumbum.path.remoter rrrBrrrrrs$        2)