blob: e728aa70f9ea5043ec8a852a1b40194c8a9039f7 [file] [log] [blame]
Benjamin Peterson3c0c4832008-09-27 02:49:54 +00001"""Test script for ftplib module."""
2
Antoine Pitrouccd5e022009-11-15 17:22:09 +00003# Modified by Giampaolo Rodola' to test FTP class, IPv6 and TLS
4# environment
Benjamin Peterson3c0c4832008-09-27 02:49:54 +00005
Facundo Batista3f100992007-03-26 20:56:09 +00006import ftplib
Benjamin Peterson3c0c4832008-09-27 02:49:54 +00007import asyncore
8import asynchat
9import socket
10import StringIO
Antoine Pitrouccd5e022009-11-15 17:22:09 +000011import errno
12import os
13try:
14 import ssl
15except ImportError:
16 ssl = None
Facundo Batista3f100992007-03-26 20:56:09 +000017
Serhiy Storchaka32e23e72013-11-03 23:15:46 +020018from unittest import TestCase, SkipTest, skipUnless
Facundo Batista3f100992007-03-26 20:56:09 +000019from test import test_support
Antoine Pitrou78254dc2013-08-22 00:39:46 +020020from test.test_support import HOST, HOSTv6
Victor Stinner6a102812010-04-27 23:55:59 +000021threading = test_support.import_module('threading')
Facundo Batista3f100992007-03-26 20:56:09 +000022
Benjamin Peterson7b4b2842015-01-04 15:36:31 -060023TIMEOUT = 3
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000024# the dummy data returned by server over the data channel when
25# RETR, LIST and NLST commands are issued
26RETR_DATA = 'abcde12345\r\n' * 1000
27LIST_DATA = 'foo\r\nbar\r\n'
28NLST_DATA = 'foo\r\nbar\r\n'
29
30
31class DummyDTPHandler(asynchat.async_chat):
Antoine Pitroua5c4b552010-04-22 23:33:02 +000032 dtp_conn_closed = False
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000033
34 def __init__(self, conn, baseclass):
35 asynchat.async_chat.__init__(self, conn)
36 self.baseclass = baseclass
37 self.baseclass.last_received_data = ''
38
39 def handle_read(self):
40 self.baseclass.last_received_data += self.recv(1024)
41
42 def handle_close(self):
Antoine Pitroua5c4b552010-04-22 23:33:02 +000043 # XXX: this method can be called many times in a row for a single
44 # connection, including in clear-text (non-TLS) mode.
45 # (behaviour witnessed with test_data_connection)
46 if not self.dtp_conn_closed:
47 self.baseclass.push('226 transfer complete')
48 self.close()
49 self.dtp_conn_closed = True
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000050
Giampaolo RodolĂ e4499a82010-05-06 20:19:32 +000051 def handle_error(self):
52 raise
53
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000054
55class DummyFTPHandler(asynchat.async_chat):
56
Antoine Pitrouccd5e022009-11-15 17:22:09 +000057 dtp_handler = DummyDTPHandler
58
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000059 def __init__(self, conn):
60 asynchat.async_chat.__init__(self, conn)
61 self.set_terminator("\r\n")
62 self.in_buffer = []
63 self.dtp = None
64 self.last_received_cmd = None
65 self.last_received_data = ''
66 self.next_response = ''
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +000067 self.rest = None
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +030068 self.next_retr_data = RETR_DATA
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000069 self.push('220 welcome')
70
71 def collect_incoming_data(self, data):
72 self.in_buffer.append(data)
73
74 def found_terminator(self):
75 line = ''.join(self.in_buffer)
76 self.in_buffer = []
77 if self.next_response:
78 self.push(self.next_response)
79 self.next_response = ''
80 cmd = line.split(' ')[0].lower()
81 self.last_received_cmd = cmd
82 space = line.find(' ')
83 if space != -1:
84 arg = line[space + 1:]
85 else:
86 arg = ""
87 if hasattr(self, 'cmd_' + cmd):
88 method = getattr(self, 'cmd_' + cmd)
89 method(arg)
90 else:
91 self.push('550 command "%s" not understood.' %cmd)
92
93 def handle_error(self):
94 raise
95
96 def push(self, data):
97 asynchat.async_chat.push(self, data + '\r\n')
98
99 def cmd_port(self, arg):
100 addr = map(int, arg.split(','))
101 ip = '%d.%d.%d.%d' %tuple(addr[:4])
102 port = (addr[4] * 256) + addr[5]
Antoine Pitrou82993932010-10-14 20:46:25 +0000103 s = socket.create_connection((ip, port), timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000104 self.dtp = self.dtp_handler(s, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000105 self.push('200 active data connection established')
106
107 def cmd_pasv(self, arg):
108 sock = socket.socket()
109 sock.bind((self.socket.getsockname()[0], 0))
110 sock.listen(5)
Antoine Pitrou82993932010-10-14 20:46:25 +0000111 sock.settimeout(10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000112 ip, port = sock.getsockname()[:2]
Ezio Melottidde5b942010-02-03 05:37:26 +0000113 ip = ip.replace('.', ',')
114 p1, p2 = divmod(port, 256)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000115 self.push('227 entering passive mode (%s,%d,%d)' %(ip, p1, p2))
116 conn, addr = sock.accept()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000117 self.dtp = self.dtp_handler(conn, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000118
119 def cmd_eprt(self, arg):
120 af, ip, port = arg.split(arg[0])[1:-1]
121 port = int(port)
Antoine Pitrou82993932010-10-14 20:46:25 +0000122 s = socket.create_connection((ip, port), timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000123 self.dtp = self.dtp_handler(s, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000124 self.push('200 active data connection established')
125
126 def cmd_epsv(self, arg):
127 sock = socket.socket(socket.AF_INET6)
128 sock.bind((self.socket.getsockname()[0], 0))
129 sock.listen(5)
Antoine Pitrou82993932010-10-14 20:46:25 +0000130 sock.settimeout(10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000131 port = sock.getsockname()[1]
132 self.push('229 entering extended passive mode (|||%d|)' %port)
133 conn, addr = sock.accept()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000134 self.dtp = self.dtp_handler(conn, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000135
136 def cmd_echo(self, arg):
137 # sends back the received string (used by the test suite)
138 self.push(arg)
139
140 def cmd_user(self, arg):
141 self.push('331 username ok')
142
143 def cmd_pass(self, arg):
144 self.push('230 password ok')
145
146 def cmd_acct(self, arg):
147 self.push('230 acct ok')
148
149 def cmd_rnfr(self, arg):
150 self.push('350 rnfr ok')
151
152 def cmd_rnto(self, arg):
153 self.push('250 rnto ok')
154
155 def cmd_dele(self, arg):
156 self.push('250 dele ok')
157
158 def cmd_cwd(self, arg):
159 self.push('250 cwd ok')
160
161 def cmd_size(self, arg):
162 self.push('250 1000')
163
164 def cmd_mkd(self, arg):
165 self.push('257 "%s"' %arg)
166
167 def cmd_rmd(self, arg):
168 self.push('250 rmd ok')
169
170 def cmd_pwd(self, arg):
171 self.push('257 "pwd ok"')
172
173 def cmd_type(self, arg):
174 self.push('200 type ok')
175
176 def cmd_quit(self, arg):
177 self.push('221 quit ok')
178 self.close()
179
180 def cmd_stor(self, arg):
181 self.push('125 stor ok')
182
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000183 def cmd_rest(self, arg):
184 self.rest = arg
185 self.push('350 rest ok')
186
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000187 def cmd_retr(self, arg):
188 self.push('125 retr ok')
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000189 if self.rest is not None:
190 offset = int(self.rest)
191 else:
192 offset = 0
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +0300193 self.dtp.push(self.next_retr_data[offset:])
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000194 self.dtp.close_when_done()
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000195 self.rest = None
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000196
197 def cmd_list(self, arg):
198 self.push('125 list ok')
199 self.dtp.push(LIST_DATA)
200 self.dtp.close_when_done()
201
202 def cmd_nlst(self, arg):
203 self.push('125 nlst ok')
204 self.dtp.push(NLST_DATA)
205 self.dtp.close_when_done()
206
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +0300207 def cmd_setlongretr(self, arg):
208 # For testing. Next RETR will return long line.
209 self.next_retr_data = 'x' * int(arg)
210 self.push('125 setlongretr ok')
211
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000212
213class DummyFTPServer(asyncore.dispatcher, threading.Thread):
214
215 handler = DummyFTPHandler
216
217 def __init__(self, address, af=socket.AF_INET):
218 threading.Thread.__init__(self)
219 asyncore.dispatcher.__init__(self)
220 self.create_socket(af, socket.SOCK_STREAM)
Victor Stinner9fb061b2017-05-04 18:10:30 +0200221 try:
222 self.bind(address)
223 self.listen(5)
224 self.active = False
225 self.active_lock = threading.Lock()
226 self.host, self.port = self.socket.getsockname()[:2]
227 self.handler_instance = None
228 except:
229 # unregister the server on bind() error,
230 # needed by TestIPv6Environment.setUpClass()
231 self.del_channel()
232 raise
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000233
234 def start(self):
235 assert not self.active
236 self.__flag = threading.Event()
237 threading.Thread.start(self)
238 self.__flag.wait()
239
240 def run(self):
241 self.active = True
242 self.__flag.set()
243 while self.active and asyncore.socket_map:
244 self.active_lock.acquire()
245 asyncore.loop(timeout=0.1, count=1)
246 self.active_lock.release()
247 asyncore.close_all(ignore_all=True)
248
249 def stop(self):
250 assert self.active
251 self.active = False
252 self.join()
253
254 def handle_accept(self):
255 conn, addr = self.accept()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600256 self.handler_instance = self.handler(conn)
Benjamin Petersone14267b2008-09-28 20:57:21 +0000257
258 def handle_connect(self):
259 self.close()
260 handle_read = handle_connect
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000261
262 def writable(self):
263 return 0
264
265 def handle_error(self):
266 raise
267
268
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000269if ssl is not None:
270
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600271 CERTFILE = os.path.join(os.path.dirname(__file__), "keycert3.pem")
272 CAFILE = os.path.join(os.path.dirname(__file__), "pycacert.pem")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000273
274 class SSLConnection(object, asyncore.dispatcher):
275 """An asyncore.dispatcher subclass supporting TLS/SSL."""
276
277 _ssl_accepting = False
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000278 _ssl_closing = False
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000279
280 def secure_connection(self):
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600281 socket = ssl.wrap_socket(self.socket, suppress_ragged_eofs=False,
282 certfile=CERTFILE, server_side=True,
283 do_handshake_on_connect=False,
284 ssl_version=ssl.PROTOCOL_SSLv23)
285 self.del_channel()
286 self.set_socket(socket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000287 self._ssl_accepting = True
288
289 def _do_ssl_handshake(self):
290 try:
291 self.socket.do_handshake()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600292 except ssl.SSLError as err:
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000293 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
294 ssl.SSL_ERROR_WANT_WRITE):
295 return
296 elif err.args[0] == ssl.SSL_ERROR_EOF:
297 return self.handle_close()
298 raise
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600299 except socket.error as err:
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000300 if err.args[0] == errno.ECONNABORTED:
301 return self.handle_close()
302 else:
303 self._ssl_accepting = False
304
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000305 def _do_ssl_shutdown(self):
306 self._ssl_closing = True
307 try:
308 self.socket = self.socket.unwrap()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600309 except ssl.SSLError as err:
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000310 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
311 ssl.SSL_ERROR_WANT_WRITE):
312 return
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600313 except socket.error as err:
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000314 # Any "socket error" corresponds to a SSL_ERROR_SYSCALL return
315 # from OpenSSL's SSL_shutdown(), corresponding to a
316 # closed socket condition. See also:
317 # http://www.mail-archive.com/openssl-users@openssl.org/msg60710.html
318 pass
319 self._ssl_closing = False
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600320 if getattr(self, '_ccc', False) is False:
321 super(SSLConnection, self).close()
322 else:
323 pass
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000324
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000325 def handle_read_event(self):
326 if self._ssl_accepting:
327 self._do_ssl_handshake()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000328 elif self._ssl_closing:
329 self._do_ssl_shutdown()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000330 else:
331 super(SSLConnection, self).handle_read_event()
332
333 def handle_write_event(self):
334 if self._ssl_accepting:
335 self._do_ssl_handshake()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000336 elif self._ssl_closing:
337 self._do_ssl_shutdown()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000338 else:
339 super(SSLConnection, self).handle_write_event()
340
341 def send(self, data):
342 try:
343 return super(SSLConnection, self).send(data)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600344 except ssl.SSLError as err:
Antoine Pitrou52093b82010-03-22 14:41:48 +0000345 if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN,
346 ssl.SSL_ERROR_WANT_READ,
347 ssl.SSL_ERROR_WANT_WRITE):
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000348 return 0
349 raise
350
351 def recv(self, buffer_size):
352 try:
353 return super(SSLConnection, self).recv(buffer_size)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600354 except ssl.SSLError as err:
Antoine Pitrou52093b82010-03-22 14:41:48 +0000355 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
356 ssl.SSL_ERROR_WANT_WRITE):
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600357 return b''
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000358 if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN):
359 self.handle_close()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600360 return b''
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000361 raise
362
363 def handle_error(self):
364 raise
365
366 def close(self):
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000367 if (isinstance(self.socket, ssl.SSLSocket) and
368 self.socket._sslobj is not None):
369 self._do_ssl_shutdown()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600370 else:
371 super(SSLConnection, self).close()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000372
373
374 class DummyTLS_DTPHandler(SSLConnection, DummyDTPHandler):
375 """A DummyDTPHandler subclass supporting TLS/SSL."""
376
377 def __init__(self, conn, baseclass):
378 DummyDTPHandler.__init__(self, conn, baseclass)
379 if self.baseclass.secure_data_channel:
380 self.secure_connection()
381
382
383 class DummyTLS_FTPHandler(SSLConnection, DummyFTPHandler):
384 """A DummyFTPHandler subclass supporting TLS/SSL."""
385
386 dtp_handler = DummyTLS_DTPHandler
387
388 def __init__(self, conn):
389 DummyFTPHandler.__init__(self, conn)
390 self.secure_data_channel = False
391
392 def cmd_auth(self, line):
393 """Set up secure control channel."""
394 self.push('234 AUTH TLS successful')
395 self.secure_connection()
396
397 def cmd_pbsz(self, line):
398 """Negotiate size of buffer for secure data transfer.
399 For TLS/SSL the only valid value for the parameter is '0'.
400 Any other value is accepted but ignored.
401 """
402 self.push('200 PBSZ=0 successful.')
403
404 def cmd_prot(self, line):
405 """Setup un/secure data channel."""
406 arg = line.upper()
407 if arg == 'C':
408 self.push('200 Protection set to Clear')
409 self.secure_data_channel = False
410 elif arg == 'P':
411 self.push('200 Protection set to Private')
412 self.secure_data_channel = True
413 else:
414 self.push("502 Unrecognized PROT type (use C or P).")
415
416
417 class DummyTLS_FTPServer(DummyFTPServer):
418 handler = DummyTLS_FTPHandler
419
420
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000421class TestFTPClass(TestCase):
422
423 def setUp(self):
424 self.server = DummyFTPServer((HOST, 0))
425 self.server.start()
Antoine Pitrou82993932010-10-14 20:46:25 +0000426 self.client = ftplib.FTP(timeout=10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000427 self.client.connect(self.server.host, self.server.port)
428
429 def tearDown(self):
430 self.client.close()
431 self.server.stop()
432
433 def test_getwelcome(self):
434 self.assertEqual(self.client.getwelcome(), '220 welcome')
435
436 def test_sanitize(self):
437 self.assertEqual(self.client.sanitize('foo'), repr('foo'))
438 self.assertEqual(self.client.sanitize('pass 12345'), repr('pass *****'))
439 self.assertEqual(self.client.sanitize('PASS 12345'), repr('PASS *****'))
440
441 def test_exceptions(self):
Dong-hee Nae5eae472017-07-27 00:50:36 +0900442 self.assertRaises(ValueError, self.client.sendcmd, 'echo 40\r\n0')
443 self.assertRaises(ValueError, self.client.sendcmd, 'echo 40\n0')
444 self.assertRaises(ValueError, self.client.sendcmd, 'echo 40\r0')
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000445 self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 400')
446 self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 499')
447 self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 500')
448 self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 599')
449 self.assertRaises(ftplib.error_proto, self.client.sendcmd, 'echo 999')
450
451 def test_all_errors(self):
452 exceptions = (ftplib.error_reply, ftplib.error_temp, ftplib.error_perm,
453 ftplib.error_proto, ftplib.Error, IOError, EOFError)
454 for x in exceptions:
455 try:
456 raise x('exception not included in all_errors set')
457 except ftplib.all_errors:
458 pass
459
460 def test_set_pasv(self):
461 # passive mode is supposed to be enabled by default
462 self.assertTrue(self.client.passiveserver)
463 self.client.set_pasv(True)
464 self.assertTrue(self.client.passiveserver)
465 self.client.set_pasv(False)
466 self.assertFalse(self.client.passiveserver)
467
468 def test_voidcmd(self):
469 self.client.voidcmd('echo 200')
470 self.client.voidcmd('echo 299')
471 self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 199')
472 self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 300')
473
474 def test_login(self):
475 self.client.login()
476
477 def test_acct(self):
478 self.client.acct('passwd')
479
480 def test_rename(self):
481 self.client.rename('a', 'b')
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600482 self.server.handler_instance.next_response = '200'
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000483 self.assertRaises(ftplib.error_reply, self.client.rename, 'a', 'b')
484
485 def test_delete(self):
486 self.client.delete('foo')
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600487 self.server.handler_instance.next_response = '199'
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000488 self.assertRaises(ftplib.error_reply, self.client.delete, 'foo')
489
490 def test_size(self):
491 self.client.size('foo')
492
493 def test_mkd(self):
494 dir = self.client.mkd('/foo')
495 self.assertEqual(dir, '/foo')
496
497 def test_rmd(self):
498 self.client.rmd('foo')
499
Senthil Kumaran1eeba832013-08-12 22:24:43 -0700500 def test_cwd(self):
501 dir = self.client.cwd('/foo')
502 self.assertEqual(dir, '250 cwd ok')
503
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000504 def test_pwd(self):
505 dir = self.client.pwd()
506 self.assertEqual(dir, 'pwd ok')
507
508 def test_quit(self):
509 self.assertEqual(self.client.quit(), '221 quit ok')
510 # Ensure the connection gets closed; sock attribute should be None
511 self.assertEqual(self.client.sock, None)
512
513 def test_retrbinary(self):
514 received = []
515 self.client.retrbinary('retr', received.append)
516 self.assertEqual(''.join(received), RETR_DATA)
517
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000518 def test_retrbinary_rest(self):
519 for rest in (0, 10, 20):
520 received = []
521 self.client.retrbinary('retr', received.append, rest=rest)
522 self.assertEqual(''.join(received), RETR_DATA[rest:],
523 msg='rest test case %d %d %d' % (rest,
524 len(''.join(received)),
525 len(RETR_DATA[rest:])))
526
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000527 def test_retrlines(self):
528 received = []
529 self.client.retrlines('retr', received.append)
530 self.assertEqual(''.join(received), RETR_DATA.replace('\r\n', ''))
531
532 def test_storbinary(self):
533 f = StringIO.StringIO(RETR_DATA)
534 self.client.storbinary('stor', f)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600535 self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000536 # test new callback arg
537 flag = []
538 f.seek(0)
539 self.client.storbinary('stor', f, callback=lambda x: flag.append(None))
540 self.assertTrue(flag)
541
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000542 def test_storbinary_rest(self):
543 f = StringIO.StringIO(RETR_DATA)
544 for r in (30, '30'):
545 f.seek(0)
546 self.client.storbinary('stor', f, rest=r)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600547 self.assertEqual(self.server.handler_instance.rest, str(r))
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000548
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000549 def test_storlines(self):
550 f = StringIO.StringIO(RETR_DATA.replace('\r\n', '\n'))
551 self.client.storlines('stor', f)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600552 self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000553 # test new callback arg
554 flag = []
555 f.seek(0)
556 self.client.storlines('stor foo', f, callback=lambda x: flag.append(None))
557 self.assertTrue(flag)
558
559 def test_nlst(self):
560 self.client.nlst()
561 self.assertEqual(self.client.nlst(), NLST_DATA.split('\r\n')[:-1])
562
563 def test_dir(self):
564 l = []
565 self.client.dir(lambda x: l.append(x))
566 self.assertEqual(''.join(l), LIST_DATA.replace('\r\n', ''))
567
568 def test_makeport(self):
569 self.client.makeport()
570 # IPv4 is in use, just make sure send_eprt has not been used
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600571 self.assertEqual(self.server.handler_instance.last_received_cmd, 'port')
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000572
573 def test_makepasv(self):
574 host, port = self.client.makepasv()
Antoine Pitrou82993932010-10-14 20:46:25 +0000575 conn = socket.create_connection((host, port), 10)
Facundo Batista93c33682007-03-30 13:00:35 +0000576 conn.close()
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000577 # IPv4 is in use, just make sure send_epsv has not been used
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600578 self.assertEqual(self.server.handler_instance.last_received_cmd, 'pasv')
Facundo Batista3f100992007-03-26 20:56:09 +0000579
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +0300580 def test_line_too_long(self):
581 self.assertRaises(ftplib.Error, self.client.sendcmd,
582 'x' * self.client.maxline * 2)
583
584 def test_retrlines_too_long(self):
585 self.client.sendcmd('SETLONGRETR %d' % (self.client.maxline * 2))
586 received = []
587 self.assertRaises(ftplib.Error,
588 self.client.retrlines, 'retr', received.append)
589
590 def test_storlines_too_long(self):
591 f = StringIO.StringIO('x' * self.client.maxline * 2)
592 self.assertRaises(ftplib.Error, self.client.storlines, 'stor', f)
593
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000594
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200595@skipUnless(socket.has_ipv6, "IPv6 not enabled")
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000596class TestIPv6Environment(TestCase):
597
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200598 @classmethod
599 def setUpClass(cls):
600 try:
601 DummyFTPServer((HOST, 0), af=socket.AF_INET6)
602 except socket.error:
603 raise SkipTest("IPv6 not enabled")
604
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000605 def setUp(self):
Antoine Pitrou78254dc2013-08-22 00:39:46 +0200606 self.server = DummyFTPServer((HOSTv6, 0), af=socket.AF_INET6)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000607 self.server.start()
608 self.client = ftplib.FTP()
609 self.client.connect(self.server.host, self.server.port)
610
611 def tearDown(self):
612 self.client.close()
613 self.server.stop()
614
615 def test_af(self):
616 self.assertEqual(self.client.af, socket.AF_INET6)
617
618 def test_makeport(self):
619 self.client.makeport()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600620 self.assertEqual(self.server.handler_instance.last_received_cmd, 'eprt')
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000621
622 def test_makepasv(self):
623 host, port = self.client.makepasv()
Antoine Pitrou82993932010-10-14 20:46:25 +0000624 conn = socket.create_connection((host, port), 10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000625 conn.close()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600626 self.assertEqual(self.server.handler_instance.last_received_cmd, 'epsv')
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000627
628 def test_transfer(self):
629 def retr():
630 received = []
631 self.client.retrbinary('retr', received.append)
632 self.assertEqual(''.join(received), RETR_DATA)
633 self.client.set_pasv(True)
634 retr()
635 self.client.set_pasv(False)
636 retr()
637
638
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200639@skipUnless(ssl, "SSL not available")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000640class TestTLS_FTPClassMixin(TestFTPClass):
641 """Repeat TestFTPClass tests starting the TLS layer for both control
642 and data connections first.
643 """
644
645 def setUp(self):
646 self.server = DummyTLS_FTPServer((HOST, 0))
647 self.server.start()
Antoine Pitrou82993932010-10-14 20:46:25 +0000648 self.client = ftplib.FTP_TLS(timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000649 self.client.connect(self.server.host, self.server.port)
650 # enable TLS
651 self.client.auth()
652 self.client.prot_p()
653
654
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200655@skipUnless(ssl, "SSL not available")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000656class TestTLS_FTPClass(TestCase):
657 """Specific TLS_FTP class tests."""
658
659 def setUp(self):
660 self.server = DummyTLS_FTPServer((HOST, 0))
661 self.server.start()
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600662 self.client = ftplib.FTP_TLS(timeout=TIMEOUT)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000663 self.client.connect(self.server.host, self.server.port)
664
665 def tearDown(self):
666 self.client.close()
667 self.server.stop()
668
669 def test_control_connection(self):
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000670 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000671 self.client.auth()
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000672 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000673
674 def test_data_connection(self):
675 # clear text
676 sock = self.client.transfercmd('list')
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000677 self.assertNotIsInstance(sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000678 sock.close()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000679 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000680
681 # secured, after PROT P
682 self.client.prot_p()
683 sock = self.client.transfercmd('list')
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000684 self.assertIsInstance(sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000685 sock.close()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000686 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000687
688 # PROT C is issued, the connection must be in cleartext again
689 self.client.prot_c()
690 sock = self.client.transfercmd('list')
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000691 self.assertNotIsInstance(sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000692 sock.close()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000693 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000694
695 def test_login(self):
696 # login() is supposed to implicitly secure the control connection
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000697 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000698 self.client.login()
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000699 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000700 # make sure that AUTH TLS doesn't get issued again
701 self.client.login()
702
703 def test_auth_issued_twice(self):
704 self.client.auth()
705 self.assertRaises(ValueError, self.client.auth)
706
707 def test_auth_ssl(self):
708 try:
Benjamin Peterson60766c42014-12-05 21:59:35 -0500709 self.client.ssl_version = ssl.PROTOCOL_SSLv23
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000710 self.client.auth()
711 self.assertRaises(ValueError, self.client.auth)
712 finally:
Christian Heimes8d4d1732018-02-25 00:45:53 +0100713 self.client.ssl_version = ssl.PROTOCOL_TLS
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000714
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600715 def test_context(self):
716 self.client.quit()
Christian Heimes8d4d1732018-02-25 00:45:53 +0100717 ctx = ssl.SSLContext(ssl.PROTOCOL_TLS)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600718 self.assertRaises(ValueError, ftplib.FTP_TLS, keyfile=CERTFILE,
719 context=ctx)
720 self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE,
721 context=ctx)
722 self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE,
723 keyfile=CERTFILE, context=ctx)
724
725 self.client = ftplib.FTP_TLS(context=ctx, timeout=TIMEOUT)
726 self.client.connect(self.server.host, self.server.port)
727 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
728 self.client.auth()
729 self.assertIs(self.client.sock.context, ctx)
730 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
731
732 self.client.prot_p()
733 sock = self.client.transfercmd('list')
734 try:
735 self.assertIs(sock.context, ctx)
736 self.assertIsInstance(sock, ssl.SSLSocket)
737 finally:
738 sock.close()
739
740 def test_check_hostname(self):
741 self.client.quit()
Christian Heimes8d4d1732018-02-25 00:45:53 +0100742 ctx = ssl.SSLContext(ssl.PROTOCOL_TLS)
Benjamin Peterson7b4b2842015-01-04 15:36:31 -0600743 ctx.verify_mode = ssl.CERT_REQUIRED
744 ctx.check_hostname = True
745 ctx.load_verify_locations(CAFILE)
746 self.client = ftplib.FTP_TLS(context=ctx, timeout=TIMEOUT)
747
748 # 127.0.0.1 doesn't match SAN
749 self.client.connect(self.server.host, self.server.port)
750 with self.assertRaises(ssl.CertificateError):
751 self.client.auth()
752 # exception quits connection
753
754 self.client.connect(self.server.host, self.server.port)
755 self.client.prot_p()
756 with self.assertRaises(ssl.CertificateError):
757 self.client.transfercmd("list").close()
758 self.client.quit()
759
760 self.client.connect("localhost", self.server.port)
761 self.client.auth()
762 self.client.quit()
763
764 self.client.connect("localhost", self.server.port)
765 self.client.prot_p()
766 self.client.transfercmd("list").close()
767
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000768
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000769class TestTimeouts(TestCase):
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000770
Facundo Batista3f100992007-03-26 20:56:09 +0000771 def setUp(self):
Facundo Batista3f100992007-03-26 20:56:09 +0000772 self.evt = threading.Event()
Trent Nelsone41b0062008-04-08 23:47:30 +0000773 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Charles-François Natali3b818072011-12-19 16:11:04 +0100774 self.sock.settimeout(10)
Trent Nelsone41b0062008-04-08 23:47:30 +0000775 self.port = test_support.bind_port(self.sock)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000776 threading.Thread(target=self.server, args=(self.evt,self.sock)).start()
Neal Norwitzb0917c12008-02-26 04:50:37 +0000777 # Wait for the server to be ready.
778 self.evt.wait()
779 self.evt.clear()
Trent Nelsone41b0062008-04-08 23:47:30 +0000780 ftplib.FTP.port = self.port
Facundo Batista3f100992007-03-26 20:56:09 +0000781
782 def tearDown(self):
783 self.evt.wait()
784
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000785 def server(self, evt, serv):
786 # This method sets the evt 3 times:
787 # 1) when the connection is ready to be accepted.
788 # 2) when it is safe for the caller to close the connection
789 # 3) when we have closed the socket
790 serv.listen(5)
791 # (1) Signal the caller that we are ready to accept the connection.
792 evt.set()
793 try:
794 conn, addr = serv.accept()
795 except socket.timeout:
796 pass
797 else:
798 conn.send("1 Hola mundo\n")
799 # (2) Signal the caller that it is safe to close the socket.
800 evt.set()
801 conn.close()
802 finally:
803 serv.close()
804 # (3) Signal the caller that we are done.
805 evt.set()
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000806
Facundo Batista3f100992007-03-26 20:56:09 +0000807 def testTimeoutDefault(self):
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000808 # default -- use global socket timeout
Serhiy Storchaka528bed82014-02-08 14:49:55 +0200809 self.assertIsNone(socket.getdefaulttimeout())
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000810 socket.setdefaulttimeout(30)
811 try:
Antoine Pitrou78254dc2013-08-22 00:39:46 +0200812 ftp = ftplib.FTP(HOST)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000813 finally:
814 socket.setdefaulttimeout(None)
815 self.assertEqual(ftp.sock.gettimeout(), 30)
816 self.evt.wait()
817 ftp.close()
818
819 def testTimeoutNone(self):
820 # no timeout -- do not use global socket timeout
Serhiy Storchaka528bed82014-02-08 14:49:55 +0200821 self.assertIsNone(socket.getdefaulttimeout())
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000822 socket.setdefaulttimeout(30)
823 try:
Antoine Pitrou78254dc2013-08-22 00:39:46 +0200824 ftp = ftplib.FTP(HOST, timeout=None)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000825 finally:
826 socket.setdefaulttimeout(None)
Serhiy Storchaka528bed82014-02-08 14:49:55 +0200827 self.assertIsNone(ftp.sock.gettimeout())
Neal Norwitzb0917c12008-02-26 04:50:37 +0000828 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000829 ftp.close()
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000830
Facundo Batista3f100992007-03-26 20:56:09 +0000831 def testTimeoutValue(self):
832 # a value
Trent Nelsone41b0062008-04-08 23:47:30 +0000833 ftp = ftplib.FTP(HOST, timeout=30)
Facundo Batista3f100992007-03-26 20:56:09 +0000834 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000835 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000836 ftp.close()
Facundo Batista3f100992007-03-26 20:56:09 +0000837
Facundo Batista93c33682007-03-30 13:00:35 +0000838 def testTimeoutConnect(self):
839 ftp = ftplib.FTP()
Trent Nelsone41b0062008-04-08 23:47:30 +0000840 ftp.connect(HOST, timeout=30)
Facundo Batista93c33682007-03-30 13:00:35 +0000841 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000842 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000843 ftp.close()
Facundo Batista93c33682007-03-30 13:00:35 +0000844
845 def testTimeoutDifferentOrder(self):
846 ftp = ftplib.FTP(timeout=30)
Trent Nelsone41b0062008-04-08 23:47:30 +0000847 ftp.connect(HOST)
Facundo Batista93c33682007-03-30 13:00:35 +0000848 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000849 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000850 ftp.close()
Facundo Batista93c33682007-03-30 13:00:35 +0000851
852 def testTimeoutDirectAccess(self):
853 ftp = ftplib.FTP()
854 ftp.timeout = 30
Trent Nelsone41b0062008-04-08 23:47:30 +0000855 ftp.connect(HOST)
Facundo Batista93c33682007-03-30 13:00:35 +0000856 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000857 self.evt.wait()
Facundo Batista3f100992007-03-26 20:56:09 +0000858 ftp.close()
859
860
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000861def test_main():
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200862 tests = [TestFTPClass, TestTimeouts,
863 TestIPv6Environment,
864 TestTLS_FTPClassMixin, TestTLS_FTPClass]
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000865
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000866 thread_info = test_support.threading_setup()
867 try:
868 test_support.run_unittest(*tests)
869 finally:
870 test_support.threading_cleanup(*thread_info)
871
Facundo Batista3f100992007-03-26 20:56:09 +0000872
873if __name__ == '__main__':
874 test_main()