U Tg^ @sddlZddlZddlZddlZddlmZddlmZddlm Z ddl m Z m Z ddl mZddlmZddlmZmZmZdd lmZdd lmZdd lmZmZmZdd lmZdd lm Z ddl!m"Z"ddl#m$Z$m%Z%ddl&m'Z'm(Z(zddl m)Z)m*Z*Wne+k rYnXe"dZ,e,rLddl-m.Z.ddl/m0Z0m1Z1m2Z2nddl3m0Z0GdddZ.zddl4m1Z5Wn2e+k rZ6zdZ7e8e6Z9[6W5dZ6[6XYnXe5Z7GdddZ:Gddde(Z;Gdddej<Z=Gdd d ej>Z?Gd!d"d"ej@ZAGd#d$d$ej@ZBGd%d&d&ej<ZCd>d(d)ZDGd*d+d+ZEGd,d-d-eEZFee0Gd.d/d/e.ZGGd0d1d1ZHGd2d3d3eEZIGd4d5d5ZJGd6d7d7eEeJe(ZKGd8d9d9eFeJe(ZLGd:d;d;eIeJe(ZMGd Tests for L{twisted.conch.scripts.conch.SSHSession}. NcCs*t}t}||_|||jdS)z} L{twisted.conch.scripts.conch.SSHSession.eofReceived} loses the write half of its stdio connection. N)r%StdioInteractingSessionstdio eofReceived assertTruer&)r(r-Zchannelr#r#r$test_eofReceivedSs z-StdioInteractingSessionTests.test_eofReceived)r r!r"r*r,_reasonskipr0r#r#r#r$r+Ksr+c@s$eZdZddZddZddZdS)EchocCstddS)NzECHO CONNECTION MADErmsgr'r#r#r$connectionMade`szEcho.connectionMadecCstddS)NzECHO CONNECTION DONEr4r(reasonr#r#r$connectionLostcszEcho.connectionLostcCs"|j|d|kr|jdS)N ) transportwriteloseConnectionr(datar#r#r$ dataReceivedfs zEcho.dataReceivedN)r r!r"r6r9r@r#r#r#r$r3_sr3c@seZdZeZdS) EchoFactoryN)r r!r"r3r r#r#r#r$rAlsrAc@s<eZdZdZdZdZdZddZddZdd Z d d Z dS) ConchTestOpenSSHProcessa Test protocol for launching an OpenSSH client process. @ivar deferred: Set by whatever uses this object. Accessed using L{_getDeferred}, which destroys the value so the Deferred is not fired twice. Fires when the process is terminated. NcCs|jd}|_|SNdeferredr(dr#r#r$ _getDeferred}sz$ConchTestOpenSSHProcess._getDeferredcCs|j|7_dSrD)bufr>r#r#r$ outReceivedsz#ConchTestOpenSSHProcess.outReceivedcCs|j|7_dSrD)problemsr>r#r#r$ errReceivedsz#ConchTestOpenSSHProcess.errReceivedc CsT|jjdkr4|td|jj|jdn|j dd}| |dS)z~ Called when the process has ended. @param reason: a Failure giving the reason for the process' end. rzexit code was not 0: {} ({})charmaps r:N) valueZexitCoderIZerrbackrformatrLdecoderJreplacecallback)r(r8rJr#r#r$ processEndeds   z$ConchTestOpenSSHProcess.processEnded) r r!r"r*rFrJrLrIrKrMrTr#r#r#r$rBpsrBc@sTeZdZdZdZddZddZddZd d Zd d Z d dZ ddZ ddZ dS)ConchTestForwardingProcessa Manages a third-party process which launches a server. Uses L{ConchTestForwardingPort} to connect to the third-party server. Once L{ConchTestForwardingPort} has disconnected, kill the process and fire a Deferred with the data received by the L{ConchTestForwardingPort}. @ivar deferred: Set by whatever uses this object. Accessed using L{_getDeferred}, which destroys the value so the Deferred is not fired twice. Fires when the process is terminated. NcCs||_d|_||_dS)aF @type port: L{int} @param port: The port on which the third-party server is listening. (it is assumed that the server is running on localhost). @type data: L{str} @param data: This is sent to the third-party server. Must end with ' ' in order to trigger a disconnect. N)portbufferr?)r(rVr?r#r#r$__init__s z#ConchTestForwardingProcess.__init__cCs|jd}|_|SrDrErGr#r#r$rIsz'ConchTestForwardingProcess._getDeferredcCs |dSrD)_connectr'r#r#r$r6sz)ConchTestForwardingProcess.connectionMadecCs0ttt||j}|d|j}||j|S)a Connect to the server, which is often a third-party process. Tries to reconnect if it fails because we have no way of determining exactly when the port becomes available for listening -- we can only know when the process starts. 127.0.0.1) r Z ClientCreatorr ConchTestForwardingPortr?Z connectTCPrVZ addErrback _ebConnect)r(ccrHr#r#r$rYs z#ConchTestForwardingProcess._connectcCstd|jdS)Ng?)r callLaterrY)r(fr#r#r$r\sz%ConchTestForwardingProcess._ebConnectcCs.||_|jd|jtd|jdS)z The network connection has died; save the buffer of output from the network and attempt to quit the process gracefully, and then (after the reactor has spun) send it a KILL signal. rN)rWr;r<r=r r^ _reallyDie)r(rWr#r#r$forwardingPortDisconnecteds  z5ConchTestForwardingProcess.forwardingPortDisconnectedcCs*z|jdWntk r$YnXdS)NZKILL)r;Z signalProcessr r'r#r#r$rasz%ConchTestForwardingProcess._reallyDiecCs||jdS)z Fire the Deferred at self.deferred with the data collected from the L{ConchTestForwardingPort} connection, if any. N)rIrSrWr7r#r#r$rTsz'ConchTestForwardingProcess.processEnded) r r!r"r*rFrXrIr6rYr\rbrarTr#r#r#r$rUs   rUc@s0eZdZdZddZddZddZdd Zd S) r[z Connects to server launched by a third-party process (managed by L{ConchTestForwardingProcess}) sends data, then reports whatever it received back to the L{ConchTestForwardingProcess} once the connection is ended. cCs||_||_dS)z @type protocol: L{ConchTestForwardingProcess} @param protocol: The L{ProcessProtocol} which made this connection. @type data: str @param data: The data to be sent to the third-party server. N)r r?)r(r r?r#r#r$rXsz ConchTestForwardingPort.__init__cCsd|_|j|jdS)NrC)rWr;r<r?r'r#r#r$r6sz&ConchTestForwardingPort.connectionMadecCs|j|7_dSrD)rWr>r#r#r$r@sz$ConchTestForwardingPort.dataReceivedcCs|j|jdSrD)r rbrWr7r#r#r$r9sz&ConchTestForwardingPort.connectionLostN)r r!r"r*rXr6r@r9r#r#r#r$r[s  r[conchcCsFtjd|g}g}|t|D]"}t|tr6|d}||q|S)Na$-c ### Twisted Preamble import sys, os path = os.path.abspath(sys.argv[0]) while os.path.dirname(path) != path: if os.path.basename(path).startswith('Twisted'): sys.path.insert(0, path) break path = os.path.dirname(path) from twisted.conch.scripts.%s import run run()utf-8)sys executablelist isinstancestrencodeappend)argsmodstartZmadeArgsargr#r#r$ _makeArgss    rpc@sHeZdZesdZeddZddZddZdd Z d d Z d d Z dS)ConchServerSetupMixinzcan't run without cryptographycCstdS)Nstestuserrr#r#r#r$ realmFactory#sz"ConchServerSetupMixin.realmFactoryc CsdD]}tj|rt|qtdd}|tW5QRXtdd}|tW5QRXtddt d }|j j s|j j rtdtdd}|dtW5QRXdS) N)rsa_test rsa_test.pubkh_testrswbrtizgprivate key readable by others despite chmod; possible windows permission issue? see https://tm.tl/9767rus 127.0.0.1 )ospathexistsremoveopenr<rrchmodrZgetPermissionsgroupreadotherr)r(r_ permissionsr#r#r$ _createFiles's       z"ConchServerSetupMixin._createFilescCs*t}|d|d}||S)N)r)socketbind getsocknameclose)r(srVr#r#r$ _getFreePort:s   z"ConchServerSetupMixin._getFreePortcCs.|}t|}|tt}||_|S)z Make a L{ConchTestServerFactory}, which allows us to start a L{ConchTestServer} -- i.e. an actually listening conch. )rrr ZPortalZregisterCheckerrr)r(realmpfactoryr#r#r$_makeConchFactoryAs   z'ConchServerSetupMixin._makeConchFactorycCsv|||_d|j_tjd|jdd|_tdt|_|j j |_ t rrtjdtdd|_ |j j |_dS)NrrrZ)Z interfacez::1)rr conchFactoryZexpectedLoseConnectionr Z listenTCP conchServerrA echoServergetHostrVechoPortr echoServerV6 echoPortV6r'r#r#r$setUpMs zConchServerSetupMixin.setUpcCspzd|jj_Wntk r"YnX|jjjt|jj t|j j g}t rf| t|j j t|S)Nr)rprotodoneAttributeErrorr;r=r Z maybeDeferredr stopListeningrrrkrZ gatherResults)r(Z deferredsr#r#r$tearDownZs  zConchServerSetupMixin.tearDownN) r r!r"rr2 staticmethodrrrrrrrr#r#r#r$rqs   rqc@s(eZdZdZddZddZddZdS) ForwardingMixina Template class for tests of the Conch server's ability to forward arbitrary protocols over SSH. These tests are integration tests, not unit tests. They launch a Conch server, a custom TCP server (just an L{EchoProtocol}) and then call L{execute}. L{execute} is implemented by subclasses of L{ForwardingMixin}. It should cause an SSH client to connect to the Conch server, asking it to forward data to the custom TCP server. cCs|dt}||jdS)z Test that we can use whatever client to send the command "echo goodbye" to the Conch server. Make sure we receive "goodbye" back from the server. echo goodbyegoodbye executerB addCallback assertEqualrGr#r#r$ test_execxszForwardingMixin.test_execcCs>|}t|d}|jd|d||jfd}||jd|S)zy Test that we can use whatever client to forward a local port to a specified port on the server. test rz-N -L%i:127.0.0.1:%isshArgsrrUrrrrr(Z localPortprocessrHr#r#r$test_localToRemoteForwardings  z,ForwardingMixin.test_localToRemoteForwardingcCs>|}t|d}|jd|d||jfd}||jd|S)zs Test that we can use whatever client to forward a port from the server to a port locally. rrz-N -R %i:127.0.0.1:%irrrr#r#r$test_remoteToLocalForwardings  z,ForwardingMixin.test_remoteToLocalForwardingN)r r!r"r*rrrr#r#r#r$rjs   rc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS) RekeyAvatara# This avatar implements a shell which sends 60 numbered lines to whatever connects to it, then closes the session with a 0 exit status. 60 lines is selected as being enough to send more than 2kB of traffic, the amount the client is configured to initiate a rekey after. cCst|t|jd<dS)Nssession)rrXrZ channelLookupr'r#r#r$rXs zRekeyAvatar.__init__csHt}|t|fdd}t|tddS)zE Write 60 lines of data to the transport, then exit. csXt|}|dkr6jjjddnd|f}|d}|dS)N<s exit-statussz line #%02d rd)nextstopsessionconnZ sendRequestr=rjr<)counterilinecallr;r#r$r<s   z$RekeyAvatar.openShell..writeg{Gz?N)r ProtocolZmakeConnectionrrrrn)r(r;rr<r#rr$ openShells   zRekeyAvatar.openShellcCsdS)z2 Ignore the close of the session. Nr#r'r#r#r$closedszRekeyAvatar.closedcCsdSrDr#r'r#r#r$r.szRekeyAvatar.eofReceivedcCsdSrDr#)r(rcommandr#r#r$ execCommandszRekeyAvatar.execCommandcCsdSrDr#)r(ZtermZ windowSizemodesr#r#r$getPtyszRekeyAvatar.getPtycCsdSrDr#)r(Z newWindowSizer#r#r$ windowChangedszRekeyAvatar.windowChangedN) r r!r"r*rXrrr.rrrr#r#r#r$rs!rc@seZdZdZddZdS) RekeyRealmzS This realm gives out new L{RekeyAvatar} instances for any avatar request. cGs|dtddfS)NrcSsdSrDr#r#r#r#r$rCz*RekeyRealm.requestAvatar..)r)r(ZavatarIDZmindZ interfacesr#r#r$ requestAvatarszRekeyRealm.requestAvatarN)r r!r"r*rr#r#r#r$rsrc@seZdZdZeZddZdS)RekeyTestsMixinzp TestCase mixin which defines tests exercising L{SSHTransportBase}'s handling of rekeying messages. cs.t}d|d}fdd}|||S)z After a client-initiated rekey is completed, application data continues to be passed over the SSH connection. rz-o RekeyLimit=2Kcs6dddtdDd}|d}||dS)N cSsg|]}d|fqS)z line #%02dr#).0rr#r#r$ szFRekeyTestsMixin.test_clientRekey..finished..rrd)joinrangerjr)resultZexpectedResultr'r#r$finisheds z2RekeyTestsMixin.test_clientRekey..finished)rBrr)r(rrHrr#r'r$test_clientRekeys   z RekeyTestsMixin.test_clientRekeyN)r r!r"r*rrrrr#r#r#r$rsrc@s"eZdZedsdZdddZdS)OpenSSHClientMixinsshz$no ssh command-line client availablerc Cslt|_d|d|}|jj}||}g}|D]}||dq:t |t dd||jS)a Connects to the SSH server started in L{ConchServerSetupMixin.setUp} by running the 'ssh' command line tool. @type remoteCommand: str @param remoteCommand: The command (with arguments) to run on the remote end. @type process: L{ConchTestOpenSSHProcess} @type sshArgs: str @param sshArgs: Arguments to pass to the 'ssh' process. @return: L{defer.Deferred} zssh -2 -l testuser -p %i -F /dev/null -oIdentitiesOnly=yes -oUserKnownHostsFile=kh_test -oPasswordAuthentication=no -oHostKeyAlgorithms=ssh-rsa -a -i rsa_test 127.0.0.1 rdrr) r DeferredrFrrrVsplitrkrjr spawnProcessr) r( remoteCommandrrZcmdlinerVcmds encodedCmdscmdr#r#r$r s       zOpenSSHClientMixin.executeN)r)r r!r"rr2rr#r#r#r$rsrc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS)OpenSSHKeyExchangeTestsz\ Tests L{SSHTransportBase}'s key exchange algorithm compatibility with OpenSSH. cCsg}z>tjtddddgtjd}t|ts8|d}|}Wntk rVYnX||krnt |d| dt d |}| |j d S) aI Call execute() method of L{OpenSSHClientMixin} with an ssh option that forces the exclusive use of the key exchange algorithm specified by keyExchangeAlgo @type keyExchangeAlgo: L{str} @param keyExchangeAlgo: The key exchange algorithm to use @return: L{defer.Deferred} rrz-QZkex)stderrrdz not supported by ssh clientz echo helloz-oKexAlgorithms=shello ) subprocess check_outputrSTDOUTrhrirQr BaseExceptionrrrBrr)r(ZkeyExchangeAlgoZ kexAlgorithmsoutputrHr#r#r$assertExecuteWithKexAlgorithm>s&    z5OpenSSHKeyExchangeTests.assertExecuteWithKexAlgorithmcCs |dS)zb The ecdh-sha2-nistp256 key exchange algorithm is compatible with OpenSSH zecdh-sha2-nistp256rr'r#r#r$test_ECDHSHA256^sz'OpenSSHKeyExchangeTests.test_ECDHSHA256cCs |dS)zb The ecdh-sha2-nistp384 key exchange algorithm is compatible with OpenSSH zecdh-sha2-nistp384rr'r#r#r$test_ECDHSHA384esz'OpenSSHKeyExchangeTests.test_ECDHSHA384cCs |dS)zb The ecdh-sha2-nistp521 key exchange algorithm is compatible with OpenSSH zecdh-sha2-nistp521rr'r#r#r$test_ECDHSHA521lsz'OpenSSHKeyExchangeTests.test_ECDHSHA521cCs |dS)zl The diffie-hellman-group14-sha1 key exchange algorithm is compatible with OpenSSH. zdiffie-hellman-group14-sha1rr'r#r#r$test_DH_GROUP14ssz'OpenSSHKeyExchangeTests.test_DH_GROUP14cCs |dS)zs The diffie-hellman-group-exchange-sha1 key exchange algorithm is compatible with OpenSSH. z"diffie-hellman-group-exchange-sha1rr'r#r#r$test_DH_GROUP_EXCHANGE_SHA1zsz3OpenSSHKeyExchangeTests.test_DH_GROUP_EXCHANGE_SHA1cCs |dS)zu The diffie-hellman-group-exchange-sha256 key exchange algorithm is compatible with OpenSSH. z$diffie-hellman-group-exchange-sha256rr'r#r#r$test_DH_GROUP_EXCHANGE_SHA256sz5OpenSSHKeyExchangeTests.test_DH_GROUP_EXCHANGE_SHA256cCs|t|jddS)zy The list of key exchange algorithms supported by OpenSSH client is obtained with C{ssh -Q kex}. zunsupported-algorithmN) assertRaisesrrr'r#r#r$test_unsupported_algorithms z2OpenSSHKeyExchangeTests.test_unsupported_algorithmN) r r!r"r*rrrrrrrrr#r#r#r$r8s  rc@seZdZdZeddZdS)OpenSSHClientForwardingTestszR Connection forwarding tests run against the OpenSSL command line client. cCs>|}t|d}|jd|d||jfd}||jd|S)zG Forwarding of arbitrary IPv6 TCP connections via SSH. rrz-N -L%i:[::1]:%ir)rrUrrrrrr#r#r$test_localToRemoteForwardingV6s  z;OpenSSHClientForwardingTests.test_localToRemoteForwardingV6N)r r!r"r*rrr#r#r#r$rsrc@seZdZdZdS)OpenSSHClientRekeyTestszE Rekeying tests run against the OpenSSL command line client. N)r r!r"r*r#r#r#r$rsrc@s8eZdZdZejdkrdZd ddZdd Zd d Z dS) CmdLineClientTestszP Connection forwarding tests run against the Conch command line client. win32z!can't run cmdline client on win32rNc Cs|dkr g}t|_|jj}d||d|}t||}t j }t j tj|d<g} i} |D]"}t|tr|d}| |qp|D]<} || } t| tr| d} t| tr| d} | | | <qtj|tj| | d|jS)z{ As for L{OpenSSHClientTestCase.execute}, except it runs the 'conch' command line tool, not 'ssh'. Nz[-p {} -l testuser --known-hosts kh_test --user-authentications publickey -a -i rsa_test -v r PYTHONPATHrd)env)r rrFrrrVrPrprrwenvironcopypathseprrerxrhrirjrkr rrf) r(rrr conchArgsrVrrrrZ encodedEnvvarvalr#r#r$rs@           zCmdLineClientTests.executecsVfdd}tjdtddjddgd}|jd |||S) z4 It can store logs to a local file. cs}d|dS)Ns Log opened.)Z getContentZassertIn)rZ logContentZlogPathr(r#r$ cb_check_logsz.cb_check_logrz--logz --logfilez--host-key-algorithmszssh-rsa)rrrr)rrmktemprrBrxrr)r(rrHr#rr$test_runWithLogFiles  z&CmdLineClientTests.test_runWithLogFilecCs"|jdtd}||jd|S)zH Do not use --host-key-algorithms flag on command line. r)rrrrrGr#r#r$%test_runWithNoHostAlgorithmsSpecifieds z8CmdLineClientTests.test_runWithNoHostAlgorithmsSpecified)rN) r r!r"r*rZ platformTyper2rrrr#r#r#r$rs   %r)rc)Orwrrre itertoolsrZzope.interfacerZtwisted.conch.errorrZtwisted.conch.test.keydatarrZtwisted.conch.test.test_sshrZ twisted.credr Ztwisted.internetr r r Ztwisted.internet.errorr Ztwisted.internet.taskrZtwisted.pythonrrrZtwisted.python.filepathrZtwisted.python.procutilsrZtwisted.python.reflectrZtwisted.test.testutilsrrZtwisted.trial.unittestrrrr ImportErrorrZtwisted.conch.avatarrZtwisted.conch.ssh.sessionrrrZtwisted.conch.interfacesZtwisted.conch.scripts.conchZ_StdioInteractingSessioner,rir1r%r+rr3ZFactoryrAZProcessProtocolrBrUr[rprqrrrrrrrrrr#r#r#r$sl             +L K6D 1\