Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 1 | """Test script for ftplib module.""" |
| 2 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 3 | # Modified by Giampaolo Rodola' to test FTP class, IPv6 and TLS |
| 4 | # environment |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 5 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 6 | import ftplib |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 7 | import asyncore |
| 8 | import asynchat |
| 9 | import socket |
| 10 | import io |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 11 | import errno |
| 12 | import os |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 13 | import time |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 14 | try: |
| 15 | import ssl |
| 16 | except ImportError: |
| 17 | ssl = None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 18 | |
| 19 | from unittest import TestCase |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 20 | from test import support |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 21 | from test.support import HOST |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 22 | threading = support.import_module('threading') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 23 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 24 | # the dummy data returned by server over the data channel when |
| 25 | # RETR, LIST and NLST commands are issued |
| 26 | RETR_DATA = 'abcde12345\r\n' * 1000 |
| 27 | LIST_DATA = 'foo\r\nbar\r\n' |
| 28 | NLST_DATA = 'foo\r\nbar\r\n' |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 29 | |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 30 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 31 | class DummyDTPHandler(asynchat.async_chat): |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 32 | dtp_conn_closed = False |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 33 | |
| 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): |
Giampaolo Rodolà | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 40 | self.baseclass.last_received_data += self.recv(1024).decode('ascii') |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 41 | |
| 42 | def handle_close(self): |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 43 | # 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 Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 50 | |
| 51 | def push(self, what): |
Giampaolo Rodolà | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 52 | super(DummyDTPHandler, self).push(what.encode('ascii')) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 53 | |
Giampaolo Rodolà | d930b63 | 2010-05-06 20:21:57 +0000 | [diff] [blame] | 54 | def handle_error(self): |
| 55 | raise |
| 56 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 57 | |
| 58 | class DummyFTPHandler(asynchat.async_chat): |
| 59 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 60 | dtp_handler = DummyDTPHandler |
| 61 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 62 | def __init__(self, conn): |
| 63 | asynchat.async_chat.__init__(self, conn) |
Giampaolo Rodola' | 0b5c21f | 2011-05-07 19:03:47 +0200 | [diff] [blame] | 64 | # tells the socket to handle urgent data inline (ABOR command) |
| 65 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_OOBINLINE, 1) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 66 | self.set_terminator(b"\r\n") |
| 67 | self.in_buffer = [] |
| 68 | self.dtp = None |
| 69 | self.last_received_cmd = None |
| 70 | self.last_received_data = '' |
| 71 | self.next_response = '' |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 72 | self.rest = None |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 73 | self.push('220 welcome') |
| 74 | |
| 75 | def collect_incoming_data(self, data): |
| 76 | self.in_buffer.append(data) |
| 77 | |
| 78 | def found_terminator(self): |
| 79 | line = b''.join(self.in_buffer).decode('ascii') |
| 80 | self.in_buffer = [] |
| 81 | if self.next_response: |
| 82 | self.push(self.next_response) |
| 83 | self.next_response = '' |
| 84 | cmd = line.split(' ')[0].lower() |
| 85 | self.last_received_cmd = cmd |
| 86 | space = line.find(' ') |
| 87 | if space != -1: |
| 88 | arg = line[space + 1:] |
| 89 | else: |
| 90 | arg = "" |
| 91 | if hasattr(self, 'cmd_' + cmd): |
| 92 | method = getattr(self, 'cmd_' + cmd) |
| 93 | method(arg) |
| 94 | else: |
| 95 | self.push('550 command "%s" not understood.' %cmd) |
| 96 | |
| 97 | def handle_error(self): |
| 98 | raise |
| 99 | |
| 100 | def push(self, data): |
| 101 | asynchat.async_chat.push(self, data.encode('ascii') + b'\r\n') |
| 102 | |
| 103 | def cmd_port(self, arg): |
| 104 | addr = list(map(int, arg.split(','))) |
| 105 | ip = '%d.%d.%d.%d' %tuple(addr[:4]) |
| 106 | port = (addr[4] * 256) + addr[5] |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 107 | s = socket.create_connection((ip, port), timeout=10) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 108 | self.dtp = self.dtp_handler(s, baseclass=self) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 109 | self.push('200 active data connection established') |
| 110 | |
| 111 | def cmd_pasv(self, arg): |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 112 | with socket.socket() as sock: |
| 113 | sock.bind((self.socket.getsockname()[0], 0)) |
| 114 | sock.listen(5) |
| 115 | sock.settimeout(10) |
| 116 | ip, port = sock.getsockname()[:2] |
| 117 | ip = ip.replace('.', ','); p1 = port / 256; p2 = port % 256 |
| 118 | self.push('227 entering passive mode (%s,%d,%d)' %(ip, p1, p2)) |
| 119 | conn, addr = sock.accept() |
| 120 | self.dtp = self.dtp_handler(conn, baseclass=self) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 121 | |
| 122 | def cmd_eprt(self, arg): |
| 123 | af, ip, port = arg.split(arg[0])[1:-1] |
| 124 | port = int(port) |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 125 | s = socket.create_connection((ip, port), timeout=10) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 126 | self.dtp = self.dtp_handler(s, baseclass=self) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 127 | self.push('200 active data connection established') |
| 128 | |
| 129 | def cmd_epsv(self, arg): |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 130 | with socket.socket(socket.AF_INET6) as sock: |
| 131 | sock.bind((self.socket.getsockname()[0], 0)) |
| 132 | sock.listen(5) |
| 133 | sock.settimeout(10) |
| 134 | port = sock.getsockname()[1] |
| 135 | self.push('229 entering extended passive mode (|||%d|)' %port) |
| 136 | conn, addr = sock.accept() |
| 137 | self.dtp = self.dtp_handler(conn, baseclass=self) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 138 | |
| 139 | def cmd_echo(self, arg): |
| 140 | # sends back the received string (used by the test suite) |
| 141 | self.push(arg) |
| 142 | |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 143 | def cmd_noop(self, arg): |
| 144 | self.push('200 noop ok') |
| 145 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 146 | def cmd_user(self, arg): |
| 147 | self.push('331 username ok') |
| 148 | |
| 149 | def cmd_pass(self, arg): |
| 150 | self.push('230 password ok') |
| 151 | |
| 152 | def cmd_acct(self, arg): |
| 153 | self.push('230 acct ok') |
| 154 | |
| 155 | def cmd_rnfr(self, arg): |
| 156 | self.push('350 rnfr ok') |
| 157 | |
| 158 | def cmd_rnto(self, arg): |
| 159 | self.push('250 rnto ok') |
| 160 | |
| 161 | def cmd_dele(self, arg): |
| 162 | self.push('250 dele ok') |
| 163 | |
| 164 | def cmd_cwd(self, arg): |
| 165 | self.push('250 cwd ok') |
| 166 | |
| 167 | def cmd_size(self, arg): |
| 168 | self.push('250 1000') |
| 169 | |
| 170 | def cmd_mkd(self, arg): |
| 171 | self.push('257 "%s"' %arg) |
| 172 | |
| 173 | def cmd_rmd(self, arg): |
| 174 | self.push('250 rmd ok') |
| 175 | |
| 176 | def cmd_pwd(self, arg): |
| 177 | self.push('257 "pwd ok"') |
| 178 | |
| 179 | def cmd_type(self, arg): |
Giampaolo Rodolà | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 180 | self.push('200 type ok') |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 181 | |
| 182 | def cmd_quit(self, arg): |
| 183 | self.push('221 quit ok') |
| 184 | self.close() |
| 185 | |
Giampaolo Rodola' | 0b5c21f | 2011-05-07 19:03:47 +0200 | [diff] [blame] | 186 | def cmd_abor(self, arg): |
| 187 | self.push('226 abor ok') |
| 188 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 189 | def cmd_stor(self, arg): |
| 190 | self.push('125 stor ok') |
| 191 | |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 192 | def cmd_rest(self, arg): |
| 193 | self.rest = arg |
| 194 | self.push('350 rest ok') |
| 195 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 196 | def cmd_retr(self, arg): |
| 197 | self.push('125 retr ok') |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 198 | if self.rest is not None: |
| 199 | offset = int(self.rest) |
| 200 | else: |
| 201 | offset = 0 |
Giampaolo Rodolà | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 202 | self.dtp.push(RETR_DATA[offset:]) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 203 | self.dtp.close_when_done() |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 204 | self.rest = None |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 205 | |
| 206 | def cmd_list(self, arg): |
| 207 | self.push('125 list ok') |
| 208 | self.dtp.push(LIST_DATA) |
| 209 | self.dtp.close_when_done() |
| 210 | |
| 211 | def cmd_nlst(self, arg): |
| 212 | self.push('125 nlst ok') |
| 213 | self.dtp.push(NLST_DATA) |
| 214 | self.dtp.close_when_done() |
| 215 | |
| 216 | |
| 217 | class DummyFTPServer(asyncore.dispatcher, threading.Thread): |
| 218 | |
| 219 | handler = DummyFTPHandler |
| 220 | |
| 221 | def __init__(self, address, af=socket.AF_INET): |
| 222 | threading.Thread.__init__(self) |
| 223 | asyncore.dispatcher.__init__(self) |
| 224 | self.create_socket(af, socket.SOCK_STREAM) |
| 225 | self.bind(address) |
| 226 | self.listen(5) |
| 227 | self.active = False |
| 228 | self.active_lock = threading.Lock() |
| 229 | self.host, self.port = self.socket.getsockname()[:2] |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 230 | self.handler_instance = None |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 231 | |
| 232 | def start(self): |
| 233 | assert not self.active |
| 234 | self.__flag = threading.Event() |
| 235 | threading.Thread.start(self) |
| 236 | self.__flag.wait() |
| 237 | |
| 238 | def run(self): |
| 239 | self.active = True |
| 240 | self.__flag.set() |
| 241 | while self.active and asyncore.socket_map: |
| 242 | self.active_lock.acquire() |
| 243 | asyncore.loop(timeout=0.1, count=1) |
| 244 | self.active_lock.release() |
| 245 | asyncore.close_all(ignore_all=True) |
| 246 | |
| 247 | def stop(self): |
| 248 | assert self.active |
| 249 | self.active = False |
| 250 | self.join() |
| 251 | |
Giampaolo Rodolà | 977c707 | 2010-10-04 21:08:36 +0000 | [diff] [blame] | 252 | def handle_accepted(self, conn, addr): |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 253 | self.handler_instance = self.handler(conn) |
Benjamin Peterson | d06e3b0 | 2008-09-28 21:00:42 +0000 | [diff] [blame] | 254 | |
| 255 | def handle_connect(self): |
| 256 | self.close() |
| 257 | handle_read = handle_connect |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 258 | |
| 259 | def writable(self): |
| 260 | return 0 |
| 261 | |
| 262 | def handle_error(self): |
| 263 | raise |
| 264 | |
| 265 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 266 | if ssl is not None: |
| 267 | |
| 268 | CERTFILE = os.path.join(os.path.dirname(__file__), "keycert.pem") |
| 269 | |
| 270 | class SSLConnection(asyncore.dispatcher): |
| 271 | """An asyncore.dispatcher subclass supporting TLS/SSL.""" |
| 272 | |
| 273 | _ssl_accepting = False |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 274 | _ssl_closing = False |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 275 | |
| 276 | def secure_connection(self): |
| 277 | self.del_channel() |
| 278 | socket = ssl.wrap_socket(self.socket, suppress_ragged_eofs=False, |
| 279 | certfile=CERTFILE, server_side=True, |
| 280 | do_handshake_on_connect=False, |
| 281 | ssl_version=ssl.PROTOCOL_SSLv23) |
| 282 | self.set_socket(socket) |
| 283 | self._ssl_accepting = True |
| 284 | |
| 285 | def _do_ssl_handshake(self): |
| 286 | try: |
| 287 | self.socket.do_handshake() |
| 288 | except ssl.SSLError as err: |
| 289 | if err.args[0] in (ssl.SSL_ERROR_WANT_READ, |
| 290 | ssl.SSL_ERROR_WANT_WRITE): |
| 291 | return |
| 292 | elif err.args[0] == ssl.SSL_ERROR_EOF: |
| 293 | return self.handle_close() |
| 294 | raise |
| 295 | except socket.error as err: |
| 296 | if err.args[0] == errno.ECONNABORTED: |
| 297 | return self.handle_close() |
| 298 | else: |
| 299 | self._ssl_accepting = False |
| 300 | |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 301 | def _do_ssl_shutdown(self): |
| 302 | self._ssl_closing = True |
| 303 | try: |
| 304 | self.socket = self.socket.unwrap() |
| 305 | except ssl.SSLError as err: |
| 306 | if err.args[0] in (ssl.SSL_ERROR_WANT_READ, |
| 307 | ssl.SSL_ERROR_WANT_WRITE): |
| 308 | return |
| 309 | except socket.error as err: |
| 310 | # Any "socket error" corresponds to a SSL_ERROR_SYSCALL return |
| 311 | # from OpenSSL's SSL_shutdown(), corresponding to a |
| 312 | # closed socket condition. See also: |
| 313 | # http://www.mail-archive.com/openssl-users@openssl.org/msg60710.html |
| 314 | pass |
| 315 | self._ssl_closing = False |
| 316 | super(SSLConnection, self).close() |
| 317 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 318 | def handle_read_event(self): |
| 319 | if self._ssl_accepting: |
| 320 | self._do_ssl_handshake() |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 321 | elif self._ssl_closing: |
| 322 | self._do_ssl_shutdown() |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 323 | else: |
| 324 | super(SSLConnection, self).handle_read_event() |
| 325 | |
| 326 | def handle_write_event(self): |
| 327 | if self._ssl_accepting: |
| 328 | self._do_ssl_handshake() |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 329 | elif self._ssl_closing: |
| 330 | self._do_ssl_shutdown() |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 331 | else: |
| 332 | super(SSLConnection, self).handle_write_event() |
| 333 | |
| 334 | def send(self, data): |
| 335 | try: |
| 336 | return super(SSLConnection, self).send(data) |
| 337 | except ssl.SSLError as err: |
Antoine Pitrou | 5733c08 | 2010-03-22 14:49:10 +0000 | [diff] [blame] | 338 | if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN, |
| 339 | ssl.SSL_ERROR_WANT_READ, |
| 340 | ssl.SSL_ERROR_WANT_WRITE): |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 341 | return 0 |
| 342 | raise |
| 343 | |
| 344 | def recv(self, buffer_size): |
| 345 | try: |
| 346 | return super(SSLConnection, self).recv(buffer_size) |
| 347 | except ssl.SSLError as err: |
Antoine Pitrou | 5733c08 | 2010-03-22 14:49:10 +0000 | [diff] [blame] | 348 | if err.args[0] in (ssl.SSL_ERROR_WANT_READ, |
| 349 | ssl.SSL_ERROR_WANT_WRITE): |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 350 | return b'' |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 351 | if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN): |
| 352 | self.handle_close() |
| 353 | return b'' |
| 354 | raise |
| 355 | |
| 356 | def handle_error(self): |
| 357 | raise |
| 358 | |
| 359 | def close(self): |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 360 | if (isinstance(self.socket, ssl.SSLSocket) and |
| 361 | self.socket._sslobj is not None): |
| 362 | self._do_ssl_shutdown() |
Benjamin Peterson | 1bd93a7 | 2010-10-31 19:58:07 +0000 | [diff] [blame] | 363 | else: |
| 364 | super(SSLConnection, self).close() |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 365 | |
| 366 | |
| 367 | class DummyTLS_DTPHandler(SSLConnection, DummyDTPHandler): |
| 368 | """A DummyDTPHandler subclass supporting TLS/SSL.""" |
| 369 | |
| 370 | def __init__(self, conn, baseclass): |
| 371 | DummyDTPHandler.__init__(self, conn, baseclass) |
| 372 | if self.baseclass.secure_data_channel: |
| 373 | self.secure_connection() |
| 374 | |
| 375 | |
| 376 | class DummyTLS_FTPHandler(SSLConnection, DummyFTPHandler): |
| 377 | """A DummyFTPHandler subclass supporting TLS/SSL.""" |
| 378 | |
| 379 | dtp_handler = DummyTLS_DTPHandler |
| 380 | |
| 381 | def __init__(self, conn): |
| 382 | DummyFTPHandler.__init__(self, conn) |
| 383 | self.secure_data_channel = False |
| 384 | |
| 385 | def cmd_auth(self, line): |
| 386 | """Set up secure control channel.""" |
| 387 | self.push('234 AUTH TLS successful') |
| 388 | self.secure_connection() |
| 389 | |
| 390 | def cmd_pbsz(self, line): |
| 391 | """Negotiate size of buffer for secure data transfer. |
| 392 | For TLS/SSL the only valid value for the parameter is '0'. |
| 393 | Any other value is accepted but ignored. |
| 394 | """ |
| 395 | self.push('200 PBSZ=0 successful.') |
| 396 | |
| 397 | def cmd_prot(self, line): |
| 398 | """Setup un/secure data channel.""" |
| 399 | arg = line.upper() |
| 400 | if arg == 'C': |
| 401 | self.push('200 Protection set to Clear') |
| 402 | self.secure_data_channel = False |
| 403 | elif arg == 'P': |
| 404 | self.push('200 Protection set to Private') |
| 405 | self.secure_data_channel = True |
| 406 | else: |
| 407 | self.push("502 Unrecognized PROT type (use C or P).") |
| 408 | |
| 409 | |
| 410 | class DummyTLS_FTPServer(DummyFTPServer): |
| 411 | handler = DummyTLS_FTPHandler |
| 412 | |
| 413 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 414 | class TestFTPClass(TestCase): |
| 415 | |
| 416 | def setUp(self): |
| 417 | self.server = DummyFTPServer((HOST, 0)) |
| 418 | self.server.start() |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 419 | self.client = ftplib.FTP(timeout=10) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 420 | self.client.connect(self.server.host, self.server.port) |
| 421 | |
| 422 | def tearDown(self): |
| 423 | self.client.close() |
| 424 | self.server.stop() |
| 425 | |
| 426 | def test_getwelcome(self): |
| 427 | self.assertEqual(self.client.getwelcome(), '220 welcome') |
| 428 | |
| 429 | def test_sanitize(self): |
| 430 | self.assertEqual(self.client.sanitize('foo'), repr('foo')) |
| 431 | self.assertEqual(self.client.sanitize('pass 12345'), repr('pass *****')) |
| 432 | self.assertEqual(self.client.sanitize('PASS 12345'), repr('PASS *****')) |
| 433 | |
| 434 | def test_exceptions(self): |
| 435 | self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 400') |
| 436 | self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 499') |
| 437 | self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 500') |
| 438 | self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 599') |
| 439 | self.assertRaises(ftplib.error_proto, self.client.sendcmd, 'echo 999') |
| 440 | |
| 441 | def test_all_errors(self): |
| 442 | exceptions = (ftplib.error_reply, ftplib.error_temp, ftplib.error_perm, |
| 443 | ftplib.error_proto, ftplib.Error, IOError, EOFError) |
| 444 | for x in exceptions: |
| 445 | try: |
| 446 | raise x('exception not included in all_errors set') |
| 447 | except ftplib.all_errors: |
| 448 | pass |
| 449 | |
| 450 | def test_set_pasv(self): |
| 451 | # passive mode is supposed to be enabled by default |
| 452 | self.assertTrue(self.client.passiveserver) |
| 453 | self.client.set_pasv(True) |
| 454 | self.assertTrue(self.client.passiveserver) |
| 455 | self.client.set_pasv(False) |
| 456 | self.assertFalse(self.client.passiveserver) |
| 457 | |
| 458 | def test_voidcmd(self): |
| 459 | self.client.voidcmd('echo 200') |
| 460 | self.client.voidcmd('echo 299') |
| 461 | self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 199') |
| 462 | self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 300') |
| 463 | |
| 464 | def test_login(self): |
| 465 | self.client.login() |
| 466 | |
| 467 | def test_acct(self): |
| 468 | self.client.acct('passwd') |
| 469 | |
| 470 | def test_rename(self): |
| 471 | self.client.rename('a', 'b') |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 472 | self.server.handler_instance.next_response = '200' |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 473 | self.assertRaises(ftplib.error_reply, self.client.rename, 'a', 'b') |
| 474 | |
| 475 | def test_delete(self): |
| 476 | self.client.delete('foo') |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 477 | self.server.handler_instance.next_response = '199' |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 478 | self.assertRaises(ftplib.error_reply, self.client.delete, 'foo') |
| 479 | |
| 480 | def test_size(self): |
| 481 | self.client.size('foo') |
| 482 | |
| 483 | def test_mkd(self): |
| 484 | dir = self.client.mkd('/foo') |
| 485 | self.assertEqual(dir, '/foo') |
| 486 | |
| 487 | def test_rmd(self): |
| 488 | self.client.rmd('foo') |
| 489 | |
| 490 | def test_pwd(self): |
| 491 | dir = self.client.pwd() |
| 492 | self.assertEqual(dir, 'pwd ok') |
| 493 | |
| 494 | def test_quit(self): |
| 495 | self.assertEqual(self.client.quit(), '221 quit ok') |
| 496 | # Ensure the connection gets closed; sock attribute should be None |
| 497 | self.assertEqual(self.client.sock, None) |
| 498 | |
Giampaolo Rodola' | 0b5c21f | 2011-05-07 19:03:47 +0200 | [diff] [blame] | 499 | def test_abort(self): |
| 500 | self.client.abort() |
| 501 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 502 | def test_retrbinary(self): |
| 503 | def callback(data): |
| 504 | received.append(data.decode('ascii')) |
| 505 | received = [] |
| 506 | self.client.retrbinary('retr', callback) |
| 507 | self.assertEqual(''.join(received), RETR_DATA) |
| 508 | |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 509 | def test_retrbinary_rest(self): |
| 510 | def callback(data): |
| 511 | received.append(data.decode('ascii')) |
| 512 | for rest in (0, 10, 20): |
| 513 | received = [] |
| 514 | self.client.retrbinary('retr', callback, rest=rest) |
| 515 | self.assertEqual(''.join(received), RETR_DATA[rest:], |
| 516 | msg='rest test case %d %d %d' % (rest, |
| 517 | len(''.join(received)), |
| 518 | len(RETR_DATA[rest:]))) |
| 519 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 520 | def test_retrlines(self): |
| 521 | received = [] |
| 522 | self.client.retrlines('retr', received.append) |
Giampaolo Rodolà | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 523 | self.assertEqual(''.join(received), RETR_DATA.replace('\r\n', '')) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 524 | |
| 525 | def test_storbinary(self): |
| 526 | f = io.BytesIO(RETR_DATA.encode('ascii')) |
| 527 | self.client.storbinary('stor', f) |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 528 | self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 529 | # test new callback arg |
| 530 | flag = [] |
| 531 | f.seek(0) |
| 532 | self.client.storbinary('stor', f, callback=lambda x: flag.append(None)) |
| 533 | self.assertTrue(flag) |
| 534 | |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 535 | def test_storbinary_rest(self): |
| 536 | f = io.BytesIO(RETR_DATA.replace('\r\n', '\n').encode('ascii')) |
| 537 | for r in (30, '30'): |
| 538 | f.seek(0) |
| 539 | self.client.storbinary('stor', f, rest=r) |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 540 | self.assertEqual(self.server.handler_instance.rest, str(r)) |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 541 | |
Giampaolo Rodolà | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 542 | def test_storlines(self): |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 543 | f = io.BytesIO(RETR_DATA.replace('\r\n', '\n').encode('ascii')) |
| 544 | self.client.storlines('stor', f) |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 545 | self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 546 | # test new callback arg |
| 547 | flag = [] |
| 548 | f.seek(0) |
| 549 | self.client.storlines('stor foo', f, callback=lambda x: flag.append(None)) |
| 550 | self.assertTrue(flag) |
| 551 | |
| 552 | def test_nlst(self): |
| 553 | self.client.nlst() |
| 554 | self.assertEqual(self.client.nlst(), NLST_DATA.split('\r\n')[:-1]) |
| 555 | |
| 556 | def test_dir(self): |
| 557 | l = [] |
| 558 | self.client.dir(lambda x: l.append(x)) |
| 559 | self.assertEqual(''.join(l), LIST_DATA.replace('\r\n', '')) |
| 560 | |
Benjamin Peterson | 3a53fbb | 2008-09-27 22:04:16 +0000 | [diff] [blame] | 561 | def test_makeport(self): |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 562 | with self.client.makeport(): |
| 563 | # IPv4 is in use, just make sure send_eprt has not been used |
| 564 | self.assertEqual(self.server.handler_instance.last_received_cmd, |
| 565 | 'port') |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 566 | |
| 567 | def test_makepasv(self): |
| 568 | host, port = self.client.makepasv() |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 569 | conn = socket.create_connection((host, port), 10) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 570 | conn.close() |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 571 | # IPv4 is in use, just make sure send_epsv has not been used |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 572 | self.assertEqual(self.server.handler_instance.last_received_cmd, 'pasv') |
| 573 | |
| 574 | def test_with_statement(self): |
| 575 | self.client.quit() |
| 576 | |
| 577 | def is_client_connected(): |
| 578 | if self.client.sock is None: |
| 579 | return False |
| 580 | try: |
| 581 | self.client.sendcmd('noop') |
| 582 | except (socket.error, EOFError): |
| 583 | return False |
| 584 | return True |
| 585 | |
| 586 | # base test |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 587 | with ftplib.FTP(timeout=10) as self.client: |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 588 | self.client.connect(self.server.host, self.server.port) |
| 589 | self.client.sendcmd('noop') |
| 590 | self.assertTrue(is_client_connected()) |
| 591 | self.assertEqual(self.server.handler_instance.last_received_cmd, 'quit') |
| 592 | self.assertFalse(is_client_connected()) |
| 593 | |
| 594 | # QUIT sent inside the with block |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 595 | with ftplib.FTP(timeout=10) as self.client: |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 596 | self.client.connect(self.server.host, self.server.port) |
| 597 | self.client.sendcmd('noop') |
| 598 | self.client.quit() |
| 599 | self.assertEqual(self.server.handler_instance.last_received_cmd, 'quit') |
| 600 | self.assertFalse(is_client_connected()) |
| 601 | |
| 602 | # force a wrong response code to be sent on QUIT: error_perm |
| 603 | # is expected and the connection is supposed to be closed |
| 604 | try: |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 605 | with ftplib.FTP(timeout=10) as self.client: |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 606 | self.client.connect(self.server.host, self.server.port) |
| 607 | self.client.sendcmd('noop') |
| 608 | self.server.handler_instance.next_response = '550 error on quit' |
| 609 | except ftplib.error_perm as err: |
| 610 | self.assertEqual(str(err), '550 error on quit') |
| 611 | else: |
| 612 | self.fail('Exception not raised') |
| 613 | # needed to give the threaded server some time to set the attribute |
| 614 | # which otherwise would still be == 'noop' |
| 615 | time.sleep(0.1) |
| 616 | self.assertEqual(self.server.handler_instance.last_received_cmd, 'quit') |
| 617 | self.assertFalse(is_client_connected()) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 618 | |
Giampaolo Rodolà | bbc4782 | 2010-08-23 22:10:32 +0000 | [diff] [blame] | 619 | def test_parse257(self): |
| 620 | self.assertEqual(ftplib.parse257('257 "/foo/bar"'), '/foo/bar') |
| 621 | self.assertEqual(ftplib.parse257('257 "/foo/bar" created'), '/foo/bar') |
| 622 | self.assertEqual(ftplib.parse257('257 ""'), '') |
| 623 | self.assertEqual(ftplib.parse257('257 "" created'), '') |
| 624 | self.assertRaises(ftplib.error_reply, ftplib.parse257, '250 "/foo/bar"') |
| 625 | # The 257 response is supposed to include the directory |
| 626 | # name and in case it contains embedded double-quotes |
| 627 | # they must be doubled (see RFC-959, chapter 7, appendix 2). |
| 628 | self.assertEqual(ftplib.parse257('257 "/foo/b""ar"'), '/foo/b"ar') |
| 629 | self.assertEqual(ftplib.parse257('257 "/foo/b""ar" created'), '/foo/b"ar') |
| 630 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 631 | |
| 632 | class TestIPv6Environment(TestCase): |
| 633 | |
| 634 | def setUp(self): |
| 635 | self.server = DummyFTPServer((HOST, 0), af=socket.AF_INET6) |
| 636 | self.server.start() |
| 637 | self.client = ftplib.FTP() |
| 638 | self.client.connect(self.server.host, self.server.port) |
| 639 | |
| 640 | def tearDown(self): |
| 641 | self.client.close() |
| 642 | self.server.stop() |
| 643 | |
| 644 | def test_af(self): |
| 645 | self.assertEqual(self.client.af, socket.AF_INET6) |
| 646 | |
| 647 | def test_makeport(self): |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 648 | with self.client.makeport(): |
| 649 | self.assertEqual(self.server.handler_instance.last_received_cmd, |
| 650 | 'eprt') |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 651 | |
| 652 | def test_makepasv(self): |
| 653 | host, port = self.client.makepasv() |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 654 | conn = socket.create_connection((host, port), 10) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 655 | conn.close() |
Giampaolo Rodolà | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 656 | self.assertEqual(self.server.handler_instance.last_received_cmd, 'epsv') |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 657 | |
| 658 | def test_transfer(self): |
| 659 | def retr(): |
| 660 | def callback(data): |
| 661 | received.append(data.decode('ascii')) |
| 662 | received = [] |
| 663 | self.client.retrbinary('retr', callback) |
| 664 | self.assertEqual(''.join(received), RETR_DATA) |
| 665 | self.client.set_pasv(True) |
| 666 | retr() |
| 667 | self.client.set_pasv(False) |
| 668 | retr() |
| 669 | |
| 670 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 671 | class TestTLS_FTPClassMixin(TestFTPClass): |
| 672 | """Repeat TestFTPClass tests starting the TLS layer for both control |
| 673 | and data connections first. |
| 674 | """ |
| 675 | |
| 676 | def setUp(self): |
| 677 | self.server = DummyTLS_FTPServer((HOST, 0)) |
| 678 | self.server.start() |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 679 | self.client = ftplib.FTP_TLS(timeout=10) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 680 | self.client.connect(self.server.host, self.server.port) |
| 681 | # enable TLS |
| 682 | self.client.auth() |
| 683 | self.client.prot_p() |
| 684 | |
| 685 | |
| 686 | class TestTLS_FTPClass(TestCase): |
| 687 | """Specific TLS_FTP class tests.""" |
| 688 | |
| 689 | def setUp(self): |
| 690 | self.server = DummyTLS_FTPServer((HOST, 0)) |
| 691 | self.server.start() |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 692 | self.client = ftplib.FTP_TLS(timeout=10) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 693 | self.client.connect(self.server.host, self.server.port) |
| 694 | |
| 695 | def tearDown(self): |
| 696 | self.client.close() |
| 697 | self.server.stop() |
| 698 | |
| 699 | def test_control_connection(self): |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 700 | self.assertNotIsInstance(self.client.sock, ssl.SSLSocket) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 701 | self.client.auth() |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 702 | self.assertIsInstance(self.client.sock, ssl.SSLSocket) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 703 | |
| 704 | def test_data_connection(self): |
| 705 | # clear text |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 706 | with self.client.transfercmd('list') as sock: |
| 707 | self.assertNotIsInstance(sock, ssl.SSLSocket) |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 708 | self.assertEqual(self.client.voidresp(), "226 transfer complete") |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 709 | |
| 710 | # secured, after PROT P |
| 711 | self.client.prot_p() |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 712 | with self.client.transfercmd('list') as sock: |
| 713 | self.assertIsInstance(sock, ssl.SSLSocket) |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 714 | self.assertEqual(self.client.voidresp(), "226 transfer complete") |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 715 | |
| 716 | # PROT C is issued, the connection must be in cleartext again |
| 717 | self.client.prot_c() |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 718 | with self.client.transfercmd('list') as sock: |
| 719 | self.assertNotIsInstance(sock, ssl.SSLSocket) |
Antoine Pitrou | 2c4f98b | 2010-04-23 00:16:21 +0000 | [diff] [blame] | 720 | self.assertEqual(self.client.voidresp(), "226 transfer complete") |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 721 | |
| 722 | def test_login(self): |
| 723 | # login() is supposed to implicitly secure the control connection |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 724 | self.assertNotIsInstance(self.client.sock, ssl.SSLSocket) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 725 | self.client.login() |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 726 | self.assertIsInstance(self.client.sock, ssl.SSLSocket) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 727 | # make sure that AUTH TLS doesn't get issued again |
| 728 | self.client.login() |
| 729 | |
| 730 | def test_auth_issued_twice(self): |
| 731 | self.client.auth() |
| 732 | self.assertRaises(ValueError, self.client.auth) |
| 733 | |
| 734 | def test_auth_ssl(self): |
| 735 | try: |
| 736 | self.client.ssl_version = ssl.PROTOCOL_SSLv3 |
| 737 | self.client.auth() |
| 738 | self.assertRaises(ValueError, self.client.auth) |
| 739 | finally: |
| 740 | self.client.ssl_version = ssl.PROTOCOL_TLSv1 |
| 741 | |
Giampaolo Rodolà | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 742 | def test_context(self): |
| 743 | self.client.quit() |
| 744 | ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1) |
| 745 | self.assertRaises(ValueError, ftplib.FTP_TLS, keyfile=CERTFILE, |
| 746 | context=ctx) |
| 747 | self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE, |
| 748 | context=ctx) |
| 749 | self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE, |
| 750 | keyfile=CERTFILE, context=ctx) |
| 751 | |
Antoine Pitrou | d778e56 | 2010-10-14 20:35:26 +0000 | [diff] [blame] | 752 | self.client = ftplib.FTP_TLS(context=ctx, timeout=10) |
Giampaolo Rodolà | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 753 | self.client.connect(self.server.host, self.server.port) |
| 754 | self.assertNotIsInstance(self.client.sock, ssl.SSLSocket) |
| 755 | self.client.auth() |
| 756 | self.assertIs(self.client.sock.context, ctx) |
| 757 | self.assertIsInstance(self.client.sock, ssl.SSLSocket) |
| 758 | |
| 759 | self.client.prot_p() |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 760 | with self.client.transfercmd('list') as sock: |
| 761 | self.assertIs(sock.context, ctx) |
| 762 | self.assertIsInstance(sock, ssl.SSLSocket) |
Giampaolo Rodolà | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 763 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 764 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 765 | class TestTimeouts(TestCase): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 766 | |
| 767 | def setUp(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 768 | self.evt = threading.Event() |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 769 | self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 770 | self.sock.settimeout(3) |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 771 | self.port = support.bind_port(self.sock) |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 772 | threading.Thread(target=self.server, args=(self.evt,self.sock)).start() |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 773 | # Wait for the server to be ready. |
| 774 | self.evt.wait() |
| 775 | self.evt.clear() |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 776 | ftplib.FTP.port = self.port |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 777 | |
| 778 | def tearDown(self): |
| 779 | self.evt.wait() |
Brett Cannon | 918e2d4 | 2010-10-29 23:26:25 +0000 | [diff] [blame] | 780 | self.sock.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 781 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 782 | def server(self, evt, serv): |
| 783 | # This method sets the evt 3 times: |
| 784 | # 1) when the connection is ready to be accepted. |
| 785 | # 2) when it is safe for the caller to close the connection |
| 786 | # 3) when we have closed the socket |
| 787 | serv.listen(5) |
| 788 | # (1) Signal the caller that we are ready to accept the connection. |
| 789 | evt.set() |
| 790 | try: |
| 791 | conn, addr = serv.accept() |
| 792 | except socket.timeout: |
| 793 | pass |
| 794 | else: |
| 795 | conn.send(b"1 Hola mundo\n") |
| 796 | # (2) Signal the caller that it is safe to close the socket. |
| 797 | evt.set() |
| 798 | conn.close() |
| 799 | finally: |
| 800 | serv.close() |
| 801 | # (3) Signal the caller that we are done. |
| 802 | evt.set() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 803 | |
| 804 | def testTimeoutDefault(self): |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 805 | # default -- use global socket timeout |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 806 | self.assertTrue(socket.getdefaulttimeout() is None) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 807 | socket.setdefaulttimeout(30) |
| 808 | try: |
| 809 | ftp = ftplib.FTP("localhost") |
| 810 | finally: |
| 811 | socket.setdefaulttimeout(None) |
| 812 | self.assertEqual(ftp.sock.gettimeout(), 30) |
| 813 | self.evt.wait() |
| 814 | ftp.close() |
| 815 | |
| 816 | def testTimeoutNone(self): |
| 817 | # no timeout -- do not use global socket timeout |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 818 | self.assertTrue(socket.getdefaulttimeout() is None) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 819 | socket.setdefaulttimeout(30) |
| 820 | try: |
| 821 | ftp = ftplib.FTP("localhost", timeout=None) |
| 822 | finally: |
| 823 | socket.setdefaulttimeout(None) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 824 | self.assertTrue(ftp.sock.gettimeout() is None) |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 825 | self.evt.wait() |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 826 | ftp.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 827 | |
| 828 | def testTimeoutValue(self): |
| 829 | # a value |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 830 | ftp = ftplib.FTP(HOST, timeout=30) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 831 | self.assertEqual(ftp.sock.gettimeout(), 30) |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 832 | self.evt.wait() |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 833 | ftp.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 834 | |
| 835 | def testTimeoutConnect(self): |
| 836 | ftp = ftplib.FTP() |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 837 | ftp.connect(HOST, timeout=30) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 838 | self.assertEqual(ftp.sock.gettimeout(), 30) |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 839 | self.evt.wait() |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 840 | ftp.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 841 | |
| 842 | def testTimeoutDifferentOrder(self): |
| 843 | ftp = ftplib.FTP(timeout=30) |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 844 | ftp.connect(HOST) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 845 | self.assertEqual(ftp.sock.gettimeout(), 30) |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 846 | self.evt.wait() |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 847 | ftp.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 848 | |
| 849 | def testTimeoutDirectAccess(self): |
| 850 | ftp = ftplib.FTP() |
| 851 | ftp.timeout = 30 |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 852 | ftp.connect(HOST) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 853 | self.assertEqual(ftp.sock.gettimeout(), 30) |
Christian Heimes | 836baa5 | 2008-02-26 08:18:30 +0000 | [diff] [blame] | 854 | self.evt.wait() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 855 | ftp.close() |
| 856 | |
| 857 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 858 | def test_main(): |
| 859 | tests = [TestFTPClass, TestTimeouts] |
| 860 | if socket.has_ipv6: |
| 861 | try: |
| 862 | DummyFTPServer((HOST, 0), af=socket.AF_INET6) |
| 863 | except socket.error: |
| 864 | pass |
| 865 | else: |
| 866 | tests.append(TestIPv6Environment) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 867 | |
| 868 | if ssl is not None: |
| 869 | tests.extend([TestTLS_FTPClassMixin, TestTLS_FTPClass]) |
| 870 | |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 871 | thread_info = support.threading_setup() |
| 872 | try: |
| 873 | support.run_unittest(*tests) |
| 874 | finally: |
| 875 | support.threading_cleanup(*thread_info) |
| 876 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 877 | |
| 878 | if __name__ == '__main__': |
| 879 | test_main() |