1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "net/ftp/ftp_network_transaction.h"
8 #include "base/bind_helpers.h"
9 #include "base/compiler_specific.h"
10 #include "base/metrics/histogram_macros.h"
11 #include "base/strings/string_number_conversions.h"
12 #include "base/strings/string_split.h"
13 #include "base/strings/string_util.h"
14 #include "base/strings/utf_string_conversions.h"
15 #include "base/values.h"
16 #include "net/base/address_list.h"
17 #include "net/base/connection_type_histograms.h"
18 #include "net/base/escape.h"
19 #include "net/base/net_errors.h"
20 #include "net/base/net_util.h"
21 #include "net/base/port_util.h"
22 #include "net/ftp/ftp_request_info.h"
23 #include "net/ftp/ftp_util.h"
24 #include "net/log/net_log.h"
25 #include "net/socket/client_socket_factory.h"
26 #include "net/socket/stream_socket.h"
27 #include "url/url_constants.h"
33 const char kCRLF
[] = "\r\n";
35 const int kCtrlBufLen
= 1024;
37 // Returns true if |input| can be safely used as a part of FTP command.
38 bool IsValidFTPCommandString(const std::string
& input
) {
39 // RFC 959 only allows ASCII strings, but at least Firefox can send non-ASCII
40 // characters in the command if the request path contains them. To be
41 // compatible, we do the same and allow non-ASCII characters in a command.
43 // Protect agains newline injection attack.
44 if (input
.find_first_of("\r\n") != std::string::npos
)
51 // The requested action was initiated. The client should expect another
52 // reply before issuing the next command.
53 ERROR_CLASS_INITIATED
,
55 // The requested action has been successfully completed.
58 // The command has been accepted, but to complete the operation, more
59 // information must be sent by the client.
60 ERROR_CLASS_INFO_NEEDED
,
62 // The command was not accepted and the requested action did not take place.
63 // This condition is temporary, and the client is encouraged to restart the
65 ERROR_CLASS_TRANSIENT_ERROR
,
67 // The command was not accepted and the requested action did not take place.
68 // This condition is rather permanent, and the client is discouraged from
69 // repeating the exact request.
70 ERROR_CLASS_PERMANENT_ERROR
,
73 // Returns the error class for given response code. Caller should ensure
74 // that |response_code| is in range 100-599.
75 ErrorClass
GetErrorClass(int response_code
) {
76 if (response_code
>= 100 && response_code
<= 199)
77 return ERROR_CLASS_INITIATED
;
79 if (response_code
>= 200 && response_code
<= 299)
80 return ERROR_CLASS_OK
;
82 if (response_code
>= 300 && response_code
<= 399)
83 return ERROR_CLASS_INFO_NEEDED
;
85 if (response_code
>= 400 && response_code
<= 499)
86 return ERROR_CLASS_TRANSIENT_ERROR
;
88 if (response_code
>= 500 && response_code
<= 599)
89 return ERROR_CLASS_PERMANENT_ERROR
;
91 // We should not be called on invalid error codes.
92 NOTREACHED() << response_code
;
93 return ERROR_CLASS_PERMANENT_ERROR
;
96 // Returns network error code for received FTP |response_code|.
97 int GetNetErrorCodeForFtpResponseCode(int response_code
) {
98 switch (response_code
) {
100 return ERR_FTP_SERVICE_UNAVAILABLE
;
102 return ERR_FTP_TRANSFER_ABORTED
;
104 return ERR_FTP_FILE_BUSY
;
107 return ERR_FTP_SYNTAX_ERROR
;
110 return ERR_FTP_COMMAND_NOT_SUPPORTED
;
112 return ERR_FTP_BAD_COMMAND_SEQUENCE
;
114 return ERR_FTP_FAILED
;
118 // From RFC 2428 Section 3:
119 // The text returned in response to the EPSV command MUST be:
120 // <some text> (<d><d><d><tcp-port><d>)
121 // <d> is a delimiter character, ideally to be |
122 bool ExtractPortFromEPSVResponse(const FtpCtrlResponse
& response
, int* port
) {
123 if (response
.lines
.size() != 1)
125 const char* ptr
= response
.lines
[0].c_str();
126 while (*ptr
&& *ptr
!= '(')
131 if (!sep
|| isdigit(sep
) || *(++ptr
) != sep
|| *(++ptr
) != sep
)
133 if (!isdigit(*(++ptr
)))
136 while (isdigit(*(++ptr
))) {
146 // There are two way we can receive IP address and port.
147 // (127,0,0,1,23,21) IP address and port encapsulated in ().
148 // 127,0,0,1,23,21 IP address and port without ().
150 // See RFC 959, Section 4.1.2
151 bool ExtractPortFromPASVResponse(const FtpCtrlResponse
& response
, int* port
) {
152 if (response
.lines
.size() != 1)
155 std::string
line(response
.lines
[0]);
156 if (!base::IsStringASCII(line
))
158 if (line
.length() < 2)
161 size_t paren_pos
= line
.find('(');
162 if (paren_pos
== std::string::npos
) {
163 // Find the first comma and use it to locate the beginning
164 // of the response data.
165 size_t comma_pos
= line
.find(',');
166 if (comma_pos
== std::string::npos
)
169 size_t space_pos
= line
.rfind(' ', comma_pos
);
170 if (space_pos
!= std::string::npos
)
171 line
= line
.substr(space_pos
+ 1);
173 // Remove the parentheses and use the text inside them.
174 size_t closing_paren_pos
= line
.rfind(')');
175 if (closing_paren_pos
== std::string::npos
)
177 if (closing_paren_pos
<= paren_pos
)
180 line
= line
.substr(paren_pos
+ 1, closing_paren_pos
- paren_pos
- 1);
183 // Split the line into comma-separated pieces and extract
185 std::vector
<base::StringPiece
> pieces
= base::SplitStringPiece(
186 line
, ",", base::TRIM_WHITESPACE
, base::SPLIT_WANT_ALL
);
187 if (pieces
.size() != 6)
190 // Ignore the IP address supplied in the response. We are always going
191 // to connect back to the same server to prevent FTP PASV port scanning.
193 if (!base::StringToInt(pieces
[4], &p0
))
195 if (!base::StringToInt(pieces
[5], &p1
))
197 *port
= (p0
<< 8) + p1
;
204 FtpNetworkTransaction::FtpNetworkTransaction(
205 HostResolver
* resolver
,
206 ClientSocketFactory
* socket_factory
)
207 : command_sent_(COMMAND_NONE
),
208 io_callback_(base::Bind(&FtpNetworkTransaction::OnIOComplete
,
209 base::Unretained(this))),
212 read_ctrl_buf_(new IOBuffer(kCtrlBufLen
)),
213 read_data_buf_len_(0),
215 system_type_(SYSTEM_TYPE_UNKNOWN
),
216 // Use image (binary) transfer by default. It should always work,
217 // whereas the ascii transfer may damage binary data.
218 data_type_(DATA_TYPE_IMAGE
),
219 resource_type_(RESOURCE_TYPE_UNKNOWN
),
221 data_connection_port_(0),
222 socket_factory_(socket_factory
),
223 next_state_(STATE_NONE
),
224 state_after_data_connect_complete_(STATE_NONE
) {
227 FtpNetworkTransaction::~FtpNetworkTransaction() {
230 int FtpNetworkTransaction::Stop(int error
) {
231 if (command_sent_
== COMMAND_QUIT
)
234 next_state_
= STATE_CTRL_WRITE_QUIT
;
239 int FtpNetworkTransaction::Start(const FtpRequestInfo
* request_info
,
240 const CompletionCallback
& callback
,
241 const BoundNetLog
& net_log
) {
243 request_
= request_info
;
245 ctrl_response_buffer_
.reset(new FtpCtrlResponseBuffer(net_log_
));
247 if (request_
->url
.has_username()) {
248 base::string16 username
;
249 base::string16 password
;
250 GetIdentityFromURL(request_
->url
, &username
, &password
);
251 credentials_
.Set(username
, password
);
253 credentials_
.Set(base::ASCIIToUTF16("anonymous"),
254 base::ASCIIToUTF16("chrome@example.com"));
259 next_state_
= STATE_CTRL_RESOLVE_HOST
;
261 if (rv
== ERR_IO_PENDING
)
262 user_callback_
= callback
;
266 int FtpNetworkTransaction::RestartWithAuth(const AuthCredentials
& credentials
,
267 const CompletionCallback
& callback
) {
268 ResetStateForRestart();
270 credentials_
= credentials
;
272 next_state_
= STATE_CTRL_RESOLVE_HOST
;
274 if (rv
== ERR_IO_PENDING
)
275 user_callback_
= callback
;
279 int FtpNetworkTransaction::Read(IOBuffer
* buf
,
281 const CompletionCallback
& callback
) {
283 DCHECK_GT(buf_len
, 0);
285 read_data_buf_
= buf
;
286 read_data_buf_len_
= buf_len
;
288 next_state_
= STATE_DATA_READ
;
290 if (rv
== ERR_IO_PENDING
)
291 user_callback_
= callback
;
295 const FtpResponseInfo
* FtpNetworkTransaction::GetResponseInfo() const {
299 LoadState
FtpNetworkTransaction::GetLoadState() const {
300 if (next_state_
== STATE_CTRL_RESOLVE_HOST_COMPLETE
)
301 return LOAD_STATE_RESOLVING_HOST
;
303 if (next_state_
== STATE_CTRL_CONNECT_COMPLETE
||
304 next_state_
== STATE_DATA_CONNECT_COMPLETE
)
305 return LOAD_STATE_CONNECTING
;
307 if (next_state_
== STATE_DATA_READ_COMPLETE
)
308 return LOAD_STATE_READING_RESPONSE
;
310 if (command_sent_
== COMMAND_RETR
&& read_data_buf_
.get())
311 return LOAD_STATE_READING_RESPONSE
;
313 if (command_sent_
== COMMAND_QUIT
)
314 return LOAD_STATE_IDLE
;
316 if (command_sent_
!= COMMAND_NONE
)
317 return LOAD_STATE_SENDING_REQUEST
;
319 return LOAD_STATE_IDLE
;
322 uint64
FtpNetworkTransaction::GetUploadProgress() const {
326 void FtpNetworkTransaction::ResetStateForRestart() {
327 command_sent_
= COMMAND_NONE
;
328 user_callback_
.Reset();
329 response_
= FtpResponseInfo();
330 read_ctrl_buf_
= new IOBuffer(kCtrlBufLen
);
331 ctrl_response_buffer_
.reset(new FtpCtrlResponseBuffer(net_log_
));
332 read_data_buf_
= NULL
;
333 read_data_buf_len_
= 0;
334 if (write_buf_
.get())
335 write_buf_
->SetOffset(0);
337 data_connection_port_
= 0;
338 ctrl_socket_
.reset();
339 data_socket_
.reset();
340 next_state_
= STATE_NONE
;
341 state_after_data_connect_complete_
= STATE_NONE
;
344 void FtpNetworkTransaction::EstablishDataConnection(State state_after_connect
) {
345 DCHECK(state_after_connect
== STATE_CTRL_WRITE_RETR
||
346 state_after_connect
== STATE_CTRL_WRITE_LIST
);
347 state_after_data_connect_complete_
= state_after_connect
;
348 next_state_
= use_epsv_
? STATE_CTRL_WRITE_EPSV
: STATE_CTRL_WRITE_PASV
;
351 void FtpNetworkTransaction::DoCallback(int rv
) {
352 DCHECK(rv
!= ERR_IO_PENDING
);
353 DCHECK(!user_callback_
.is_null());
355 // Since Run may result in Read being called, clear callback_ up front.
356 CompletionCallback c
= user_callback_
;
357 user_callback_
.Reset();
361 void FtpNetworkTransaction::OnIOComplete(int result
) {
362 int rv
= DoLoop(result
);
363 if (rv
!= ERR_IO_PENDING
)
367 int FtpNetworkTransaction::ProcessCtrlResponse() {
368 FtpCtrlResponse response
= ctrl_response_buffer_
->PopResponse();
371 switch (command_sent_
) {
373 // TODO(phajdan.jr): Check for errors in the welcome message.
374 next_state_
= STATE_CTRL_WRITE_USER
;
377 rv
= ProcessResponseUSER(response
);
380 rv
= ProcessResponsePASS(response
);
383 rv
= ProcessResponseSYST(response
);
386 rv
= ProcessResponsePWD(response
);
389 rv
= ProcessResponseTYPE(response
);
392 rv
= ProcessResponseEPSV(response
);
395 rv
= ProcessResponsePASV(response
);
398 rv
= ProcessResponseSIZE(response
);
401 rv
= ProcessResponseRETR(response
);
404 rv
= ProcessResponseCWD(response
);
407 rv
= ProcessResponseLIST(response
);
410 rv
= ProcessResponseQUIT(response
);
413 LOG(DFATAL
) << "Unexpected value of command_sent_: " << command_sent_
;
414 return ERR_UNEXPECTED
;
417 // We may get multiple responses for some commands,
418 // see http://crbug.com/18036.
419 while (ctrl_response_buffer_
->ResponseAvailable() && rv
== OK
) {
420 response
= ctrl_response_buffer_
->PopResponse();
422 switch (command_sent_
) {
424 rv
= ProcessResponseRETR(response
);
427 rv
= ProcessResponseLIST(response
);
430 // Multiple responses for other commands are invalid.
431 return Stop(ERR_INVALID_RESPONSE
);
438 // Used to prepare and send FTP command.
439 int FtpNetworkTransaction::SendFtpCommand(const std::string
& command
,
440 const std::string
& command_for_log
,
442 // If we send a new command when we still have unprocessed responses
443 // for previous commands, the response receiving code will have no way to know
444 // which responses are for which command.
445 DCHECK(!ctrl_response_buffer_
->ResponseAvailable());
447 DCHECK(!write_command_buf_
.get());
448 DCHECK(!write_buf_
.get());
450 if (!IsValidFTPCommandString(command
)) {
451 // Callers should validate the command themselves and return a more specific
454 return Stop(ERR_UNEXPECTED
);
459 write_command_buf_
= new IOBufferWithSize(command
.length() + 2);
460 write_buf_
= new DrainableIOBuffer(write_command_buf_
.get(),
461 write_command_buf_
->size());
462 memcpy(write_command_buf_
->data(), command
.data(), command
.length());
463 memcpy(write_command_buf_
->data() + command
.length(), kCRLF
, 2);
465 net_log_
.AddEvent(NetLog::TYPE_FTP_COMMAND_SENT
,
466 NetLog::StringCallback("command", &command_for_log
));
468 next_state_
= STATE_CTRL_WRITE
;
472 std::string
FtpNetworkTransaction::GetRequestPathForFtpCommand(
473 bool is_directory
) const {
474 std::string
path(current_remote_directory_
);
475 if (request_
->url
.has_path()) {
476 std::string
gurl_path(request_
->url
.path());
478 // Get rid of the typecode, see RFC 1738 section 3.2.2. FTP url-path.
479 std::string::size_type pos
= gurl_path
.rfind(';');
480 if (pos
!= std::string::npos
)
481 gurl_path
.resize(pos
);
483 path
.append(gurl_path
);
485 // Make sure that if the path is expected to be a file, it won't end
486 // with a trailing slash.
487 if (!is_directory
&& path
.length() > 1 && path
[path
.length() - 1] == '/')
488 path
.erase(path
.length() - 1);
489 UnescapeRule::Type unescape_rules
= UnescapeRule::SPACES
|
490 UnescapeRule::URL_SPECIAL_CHARS
;
491 // This may unescape to non-ASCII characters, but we allow that. See the
492 // comment for IsValidFTPCommandString.
493 path
= UnescapeURLComponent(path
, unescape_rules
);
495 if (system_type_
== SYSTEM_TYPE_VMS
) {
497 path
= FtpUtil::UnixDirectoryPathToVMS(path
);
499 path
= FtpUtil::UnixFilePathToVMS(path
);
502 DCHECK(IsValidFTPCommandString(path
));
506 void FtpNetworkTransaction::DetectTypecode() {
507 if (!request_
->url
.has_path())
509 std::string
gurl_path(request_
->url
.path());
511 // Extract the typecode, see RFC 1738 section 3.2.2. FTP url-path.
512 std::string::size_type pos
= gurl_path
.rfind(';');
513 if (pos
== std::string::npos
)
515 std::string
typecode_string(gurl_path
.substr(pos
));
516 if (typecode_string
== ";type=a") {
517 data_type_
= DATA_TYPE_ASCII
;
518 resource_type_
= RESOURCE_TYPE_FILE
;
519 } else if (typecode_string
== ";type=i") {
520 data_type_
= DATA_TYPE_IMAGE
;
521 resource_type_
= RESOURCE_TYPE_FILE
;
522 } else if (typecode_string
== ";type=d") {
523 resource_type_
= RESOURCE_TYPE_DIRECTORY
;
527 int FtpNetworkTransaction::DoLoop(int result
) {
528 DCHECK(next_state_
!= STATE_NONE
);
532 State state
= next_state_
;
533 next_state_
= STATE_NONE
;
535 case STATE_CTRL_RESOLVE_HOST
:
537 rv
= DoCtrlResolveHost();
539 case STATE_CTRL_RESOLVE_HOST_COMPLETE
:
540 rv
= DoCtrlResolveHostComplete(rv
);
542 case STATE_CTRL_CONNECT
:
544 rv
= DoCtrlConnect();
546 case STATE_CTRL_CONNECT_COMPLETE
:
547 rv
= DoCtrlConnectComplete(rv
);
549 case STATE_CTRL_READ
:
553 case STATE_CTRL_READ_COMPLETE
:
554 rv
= DoCtrlReadComplete(rv
);
556 case STATE_CTRL_WRITE
:
560 case STATE_CTRL_WRITE_COMPLETE
:
561 rv
= DoCtrlWriteComplete(rv
);
563 case STATE_CTRL_WRITE_USER
:
565 rv
= DoCtrlWriteUSER();
567 case STATE_CTRL_WRITE_PASS
:
569 rv
= DoCtrlWritePASS();
571 case STATE_CTRL_WRITE_SYST
:
573 rv
= DoCtrlWriteSYST();
575 case STATE_CTRL_WRITE_PWD
:
577 rv
= DoCtrlWritePWD();
579 case STATE_CTRL_WRITE_TYPE
:
581 rv
= DoCtrlWriteTYPE();
583 case STATE_CTRL_WRITE_EPSV
:
585 rv
= DoCtrlWriteEPSV();
587 case STATE_CTRL_WRITE_PASV
:
589 rv
= DoCtrlWritePASV();
591 case STATE_CTRL_WRITE_RETR
:
593 rv
= DoCtrlWriteRETR();
595 case STATE_CTRL_WRITE_SIZE
:
597 rv
= DoCtrlWriteSIZE();
599 case STATE_CTRL_WRITE_CWD
:
601 rv
= DoCtrlWriteCWD();
603 case STATE_CTRL_WRITE_LIST
:
605 rv
= DoCtrlWriteLIST();
607 case STATE_CTRL_WRITE_QUIT
:
609 rv
= DoCtrlWriteQUIT();
611 case STATE_DATA_CONNECT
:
613 rv
= DoDataConnect();
615 case STATE_DATA_CONNECT_COMPLETE
:
616 rv
= DoDataConnectComplete(rv
);
618 case STATE_DATA_READ
:
622 case STATE_DATA_READ_COMPLETE
:
623 rv
= DoDataReadComplete(rv
);
626 NOTREACHED() << "bad state";
630 } while (rv
!= ERR_IO_PENDING
&& next_state_
!= STATE_NONE
);
634 int FtpNetworkTransaction::DoCtrlResolveHost() {
635 next_state_
= STATE_CTRL_RESOLVE_HOST_COMPLETE
;
637 HostResolver::RequestInfo
info(HostPortPair::FromURL(request_
->url
));
638 // No known referrer.
639 return resolver_
.Resolve(
643 base::Bind(&FtpNetworkTransaction::OnIOComplete
, base::Unretained(this)),
647 int FtpNetworkTransaction::DoCtrlResolveHostComplete(int result
) {
649 next_state_
= STATE_CTRL_CONNECT
;
653 int FtpNetworkTransaction::DoCtrlConnect() {
654 next_state_
= STATE_CTRL_CONNECT_COMPLETE
;
655 ctrl_socket_
= socket_factory_
->CreateTransportClientSocket(
656 addresses_
, net_log_
.net_log(), net_log_
.source());
658 NetLog::TYPE_FTP_CONTROL_CONNECTION
,
659 ctrl_socket_
->NetLog().source().ToEventParametersCallback());
660 return ctrl_socket_
->Connect(io_callback_
);
663 int FtpNetworkTransaction::DoCtrlConnectComplete(int result
) {
665 // Put the peer's IP address and port into the response.
666 IPEndPoint ip_endpoint
;
667 result
= ctrl_socket_
->GetPeerAddress(&ip_endpoint
);
669 response_
.socket_address
= HostPortPair::FromIPEndPoint(ip_endpoint
);
670 next_state_
= STATE_CTRL_READ
;
672 if (ip_endpoint
.GetFamily() == ADDRESS_FAMILY_IPV4
) {
673 // Do not use EPSV for IPv4 connections. Some servers become confused
674 // and we time out while waiting to connect. PASV is perfectly fine for
675 // IPv4. Note that this blacklists IPv4 not to use EPSV instead of
676 // whitelisting IPv6 to use it, to make the code more future-proof:
677 // all future protocols should just use EPSV.
685 int FtpNetworkTransaction::DoCtrlRead() {
686 next_state_
= STATE_CTRL_READ_COMPLETE
;
687 return ctrl_socket_
->Read(read_ctrl_buf_
.get(), kCtrlBufLen
, io_callback_
);
690 int FtpNetworkTransaction::DoCtrlReadComplete(int result
) {
692 // Some servers (for example Pure-FTPd) apparently close the control
693 // connection when anonymous login is not permitted. For more details
694 // see http://crbug.com/25023.
695 if (command_sent_
== COMMAND_USER
&&
696 credentials_
.username() == base::ASCIIToUTF16("anonymous")) {
697 response_
.needs_auth
= true;
699 return Stop(ERR_EMPTY_RESPONSE
);
704 ctrl_response_buffer_
->ConsumeData(read_ctrl_buf_
->data(), result
);
706 if (!ctrl_response_buffer_
->ResponseAvailable()) {
707 // Read more data from the control socket.
708 next_state_
= STATE_CTRL_READ
;
712 return ProcessCtrlResponse();
715 int FtpNetworkTransaction::DoCtrlWrite() {
716 next_state_
= STATE_CTRL_WRITE_COMPLETE
;
718 return ctrl_socket_
->Write(
719 write_buf_
.get(), write_buf_
->BytesRemaining(), io_callback_
);
722 int FtpNetworkTransaction::DoCtrlWriteComplete(int result
) {
726 write_buf_
->DidConsume(result
);
727 if (write_buf_
->BytesRemaining() == 0) {
728 // Clear the write buffer.
730 write_command_buf_
= NULL
;
732 next_state_
= STATE_CTRL_READ
;
734 next_state_
= STATE_CTRL_WRITE
;
739 // FTP Commands and responses
742 int FtpNetworkTransaction::DoCtrlWriteUSER() {
743 std::string command
= "USER " + base::UTF16ToUTF8(credentials_
.username());
745 if (!IsValidFTPCommandString(command
))
746 return Stop(ERR_MALFORMED_IDENTITY
);
748 next_state_
= STATE_CTRL_READ
;
749 return SendFtpCommand(command
, "USER ***", COMMAND_USER
);
752 int FtpNetworkTransaction::ProcessResponseUSER(
753 const FtpCtrlResponse
& response
) {
754 switch (GetErrorClass(response
.status_code
)) {
756 next_state_
= STATE_CTRL_WRITE_SYST
;
758 case ERROR_CLASS_INFO_NEEDED
:
759 next_state_
= STATE_CTRL_WRITE_PASS
;
761 case ERROR_CLASS_TRANSIENT_ERROR
:
762 case ERROR_CLASS_PERMANENT_ERROR
:
763 response_
.needs_auth
= true;
764 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
767 return Stop(ERR_UNEXPECTED
);
773 int FtpNetworkTransaction::DoCtrlWritePASS() {
774 std::string command
= "PASS " + base::UTF16ToUTF8(credentials_
.password());
776 if (!IsValidFTPCommandString(command
))
777 return Stop(ERR_MALFORMED_IDENTITY
);
779 next_state_
= STATE_CTRL_READ
;
780 return SendFtpCommand(command
, "PASS ***", COMMAND_PASS
);
783 int FtpNetworkTransaction::ProcessResponsePASS(
784 const FtpCtrlResponse
& response
) {
785 switch (GetErrorClass(response
.status_code
)) {
787 next_state_
= STATE_CTRL_WRITE_SYST
;
789 case ERROR_CLASS_INFO_NEEDED
:
790 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
791 case ERROR_CLASS_TRANSIENT_ERROR
:
792 case ERROR_CLASS_PERMANENT_ERROR
:
793 response_
.needs_auth
= true;
794 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
797 return Stop(ERR_UNEXPECTED
);
803 int FtpNetworkTransaction::DoCtrlWriteSYST() {
804 std::string command
= "SYST";
805 next_state_
= STATE_CTRL_READ
;
806 return SendFtpCommand(command
, command
, COMMAND_SYST
);
809 int FtpNetworkTransaction::ProcessResponseSYST(
810 const FtpCtrlResponse
& response
) {
811 switch (GetErrorClass(response
.status_code
)) {
812 case ERROR_CLASS_INITIATED
:
813 return Stop(ERR_INVALID_RESPONSE
);
814 case ERROR_CLASS_OK
: {
815 // All important info should be on the first line.
816 std::string line
= response
.lines
[0];
817 // The response should be ASCII, which allows us to do case-insensitive
818 // comparisons easily. If it is not ASCII, we leave the system type
820 if (base::IsStringASCII(line
)) {
821 line
= base::ToLowerASCII(line
);
823 // Remove all whitespace, to correctly handle cases like fancy "V M S"
824 // response instead of "VMS".
825 base::RemoveChars(line
, base::kWhitespaceASCII
, &line
);
827 // The "magic" strings we test for below have been gathered by an
828 // empirical study. VMS needs to come first because some VMS systems
829 // also respond with "UNIX emulation", which is not perfect. It is much
830 // more reliable to talk to these servers in their native language.
831 if (line
.find("vms") != std::string::npos
) {
832 system_type_
= SYSTEM_TYPE_VMS
;
833 } else if (line
.find("l8") != std::string::npos
||
834 line
.find("unix") != std::string::npos
||
835 line
.find("bsd") != std::string::npos
) {
836 system_type_
= SYSTEM_TYPE_UNIX
;
837 } else if (line
.find("win32") != std::string::npos
||
838 line
.find("windows") != std::string::npos
) {
839 system_type_
= SYSTEM_TYPE_WINDOWS
;
840 } else if (line
.find("os/2") != std::string::npos
) {
841 system_type_
= SYSTEM_TYPE_OS2
;
844 next_state_
= STATE_CTRL_WRITE_PWD
;
847 case ERROR_CLASS_INFO_NEEDED
:
848 return Stop(ERR_INVALID_RESPONSE
);
849 case ERROR_CLASS_TRANSIENT_ERROR
:
850 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
851 case ERROR_CLASS_PERMANENT_ERROR
:
852 // Server does not recognize the SYST command so proceed.
853 next_state_
= STATE_CTRL_WRITE_PWD
;
857 return Stop(ERR_UNEXPECTED
);
863 int FtpNetworkTransaction::DoCtrlWritePWD() {
864 std::string command
= "PWD";
865 next_state_
= STATE_CTRL_READ
;
866 return SendFtpCommand(command
, command
, COMMAND_PWD
);
869 int FtpNetworkTransaction::ProcessResponsePWD(const FtpCtrlResponse
& response
) {
870 switch (GetErrorClass(response
.status_code
)) {
871 case ERROR_CLASS_INITIATED
:
872 return Stop(ERR_INVALID_RESPONSE
);
873 case ERROR_CLASS_OK
: {
874 // The info we look for should be on the first line.
875 std::string line
= response
.lines
[0];
877 return Stop(ERR_INVALID_RESPONSE
);
878 std::string::size_type quote_pos
= line
.find('"');
879 if (quote_pos
!= std::string::npos
) {
880 line
= line
.substr(quote_pos
+ 1);
881 quote_pos
= line
.find('"');
882 if (quote_pos
== std::string::npos
)
883 return Stop(ERR_INVALID_RESPONSE
);
884 line
= line
.substr(0, quote_pos
);
886 if (system_type_
== SYSTEM_TYPE_VMS
)
887 line
= FtpUtil::VMSPathToUnix(line
);
888 if (line
.length() && line
[line
.length() - 1] == '/')
889 line
.erase(line
.length() - 1);
890 current_remote_directory_
= line
;
891 next_state_
= STATE_CTRL_WRITE_TYPE
;
894 case ERROR_CLASS_INFO_NEEDED
:
895 return Stop(ERR_INVALID_RESPONSE
);
896 case ERROR_CLASS_TRANSIENT_ERROR
:
897 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
898 case ERROR_CLASS_PERMANENT_ERROR
:
899 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
902 return Stop(ERR_UNEXPECTED
);
908 int FtpNetworkTransaction::DoCtrlWriteTYPE() {
909 std::string command
= "TYPE ";
910 if (data_type_
== DATA_TYPE_ASCII
) {
912 } else if (data_type_
== DATA_TYPE_IMAGE
) {
916 return Stop(ERR_UNEXPECTED
);
918 next_state_
= STATE_CTRL_READ
;
919 return SendFtpCommand(command
, command
, COMMAND_TYPE
);
922 int FtpNetworkTransaction::ProcessResponseTYPE(
923 const FtpCtrlResponse
& response
) {
924 switch (GetErrorClass(response
.status_code
)) {
925 case ERROR_CLASS_INITIATED
:
926 return Stop(ERR_INVALID_RESPONSE
);
928 next_state_
= STATE_CTRL_WRITE_SIZE
;
930 case ERROR_CLASS_INFO_NEEDED
:
931 return Stop(ERR_INVALID_RESPONSE
);
932 case ERROR_CLASS_TRANSIENT_ERROR
:
933 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
934 case ERROR_CLASS_PERMANENT_ERROR
:
935 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
938 return Stop(ERR_UNEXPECTED
);
944 int FtpNetworkTransaction::DoCtrlWriteEPSV() {
945 const std::string command
= "EPSV";
946 next_state_
= STATE_CTRL_READ
;
947 return SendFtpCommand(command
, command
, COMMAND_EPSV
);
950 int FtpNetworkTransaction::ProcessResponseEPSV(
951 const FtpCtrlResponse
& response
) {
952 switch (GetErrorClass(response
.status_code
)) {
953 case ERROR_CLASS_INITIATED
:
954 return Stop(ERR_INVALID_RESPONSE
);
955 case ERROR_CLASS_OK
: {
957 if (!ExtractPortFromEPSVResponse(response
, &port
))
958 return Stop(ERR_INVALID_RESPONSE
);
959 if (IsWellKnownPort(port
) ||
960 !IsPortAllowedForScheme(port
, url::kFtpScheme
)) {
961 return Stop(ERR_UNSAFE_PORT
);
963 data_connection_port_
= static_cast<uint16
>(port
);
964 next_state_
= STATE_DATA_CONNECT
;
967 case ERROR_CLASS_INFO_NEEDED
:
968 return Stop(ERR_INVALID_RESPONSE
);
969 case ERROR_CLASS_TRANSIENT_ERROR
:
970 case ERROR_CLASS_PERMANENT_ERROR
:
972 next_state_
= STATE_CTRL_WRITE_PASV
;
976 return Stop(ERR_UNEXPECTED
);
982 int FtpNetworkTransaction::DoCtrlWritePASV() {
983 std::string command
= "PASV";
984 next_state_
= STATE_CTRL_READ
;
985 return SendFtpCommand(command
, command
, COMMAND_PASV
);
988 int FtpNetworkTransaction::ProcessResponsePASV(
989 const FtpCtrlResponse
& response
) {
990 switch (GetErrorClass(response
.status_code
)) {
991 case ERROR_CLASS_INITIATED
:
992 return Stop(ERR_INVALID_RESPONSE
);
993 case ERROR_CLASS_OK
: {
995 if (!ExtractPortFromPASVResponse(response
, &port
))
996 return Stop(ERR_INVALID_RESPONSE
);
997 if (IsWellKnownPort(port
) ||
998 !IsPortAllowedForScheme(port
, url::kFtpScheme
)) {
999 return Stop(ERR_UNSAFE_PORT
);
1001 data_connection_port_
= static_cast<uint16
>(port
);
1002 next_state_
= STATE_DATA_CONNECT
;
1005 case ERROR_CLASS_INFO_NEEDED
:
1006 return Stop(ERR_INVALID_RESPONSE
);
1007 case ERROR_CLASS_TRANSIENT_ERROR
:
1008 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1009 case ERROR_CLASS_PERMANENT_ERROR
:
1010 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1013 return Stop(ERR_UNEXPECTED
);
1019 int FtpNetworkTransaction::DoCtrlWriteRETR() {
1020 std::string command
= "RETR " + GetRequestPathForFtpCommand(false);
1021 next_state_
= STATE_CTRL_READ
;
1022 return SendFtpCommand(command
, command
, COMMAND_RETR
);
1025 int FtpNetworkTransaction::ProcessResponseRETR(
1026 const FtpCtrlResponse
& response
) {
1027 // Resource type should be either filled in by DetectTypecode() or
1028 // detected with CWD. RETR is sent only when the resource is a file.
1029 DCHECK_EQ(RESOURCE_TYPE_FILE
, resource_type_
);
1031 switch (GetErrorClass(response
.status_code
)) {
1032 case ERROR_CLASS_INITIATED
:
1033 // We want the client to start reading the response at this point.
1034 // It got here either through Start or RestartWithAuth. We want that
1035 // method to complete. Not setting next state here will make DoLoop exit
1036 // and in turn make Start/RestartWithAuth complete.
1038 case ERROR_CLASS_OK
:
1039 next_state_
= STATE_CTRL_WRITE_QUIT
;
1041 case ERROR_CLASS_INFO_NEEDED
:
1042 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1043 case ERROR_CLASS_TRANSIENT_ERROR
:
1044 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1045 case ERROR_CLASS_PERMANENT_ERROR
:
1046 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1049 return Stop(ERR_UNEXPECTED
);
1056 int FtpNetworkTransaction::DoCtrlWriteSIZE() {
1057 std::string command
= "SIZE " + GetRequestPathForFtpCommand(false);
1058 next_state_
= STATE_CTRL_READ
;
1059 return SendFtpCommand(command
, command
, COMMAND_SIZE
);
1062 int FtpNetworkTransaction::ProcessResponseSIZE(
1063 const FtpCtrlResponse
& response
) {
1064 switch (GetErrorClass(response
.status_code
)) {
1065 case ERROR_CLASS_INITIATED
:
1067 case ERROR_CLASS_OK
:
1068 if (response
.lines
.size() != 1)
1069 return Stop(ERR_INVALID_RESPONSE
);
1071 if (!base::StringToInt64(response
.lines
[0], &size
))
1072 return Stop(ERR_INVALID_RESPONSE
);
1074 return Stop(ERR_INVALID_RESPONSE
);
1076 // A successful response to SIZE does not mean the resource is a file.
1077 // Some FTP servers (for example, the qnx one) send a SIZE even for
1079 response_
.expected_content_size
= size
;
1081 case ERROR_CLASS_INFO_NEEDED
:
1083 case ERROR_CLASS_TRANSIENT_ERROR
:
1085 case ERROR_CLASS_PERMANENT_ERROR
:
1086 // It's possible that SIZE failed because the path is a directory.
1087 // TODO(xunjieli): Add a test for this case.
1088 if (resource_type_
== RESOURCE_TYPE_UNKNOWN
&&
1089 response
.status_code
!= 550) {
1090 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1095 return Stop(ERR_UNEXPECTED
);
1098 // If the resource is known beforehand to be a file, RETR should be issued,
1099 // otherwise do CWD which will detect the resource type.
1100 if (resource_type_
== RESOURCE_TYPE_FILE
)
1101 EstablishDataConnection(STATE_CTRL_WRITE_RETR
);
1103 next_state_
= STATE_CTRL_WRITE_CWD
;
1108 int FtpNetworkTransaction::DoCtrlWriteCWD() {
1109 std::string command
= "CWD " + GetRequestPathForFtpCommand(true);
1110 next_state_
= STATE_CTRL_READ
;
1111 return SendFtpCommand(command
, command
, COMMAND_CWD
);
1114 int FtpNetworkTransaction::ProcessResponseCWD(const FtpCtrlResponse
& response
) {
1115 // CWD should be invoked only when the resource is not a file.
1116 DCHECK_NE(RESOURCE_TYPE_FILE
, resource_type_
);
1118 switch (GetErrorClass(response
.status_code
)) {
1119 case ERROR_CLASS_INITIATED
:
1120 return Stop(ERR_INVALID_RESPONSE
);
1121 case ERROR_CLASS_OK
:
1122 resource_type_
= RESOURCE_TYPE_DIRECTORY
;
1123 EstablishDataConnection(STATE_CTRL_WRITE_LIST
);
1125 case ERROR_CLASS_INFO_NEEDED
:
1126 return Stop(ERR_INVALID_RESPONSE
);
1127 case ERROR_CLASS_TRANSIENT_ERROR
:
1128 // Some FTP servers send response 451 (not a valid CWD response according
1129 // to RFC 959) instead of 550.
1130 if (response
.status_code
== 451)
1131 return ProcessResponseCWDNotADirectory();
1133 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1134 case ERROR_CLASS_PERMANENT_ERROR
:
1135 if (response
.status_code
== 550)
1136 return ProcessResponseCWDNotADirectory();
1138 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1141 return Stop(ERR_UNEXPECTED
);
1147 int FtpNetworkTransaction::ProcessResponseCWDNotADirectory() {
1148 if (resource_type_
== RESOURCE_TYPE_DIRECTORY
) {
1149 // We're assuming that the resource is a directory, but the server
1150 // says it's not true. The most probable interpretation is that it
1151 // doesn't exist (with FTP we can't be sure).
1152 return Stop(ERR_FILE_NOT_FOUND
);
1155 // If it is not a directory, it is probably a file.
1156 resource_type_
= RESOURCE_TYPE_FILE
;
1158 EstablishDataConnection(STATE_CTRL_WRITE_RETR
);
1163 int FtpNetworkTransaction::DoCtrlWriteLIST() {
1164 // Use the -l option for mod_ftp configured in LISTIsNLST mode: the option
1165 // forces LIST output instead of NLST (which would be ambiguous for us
1167 std::string
command("LIST -l");
1168 if (system_type_
== SYSTEM_TYPE_VMS
)
1169 command
= "LIST *.*;0";
1171 next_state_
= STATE_CTRL_READ
;
1172 return SendFtpCommand(command
, command
, COMMAND_LIST
);
1175 int FtpNetworkTransaction::ProcessResponseLIST(
1176 const FtpCtrlResponse
& response
) {
1177 // Resource type should be either filled in by DetectTypecode() or
1178 // detected with CWD. LIST is sent only when the resource is a directory.
1179 DCHECK_EQ(RESOURCE_TYPE_DIRECTORY
, resource_type_
);
1181 switch (GetErrorClass(response
.status_code
)) {
1182 case ERROR_CLASS_INITIATED
:
1183 // We want the client to start reading the response at this point.
1184 // It got here either through Start or RestartWithAuth. We want that
1185 // method to complete. Not setting next state here will make DoLoop exit
1186 // and in turn make Start/RestartWithAuth complete.
1187 response_
.is_directory_listing
= true;
1189 case ERROR_CLASS_OK
:
1190 response_
.is_directory_listing
= true;
1191 next_state_
= STATE_CTRL_WRITE_QUIT
;
1193 case ERROR_CLASS_INFO_NEEDED
:
1194 return Stop(ERR_INVALID_RESPONSE
);
1195 case ERROR_CLASS_TRANSIENT_ERROR
:
1196 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1197 case ERROR_CLASS_PERMANENT_ERROR
:
1198 return Stop(GetNetErrorCodeForFtpResponseCode(response
.status_code
));
1201 return Stop(ERR_UNEXPECTED
);
1207 int FtpNetworkTransaction::DoCtrlWriteQUIT() {
1208 std::string command
= "QUIT";
1209 next_state_
= STATE_CTRL_READ
;
1210 return SendFtpCommand(command
, command
, COMMAND_QUIT
);
1213 int FtpNetworkTransaction::ProcessResponseQUIT(
1214 const FtpCtrlResponse
& response
) {
1215 ctrl_socket_
->Disconnect();
1221 int FtpNetworkTransaction::DoDataConnect() {
1222 next_state_
= STATE_DATA_CONNECT_COMPLETE
;
1223 IPEndPoint ip_endpoint
;
1224 AddressList data_address
;
1225 // Connect to the same host as the control socket to prevent PASV port
1226 // scanning attacks.
1227 int rv
= ctrl_socket_
->GetPeerAddress(&ip_endpoint
);
1230 data_address
= AddressList::CreateFromIPAddress(
1231 ip_endpoint
.address(), data_connection_port_
);
1232 data_socket_
= socket_factory_
->CreateTransportClientSocket(
1233 data_address
, net_log_
.net_log(), net_log_
.source());
1235 NetLog::TYPE_FTP_DATA_CONNECTION
,
1236 data_socket_
->NetLog().source().ToEventParametersCallback());
1237 return data_socket_
->Connect(io_callback_
);
1240 int FtpNetworkTransaction::DoDataConnectComplete(int result
) {
1241 if (result
!= OK
&& use_epsv_
) {
1242 // It's possible we hit a broken server, sadly. They can break in different
1243 // ways. Some time out, some reset a connection. Fall back to PASV.
1244 // TODO(phajdan.jr): remember it for future transactions with this server.
1245 // TODO(phajdan.jr): write a test for this code path.
1247 next_state_
= STATE_CTRL_WRITE_PASV
;
1251 // Only record the connection error after we've applied all our fallbacks.
1252 // We want to capture the final error, one we're not going to recover from.
1253 RecordDataConnectionError(result
);
1256 return Stop(result
);
1258 next_state_
= state_after_data_connect_complete_
;
1262 int FtpNetworkTransaction::DoDataRead() {
1263 DCHECK(read_data_buf_
.get());
1264 DCHECK_GT(read_data_buf_len_
, 0);
1266 if (data_socket_
== NULL
|| !data_socket_
->IsConnected()) {
1267 // If we don't destroy the data socket completely, some servers will wait
1268 // for us (http://crbug.com/21127). The half-closed TCP connection needs
1269 // to be closed on our side too.
1270 data_socket_
.reset();
1272 if (ctrl_socket_
->IsConnected()) {
1273 // Wait for the server's response, we should get it before sending QUIT.
1274 next_state_
= STATE_CTRL_READ
;
1278 // We are no longer connected to the server, so just finish the transaction.
1282 next_state_
= STATE_DATA_READ_COMPLETE
;
1283 read_data_buf_
->data()[0] = 0;
1284 return data_socket_
->Read(
1285 read_data_buf_
.get(), read_data_buf_len_
, io_callback_
);
1288 int FtpNetworkTransaction::DoDataReadComplete(int result
) {
1292 // We're using a histogram as a group of counters, with one bucket for each
1293 // enumeration value. We're only interested in the values of the counters.
1294 // Ignore the shape, average, and standard deviation of the histograms because
1295 // they are meaningless.
1297 // We use two histograms. In the first histogram we tally whether the user has
1298 // seen an error of that type during the session. In the second histogram we
1299 // tally the total number of times the users sees each errer.
1300 void FtpNetworkTransaction::RecordDataConnectionError(int result
) {
1301 // Gather data for http://crbug.com/3073. See how many users have trouble
1302 // establishing FTP data connection in passive FTP mode.
1304 // Data connection successful.
1307 // Local firewall blocked the connection.
1308 NET_ERROR_ACCESS_DENIED
= 1,
1310 // Connection timed out.
1311 NET_ERROR_TIMED_OUT
= 2,
1313 // Connection has been estabilished, but then got broken (either reset
1315 NET_ERROR_CONNECTION_BROKEN
= 3,
1317 // Connection has been refused.
1318 NET_ERROR_CONNECTION_REFUSED
= 4,
1320 // No connection to the internet.
1321 NET_ERROR_INTERNET_DISCONNECTED
= 5,
1323 // Could not reach the destination address.
1324 NET_ERROR_ADDRESS_UNREACHABLE
= 6,
1326 // A programming error in our network stack.
1327 NET_ERROR_UNEXPECTED
= 7,
1329 // Other kind of error.
1330 NET_ERROR_OTHER
= 20,
1332 NUM_OF_NET_ERROR_TYPES
1336 type
= NET_ERROR_OK
;
1338 case ERR_ACCESS_DENIED
:
1339 case ERR_NETWORK_ACCESS_DENIED
:
1340 type
= NET_ERROR_ACCESS_DENIED
;
1343 type
= NET_ERROR_TIMED_OUT
;
1345 case ERR_CONNECTION_ABORTED
:
1346 case ERR_CONNECTION_RESET
:
1347 case ERR_CONNECTION_CLOSED
:
1348 type
= NET_ERROR_CONNECTION_BROKEN
;
1350 case ERR_CONNECTION_FAILED
:
1351 case ERR_CONNECTION_REFUSED
:
1352 type
= NET_ERROR_CONNECTION_REFUSED
;
1354 case ERR_INTERNET_DISCONNECTED
:
1355 type
= NET_ERROR_INTERNET_DISCONNECTED
;
1357 case ERR_ADDRESS_INVALID
:
1358 case ERR_ADDRESS_UNREACHABLE
:
1359 type
= NET_ERROR_ADDRESS_UNREACHABLE
;
1361 case ERR_UNEXPECTED
:
1362 type
= NET_ERROR_UNEXPECTED
;
1365 type
= NET_ERROR_OTHER
;
1368 static bool had_error_type
[NUM_OF_NET_ERROR_TYPES
];
1370 DCHECK(type
>= 0 && type
< NUM_OF_NET_ERROR_TYPES
);
1371 if (!had_error_type
[type
]) {
1372 had_error_type
[type
] = true;
1373 UMA_HISTOGRAM_ENUMERATION("Net.FtpDataConnectionErrorHappened",
1374 type
, NUM_OF_NET_ERROR_TYPES
);
1376 UMA_HISTOGRAM_ENUMERATION("Net.FtpDataConnectionErrorCount",
1377 type
, NUM_OF_NET_ERROR_TYPES
);