/usr/lib/python2.7/dist-packages/twisted/conch/test/test_endpoints.py is in python-twisted-conch 1:13.2.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 | # Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Tests for L{twisted.conch.endpoints}.
"""
import os.path
from struct import pack
from errno import ENOSYS
from zope.interface.verify import verifyObject, verifyClass
from zope.interface import implementer
from twisted.python.log import msg
from twisted.python.filepath import FilePath
from twisted.python.failure import Failure
from twisted.internet.interfaces import IAddress, IStreamClientEndpoint
from twisted.internet.protocol import Factory, Protocol
from twisted.internet.defer import CancelledError, Deferred, succeed, fail
from twisted.internet.error import ConnectionDone, ConnectionRefusedError
from twisted.internet.address import IPv4Address
from twisted.trial.unittest import TestCase
from twisted.test.proto_helpers import MemoryReactorClock
from twisted.internet.error import ProcessTerminated, ConnectingCancelledError
from twisted.cred.portal import Portal
from twisted.cred.checkers import InMemoryUsernamePasswordDatabaseDontUse
from twisted.conch.interfaces import IConchUser
from twisted.conch.error import ConchError, UserRejectedKey, HostKeyChanged
try:
from Crypto.Cipher import AES
from pyasn1 import type
except ImportError as e:
skip = "can't run w/o PyCrypto and pyasn1 (%s)" % (e,)
SSHFactory = SSHUserAuthServer = SSHConnection = Key = SSHChannel = \
SSHAgentServer = KnownHostsFile = SSHPublicKeyDatabase = ConchUser = \
object
else:
from twisted.conch.ssh.factory import SSHFactory
from twisted.conch.ssh.userauth import SSHUserAuthServer
from twisted.conch.ssh.connection import SSHConnection
from twisted.conch.ssh.keys import Key
from twisted.conch.ssh.channel import SSHChannel
from twisted.conch.ssh.agent import SSHAgentServer
from twisted.conch.client.knownhosts import KnownHostsFile, ConsoleUI
from twisted.conch.checkers import SSHPublicKeyDatabase
from twisted.conch.avatar import ConchUser
from twisted.conch.test.keydata import (
publicRSA_openssh, privateRSA_openssh, privateDSA_openssh)
from twisted.conch.endpoints import (
_ISSHConnectionCreator, AuthenticationFailed, SSHCommandAddress,
SSHCommandClientEndpoint, _ReadFile, _NewConnectionHelper,
_ExistingConnectionHelper)
from twisted.conch.ssh.transport import SSHClientTransport
from twisted.python.fakepwd import UserDatabase
from twisted.test.proto_helpers import StringTransport
from twisted.test.iosim import FakeTransport, connect
class AbortableFakeTransport(FakeTransport):
"""
A L{FakeTransport} with added C{abortConnection} support.
"""
aborted = False
def abortConnection(self):
"""
Abort the connection in a fake manner.
This should really be implemented in the underlying module.
"""
self.aborted = True
class BrokenExecSession(SSHChannel):
"""
L{BrokenExecSession} is a session on which exec requests always fail.
"""
def request_exec(self, data):
"""
Fail all exec requests.
@param data: Information about what is being executed.
@type data: L{bytes}
@return: C{0} to indicate failure
@rtype: L{int}
"""
return 0
class WorkingExecSession(SSHChannel):
"""
L{WorkingExecSession} is a session on which exec requests always succeed.
"""
def request_exec(self, data):
"""
Succeed all exec requests.
@param data: Information about what is being executed.
@type data: L{bytes}
@return: C{1} to indicate success
@rtype: L{int}
"""
return 1
class UnsatisfiedExecSession(SSHChannel):
"""
L{UnsatisfiedExecSession} is a session on which exec requests are always
delayed indefinitely, never succeeding or failing.
"""
def request_exec(self, data):
"""
Delay all exec requests indefinitely.
@param data: Information about what is being executed.
@type data: L{bytes}
@return: A L{Deferred} which will never fire.
@rtype: L{Deferred}
"""
return Deferred()
class TrivialRealm(object):
def __init__(self):
self.channelLookup = {}
def requestAvatar(self, avatarId, mind, *interfaces):
avatar = ConchUser()
avatar.channelLookup = self.channelLookup
return (IConchUser, avatar, lambda: None)
class AddressSpyFactory(Factory):
address = None
def buildProtocol(self, address):
self.address = address
return Factory.buildProtocol(self, address)
class FixedResponseUI(object):
def __init__(self, result):
self.result = result
def prompt(self, text):
return succeed(self.result)
def warn(self, text):
pass
class FakeClockSSHUserAuthServer(SSHUserAuthServer):
# Delegate this setting to the factory to simplify tweaking it
@property
def attemptsBeforeDisconnect(self):
"""
Use the C{attemptsBeforeDisconnect} value defined by the factory to make
it easier to override.
"""
return self.transport.factory.attemptsBeforeDisconnect
@property
def clock(self):
"""
Use the reactor defined by the factory, rather than the default global
reactor, to simplify testing (by allowing an alternate implementation
to be supplied by tests).
"""
return self.transport.factory.reactor
class CommandFactory(SSHFactory):
@property
def publicKeys(self):
return {
'ssh-rsa': Key.fromString(data=publicRSA_openssh)
}
@property
def privateKeys(self):
return {
'ssh-rsa': Key.fromString(data=privateRSA_openssh)
}
services = {
'ssh-userauth': FakeClockSSHUserAuthServer,
'ssh-connection': SSHConnection
}
# Simplify the tests by disconnecting after the first authentication
# failure. One attempt should be sufficient to test authentication success
# and failure. There is an off-by-one in the implementation of this
# feature in Conch, so set it to 0 in order to allow 1 attempt.
attemptsBeforeDisconnect = 0
@implementer(IAddress)
class MemoryAddress(object):
pass
@implementer(IStreamClientEndpoint)
class SingleUseMemoryEndpoint(object):
"""
L{SingleUseMemoryEndpoint} is a client endpoint which allows one connection
to be set up and then exposes an API for moving around bytes related to
that connection.
@ivar pump: L{None} until a connection is attempted, then a L{IOPump}
instance associated with the protocol which is connected.
@type pump: L{IOPump}
"""
def __init__(self, server):
"""
@param server: An L{IProtocol} provider to which the client will be
connected.
@type server: L{IProtocol} provider
"""
self.pump = None
self._server = server
def connect(self, factory):
if self.pump is not None:
raise Exception("SingleUseMemoryEndpoint was already used")
try:
protocol = factory.buildProtocol(MemoryAddress())
except:
return fail()
else:
self.pump = connect(
self._server, AbortableFakeTransport(
self._server, isServer=True),
protocol, AbortableFakeTransport(protocol, isServer=False))
return succeed(protocol)
class MemorySSHPublicKeyDatabase(SSHPublicKeyDatabase):
def __init__(self, users):
self._users = users
self._userdb = UserDatabase()
for i, username in enumerate(self._users):
self._userdb.addUser(
username, b"garbage", 123 + i, 456, None, None, None)
def getAuthorizedKeysFiles(self, credentials):
try:
return self._users[credentials.username]
except KeyError:
return []
class SSHCommandClientEndpointTestsMixin(object):
"""
Tests for L{SSHCommandClientEndpoint}, an L{IStreamClientEndpoint}
implementations which connects a protocol with the stdin and stdout of a
command running in an SSH session.
These tests apply to L{SSHCommandClientEndpoint} whether it is constructed
using L{SSHCommandClientEndpoint.existingConnection} or
L{SSHCommandClientEndpoint.newConnection}.
Subclasses must override L{create}, L{assertClientTransportState}, and
L{finishConnection}.
"""
def setUp(self):
self.hostname = b"ssh.example.com"
self.port = 42022
self.user = b"user"
self.password = b"password"
self.reactor = MemoryReactorClock()
self.realm = TrivialRealm()
self.portal = Portal(self.realm)
self.passwdDB = InMemoryUsernamePasswordDatabaseDontUse()
self.passwdDB.addUser(self.user, self.password)
self.portal.registerChecker(self.passwdDB)
self.factory = CommandFactory()
self.factory.reactor = self.reactor
self.factory.portal = self.portal
self.factory.doStart()
self.addCleanup(self.factory.doStop)
self.clientAddress = IPv4Address("TCP", "10.0.0.1", 12345)
self.serverAddress = IPv4Address("TCP", "192.168.100.200", 54321)
def create(self):
"""
Create and return a new L{SSHCommandClientEndpoint} to be tested.
Override this to implement creation in an interesting way the endpoint.
"""
raise NotImplementedError(
"%r did not implement create" % (self.__class__.__name__,))
def assertClientTransportState(self, client, immediateClose):
"""
Make an assertion about the connectedness of the given protocol's
transport. Override this to implement either a check for the
connection still being open or having been closed as appropriate.
@param client: The client whose state is being checked.
@param immediateClose: Boolean indicating whether the connection was
closed immediately or not.
"""
raise NotImplementedError(
"%r did not implement assertClientTransportState" % (
self.__class__.__name__,))
def finishConnection(self):
"""
Do any remaining work necessary to complete an in-memory connection
attempted initiated using C{self.reactor}.
"""
raise NotImplementedError(
"%r did not implement finishConnection" % (
self.__class__.__name__,))
def connectedServerAndClient(self, serverFactory, clientFactory):
"""
Set up an in-memory connection between protocols created by
C{serverFactory} and C{clientFactory}.
@return: A three-tuple. The first element is the protocol created by
C{serverFactory}. The second element is the protocol created by
C{clientFactory}. The third element is the L{IOPump} connecting
them.
"""
clientProtocol = clientFactory.buildProtocol(None)
serverProtocol = serverFactory.buildProtocol(None)
clientTransport = AbortableFakeTransport(
clientProtocol, isServer=False, hostAddress=self.clientAddress,
peerAddress=self.serverAddress)
serverTransport = AbortableFakeTransport(
serverProtocol, isServer=True, hostAddress=self.serverAddress,
peerAddress=self.clientAddress)
pump = connect(
serverProtocol, serverTransport, clientProtocol, clientTransport)
return serverProtocol, clientProtocol, pump
def test_channelOpenFailure(self):
"""
If a channel cannot be opened on the authenticated SSH connection, the
L{Deferred} returned by L{SSHCommandClientEndpoint.connect} fires with
a L{Failure} wrapping the reason given by the server.
"""
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
# The server logs the channel open failure - this is expected.
errors = self.flushLoggedErrors(ConchError)
self.assertIn(
'unknown channel', (errors[0].value.data, errors[0].value.value))
self.assertEqual(1, len(errors))
# Now deal with the results on the endpoint side.
f = self.failureResultOf(connected)
f.trap(ConchError)
self.assertEqual('unknown channel', f.value.value)
self.assertClientTransportState(client, False)
def test_execFailure(self):
"""
If execution of the command fails, the L{Deferred} returned by
L{SSHCommandClientEndpoint.connect} fires with a L{Failure} wrapping
the reason given by the server.
"""
self.realm.channelLookup[b'session'] = BrokenExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
f = self.failureResultOf(connected)
f.trap(ConchError)
self.assertEqual('channel request failed', f.value.value)
self.assertClientTransportState(client, False)
def test_execCancelled(self):
"""
If execution of the command is cancelled via the L{Deferred} returned
by L{SSHCommandClientEndpoint.connect}, the connection is closed
immediately.
"""
self.realm.channelLookup[b'session'] = UnsatisfiedExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
connected.cancel()
f = self.failureResultOf(connected)
f.trap(CancelledError)
self.assertClientTransportState(client, True)
def test_buildProtocol(self):
"""
Once the necessary SSH actions have completed successfully,
L{SSHCommandClientEndpoint.connect} uses the factory passed to it to
construct a protocol instance by calling its C{buildProtocol} method
with an address object representing the SSH connection and command
executed.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = AddressSpyFactory()
factory.protocol = Protocol
endpoint.connect(factory)
server, client, pump = self.finishConnection()
self.assertIsInstance(factory.address, SSHCommandAddress)
self.assertEqual(server.transport.getHost(), factory.address.server)
self.assertEqual(self.user, factory.address.username)
self.assertEqual(b"/bin/ls -l", factory.address.command)
def test_makeConnection(self):
"""
L{SSHCommandClientEndpoint} establishes an SSH connection, creates a
channel in it, runs a command in that channel, and uses the protocol's
C{makeConnection} to associate it with a protocol representing that
command's stdin and stdout.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
self.assertIsNot(None, protocol.transport)
def test_dataReceived(self):
"""
After establishing the connection, when the command on the SSH server
produces output, it is delivered to the protocol's C{dataReceived}
method.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
dataReceived = []
protocol.dataReceived = dataReceived.append
# Figure out which channel on the connection this protocol is
# associated with so the test can do a write on it.
channelId = protocol.transport.id
server.service.channels[channelId].write(b"hello, world")
pump.pump()
self.assertEqual(b"hello, world", b"".join(dataReceived))
def test_connectionLost(self):
"""
When the command closes the channel, the protocol's C{connectionLost}
method is called.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
connectionLost = []
protocol.connectionLost = connectionLost.append
# Figure out which channel on the connection this protocol is associated
# with so the test can do a write on it.
channelId = protocol.transport.id
server.service.channels[channelId].loseConnection()
pump.pump()
connectionLost[0].trap(ConnectionDone)
self.assertClientTransportState(client, False)
def _exitStatusTest(self, request, requestArg):
"""
Test handling of non-zero exit statuses or exit signals.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
connectionLost = []
protocol.connectionLost = connectionLost.append
# Figure out which channel on the connection this protocol is associated
# with so the test can simulate command exit and channel close.
channelId = protocol.transport.id
channel = server.service.channels[channelId]
server.service.sendRequest(channel, request, requestArg)
channel.loseConnection()
pump.pump()
self.assertClientTransportState(client, False)
return connectionLost[0]
def test_zeroExitCode(self):
"""
When the command exits with a non-zero status, the protocol's
C{connectionLost} method is called with a L{Failure} wrapping an
exception which encapsulates that status.
"""
exitCode = 0
exc = self._exitStatusTest('exit-status', pack('>L', exitCode))
exc.trap(ConnectionDone)
def test_nonZeroExitStatus(self):
"""
When the command exits with a non-zero status, the protocol's
C{connectionLost} method is called with a L{Failure} wrapping an
exception which encapsulates that status.
"""
exitCode = 123
signal = None
exc = self._exitStatusTest('exit-status', pack('>L', exitCode))
exc.trap(ProcessTerminated)
self.assertEqual(exitCode, exc.value.exitCode)
self.assertEqual(signal, exc.value.signal)
def test_nonZeroExitSignal(self):
"""
When the command exits with a non-zero signal, the protocol's
C{connectionLost} method is called with a L{Failure} wrapping an
exception which encapsulates that status.
"""
exitCode = None
signal = 123
exc = self._exitStatusTest('exit-signal', pack('>L', signal))
exc.trap(ProcessTerminated)
self.assertEqual(exitCode, exc.value.exitCode)
self.assertEqual(signal, exc.value.signal)
def record(self, server, protocol, event, noArgs=False):
"""
Hook into and record events which happen to C{protocol}.
@param server: The SSH server protocol over which C{protocol} is
running.
@type server: L{IProtocol} provider
@param protocol:
@param event:
@param noArgs:
"""
# Figure out which channel the test is going to send data over so we can
# look for it to arrive at the right place on the server.
channelId = protocol.transport.id
recorder = []
if noArgs:
f = lambda: recorder.append(None)
else:
f = recorder.append
setattr(server.service.channels[channelId], event, f)
return recorder
def test_write(self):
"""
The transport connected to the protocol has a C{write} method which
sends bytes to the input of the command executing on the SSH server.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
dataReceived = self.record(server, protocol, 'dataReceived')
protocol.transport.write(b"hello, world")
pump.pump()
self.assertEqual(b"hello, world", b"".join(dataReceived))
def test_writeSequence(self):
"""
The transport connected to the protocol has a C{writeSequence} method which
sends bytes to the input of the command executing on the SSH server.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
dataReceived = self.record(server, protocol, 'dataReceived')
protocol.transport.writeSequence(list(b"hello, world"))
pump.pump()
self.assertEqual(b"hello, world", b"".join(dataReceived))
class NewConnectionTests(TestCase, SSHCommandClientEndpointTestsMixin):
"""
Tests for L{SSHCommandClientEndpoint} when using the C{newConnection}
constructor.
"""
def setUp(self):
"""
Configure an SSH server with password authentication enabled for a
well-known (to the tests) account.
"""
SSHCommandClientEndpointTestsMixin.setUp(self)
# Make the server's host key available to be verified by the client.
self.hostKeyPath = FilePath(self.mktemp())
self.knownHosts = KnownHostsFile(self.hostKeyPath)
self.knownHosts.addHostKey(
self.hostname, self.factory.publicKeys['ssh-rsa'])
self.knownHosts.addHostKey(
self.serverAddress.host, self.factory.publicKeys['ssh-rsa'])
self.knownHosts.save()
def create(self):
"""
Create and return a new L{SSHCommandClientEndpoint} using the
C{newConnection} constructor.
"""
return SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
password=self.password, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
def finishConnection(self):
"""
Establish the first attempted TCP connection using the SSH server which
C{self.factory} can create.
"""
return self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
def assertClientTransportState(self, client, immediateClose):
"""
Assert that the transport for the given protocol has been disconnected.
L{SSHCommandClientEndpoint.newConnection} creates a new dedicated SSH
connection and cleans it up after the command exits.
"""
# Nothing useful can be done with the connection at this point, so the
# endpoint should close it.
if immediateClose:
self.assertTrue(client.transport.aborted)
else:
self.assertTrue(client.transport.disconnecting)
def test_interface(self):
"""
L{SSHCommandClientEndpoint} instances provide L{IStreamClientEndpoint}.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"dummy command", b"dummy user",
self.hostname, self.port)
self.assertTrue(verifyObject(IStreamClientEndpoint, endpoint))
def test_defaultPort(self):
"""
L{SSHCommandClientEndpoint} uses the default port number for SSH when
the C{port} argument is not specified.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"dummy command", b"dummy user", self.hostname)
self.assertEqual(22, endpoint._creator.port)
def test_specifiedPort(self):
"""
L{SSHCommandClientEndpoint} uses the C{port} argument if specified.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"dummy command", b"dummy user",
self.hostname, port=2222)
self.assertEqual(2222, endpoint._creator.port)
def test_destination(self):
"""
L{SSHCommandClientEndpoint} uses the L{IReactorTCP} passed to it to
attempt a connection to the host/port address also passed to it.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
password=self.password, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
endpoint.connect(factory)
host, port, factory, timeout, bindAddress = self.reactor.tcpClients[0]
self.assertEqual(self.hostname, host)
self.assertEqual(self.port, port)
self.assertEqual(1, len(self.reactor.tcpClients))
def test_connectionFailed(self):
"""
If a connection cannot be established, the L{Deferred} returned by
L{SSHCommandClientEndpoint.connect} fires with a L{Failure}
representing the reason for the connection setup failure.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
d = endpoint.connect(factory)
factory = self.reactor.tcpClients[0][2]
factory.clientConnectionFailed(None, Failure(ConnectionRefusedError()))
self.failureResultOf(d).trap(ConnectionRefusedError)
def test_userRejectedHostKey(self):
"""
If the L{KnownHostsFile} instance used to construct
L{SSHCommandClientEndpoint} rejects the SSH public key presented by the
server, the L{Deferred} returned by L{SSHCommandClientEndpoint.connect}
fires with a L{Failure} wrapping L{UserRejectedKey}.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, knownHosts=KnownHostsFile(self.mktemp()),
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
f = self.failureResultOf(connected)
f.trap(UserRejectedKey)
def test_mismatchedHostKey(self):
"""
If the SSH public key presented by the SSH server does not match the
previously remembered key, as reported by the L{KnownHostsFile}
instance use to construct the endpoint, for that server, the
L{Deferred} returned by L{SSHCommandClientEndpoint.connect} fires with
a L{Failure} wrapping L{HostKeyChanged}.
"""
differentKey = Key.fromString(privateDSA_openssh).public()
knownHosts = KnownHostsFile(self.mktemp())
knownHosts.addHostKey(self.serverAddress.host, differentKey)
knownHosts.addHostKey(self.hostname, differentKey)
# The UI may answer true to any questions asked of it; they should
# make no difference, since a *mismatched* key is not even optionally
# allowed to complete a connection.
ui = FixedResponseUI(True)
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, password=b"dummy password",
knownHosts=knownHosts, ui=ui)
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
f = self.failureResultOf(connected)
f.trap(HostKeyChanged)
def test_connectionClosedBeforeSecure(self):
"""
If the connection closes at any point before the SSH transport layer
has finished key exchange (ie, gotten to the point where we may attempt
to authenticate), the L{Deferred} returned by
L{SSHCommandClientEndpoint.connect} fires with a L{Failure} wrapping
the reason for the lost connection.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
d = endpoint.connect(factory)
transport = StringTransport()
factory = self.reactor.tcpClients[0][2]
client = factory.buildProtocol(None)
client.makeConnection(transport)
client.connectionLost(Failure(ConnectionDone()))
self.failureResultOf(d).trap(ConnectionDone)
def test_connectionCancelledBeforeSecure(self):
"""
If the connection is cancelled before the SSH transport layer has
finished key exchange (ie, gotten to the point where we may attempt to
authenticate), the L{Deferred} returned by
L{SSHCommandClientEndpoint.connect} fires with a L{Failure} wrapping
L{CancelledError} and the connection is aborted.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
d = endpoint.connect(factory)
transport = AbortableFakeTransport(None, isServer=False)
factory = self.reactor.tcpClients[0][2]
client = factory.buildProtocol(None)
client.makeConnection(transport)
d.cancel()
self.failureResultOf(d).trap(CancelledError)
self.assertTrue(transport.aborted)
# Make sure the connection closing doesn't result in unexpected
# behavior when due to cancellation:
client.connectionLost(Failure(ConnectionDone()))
def test_connectionCancelledBeforeConnected(self):
"""
If the connection is cancelled before it finishes connecting, the
connection attempt is stopped.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
d = endpoint.connect(factory)
d.cancel()
self.failureResultOf(d).trap(ConnectingCancelledError)
self.assertTrue(self.reactor.connectors[0].stoppedConnecting)
def test_passwordAuthenticationFailure(self):
"""
If the SSH server rejects the password presented during authentication,
the L{Deferred} returned by L{SSHCommandClientEndpoint.connect} fires
with a L{Failure} wrapping L{AuthenticationFailed}.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", b"dummy user",
self.hostname, self.port, password=b"dummy password",
knownHosts=self.knownHosts, ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
# For security, the server delays password authentication failure
# response. Advance the simulation clock so the client sees the
# failure.
self.reactor.advance(server.service.passwordDelay)
# Let the failure response traverse the "network"
pump.flush()
f = self.failureResultOf(connected)
f.trap(AuthenticationFailed)
# XXX Should assert something specific about the arguments of the
# exception
self.assertClientTransportState(client, False)
def setupKeyChecker(self, portal, users):
"""
Create an L{ISSHPrivateKey} checker which recognizes C{users} and add it
to C{portal}.
@param portal: A L{Portal} to which to add the checker.
@type portal: L{Portal}
@param users: The users and their keys the checker will recognize. Keys
are byte strings giving user names. Values are byte strings giving
OpenSSH-formatted private keys.
@type users: C{dict}
"""
credentials = {}
for username, keyString in users.iteritems():
goodKey = Key.fromString(keyString)
authorizedKeys = FilePath(self.mktemp())
authorizedKeys.setContent(goodKey.public().toString("OPENSSH"))
credentials[username] = [authorizedKeys]
checker = MemorySSHPublicKeyDatabase(credentials)
portal.registerChecker(checker)
def test_publicKeyAuthenticationFailure(self):
"""
If the SSH server rejects the key pair presented during authentication,
the L{Deferred} returned by L{SSHCommandClientEndpoint.connect} fires
with a L{Failure} wrapping L{AuthenticationFailed}.
"""
badKey = Key.fromString(privateRSA_openssh)
self.setupKeyChecker(self.portal, {self.user: privateDSA_openssh})
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user,
self.hostname, self.port, keys=[badKey],
knownHosts=self.knownHosts, ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
f = self.failureResultOf(connected)
f.trap(AuthenticationFailed)
# XXX Should assert something specific about the arguments of the
# exception
# Nothing useful can be done with the connection at this point, so the
# endpoint should close it.
self.assertTrue(client.transport.disconnecting)
def test_authenticationFallback(self):
"""
If the SSH server does not accept any of the specified SSH keys, the
specified password is tried.
"""
badKey = Key.fromString(privateRSA_openssh)
self.setupKeyChecker(self.portal, {self.user: privateDSA_openssh})
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
keys=[badKey], password=self.password, knownHosts=self.knownHosts,
ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
# Exercising fallback requires a failed authentication attempt. Allow
# one.
self.factory.attemptsBeforeDisconnect += 1
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
pump.pump()
# The server logs the channel open failure - this is expected.
errors = self.flushLoggedErrors(ConchError)
self.assertIn(
'unknown channel', (errors[0].value.data, errors[0].value.value))
self.assertEqual(1, len(errors))
# Now deal with the results on the endpoint side.
f = self.failureResultOf(connected)
f.trap(ConchError)
self.assertEqual('unknown channel', f.value.value)
# Nothing useful can be done with the connection at this point, so the
# endpoint should close it.
self.assertTrue(client.transport.disconnecting)
def test_publicKeyAuthentication(self):
"""
If L{SSHCommandClientEndpoint} is initialized with any private keys, it
will try to use them to authenticate with the SSH server.
"""
key = Key.fromString(privateDSA_openssh)
self.setupKeyChecker(self.portal, {self.user: privateDSA_openssh})
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
keys=[key], knownHosts=self.knownHosts, ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
protocol = self.successResultOf(connected)
self.assertIsNot(None, protocol.transport)
def test_skipPasswordAuthentication(self):
"""
If the password is not specified, L{SSHCommandClientEndpoint} doesn't
try it as an authentication mechanism.
"""
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
knownHosts=self.knownHosts, ui=FixedResponseUI(False))
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
pump.pump()
# Now deal with the results on the endpoint side.
f = self.failureResultOf(connected)
f.trap(AuthenticationFailed)
# Nothing useful can be done with the connection at this point, so the
# endpoint should close it.
self.assertTrue(client.transport.disconnecting)
def test_agentAuthentication(self):
"""
If L{SSHCommandClientEndpoint} is initialized with an
L{SSHAgentClient}, the agent is used to authenticate with the SSH
server.
"""
key = Key.fromString(privateRSA_openssh)
agentServer = SSHAgentServer()
agentServer.factory = Factory()
agentServer.factory.keys = {key.blob(): (key, "")}
self.setupKeyChecker(self.portal, {self.user: privateRSA_openssh})
agentEndpoint = SingleUseMemoryEndpoint(agentServer)
endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
knownHosts=self.knownHosts, ui=FixedResponseUI(False),
agentEndpoint=agentEndpoint)
self.realm.channelLookup[b'session'] = WorkingExecSession
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
# Let the agent client talk with the agent server and the ssh client
# talk with the ssh server.
for i in range(14):
agentEndpoint.pump.pump()
pump.pump()
protocol = self.successResultOf(connected)
self.assertIsNot(None, protocol.transport)
def test_loseConnection(self):
"""
The transport connected to the protocol has a C{loseConnection} method
which causes the channel in which the command is running to close and
the overall connection to be closed.
"""
self.realm.channelLookup[b'session'] = WorkingExecSession
endpoint = self.create()
factory = Factory()
factory.protocol = Protocol
connected = endpoint.connect(factory)
server, client, pump = self.finishConnection()
protocol = self.successResultOf(connected)
closed = self.record(server, protocol, 'closed', noArgs=True)
protocol.transport.loseConnection()
pump.pump()
self.assertEqual([None], closed)
# Let the last bit of network traffic flow. This lets the server's
# close acknowledgement through, at which point the client can close
# the overall SSH connection.
pump.pump()
# Nothing useful can be done with the connection at this point, so the
# endpoint should close it.
self.assertTrue(client.transport.disconnecting)
class ExistingConnectionTests(TestCase, SSHCommandClientEndpointTestsMixin):
"""
Tests for L{SSHCommandClientEndpoint} when using the C{existingConnection}
constructor.
"""
def setUp(self):
"""
Configure an SSH server with password authentication enabled for a
well-known (to the tests) account.
"""
SSHCommandClientEndpointTestsMixin.setUp(self)
knownHosts = KnownHostsFile(FilePath(self.mktemp()))
knownHosts.addHostKey(
self.hostname, self.factory.publicKeys['ssh-rsa'])
knownHosts.addHostKey(
self.serverAddress.host, self.factory.publicKeys['ssh-rsa'])
self.endpoint = SSHCommandClientEndpoint.newConnection(
self.reactor, b"/bin/ls -l", self.user, self.hostname, self.port,
password=self.password, knownHosts=knownHosts,
ui=FixedResponseUI(False))
def create(self):
"""
Create and return a new L{SSHCommandClientEndpoint} using the
C{existingConnection} constructor.
"""
factory = Factory()
factory.protocol = Protocol
connected = self.endpoint.connect(factory)
# Please, let me in. This kinda sucks.
channelLookup = self.realm.channelLookup.copy()
try:
self.realm.channelLookup[b'session'] = WorkingExecSession
server, client, pump = self.connectedServerAndClient(
self.factory, self.reactor.tcpClients[0][2])
finally:
self.realm.channelLookup.clear()
self.realm.channelLookup.update(channelLookup)
self._server = server
self._client = client
self._pump = pump
protocol = self.successResultOf(connected)
connection = protocol.transport.conn
return SSHCommandClientEndpoint.existingConnection(
connection, b"/bin/ls -l")
def finishConnection(self):
"""
Give back the connection established in L{create} over which the new
command channel being tested will exchange data.
"""
# The connection was set up and the first command channel set up, but
# some more I/O needs to happen for the second command channel to be
# ready. Make that I/O happen before giving back the objects.
self._pump.pump()
self._pump.pump()
self._pump.pump()
self._pump.pump()
return self._server, self._client, self._pump
def assertClientTransportState(self, client, immediateClose):
"""
Assert that the transport for the given protocol is still connected.
L{SSHCommandClientEndpoint.existingConnection} re-uses an SSH connected
created by some other code, so other code is responsible for cleaning
it up.
"""
self.assertFalse(client.transport.disconnecting)
self.assertFalse(client.transport.aborted)
class ExistingConnectionHelperTests(TestCase):
"""
Tests for L{_ExistingConnectionHelper}.
"""
def test_interface(self):
"""
L{_ExistingConnectionHelper} implements L{_ISSHConnectionCreator}.
"""
self.assertTrue(
verifyClass(_ISSHConnectionCreator, _ExistingConnectionHelper))
def test_secureConnection(self):
"""
L{_ExistingConnectionHelper.secureConnection} returns a L{Deferred}
which fires with whatever object was fed to
L{_ExistingConnectionHelper.__init__}.
"""
result = object()
helper = _ExistingConnectionHelper(result)
self.assertIs(
result, self.successResultOf(helper.secureConnection()))
def test_cleanupConnectionNotImmediately(self):
"""
L{_ExistingConnectionHelper.cleanupConnection} does nothing to the
existing connection if called with C{immediate} set to C{False}.
"""
helper = _ExistingConnectionHelper(object())
# Bit hard to test nothing happens. However, since object() has no
# relevant methods or attributes, if the code is incorrect we can
# expect an AttributeError.
helper.cleanupConnection(object(), False)
def test_cleanupConnectionImmediately(self):
"""
L{_ExistingConnectionHelper.cleanupConnection} does nothing to the
existing connection if called with C{immediate} set to C{True}.
"""
helper = _ExistingConnectionHelper(object())
# Bit hard to test nothing happens. However, since object() has no
# relevant methods or attributes, if the code is incorrect we can
# expect an AttributeError.
helper.cleanupConnection(object(), True)
class _PTYPath(object):
"""
A L{FilePath}-like object which can be opened to create a L{_ReadFile} with
certain contents.
"""
def __init__(self, contents):
"""
@param contents: L{bytes} which will be the contents of the
L{_ReadFile} this path can open.
"""
self.contents = contents
def open(self, mode):
"""
If the mode is r+, return a L{_ReadFile} with the contents given to
this path's initializer.
@raise OSError: If the mode is unsupported.
@return: A L{_ReadFile} instance
"""
if mode == "r+":
return _ReadFile(self.contents)
raise OSError(ENOSYS, "Function not implemented")
class NewConnectionHelperTests(TestCase):
"""
Tests for L{_NewConnectionHelper}.
"""
def test_interface(self):
"""
L{_NewConnectionHelper} implements L{_ISSHConnectionCreator}.
"""
self.assertTrue(
verifyClass(_ISSHConnectionCreator, _NewConnectionHelper))
def test_defaultPath(self):
"""
The default I{known_hosts} path is I{~/.ssh/known_hosts}.
"""
self.assertEqual(
"~/.ssh/known_hosts", _NewConnectionHelper._KNOWN_HOSTS)
def test_defaultKnownHosts(self):
"""
L{_NewConnectionHelper._knownHosts} is used to create a
L{KnownHostsFile} if one is not passed to the initializer.
"""
result = object()
self.patch(_NewConnectionHelper, '_knownHosts', lambda cls: result)
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None)
self.assertIs(result, helper.knownHosts)
def test_readExisting(self):
"""
Existing entries in the I{known_hosts} file are reflected by the
L{KnownHostsFile} created by L{_NewConnectionHelper} when none is
supplied to it.
"""
key = CommandFactory().publicKeys['ssh-rsa']
path = FilePath(self.mktemp())
knownHosts = KnownHostsFile(path)
knownHosts.addHostKey("127.0.0.1", key)
knownHosts.save()
msg("Created known_hosts file at %r" % (path.path,))
# Unexpand ${HOME} to make sure ~ syntax is respected.
home = os.path.expanduser("~/")
default = path.path.replace(home, "~/")
self.patch(_NewConnectionHelper, "_KNOWN_HOSTS", default)
msg("Patched _KNOWN_HOSTS with %r" % (default,))
loaded = _NewConnectionHelper._knownHosts()
self.assertTrue(loaded.hasHostKey("127.0.0.1", key))
def test_defaultConsoleUI(self):
"""
If C{None} is passed for the C{ui} parameter to
L{_NewConnectionHelper}, a L{ConsoleUI} is used.
"""
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None)
self.assertIsInstance(helper.ui, ConsoleUI)
def test_ttyConsoleUI(self):
"""
If C{None} is passed for the C{ui} parameter to L{_NewConnectionHelper}
and /dev/tty is available, the L{ConsoleUI} used is associated with
/dev/tty.
"""
tty = _PTYPath(b"yes")
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None, tty)
result = self.successResultOf(helper.ui.prompt(b"does this work?"))
self.assertTrue(result)
def test_nottyUI(self):
"""
If C{None} is passed for the C{ui} parameter to L{_NewConnectionHelper}
and /dev/tty is not available, the L{ConsoleUI} used is associated with
some file which always produces a C{b"no"} response.
"""
tty = FilePath(self.mktemp())
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None, tty)
result = self.successResultOf(helper.ui.prompt(b"did this break?"))
self.assertFalse(result)
def test_defaultTTYFilename(self):
"""
If not passed the name of a tty in the filesystem,
L{_NewConnectionHelper} uses C{b"/dev/tty"}.
"""
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None)
self.assertEqual(FilePath(b"/dev/tty"), helper.tty)
def test_cleanupConnectionNotImmediately(self):
"""
L{_NewConnectionHelper.cleanupConnection} closes the transport cleanly
if called with C{immediate} set to C{False}.
"""
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None)
connection = SSHConnection()
connection.transport = StringTransport()
helper.cleanupConnection(connection, False)
self.assertTrue(connection.transport.disconnecting)
def test_cleanupConnectionImmediately(self):
"""
L{_NewConnectionHelper.cleanupConnection} closes the transport with
C{abortConnection} if called with C{immediate} set to C{True}.
"""
class Abortable:
aborted = False
def abortConnection(self):
"""
Abort the connection.
"""
self.aborted = True
helper = _NewConnectionHelper(
None, None, None, None, None, None, None, None, None, None)
connection = SSHConnection()
connection.transport = SSHClientTransport()
connection.transport.transport = Abortable()
helper.cleanupConnection(connection, True)
self.assertTrue(connection.transport.transport.aborted)
|