blob: 1f760ed1ce0bf09e7355f54a90393f6c4ee8cf57 [file] [log] [blame]
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +00001"""An FTP client class and some helper functions.
2
Barry Warsaw100d81e2000-09-01 06:09:23 +00003Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
Guido van Rossum1115ab21992-11-04 15:51:30 +00004
Guido van Rossumd2560b01996-05-28 23:41:25 +00005Example:
6
7>>> from ftplib import FTP
8>>> ftp = FTP('ftp.python.org') # connect to host, default port
Guido van Rossum24a64342001-12-28 20:54:55 +00009>>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@
Guido van Rossum2f3941d1997-10-07 14:49:56 +000010'230 Guest login ok, access restrictions apply.'
Guido van Rossumd2560b01996-05-28 23:41:25 +000011>>> ftp.retrlines('LIST') # list directory contents
12total 9
13drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
14drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
15drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
16drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
17d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
18drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
19drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
20drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
21-rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
Guido van Rossum2f3941d1997-10-07 14:49:56 +000022'226 Transfer complete.'
Guido van Rossumd2560b01996-05-28 23:41:25 +000023>>> ftp.quit()
Guido van Rossum2f3941d1997-10-07 14:49:56 +000024'221 Goodbye.'
Tim Peters88869f92001-01-14 23:36:06 +000025>>>
Guido van Rossumd2560b01996-05-28 23:41:25 +000026
27A nice test that reveals some of the network dialogue would be:
28python ftplib.py -d localhost -l -p -l
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000029"""
Guido van Rossumc567c601992-11-05 22:22:37 +000030
Tim Peters88869f92001-01-14 23:36:06 +000031#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000032# Changes and improvements suggested by Steve Majewski.
33# Modified by Jack to work on the mac.
34# Modified by Siebren to support docstrings and PASV.
Christian Heimes1af737c2008-01-23 08:24:23 +000035# Modified by Phil Schwartz to add storbinary and storlines callbacks.
Antoine Pitrouf988cd02009-11-17 20:21:14 +000036# Modified by Giampaolo Rodola' to add TLS support.
Guido van Rossum98d9fd32000-02-28 15:12:25 +000037#
Guido van Rossumc567c601992-11-05 22:22:37 +000038
Guido van Rossum1115ab21992-11-04 15:51:30 +000039import sys
Giampaolo Rodolà6545ed62010-08-21 20:34:37 +000040import socket
Georg Brandlf78e02b2008-06-10 17:40:04 +000041from socket import _GLOBAL_DEFAULT_TIMEOUT
Guido van Rossumb6775db1994-08-01 11:34:53 +000042
Martin Panter19e69c52015-11-14 12:46:42 +000043__all__ = ["FTP", "error_reply", "error_temp", "error_perm", "error_proto",
44 "all_errors"]
Guido van Rossum1115ab21992-11-04 15:51:30 +000045
Guido van Rossumd3166071993-05-24 14:16:22 +000046# Magic number from <socket.h>
Tim Peters88869f92001-01-14 23:36:06 +000047MSG_OOB = 0x1 # Process data out of band
Guido van Rossumd3166071993-05-24 14:16:22 +000048
49
Guido van Rossumc567c601992-11-05 22:22:37 +000050# The standard FTP server control port
Guido van Rossum1115ab21992-11-04 15:51:30 +000051FTP_PORT = 21
Serhiy Storchakac30b1782013-10-20 16:58:27 +030052# The sizehint parameter passed to readline() calls
53MAXLINE = 8192
Guido van Rossum1115ab21992-11-04 15:51:30 +000054
55
Guido van Rossum21974791992-11-06 13:34:17 +000056# Exception raised when an error or invalid response is received
Fred Drake227b1202000-08-17 05:06:49 +000057class Error(Exception): pass
Tim Peters88869f92001-01-14 23:36:06 +000058class error_reply(Error): pass # unexpected [123]xx reply
59class error_temp(Error): pass # 4xx errors
60class error_perm(Error): pass # 5xx errors
61class error_proto(Error): pass # response does not begin with [1-5]
Guido van Rossum1115ab21992-11-04 15:51:30 +000062
63
Guido van Rossum21974791992-11-06 13:34:17 +000064# All exceptions (hopefully) that may be raised here and that aren't
65# (always) programming errors on our side
Andrew Svetlovf7a17b42012-12-25 16:47:37 +020066all_errors = (Error, OSError, EOFError)
Guido van Rossum21974791992-11-06 13:34:17 +000067
68
Guido van Rossum1115ab21992-11-04 15:51:30 +000069# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
70CRLF = '\r\n'
Benjamin Petersonbe17a112008-09-27 21:49:47 +000071B_CRLF = b'\r\n'
Guido van Rossum1115ab21992-11-04 15:51:30 +000072
Guido van Rossum1115ab21992-11-04 15:51:30 +000073# The class itself
74class FTP:
Tim Peters88869f92001-01-14 23:36:06 +000075 '''An FTP client class.
Guido van Rossumd2560b01996-05-28 23:41:25 +000076
Guido van Rossumd8faa362007-04-27 19:54:29 +000077 To create a connection, call the class using these arguments:
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +020078 host, user, passwd, acct, timeout, source_address, encoding
Guido van Rossumd8faa362007-04-27 19:54:29 +000079
80 The first four arguments are all strings, and have default value ''.
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +020081 The parameter ´timeout´ must be numeric and defaults to None if not
82 passed, meaning that no timeout will be set on any ftp socket(s).
Guido van Rossumd8faa362007-04-27 19:54:29 +000083 If a timeout is passed, then this is now the default timeout for all ftp
84 socket operations for this instance.
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +020085 The last parameter is the encoding of filenames, which defaults to utf-8.
Guido van Rossumd8faa362007-04-27 19:54:29 +000086
Tim Peters88869f92001-01-14 23:36:06 +000087 Then use self.connect() with optional host and port argument.
Guido van Rossumd2560b01996-05-28 23:41:25 +000088
Tim Peters88869f92001-01-14 23:36:06 +000089 To download a file, use ftp.retrlines('RETR ' + filename),
90 or ftp.retrbinary() with slightly different arguments.
91 To upload a file, use ftp.storlines() or ftp.storbinary(),
92 which have an open file as argument (see their definitions
93 below for details).
94 The download/upload functions first issue appropriate TYPE
95 and PORT or PASV commands.
Guido van Rossum52b89762007-07-17 20:45:57 +000096 '''
Guido van Rossumd2560b01996-05-28 23:41:25 +000097
Fred Drake9c98a422001-02-28 21:46:37 +000098 debugging = 0
99 host = ''
100 port = FTP_PORT
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300101 maxline = MAXLINE
Fred Drake9c98a422001-02-28 21:46:37 +0000102 sock = None
103 file = None
104 welcome = None
105 passiveserver = 1
106
Georg Brandlf78e02b2008-06-10 17:40:04 +0000107 def __init__(self, host='', user='', passwd='', acct='',
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +0200108 timeout=_GLOBAL_DEFAULT_TIMEOUT, source_address=None, *,
109 encoding='utf-8'):
Alan Yeeefa3b512019-09-02 21:21:33 -0700110 """Initialization method (called by class instantiation).
111 Initialize host to localhost, port to standard ftp port.
112 Optional arguments are host (for connect()),
113 and user, passwd, acct (for login()).
114 """
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +0200115 self.encoding = encoding
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000116 self.source_address = source_address
Guido van Rossumd8faa362007-04-27 19:54:29 +0000117 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000118 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000119 self.connect(host)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000120 if user:
121 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000122
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000123 def __enter__(self):
124 return self
125
126 # Context management protocol: try to quit() if active
127 def __exit__(self, *args):
128 if self.sock is not None:
129 try:
130 self.quit()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200131 except (OSError, EOFError):
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000132 pass
133 finally:
134 if self.sock is not None:
135 self.close()
136
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000137 def connect(self, host='', port=0, timeout=-999, source_address=None):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000138 '''Connect to host. Arguments are:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000139 - host: hostname to connect to (string, default previous host)
140 - port: port to connect to (integer, default previous port)
Giampaolo Rodola'11a9bd62013-04-26 15:23:43 +0200141 - timeout: the timeout to set against the ftp socket(s)
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000142 - source_address: a 2-tuple (host, port) for the socket to bind
143 to as its source address before connecting.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000144 '''
145 if host != '':
146 self.host = host
147 if port > 0:
148 self.port = port
Georg Brandlf78e02b2008-06-10 17:40:04 +0000149 if timeout != -999:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000150 self.timeout = timeout
Dong-hee Naa190e2a2020-01-14 04:34:34 +0900151 if self.timeout is not None and not self.timeout:
152 raise ValueError('Non-blocking socket (timeout=0) is not supported')
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000153 if source_address is not None:
154 self.source_address = source_address
Steve Dower44f91c32019-06-27 10:47:59 -0700155 sys.audit("ftplib.connect", self, self.host, self.port)
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000156 self.sock = socket.create_connection((self.host, self.port), self.timeout,
157 source_address=self.source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000158 self.af = self.sock.family
Guido van Rossum52b89762007-07-17 20:45:57 +0000159 self.file = self.sock.makefile('r', encoding=self.encoding)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000160 self.welcome = self.getresp()
161 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000162
Tim Peters88869f92001-01-14 23:36:06 +0000163 def getwelcome(self):
164 '''Get the welcome message from the server.
165 (this is read and squirreled away by connect())'''
166 if self.debugging:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000167 print('*welcome*', self.sanitize(self.welcome))
Tim Peters88869f92001-01-14 23:36:06 +0000168 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000169
Tim Peters88869f92001-01-14 23:36:06 +0000170 def set_debuglevel(self, level):
171 '''Set the debugging level.
172 The required argument level means:
173 0: no debugging output (default)
174 1: print commands and responses but not body text etc.
175 2: also print raw lines read and sent before stripping CR/LF'''
176 self.debugging = level
177 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000178
Tim Peters88869f92001-01-14 23:36:06 +0000179 def set_pasv(self, val):
180 '''Use passive or active mode for data transfers.
181 With a false argument, use the normal PORT mode,
182 With a true argument, use the PASV command.'''
183 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000184
Tim Peters88869f92001-01-14 23:36:06 +0000185 # Internal: "sanitize" a string for printing
186 def sanitize(self, s):
Florent Xicluna2bb96f52011-10-23 22:11:00 +0200187 if s[:5] in {'pass ', 'PASS '}:
188 i = len(s.rstrip('\r\n'))
Tim Peters88869f92001-01-14 23:36:06 +0000189 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000190 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000191
Tim Peters88869f92001-01-14 23:36:06 +0000192 # Internal: send one line to the server, appending CRLF
193 def putline(self, line):
Dong-hee Na2b1e6e92017-07-23 02:20:22 +0900194 if '\r' in line or '\n' in line:
195 raise ValueError('an illegal newline character should not be contained')
Steve Dower44f91c32019-06-27 10:47:59 -0700196 sys.audit("ftplib.sendcmd", self, line)
Tim Peters88869f92001-01-14 23:36:06 +0000197 line = line + CRLF
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100198 if self.debugging > 1:
199 print('*put*', self.sanitize(line))
Guido van Rossum52b89762007-07-17 20:45:57 +0000200 self.sock.sendall(line.encode(self.encoding))
Guido van Rossum1115ab21992-11-04 15:51:30 +0000201
Tim Peters88869f92001-01-14 23:36:06 +0000202 # Internal: send one command to the server (through putline())
203 def putcmd(self, line):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000204 if self.debugging: print('*cmd*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000205 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000206
Tim Peters88869f92001-01-14 23:36:06 +0000207 # Internal: return one line from the server, stripping CRLF.
208 # Raise EOFError if the connection is closed
209 def getline(self):
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300210 line = self.file.readline(self.maxline + 1)
211 if len(line) > self.maxline:
212 raise Error("got more than %d bytes" % self.maxline)
Tim Peters88869f92001-01-14 23:36:06 +0000213 if self.debugging > 1:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000214 print('*get*', self.sanitize(line))
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100215 if not line:
216 raise EOFError
217 if line[-2:] == CRLF:
218 line = line[:-2]
219 elif line[-1:] in CRLF:
220 line = line[:-1]
Tim Peters88869f92001-01-14 23:36:06 +0000221 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000222
Tim Peters88869f92001-01-14 23:36:06 +0000223 # Internal: get a response from the server, which may possibly
224 # consist of multiple lines. Return a single string with no
225 # trailing CRLF. If the response consists of multiple lines,
226 # these are separated by '\n' characters in the string
227 def getmultiline(self):
228 line = self.getline()
229 if line[3:4] == '-':
230 code = line[:3]
231 while 1:
232 nextline = self.getline()
233 line = line + ('\n' + nextline)
234 if nextline[:3] == code and \
235 nextline[3:4] != '-':
236 break
237 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000238
Tim Peters88869f92001-01-14 23:36:06 +0000239 # Internal: get a response from the server.
240 # Raise various errors if the response indicates an error
241 def getresp(self):
242 resp = self.getmultiline()
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100243 if self.debugging:
244 print('*resp*', self.sanitize(resp))
Tim Peters88869f92001-01-14 23:36:06 +0000245 self.lastresp = resp[:3]
246 c = resp[:1]
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000247 if c in {'1', '2', '3'}:
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000248 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000249 if c == '4':
Collin Winterce36ad82007-08-30 01:19:48 +0000250 raise error_temp(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000251 if c == '5':
Collin Winterce36ad82007-08-30 01:19:48 +0000252 raise error_perm(resp)
253 raise error_proto(resp)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000254
Tim Peters88869f92001-01-14 23:36:06 +0000255 def voidresp(self):
256 """Expect a response beginning with '2'."""
257 resp = self.getresp()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000258 if resp[:1] != '2':
Collin Winterce36ad82007-08-30 01:19:48 +0000259 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000260 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000261
Tim Peters88869f92001-01-14 23:36:06 +0000262 def abort(self):
263 '''Abort a file transfer. Uses out-of-band data.
264 This does not follow the procedure from the RFC to send Telnet
265 IP and Synch; that doesn't seem to work with the servers I've
266 tried. Instead, just send the ABOR command as OOB data.'''
Giampaolo Rodola'0b5c21f2011-05-07 19:03:47 +0200267 line = b'ABOR' + B_CRLF
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100268 if self.debugging > 1:
269 print('*put urgent*', self.sanitize(line))
Martin v. Löwise12454f2002-02-16 23:06:19 +0000270 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000271 resp = self.getmultiline()
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000272 if resp[:3] not in {'426', '225', '226'}:
Collin Winterce36ad82007-08-30 01:19:48 +0000273 raise error_proto(resp)
Giampaolo Rodola'0b5c21f2011-05-07 19:03:47 +0200274 return resp
Guido van Rossumd3166071993-05-24 14:16:22 +0000275
Tim Peters88869f92001-01-14 23:36:06 +0000276 def sendcmd(self, cmd):
277 '''Send a command and return the response.'''
278 self.putcmd(cmd)
279 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000280
Tim Peters88869f92001-01-14 23:36:06 +0000281 def voidcmd(self, cmd):
282 """Send a command and expect a response beginning with '2'."""
283 self.putcmd(cmd)
284 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000285
Tim Peters88869f92001-01-14 23:36:06 +0000286 def sendport(self, host, port):
287 '''Send a PORT command with the current host and the given
288 port number.
289 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000290 hbytes = host.split('.')
Benjamin Peterson3a53fbb2008-09-27 22:04:16 +0000291 pbytes = [repr(port//256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000292 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000293 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000294 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000295
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296 def sendeprt(self, host, port):
Martin Panter7462b6492015-11-02 03:37:02 +0000297 '''Send an EPRT command with the current host and the given port number.'''
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000298 af = 0
299 if self.af == socket.AF_INET:
300 af = 1
301 if self.af == socket.AF_INET6:
302 af = 2
303 if af == 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000304 raise error_proto('unsupported address family')
Walter Dörwald70a6b492004-02-12 17:35:32 +0000305 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000306 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000307 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000308
Tim Peters88869f92001-01-14 23:36:06 +0000309 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000310 '''Create a new socket and send a PORT command for it.'''
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +0200311 sock = socket.create_server(("", 0), family=self.af, backlog=1)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000312 port = sock.getsockname()[1] # Get proper port
313 host = self.sock.getsockname()[0] # Get proper host
314 if self.af == socket.AF_INET:
315 resp = self.sendport(host, port)
316 else:
317 resp = self.sendeprt(host, port)
Giampaolo Rodolà5fb313b2010-04-19 22:05:54 +0000318 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
319 sock.settimeout(self.timeout)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000320 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000321
322 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000323 if self.af == socket.AF_INET:
324 host, port = parse227(self.sendcmd('PASV'))
325 else:
326 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
327 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000328
Tim Peters88869f92001-01-14 23:36:06 +0000329 def ntransfercmd(self, cmd, rest=None):
330 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000331
Tim Peters88869f92001-01-14 23:36:06 +0000332 If the transfer is active, send a port command and the
333 transfer command, and accept the connection. If the server is
334 passive, send a pasv command, connect to it, and start the
335 transfer command. Either way, return the socket for the
336 connection and the expected size of the transfer. The
337 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000338
Tim Peters88869f92001-01-14 23:36:06 +0000339 Optional `rest' argument can be a string that is sent as the
Christian Heimes1af737c2008-01-23 08:24:23 +0000340 argument to a REST command. This is essentially a server
Tim Peters88869f92001-01-14 23:36:06 +0000341 marker used to tell the server to skip over any data up to the
342 given marker.
343 """
344 size = None
345 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000346 host, port = self.makepasv()
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000347 conn = socket.create_connection((host, port), self.timeout,
348 source_address=self.source_address)
Nadeem Vawda08f5f7a2011-07-23 14:03:00 +0200349 try:
350 if rest is not None:
351 self.sendcmd("REST %s" % rest)
352 resp = self.sendcmd(cmd)
353 # Some servers apparently send a 200 reply to
354 # a LIST or STOR command, before the 150 reply
355 # (and way before the 226 reply). This seems to
356 # be in violation of the protocol (which only allows
357 # 1xx or error messages for LIST), so we just discard
358 # this response.
359 if resp[0] == '2':
360 resp = self.getresp()
361 if resp[0] != '1':
362 raise error_reply(resp)
363 except:
364 conn.close()
365 raise
Tim Peters88869f92001-01-14 23:36:06 +0000366 else:
Giampaolo Rodola'836e9aa2011-12-10 21:25:04 +0100367 with self.makeport() as sock:
Nadeem Vawda08f5f7a2011-07-23 14:03:00 +0200368 if rest is not None:
369 self.sendcmd("REST %s" % rest)
370 resp = self.sendcmd(cmd)
371 # See above.
372 if resp[0] == '2':
373 resp = self.getresp()
374 if resp[0] != '1':
375 raise error_reply(resp)
376 conn, sockaddr = sock.accept()
377 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
378 conn.settimeout(self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000379 if resp[:3] == '150':
380 # this is conditional in case we received a 125
381 size = parse150(resp)
382 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000383
Tim Peters88869f92001-01-14 23:36:06 +0000384 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000385 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000386 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000387
Tim Peters88869f92001-01-14 23:36:06 +0000388 def login(self, user = '', passwd = '', acct = ''):
389 '''Login, default anonymous.'''
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100390 if not user:
391 user = 'anonymous'
392 if not passwd:
393 passwd = ''
394 if not acct:
395 acct = ''
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000396 if user == 'anonymous' and passwd in {'', '-'}:
Tim Peterse4418602002-02-16 07:34:19 +0000397 # If there is no anonymous ftp password specified
398 # then we'll just use anonymous@
399 # We don't send any other thing because:
400 # - We want to remain anonymous
401 # - We want to stop SPAM
402 # - We don't want to let ftp sites to discriminate by the user,
403 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000404 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000405 resp = self.sendcmd('USER ' + user)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100406 if resp[0] == '3':
407 resp = self.sendcmd('PASS ' + passwd)
408 if resp[0] == '3':
409 resp = self.sendcmd('ACCT ' + acct)
Tim Peters88869f92001-01-14 23:36:06 +0000410 if resp[0] != '2':
Collin Winterce36ad82007-08-30 01:19:48 +0000411 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000412 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000413
Tim Peters88869f92001-01-14 23:36:06 +0000414 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000415 """Retrieve data in binary mode. A new port is created for you.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000416
Christian Heimes1af737c2008-01-23 08:24:23 +0000417 Args:
418 cmd: A RETR command.
419 callback: A single parameter callable to be called on each
420 block of data read.
421 blocksize: The maximum number of bytes to read from the
422 socket at one time. [default: 8192]
423 rest: Passed to transfercmd(). [default: None]
Guido van Rossum1115ab21992-11-04 15:51:30 +0000424
Christian Heimes1af737c2008-01-23 08:24:23 +0000425 Returns:
426 The response code.
Tim Peters88869f92001-01-14 23:36:06 +0000427 """
428 self.voidcmd('TYPE I')
Benjamin Petersona8071372010-10-31 18:21:16 +0000429 with self.transfercmd(cmd, rest) as conn:
430 while 1:
431 data = conn.recv(blocksize)
432 if not data:
433 break
434 callback(data)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100435 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100436 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100437 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000438 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000439
Tim Peters88869f92001-01-14 23:36:06 +0000440 def retrlines(self, cmd, callback = None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000441 """Retrieve data in line mode. A new port is created for you.
442
443 Args:
Giampaolo Rodola'd78def92011-05-06 19:49:08 +0200444 cmd: A RETR, LIST, or NLST command.
Christian Heimes1af737c2008-01-23 08:24:23 +0000445 callback: An optional single parameter callable that is called
446 for each line with the trailing CRLF stripped.
447 [default: print_line()]
448
449 Returns:
450 The response code.
451 """
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100452 if callback is None:
453 callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000454 resp = self.sendcmd('TYPE A')
Benjamin Petersona8071372010-10-31 18:21:16 +0000455 with self.transfercmd(cmd) as conn, \
456 conn.makefile('r', encoding=self.encoding) as fp:
457 while 1:
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300458 line = fp.readline(self.maxline + 1)
459 if len(line) > self.maxline:
460 raise Error("got more than %d bytes" % self.maxline)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100461 if self.debugging > 2:
462 print('*retr*', repr(line))
Benjamin Petersona8071372010-10-31 18:21:16 +0000463 if not line:
464 break
465 if line[-2:] == CRLF:
466 line = line[:-2]
467 elif line[-1:] == '\n':
468 line = line[:-1]
469 callback(line)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100470 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100471 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100472 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000473 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000474
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000475 def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000476 """Store a file in binary mode. A new port is created for you.
477
478 Args:
479 cmd: A STOR command.
480 fp: A file-like object with a read(num_bytes) method.
481 blocksize: The maximum data size to read from fp and send over
482 the connection at once. [default: 8192]
483 callback: An optional single parameter callable that is called on
Terry Jan Reedyc30b7b12013-03-11 17:57:08 -0400484 each block of data after it is sent. [default: None]
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000485 rest: Passed to transfercmd(). [default: None]
Christian Heimes1af737c2008-01-23 08:24:23 +0000486
487 Returns:
488 The response code.
489 """
Tim Peters88869f92001-01-14 23:36:06 +0000490 self.voidcmd('TYPE I')
Benjamin Petersona8071372010-10-31 18:21:16 +0000491 with self.transfercmd(cmd, rest) as conn:
492 while 1:
493 buf = fp.read(blocksize)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100494 if not buf:
495 break
Benjamin Petersona8071372010-10-31 18:21:16 +0000496 conn.sendall(buf)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100497 if callback:
498 callback(buf)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100499 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100500 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100501 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000502 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000503
Christian Heimes1af737c2008-01-23 08:24:23 +0000504 def storlines(self, cmd, fp, callback=None):
505 """Store a file in line mode. A new port is created for you.
506
507 Args:
508 cmd: A STOR command.
509 fp: A file-like object with a readline() method.
510 callback: An optional single parameter callable that is called on
Terry Jan Reedyc30b7b12013-03-11 17:57:08 -0400511 each line after it is sent. [default: None]
Christian Heimes1af737c2008-01-23 08:24:23 +0000512
513 Returns:
514 The response code.
515 """
Tim Peters88869f92001-01-14 23:36:06 +0000516 self.voidcmd('TYPE A')
Benjamin Petersona8071372010-10-31 18:21:16 +0000517 with self.transfercmd(cmd) as conn:
518 while 1:
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300519 buf = fp.readline(self.maxline + 1)
520 if len(buf) > self.maxline:
521 raise Error("got more than %d bytes" % self.maxline)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100522 if not buf:
523 break
Benjamin Petersona8071372010-10-31 18:21:16 +0000524 if buf[-2:] != B_CRLF:
525 if buf[-1] in B_CRLF: buf = buf[:-1]
526 buf = buf + B_CRLF
527 conn.sendall(buf)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100528 if callback:
529 callback(buf)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100530 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100531 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100532 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000533 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000534
Tim Peters88869f92001-01-14 23:36:06 +0000535 def acct(self, password):
536 '''Send new account name.'''
537 cmd = 'ACCT ' + password
538 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000539
Tim Peters88869f92001-01-14 23:36:06 +0000540 def nlst(self, *args):
541 '''Return a list of files in a given directory (default the current).'''
542 cmd = 'NLST'
543 for arg in args:
544 cmd = cmd + (' ' + arg)
545 files = []
546 self.retrlines(cmd, files.append)
547 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000548
Tim Peters88869f92001-01-14 23:36:06 +0000549 def dir(self, *args):
550 '''List a directory in long form.
551 By default list current directory to stdout.
552 Optional last argument is callback function; all
553 non-empty arguments before it are concatenated to the
554 LIST command. (This *should* only be used for a pathname.)'''
555 cmd = 'LIST'
556 func = None
557 if args[-1:] and type(args[-1]) != type(''):
558 args, func = args[:-1], args[-1]
559 for arg in args:
560 if arg:
561 cmd = cmd + (' ' + arg)
562 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000563
Giampaolo Rodola'd78def92011-05-06 19:49:08 +0200564 def mlsd(self, path="", facts=[]):
565 '''List a directory in a standardized format by using MLSD
566 command (RFC-3659). If path is omitted the current directory
567 is assumed. "facts" is a list of strings representing the type
568 of information desired (e.g. ["type", "size", "perm"]).
569
570 Return a generator object yielding a tuple of two elements
571 for every file found in path.
572 First element is the file name, the second one is a dictionary
573 including a variable number of "facts" depending on the server
574 and whether "facts" argument has been provided.
575 '''
576 if facts:
577 self.sendcmd("OPTS MLST " + ";".join(facts) + ";")
578 if path:
579 cmd = "MLSD %s" % path
580 else:
581 cmd = "MLSD"
582 lines = []
583 self.retrlines(cmd, lines.append)
584 for line in lines:
585 facts_found, _, name = line.rstrip(CRLF).partition(' ')
586 entry = {}
587 for fact in facts_found[:-1].split(";"):
588 key, _, value = fact.partition("=")
589 entry[key.lower()] = value
590 yield (name, entry)
591
Tim Peters88869f92001-01-14 23:36:06 +0000592 def rename(self, fromname, toname):
593 '''Rename a file.'''
594 resp = self.sendcmd('RNFR ' + fromname)
595 if resp[0] != '3':
Collin Winterce36ad82007-08-30 01:19:48 +0000596 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000597 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000598
Tim Peters88869f92001-01-14 23:36:06 +0000599 def delete(self, filename):
600 '''Delete a file.'''
601 resp = self.sendcmd('DELE ' + filename)
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000602 if resp[:3] in {'250', '200'}:
Tim Peters88869f92001-01-14 23:36:06 +0000603 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000604 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000605 raise error_reply(resp)
Guido van Rossum02cf5821993-05-17 08:00:02 +0000606
Tim Peters88869f92001-01-14 23:36:06 +0000607 def cwd(self, dirname):
608 '''Change to a directory.'''
609 if dirname == '..':
610 try:
611 return self.voidcmd('CDUP')
Guido van Rossumb940e112007-01-10 16:19:56 +0000612 except error_perm as msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000613 if msg.args[0][:3] != '500':
614 raise
Tim Peters88869f92001-01-14 23:36:06 +0000615 elif dirname == '':
616 dirname = '.' # does nothing, but could return error
617 cmd = 'CWD ' + dirname
618 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000619
Tim Peters88869f92001-01-14 23:36:06 +0000620 def size(self, filename):
621 '''Retrieve the size of a file.'''
Christian Heimes1af737c2008-01-23 08:24:23 +0000622 # The SIZE command is defined in RFC-3659
Tim Peters88869f92001-01-14 23:36:06 +0000623 resp = self.sendcmd('SIZE ' + filename)
624 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000625 s = resp[3:].strip()
Florent Xicluna2bb96f52011-10-23 22:11:00 +0200626 return int(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000627
Tim Peters88869f92001-01-14 23:36:06 +0000628 def mkd(self, dirname):
629 '''Make a directory, return its full pathname.'''
Giampaolo Rodolàbbc47822010-08-23 22:10:32 +0000630 resp = self.voidcmd('MKD ' + dirname)
631 # fix around non-compliant implementations such as IIS shipped
632 # with Windows server 2003
633 if not resp.startswith('257'):
634 return ''
Tim Peters88869f92001-01-14 23:36:06 +0000635 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000636
Tim Peters88869f92001-01-14 23:36:06 +0000637 def rmd(self, dirname):
638 '''Remove a directory.'''
639 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000640
Tim Peters88869f92001-01-14 23:36:06 +0000641 def pwd(self):
642 '''Return current working directory.'''
Giampaolo Rodolàbbc47822010-08-23 22:10:32 +0000643 resp = self.voidcmd('PWD')
644 # fix around non-compliant implementations such as IIS shipped
645 # with Windows server 2003
646 if not resp.startswith('257'):
647 return ''
Tim Peters88869f92001-01-14 23:36:06 +0000648 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000649
Tim Peters88869f92001-01-14 23:36:06 +0000650 def quit(self):
651 '''Quit, and close the connection.'''
652 resp = self.voidcmd('QUIT')
653 self.close()
654 return resp
655
656 def close(self):
657 '''Close the connection without assuming anything about it.'''
Serhiy Storchaka7e7a3db2015-04-10 13:24:41 +0300658 try:
659 file = self.file
660 self.file = None
661 if file is not None:
662 file.close()
663 finally:
664 sock = self.sock
665 self.sock = None
666 if sock is not None:
667 sock.close()
Guido van Rossumc567c601992-11-05 22:22:37 +0000668
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000669try:
670 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -0400671except ImportError:
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100672 _SSLSocket = None
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000673else:
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100674 _SSLSocket = ssl.SSLSocket
675
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000676 class FTP_TLS(FTP):
677 '''A FTP subclass which adds TLS support to FTP as described
678 in RFC-4217.
679
680 Connect as usual to port 21 implicitly securing the FTP control
681 connection before authenticating.
682
683 Securing the data connection requires user to explicitly ask
684 for it by calling prot_p() method.
685
686 Usage example:
687 >>> from ftplib import FTP_TLS
688 >>> ftps = FTP_TLS('ftp.python.org')
Ezio Melotti4969f702011-03-15 05:59:46 +0200689 >>> ftps.login() # login anonymously previously securing control channel
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000690 '230 Guest login ok, access restrictions apply.'
691 >>> ftps.prot_p() # switch to secure data connection
692 '200 Protection level set to P'
693 >>> ftps.retrlines('LIST') # list directory content securely
694 total 9
695 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
696 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
697 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
698 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
699 d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
700 drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
701 drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
702 drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
703 -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
704 '226 Transfer complete.'
705 >>> ftps.quit()
706 '221 Goodbye.'
707 >>>
708 '''
Christian Heimesa170fa12017-09-15 20:27:30 +0200709 ssl_version = ssl.PROTOCOL_TLS_CLIENT
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000710
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +0200711 def __init__(self, host='', user='', passwd='', acct='',
712 keyfile=None, certfile=None, context=None,
713 timeout=_GLOBAL_DEFAULT_TIMEOUT, source_address=None, *,
714 encoding='utf-8'):
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000715 if context is not None and keyfile is not None:
716 raise ValueError("context and keyfile arguments are mutually "
717 "exclusive")
718 if context is not None and certfile is not None:
719 raise ValueError("context and certfile arguments are mutually "
720 "exclusive")
Christian Heimesd0486372016-09-10 23:23:33 +0200721 if keyfile is not None or certfile is not None:
722 import warnings
Pablo Aguiar4b5e62d2018-11-01 11:33:35 +0100723 warnings.warn("keyfile and certfile are deprecated, use a "
Christian Heimesd0486372016-09-10 23:23:33 +0200724 "custom context instead", DeprecationWarning, 2)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000725 self.keyfile = keyfile
726 self.certfile = certfile
Christian Heimes67986f92013-11-23 22:43:47 +0100727 if context is None:
728 context = ssl._create_stdlib_context(self.ssl_version,
729 certfile=certfile,
730 keyfile=keyfile)
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000731 self.context = context
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000732 self._prot_p = False
Sebastian Pedersena1a0eb42020-04-14 01:07:56 +0200733 super().__init__(host, user, passwd, acct,
734 timeout, source_address, encoding=encoding)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000735
736 def login(self, user='', passwd='', acct='', secure=True):
737 if secure and not isinstance(self.sock, ssl.SSLSocket):
738 self.auth()
Dong-hee Naa190e2a2020-01-14 04:34:34 +0900739 return super().login(user, passwd, acct)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000740
741 def auth(self):
742 '''Set up secure control connection by using TLS/SSL.'''
743 if isinstance(self.sock, ssl.SSLSocket):
744 raise ValueError("Already using TLS")
Christian Heimesa170fa12017-09-15 20:27:30 +0200745 if self.ssl_version >= ssl.PROTOCOL_TLS:
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000746 resp = self.voidcmd('AUTH TLS')
747 else:
748 resp = self.voidcmd('AUTH SSL')
Dong-hee Naa190e2a2020-01-14 04:34:34 +0900749 self.sock = self.context.wrap_socket(self.sock, server_hostname=self.host)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000750 self.file = self.sock.makefile(mode='r', encoding=self.encoding)
751 return resp
752
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +0200753 def ccc(self):
754 '''Switch back to a clear-text control connection.'''
755 if not isinstance(self.sock, ssl.SSLSocket):
756 raise ValueError("not using TLS")
757 resp = self.voidcmd('CCC')
758 self.sock = self.sock.unwrap()
759 return resp
760
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000761 def prot_p(self):
762 '''Set up secure data connection.'''
763 # PROT defines whether or not the data channel is to be protected.
764 # Though RFC-2228 defines four possible protection levels,
765 # RFC-4217 only recommends two, Clear and Private.
766 # Clear (PROT C) means that no security is to be used on the
767 # data-channel, Private (PROT P) means that the data-channel
768 # should be protected by TLS.
769 # PBSZ command MUST still be issued, but must have a parameter of
770 # '0' to indicate that no buffering is taking place and the data
771 # connection should not be encapsulated.
772 self.voidcmd('PBSZ 0')
773 resp = self.voidcmd('PROT P')
774 self._prot_p = True
775 return resp
776
777 def prot_c(self):
778 '''Set up clear text data connection.'''
779 resp = self.voidcmd('PROT C')
780 self._prot_p = False
781 return resp
782
783 # --- Overridden FTP methods
784
785 def ntransfercmd(self, cmd, rest=None):
Dong-hee Naa190e2a2020-01-14 04:34:34 +0900786 conn, size = super().ntransfercmd(cmd, rest)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000787 if self._prot_p:
Christian Heimese5b5edf2013-12-02 02:56:02 +0100788 conn = self.context.wrap_socket(conn,
Benjamin Peterson7243b572014-11-23 17:04:34 -0600789 server_hostname=self.host)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000790 return conn, size
791
Giampaolo Rodola'24befa82011-05-07 19:09:34 +0200792 def abort(self):
793 # overridden as we can't pass MSG_OOB flag to sendall()
794 line = b'ABOR' + B_CRLF
795 self.sock.sendall(line)
796 resp = self.getmultiline()
797 if resp[:3] not in {'426', '225', '226'}:
798 raise error_proto(resp)
799 return resp
800
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000801 __all__.append('FTP_TLS')
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200802 all_errors = (Error, OSError, EOFError, ssl.SSLError)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000803
804
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000805_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000806
807def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000808 '''Parse the '150' response for a RETR request.
809 Returns the expected transfer size or None; size is not guaranteed to
810 be present in the 150 message.
811 '''
812 if resp[:3] != '150':
Collin Winterce36ad82007-08-30 01:19:48 +0000813 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000814 global _150_re
815 if _150_re is None:
816 import re
Antoine Pitroufd036452008-08-19 17:56:33 +0000817 _150_re = re.compile(
R David Murray44b548d2016-09-08 13:59:53 -0400818 r"150 .* \((\d+) bytes\)", re.IGNORECASE | re.ASCII)
Tim Peters88869f92001-01-14 23:36:06 +0000819 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000820 if not m:
821 return None
Florent Xicluna2bb96f52011-10-23 22:11:00 +0200822 return int(m.group(1))
Fred Drake4de02d91997-01-10 18:26:09 +0000823
824
Guido van Rossum70297d32001-08-17 17:24:29 +0000825_227_re = None
826
Guido van Rossumd2560b01996-05-28 23:41:25 +0000827def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000828 '''Parse the '227' response for a PASV request.
829 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
830 Return ('host.addr.as.numbers', port#) tuple.'''
Tim Peters88869f92001-01-14 23:36:06 +0000831 if resp[:3] != '227':
Collin Winterce36ad82007-08-30 01:19:48 +0000832 raise error_reply(resp)
Guido van Rossum70297d32001-08-17 17:24:29 +0000833 global _227_re
834 if _227_re is None:
835 import re
Antoine Pitroufd036452008-08-19 17:56:33 +0000836 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)', re.ASCII)
Guido van Rossum70297d32001-08-17 17:24:29 +0000837 m = _227_re.search(resp)
838 if not m:
Collin Winterce36ad82007-08-30 01:19:48 +0000839 raise error_proto(resp)
Guido van Rossum70297d32001-08-17 17:24:29 +0000840 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000841 host = '.'.join(numbers[:4])
842 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000843 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000844
845
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000846def parse229(resp, peer):
Martin Panter7462b6492015-11-02 03:37:02 +0000847 '''Parse the '229' response for an EPSV request.
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000848 Raises error_proto if it does not contain '(|||port|)'
849 Return ('host.addr.as.numbers', port#) tuple.'''
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000850 if resp[:3] != '229':
Collin Winterce36ad82007-08-30 01:19:48 +0000851 raise error_reply(resp)
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000852 left = resp.find('(')
Collin Winterce36ad82007-08-30 01:19:48 +0000853 if left < 0: raise error_proto(resp)
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000854 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000855 if right < 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000856 raise error_proto(resp) # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000857 if resp[left + 1] != resp[right - 1]:
Collin Winterce36ad82007-08-30 01:19:48 +0000858 raise error_proto(resp)
Walter Dörwalda401ae42002-06-03 10:41:45 +0000859 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000860 if len(parts) != 5:
Collin Winterce36ad82007-08-30 01:19:48 +0000861 raise error_proto(resp)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000862 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000863 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000864 return host, port
865
866
Guido van Rossumc567c601992-11-05 22:22:37 +0000867def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000868 '''Parse the '257' response for a MKD or PWD request.
869 This is a response to a MKD or PWD request: a directory name.
870 Returns the directoryname in the 257 reply.'''
Tim Peters88869f92001-01-14 23:36:06 +0000871 if resp[:3] != '257':
Collin Winterce36ad82007-08-30 01:19:48 +0000872 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000873 if resp[3:5] != ' "':
874 return '' # Not compliant to RFC 959, but UNIX ftpd does this
875 dirname = ''
876 i = 5
877 n = len(resp)
878 while i < n:
879 c = resp[i]
880 i = i+1
881 if c == '"':
882 if i >= n or resp[i] != '"':
883 break
884 i = i+1
885 dirname = dirname + c
886 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000887
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000888
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000889def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000890 '''Default retrlines callback to print a line.'''
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000891 print(line)
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000892
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000893
Guido van Rossumd2560b01996-05-28 23:41:25 +0000894def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000895 '''Copy file from one FTP-instance to another.'''
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100896 if not targetname:
897 targetname = sourcename
Tim Peters88869f92001-01-14 23:36:06 +0000898 type = 'TYPE ' + type
899 source.voidcmd(type)
900 target.voidcmd(type)
901 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
902 target.sendport(sourcehost, sourceport)
903 # RFC 959: the user must "listen" [...] BEFORE sending the
904 # transfer request.
905 # So: STOR before RETR, because here the target is a "user".
906 treply = target.sendcmd('STOR ' + targetname)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100907 if treply[:3] not in {'125', '150'}:
908 raise error_proto # RFC 959
Tim Peters88869f92001-01-14 23:36:06 +0000909 sreply = source.sendcmd('RETR ' + sourcename)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100910 if sreply[:3] not in {'125', '150'}:
911 raise error_proto # RFC 959
Tim Peters88869f92001-01-14 23:36:06 +0000912 source.voidresp()
913 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000914
Tim Peters88869f92001-01-14 23:36:06 +0000915
Guido van Rossum1115ab21992-11-04 15:51:30 +0000916def test():
Tim Peters88869f92001-01-14 23:36:06 +0000917 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000918 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
919
920 -d dir
921 -l list
922 -p password
923 '''
924
925 if len(sys.argv) < 2:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000926 print(test.__doc__)
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000927 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +0000928
Berker Peksag8f791d32014-11-01 10:45:57 +0200929 import netrc
930
Tim Peters88869f92001-01-14 23:36:06 +0000931 debugging = 0
932 rcfile = None
933 while sys.argv[1] == '-d':
934 debugging = debugging+1
935 del sys.argv[1]
936 if sys.argv[1][:2] == '-r':
937 # get name of alternate ~/.netrc file:
938 rcfile = sys.argv[1][2:]
939 del sys.argv[1]
940 host = sys.argv[1]
941 ftp = FTP(host)
942 ftp.set_debuglevel(debugging)
943 userid = passwd = acct = ''
944 try:
Berker Peksag8f791d32014-11-01 10:45:57 +0200945 netrcobj = netrc.netrc(rcfile)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200946 except OSError:
Tim Peters88869f92001-01-14 23:36:06 +0000947 if rcfile is not None:
948 sys.stderr.write("Could not open account file"
949 " -- using anonymous login.")
950 else:
951 try:
Berker Peksag8f791d32014-11-01 10:45:57 +0200952 userid, acct, passwd = netrcobj.authenticators(host)
Tim Peters88869f92001-01-14 23:36:06 +0000953 except KeyError:
954 # no account for host
955 sys.stderr.write(
956 "No account -- using anonymous login.")
957 ftp.login(userid, passwd, acct)
958 for file in sys.argv[2:]:
959 if file[:2] == '-l':
960 ftp.dir(file[2:])
961 elif file[:2] == '-d':
962 cmd = 'CWD'
963 if file[2:]: cmd = cmd + ' ' + file[2:]
964 resp = ftp.sendcmd(cmd)
965 elif file == '-p':
966 ftp.set_pasv(not ftp.passiveserver)
967 else:
968 ftp.retrbinary('RETR ' + file, \
969 sys.stdout.write, 1024)
970 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +0000971
972
973if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +0000974 test()