test_ftplib.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  1. """Test script for ftplib module."""
  2. # Modified by Giampaolo Rodola' to test FTP class, IPv6 and TLS
  3. # environment
  4. import ftplib
  5. import asyncore
  6. import asynchat
  7. import socket
  8. import StringIO
  9. import errno
  10. import os
  11. try:
  12. import ssl
  13. except ImportError:
  14. ssl = None
  15. from unittest import TestCase, SkipTest, skipUnless
  16. from test import test_support
  17. from test.test_support import HOST, HOSTv6
  18. threading = test_support.import_module('threading')
  19. TIMEOUT = 3
  20. # the dummy data returned by server over the data channel when
  21. # RETR, LIST and NLST commands are issued
  22. RETR_DATA = 'abcde12345\r\n' * 1000
  23. LIST_DATA = 'foo\r\nbar\r\n'
  24. NLST_DATA = 'foo\r\nbar\r\n'
  25. class DummyDTPHandler(asynchat.async_chat):
  26. dtp_conn_closed = False
  27. def __init__(self, conn, baseclass):
  28. asynchat.async_chat.__init__(self, conn)
  29. self.baseclass = baseclass
  30. self.baseclass.last_received_data = ''
  31. def handle_read(self):
  32. self.baseclass.last_received_data += self.recv(1024)
  33. def handle_close(self):
  34. # XXX: this method can be called many times in a row for a single
  35. # connection, including in clear-text (non-TLS) mode.
  36. # (behaviour witnessed with test_data_connection)
  37. if not self.dtp_conn_closed:
  38. self.baseclass.push('226 transfer complete')
  39. self.close()
  40. self.dtp_conn_closed = True
  41. def handle_error(self):
  42. raise
  43. class DummyFTPHandler(asynchat.async_chat):
  44. dtp_handler = DummyDTPHandler
  45. def __init__(self, conn):
  46. asynchat.async_chat.__init__(self, conn)
  47. self.set_terminator("\r\n")
  48. self.in_buffer = []
  49. self.dtp = None
  50. self.last_received_cmd = None
  51. self.last_received_data = ''
  52. self.next_response = ''
  53. self.rest = None
  54. self.next_retr_data = RETR_DATA
  55. self.push('220 welcome')
  56. def collect_incoming_data(self, data):
  57. self.in_buffer.append(data)
  58. def found_terminator(self):
  59. line = ''.join(self.in_buffer)
  60. self.in_buffer = []
  61. if self.next_response:
  62. self.push(self.next_response)
  63. self.next_response = ''
  64. cmd = line.split(' ')[0].lower()
  65. self.last_received_cmd = cmd
  66. space = line.find(' ')
  67. if space != -1:
  68. arg = line[space + 1:]
  69. else:
  70. arg = ""
  71. if hasattr(self, 'cmd_' + cmd):
  72. method = getattr(self, 'cmd_' + cmd)
  73. method(arg)
  74. else:
  75. self.push('550 command "%s" not understood.' %cmd)
  76. def handle_error(self):
  77. raise
  78. def push(self, data):
  79. asynchat.async_chat.push(self, data + '\r\n')
  80. def cmd_port(self, arg):
  81. addr = map(int, arg.split(','))
  82. ip = '%d.%d.%d.%d' %tuple(addr[:4])
  83. port = (addr[4] * 256) + addr[5]
  84. s = socket.create_connection((ip, port), timeout=10)
  85. self.dtp = self.dtp_handler(s, baseclass=self)
  86. self.push('200 active data connection established')
  87. def cmd_pasv(self, arg):
  88. sock = socket.socket()
  89. sock.bind((self.socket.getsockname()[0], 0))
  90. sock.listen(5)
  91. sock.settimeout(10)
  92. ip, port = sock.getsockname()[:2]
  93. ip = ip.replace('.', ',')
  94. p1, p2 = divmod(port, 256)
  95. self.push('227 entering passive mode (%s,%d,%d)' %(ip, p1, p2))
  96. conn, addr = sock.accept()
  97. self.dtp = self.dtp_handler(conn, baseclass=self)
  98. def cmd_eprt(self, arg):
  99. af, ip, port = arg.split(arg[0])[1:-1]
  100. port = int(port)
  101. s = socket.create_connection((ip, port), timeout=10)
  102. self.dtp = self.dtp_handler(s, baseclass=self)
  103. self.push('200 active data connection established')
  104. def cmd_epsv(self, arg):
  105. sock = socket.socket(socket.AF_INET6)
  106. sock.bind((self.socket.getsockname()[0], 0))
  107. sock.listen(5)
  108. sock.settimeout(10)
  109. port = sock.getsockname()[1]
  110. self.push('229 entering extended passive mode (|||%d|)' %port)
  111. conn, addr = sock.accept()
  112. self.dtp = self.dtp_handler(conn, baseclass=self)
  113. def cmd_echo(self, arg):
  114. # sends back the received string (used by the test suite)
  115. self.push(arg)
  116. def cmd_user(self, arg):
  117. self.push('331 username ok')
  118. def cmd_pass(self, arg):
  119. self.push('230 password ok')
  120. def cmd_acct(self, arg):
  121. self.push('230 acct ok')
  122. def cmd_rnfr(self, arg):
  123. self.push('350 rnfr ok')
  124. def cmd_rnto(self, arg):
  125. self.push('250 rnto ok')
  126. def cmd_dele(self, arg):
  127. self.push('250 dele ok')
  128. def cmd_cwd(self, arg):
  129. self.push('250 cwd ok')
  130. def cmd_size(self, arg):
  131. self.push('250 1000')
  132. def cmd_mkd(self, arg):
  133. self.push('257 "%s"' %arg)
  134. def cmd_rmd(self, arg):
  135. self.push('250 rmd ok')
  136. def cmd_pwd(self, arg):
  137. self.push('257 "pwd ok"')
  138. def cmd_type(self, arg):
  139. self.push('200 type ok')
  140. def cmd_quit(self, arg):
  141. self.push('221 quit ok')
  142. self.close()
  143. def cmd_stor(self, arg):
  144. self.push('125 stor ok')
  145. def cmd_rest(self, arg):
  146. self.rest = arg
  147. self.push('350 rest ok')
  148. def cmd_retr(self, arg):
  149. self.push('125 retr ok')
  150. if self.rest is not None:
  151. offset = int(self.rest)
  152. else:
  153. offset = 0
  154. self.dtp.push(self.next_retr_data[offset:])
  155. self.dtp.close_when_done()
  156. self.rest = None
  157. def cmd_list(self, arg):
  158. self.push('125 list ok')
  159. self.dtp.push(LIST_DATA)
  160. self.dtp.close_when_done()
  161. def cmd_nlst(self, arg):
  162. self.push('125 nlst ok')
  163. self.dtp.push(NLST_DATA)
  164. self.dtp.close_when_done()
  165. def cmd_setlongretr(self, arg):
  166. # For testing. Next RETR will return long line.
  167. self.next_retr_data = 'x' * int(arg)
  168. self.push('125 setlongretr ok')
  169. class DummyFTPServer(asyncore.dispatcher, threading.Thread):
  170. handler = DummyFTPHandler
  171. def __init__(self, address, af=socket.AF_INET):
  172. threading.Thread.__init__(self)
  173. asyncore.dispatcher.__init__(self)
  174. self.create_socket(af, socket.SOCK_STREAM)
  175. self.bind(address)
  176. self.listen(5)
  177. self.active = False
  178. self.active_lock = threading.Lock()
  179. self.host, self.port = self.socket.getsockname()[:2]
  180. self.handler_instance = None
  181. def start(self):
  182. assert not self.active
  183. self.__flag = threading.Event()
  184. threading.Thread.start(self)
  185. self.__flag.wait()
  186. def run(self):
  187. self.active = True
  188. self.__flag.set()
  189. while self.active and asyncore.socket_map:
  190. self.active_lock.acquire()
  191. asyncore.loop(timeout=0.1, count=1)
  192. self.active_lock.release()
  193. asyncore.close_all(ignore_all=True)
  194. def stop(self):
  195. assert self.active
  196. self.active = False
  197. self.join()
  198. def handle_accept(self):
  199. conn, addr = self.accept()
  200. self.handler_instance = self.handler(conn)
  201. def handle_connect(self):
  202. self.close()
  203. handle_read = handle_connect
  204. def writable(self):
  205. return 0
  206. def handle_error(self):
  207. raise
  208. if ssl is not None:
  209. CERTFILE = os.path.join(os.path.dirname(__file__), "keycert3.pem")
  210. CAFILE = os.path.join(os.path.dirname(__file__), "pycacert.pem")
  211. class SSLConnection(object, asyncore.dispatcher):
  212. """An asyncore.dispatcher subclass supporting TLS/SSL."""
  213. _ssl_accepting = False
  214. _ssl_closing = False
  215. def secure_connection(self):
  216. socket = ssl.wrap_socket(self.socket, suppress_ragged_eofs=False,
  217. certfile=CERTFILE, server_side=True,
  218. do_handshake_on_connect=False,
  219. ssl_version=ssl.PROTOCOL_SSLv23)
  220. self.del_channel()
  221. self.set_socket(socket)
  222. self._ssl_accepting = True
  223. def _do_ssl_handshake(self):
  224. try:
  225. self.socket.do_handshake()
  226. except ssl.SSLError as err:
  227. if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
  228. ssl.SSL_ERROR_WANT_WRITE):
  229. return
  230. elif err.args[0] == ssl.SSL_ERROR_EOF:
  231. return self.handle_close()
  232. raise
  233. except socket.error as err:
  234. if err.args[0] == errno.ECONNABORTED:
  235. return self.handle_close()
  236. else:
  237. self._ssl_accepting = False
  238. def _do_ssl_shutdown(self):
  239. self._ssl_closing = True
  240. try:
  241. self.socket = self.socket.unwrap()
  242. except ssl.SSLError as err:
  243. if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
  244. ssl.SSL_ERROR_WANT_WRITE):
  245. return
  246. except socket.error as err:
  247. # Any "socket error" corresponds to a SSL_ERROR_SYSCALL return
  248. # from OpenSSL's SSL_shutdown(), corresponding to a
  249. # closed socket condition. See also:
  250. # http://www.mail-archive.com/openssl-users@openssl.org/msg60710.html
  251. pass
  252. self._ssl_closing = False
  253. if getattr(self, '_ccc', False) is False:
  254. super(SSLConnection, self).close()
  255. else:
  256. pass
  257. def handle_read_event(self):
  258. if self._ssl_accepting:
  259. self._do_ssl_handshake()
  260. elif self._ssl_closing:
  261. self._do_ssl_shutdown()
  262. else:
  263. super(SSLConnection, self).handle_read_event()
  264. def handle_write_event(self):
  265. if self._ssl_accepting:
  266. self._do_ssl_handshake()
  267. elif self._ssl_closing:
  268. self._do_ssl_shutdown()
  269. else:
  270. super(SSLConnection, self).handle_write_event()
  271. def send(self, data):
  272. try:
  273. return super(SSLConnection, self).send(data)
  274. except ssl.SSLError as err:
  275. if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN,
  276. ssl.SSL_ERROR_WANT_READ,
  277. ssl.SSL_ERROR_WANT_WRITE):
  278. return 0
  279. raise
  280. def recv(self, buffer_size):
  281. try:
  282. return super(SSLConnection, self).recv(buffer_size)
  283. except ssl.SSLError as err:
  284. if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
  285. ssl.SSL_ERROR_WANT_WRITE):
  286. return b''
  287. if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN):
  288. self.handle_close()
  289. return b''
  290. raise
  291. def handle_error(self):
  292. raise
  293. def close(self):
  294. if (isinstance(self.socket, ssl.SSLSocket) and
  295. self.socket._sslobj is not None):
  296. self._do_ssl_shutdown()
  297. else:
  298. super(SSLConnection, self).close()
  299. class DummyTLS_DTPHandler(SSLConnection, DummyDTPHandler):
  300. """A DummyDTPHandler subclass supporting TLS/SSL."""
  301. def __init__(self, conn, baseclass):
  302. DummyDTPHandler.__init__(self, conn, baseclass)
  303. if self.baseclass.secure_data_channel:
  304. self.secure_connection()
  305. class DummyTLS_FTPHandler(SSLConnection, DummyFTPHandler):
  306. """A DummyFTPHandler subclass supporting TLS/SSL."""
  307. dtp_handler = DummyTLS_DTPHandler
  308. def __init__(self, conn):
  309. DummyFTPHandler.__init__(self, conn)
  310. self.secure_data_channel = False
  311. def cmd_auth(self, line):
  312. """Set up secure control channel."""
  313. self.push('234 AUTH TLS successful')
  314. self.secure_connection()
  315. def cmd_pbsz(self, line):
  316. """Negotiate size of buffer for secure data transfer.
  317. For TLS/SSL the only valid value for the parameter is '0'.
  318. Any other value is accepted but ignored.
  319. """
  320. self.push('200 PBSZ=0 successful.')
  321. def cmd_prot(self, line):
  322. """Setup un/secure data channel."""
  323. arg = line.upper()
  324. if arg == 'C':
  325. self.push('200 Protection set to Clear')
  326. self.secure_data_channel = False
  327. elif arg == 'P':
  328. self.push('200 Protection set to Private')
  329. self.secure_data_channel = True
  330. else:
  331. self.push("502 Unrecognized PROT type (use C or P).")
  332. class DummyTLS_FTPServer(DummyFTPServer):
  333. handler = DummyTLS_FTPHandler
  334. class TestFTPClass(TestCase):
  335. def setUp(self):
  336. self.server = DummyFTPServer((HOST, 0))
  337. self.server.start()
  338. self.client = ftplib.FTP(timeout=10)
  339. self.client.connect(self.server.host, self.server.port)
  340. def tearDown(self):
  341. self.client.close()
  342. self.server.stop()
  343. def test_getwelcome(self):
  344. self.assertEqual(self.client.getwelcome(), '220 welcome')
  345. def test_sanitize(self):
  346. self.assertEqual(self.client.sanitize('foo'), repr('foo'))
  347. self.assertEqual(self.client.sanitize('pass 12345'), repr('pass *****'))
  348. self.assertEqual(self.client.sanitize('PASS 12345'), repr('PASS *****'))
  349. def test_exceptions(self):
  350. self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 400')
  351. self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 499')
  352. self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 500')
  353. self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 599')
  354. self.assertRaises(ftplib.error_proto, self.client.sendcmd, 'echo 999')
  355. def test_all_errors(self):
  356. exceptions = (ftplib.error_reply, ftplib.error_temp, ftplib.error_perm,
  357. ftplib.error_proto, ftplib.Error, IOError, EOFError)
  358. for x in exceptions:
  359. try:
  360. raise x('exception not included in all_errors set')
  361. except ftplib.all_errors:
  362. pass
  363. def test_set_pasv(self):
  364. # passive mode is supposed to be enabled by default
  365. self.assertTrue(self.client.passiveserver)
  366. self.client.set_pasv(True)
  367. self.assertTrue(self.client.passiveserver)
  368. self.client.set_pasv(False)
  369. self.assertFalse(self.client.passiveserver)
  370. def test_voidcmd(self):
  371. self.client.voidcmd('echo 200')
  372. self.client.voidcmd('echo 299')
  373. self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 199')
  374. self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 300')
  375. def test_login(self):
  376. self.client.login()
  377. def test_acct(self):
  378. self.client.acct('passwd')
  379. def test_rename(self):
  380. self.client.rename('a', 'b')
  381. self.server.handler_instance.next_response = '200'
  382. self.assertRaises(ftplib.error_reply, self.client.rename, 'a', 'b')
  383. def test_delete(self):
  384. self.client.delete('foo')
  385. self.server.handler_instance.next_response = '199'
  386. self.assertRaises(ftplib.error_reply, self.client.delete, 'foo')
  387. def test_size(self):
  388. self.client.size('foo')
  389. def test_mkd(self):
  390. dir = self.client.mkd('/foo')
  391. self.assertEqual(dir, '/foo')
  392. def test_rmd(self):
  393. self.client.rmd('foo')
  394. def test_cwd(self):
  395. dir = self.client.cwd('/foo')
  396. self.assertEqual(dir, '250 cwd ok')
  397. def test_pwd(self):
  398. dir = self.client.pwd()
  399. self.assertEqual(dir, 'pwd ok')
  400. def test_quit(self):
  401. self.assertEqual(self.client.quit(), '221 quit ok')
  402. # Ensure the connection gets closed; sock attribute should be None
  403. self.assertEqual(self.client.sock, None)
  404. def test_retrbinary(self):
  405. received = []
  406. self.client.retrbinary('retr', received.append)
  407. self.assertEqual(''.join(received), RETR_DATA)
  408. def test_retrbinary_rest(self):
  409. for rest in (0, 10, 20):
  410. received = []
  411. self.client.retrbinary('retr', received.append, rest=rest)
  412. self.assertEqual(''.join(received), RETR_DATA[rest:],
  413. msg='rest test case %d %d %d' % (rest,
  414. len(''.join(received)),
  415. len(RETR_DATA[rest:])))
  416. def test_retrlines(self):
  417. received = []
  418. self.client.retrlines('retr', received.append)
  419. self.assertEqual(''.join(received), RETR_DATA.replace('\r\n', ''))
  420. def test_storbinary(self):
  421. f = StringIO.StringIO(RETR_DATA)
  422. self.client.storbinary('stor', f)
  423. self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
  424. # test new callback arg
  425. flag = []
  426. f.seek(0)
  427. self.client.storbinary('stor', f, callback=lambda x: flag.append(None))
  428. self.assertTrue(flag)
  429. def test_storbinary_rest(self):
  430. f = StringIO.StringIO(RETR_DATA)
  431. for r in (30, '30'):
  432. f.seek(0)
  433. self.client.storbinary('stor', f, rest=r)
  434. self.assertEqual(self.server.handler_instance.rest, str(r))
  435. def test_storlines(self):
  436. f = StringIO.StringIO(RETR_DATA.replace('\r\n', '\n'))
  437. self.client.storlines('stor', f)
  438. self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
  439. # test new callback arg
  440. flag = []
  441. f.seek(0)
  442. self.client.storlines('stor foo', f, callback=lambda x: flag.append(None))
  443. self.assertTrue(flag)
  444. def test_nlst(self):
  445. self.client.nlst()
  446. self.assertEqual(self.client.nlst(), NLST_DATA.split('\r\n')[:-1])
  447. def test_dir(self):
  448. l = []
  449. self.client.dir(lambda x: l.append(x))
  450. self.assertEqual(''.join(l), LIST_DATA.replace('\r\n', ''))
  451. def test_makeport(self):
  452. self.client.makeport()
  453. # IPv4 is in use, just make sure send_eprt has not been used
  454. self.assertEqual(self.server.handler_instance.last_received_cmd, 'port')
  455. def test_makepasv(self):
  456. host, port = self.client.makepasv()
  457. conn = socket.create_connection((host, port), 10)
  458. conn.close()
  459. # IPv4 is in use, just make sure send_epsv has not been used
  460. self.assertEqual(self.server.handler_instance.last_received_cmd, 'pasv')
  461. def test_line_too_long(self):
  462. self.assertRaises(ftplib.Error, self.client.sendcmd,
  463. 'x' * self.client.maxline * 2)
  464. def test_retrlines_too_long(self):
  465. self.client.sendcmd('SETLONGRETR %d' % (self.client.maxline * 2))
  466. received = []
  467. self.assertRaises(ftplib.Error,
  468. self.client.retrlines, 'retr', received.append)
  469. def test_storlines_too_long(self):
  470. f = StringIO.StringIO('x' * self.client.maxline * 2)
  471. self.assertRaises(ftplib.Error, self.client.storlines, 'stor', f)
  472. @skipUnless(socket.has_ipv6, "IPv6 not enabled")
  473. class TestIPv6Environment(TestCase):
  474. @classmethod
  475. def setUpClass(cls):
  476. try:
  477. DummyFTPServer((HOST, 0), af=socket.AF_INET6)
  478. except socket.error:
  479. raise SkipTest("IPv6 not enabled")
  480. def setUp(self):
  481. self.server = DummyFTPServer((HOSTv6, 0), af=socket.AF_INET6)
  482. self.server.start()
  483. self.client = ftplib.FTP()
  484. self.client.connect(self.server.host, self.server.port)
  485. def tearDown(self):
  486. self.client.close()
  487. self.server.stop()
  488. def test_af(self):
  489. self.assertEqual(self.client.af, socket.AF_INET6)
  490. def test_makeport(self):
  491. self.client.makeport()
  492. self.assertEqual(self.server.handler_instance.last_received_cmd, 'eprt')
  493. def test_makepasv(self):
  494. host, port = self.client.makepasv()
  495. conn = socket.create_connection((host, port), 10)
  496. conn.close()
  497. self.assertEqual(self.server.handler_instance.last_received_cmd, 'epsv')
  498. def test_transfer(self):
  499. def retr():
  500. received = []
  501. self.client.retrbinary('retr', received.append)
  502. self.assertEqual(''.join(received), RETR_DATA)
  503. self.client.set_pasv(True)
  504. retr()
  505. self.client.set_pasv(False)
  506. retr()
  507. @skipUnless(ssl, "SSL not available")
  508. class TestTLS_FTPClassMixin(TestFTPClass):
  509. """Repeat TestFTPClass tests starting the TLS layer for both control
  510. and data connections first.
  511. """
  512. def setUp(self):
  513. self.server = DummyTLS_FTPServer((HOST, 0))
  514. self.server.start()
  515. self.client = ftplib.FTP_TLS(timeout=10)
  516. self.client.connect(self.server.host, self.server.port)
  517. # enable TLS
  518. self.client.auth()
  519. self.client.prot_p()
  520. @skipUnless(ssl, "SSL not available")
  521. class TestTLS_FTPClass(TestCase):
  522. """Specific TLS_FTP class tests."""
  523. def setUp(self):
  524. self.server = DummyTLS_FTPServer((HOST, 0))
  525. self.server.start()
  526. self.client = ftplib.FTP_TLS(timeout=TIMEOUT)
  527. self.client.connect(self.server.host, self.server.port)
  528. def tearDown(self):
  529. self.client.close()
  530. self.server.stop()
  531. def test_control_connection(self):
  532. self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
  533. self.client.auth()
  534. self.assertIsInstance(self.client.sock, ssl.SSLSocket)
  535. def test_data_connection(self):
  536. # clear text
  537. sock = self.client.transfercmd('list')
  538. self.assertNotIsInstance(sock, ssl.SSLSocket)
  539. sock.close()
  540. self.assertEqual(self.client.voidresp(), "226 transfer complete")
  541. # secured, after PROT P
  542. self.client.prot_p()
  543. sock = self.client.transfercmd('list')
  544. self.assertIsInstance(sock, ssl.SSLSocket)
  545. sock.close()
  546. self.assertEqual(self.client.voidresp(), "226 transfer complete")
  547. # PROT C is issued, the connection must be in cleartext again
  548. self.client.prot_c()
  549. sock = self.client.transfercmd('list')
  550. self.assertNotIsInstance(sock, ssl.SSLSocket)
  551. sock.close()
  552. self.assertEqual(self.client.voidresp(), "226 transfer complete")
  553. def test_login(self):
  554. # login() is supposed to implicitly secure the control connection
  555. self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
  556. self.client.login()
  557. self.assertIsInstance(self.client.sock, ssl.SSLSocket)
  558. # make sure that AUTH TLS doesn't get issued again
  559. self.client.login()
  560. def test_auth_issued_twice(self):
  561. self.client.auth()
  562. self.assertRaises(ValueError, self.client.auth)
  563. def test_auth_ssl(self):
  564. try:
  565. self.client.ssl_version = ssl.PROTOCOL_SSLv23
  566. self.client.auth()
  567. self.assertRaises(ValueError, self.client.auth)
  568. finally:
  569. self.client.ssl_version = ssl.PROTOCOL_TLSv1
  570. def test_context(self):
  571. self.client.quit()
  572. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  573. self.assertRaises(ValueError, ftplib.FTP_TLS, keyfile=CERTFILE,
  574. context=ctx)
  575. self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE,
  576. context=ctx)
  577. self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE,
  578. keyfile=CERTFILE, context=ctx)
  579. self.client = ftplib.FTP_TLS(context=ctx, timeout=TIMEOUT)
  580. self.client.connect(self.server.host, self.server.port)
  581. self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
  582. self.client.auth()
  583. self.assertIs(self.client.sock.context, ctx)
  584. self.assertIsInstance(self.client.sock, ssl.SSLSocket)
  585. self.client.prot_p()
  586. sock = self.client.transfercmd('list')
  587. try:
  588. self.assertIs(sock.context, ctx)
  589. self.assertIsInstance(sock, ssl.SSLSocket)
  590. finally:
  591. sock.close()
  592. def test_check_hostname(self):
  593. self.client.quit()
  594. ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
  595. ctx.verify_mode = ssl.CERT_REQUIRED
  596. ctx.check_hostname = True
  597. ctx.load_verify_locations(CAFILE)
  598. self.client = ftplib.FTP_TLS(context=ctx, timeout=TIMEOUT)
  599. # 127.0.0.1 doesn't match SAN
  600. self.client.connect(self.server.host, self.server.port)
  601. with self.assertRaises(ssl.CertificateError):
  602. self.client.auth()
  603. # exception quits connection
  604. self.client.connect(self.server.host, self.server.port)
  605. self.client.prot_p()
  606. with self.assertRaises(ssl.CertificateError):
  607. self.client.transfercmd("list").close()
  608. self.client.quit()
  609. self.client.connect("localhost", self.server.port)
  610. self.client.auth()
  611. self.client.quit()
  612. self.client.connect("localhost", self.server.port)
  613. self.client.prot_p()
  614. self.client.transfercmd("list").close()
  615. class TestTimeouts(TestCase):
  616. def setUp(self):
  617. self.evt = threading.Event()
  618. self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  619. self.sock.settimeout(10)
  620. self.port = test_support.bind_port(self.sock)
  621. threading.Thread(target=self.server, args=(self.evt,self.sock)).start()
  622. # Wait for the server to be ready.
  623. self.evt.wait()
  624. self.evt.clear()
  625. ftplib.FTP.port = self.port
  626. def tearDown(self):
  627. self.evt.wait()
  628. def server(self, evt, serv):
  629. # This method sets the evt 3 times:
  630. # 1) when the connection is ready to be accepted.
  631. # 2) when it is safe for the caller to close the connection
  632. # 3) when we have closed the socket
  633. serv.listen(5)
  634. # (1) Signal the caller that we are ready to accept the connection.
  635. evt.set()
  636. try:
  637. conn, addr = serv.accept()
  638. except socket.timeout:
  639. pass
  640. else:
  641. conn.send("1 Hola mundo\n")
  642. # (2) Signal the caller that it is safe to close the socket.
  643. evt.set()
  644. conn.close()
  645. finally:
  646. serv.close()
  647. # (3) Signal the caller that we are done.
  648. evt.set()
  649. def testTimeoutDefault(self):
  650. # default -- use global socket timeout
  651. self.assertIsNone(socket.getdefaulttimeout())
  652. socket.setdefaulttimeout(30)
  653. try:
  654. ftp = ftplib.FTP(HOST)
  655. finally:
  656. socket.setdefaulttimeout(None)
  657. self.assertEqual(ftp.sock.gettimeout(), 30)
  658. self.evt.wait()
  659. ftp.close()
  660. def testTimeoutNone(self):
  661. # no timeout -- do not use global socket timeout
  662. self.assertIsNone(socket.getdefaulttimeout())
  663. socket.setdefaulttimeout(30)
  664. try:
  665. ftp = ftplib.FTP(HOST, timeout=None)
  666. finally:
  667. socket.setdefaulttimeout(None)
  668. self.assertIsNone(ftp.sock.gettimeout())
  669. self.evt.wait()
  670. ftp.close()
  671. def testTimeoutValue(self):
  672. # a value
  673. ftp = ftplib.FTP(HOST, timeout=30)
  674. self.assertEqual(ftp.sock.gettimeout(), 30)
  675. self.evt.wait()
  676. ftp.close()
  677. def testTimeoutConnect(self):
  678. ftp = ftplib.FTP()
  679. ftp.connect(HOST, timeout=30)
  680. self.assertEqual(ftp.sock.gettimeout(), 30)
  681. self.evt.wait()
  682. ftp.close()
  683. def testTimeoutDifferentOrder(self):
  684. ftp = ftplib.FTP(timeout=30)
  685. ftp.connect(HOST)
  686. self.assertEqual(ftp.sock.gettimeout(), 30)
  687. self.evt.wait()
  688. ftp.close()
  689. def testTimeoutDirectAccess(self):
  690. ftp = ftplib.FTP()
  691. ftp.timeout = 30
  692. ftp.connect(HOST)
  693. self.assertEqual(ftp.sock.gettimeout(), 30)
  694. self.evt.wait()
  695. ftp.close()
  696. def test_main():
  697. tests = [TestFTPClass, TestTimeouts,
  698. TestIPv6Environment,
  699. TestTLS_FTPClassMixin, TestTLS_FTPClass]
  700. thread_info = test_support.threading_setup()
  701. try:
  702. test_support.run_unittest(*tests)
  703. finally:
  704. test_support.threading_cleanup(*thread_info)
  705. if __name__ == '__main__':
  706. test_main()