Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added minimal support for FTP with TLS/SSL #110

Closed
wants to merge 5 commits into from
Closed

Added minimal support for FTP with TLS/SSL #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3184b1
Added minimal support for FTP with TLS/SSL
Dec 5, 2014
1b6ee55
Updated tests for TLS/SSL
Dec 17, 2014
884e87d
Removed minor artefact from testing in jsftp_test.js
Dec 17, 2014
fcae5b6
Minor code style edit
Dec 17, 2014
2a82372
Added TODO for timeout on TLS
Dec 17, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions lib/jsftp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
'use strict';

var Net = require('net');
var tls = require('tls');
var EventEmitter = require('events').EventEmitter;
var es = require('event-stream');
var ResponseParser = require('ftp-response-parser');
Expand Down Expand Up @@ -117,13 +118,26 @@ Ftp.prototype._createSocket = function(port, host, firstAction) {
}

this.authenticated = false;
var socket = Net.createConnection(port, host, firstAction || NOOP);
socket.on('connect', this.reemit('connect'));
socket.on('timeout', this.reemit('timeout'));
var self = this;
var socket;

if (this.ssl) {
socket = tls.connect(port, host, this.sslOptions, function() {
//runt PROT command to specify that the data channel is secure
self.runCommand('prot p', function() {
self.reemit('connect');
//TODO timeout for tls connection?
});
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no timeout in tls connections?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't really find any way of detecting timeouts with a tls connection actually

});
}
else{
socket = Net.createConnection(port, host, firstAction || NOOP);
socket.on('connect', this.reemit('connect'));
socket.on('timeout', this.reemit('timeout'));
}

this.pipeline = es.pipeline(socket, this.resParser);

var self = this;
this.pipeline = es.pipeline(socket, this.resParser);
this.pipeline.on('data', function(data) {
self.emit('data', data);
self.parseResponse.call(self, data);
Expand Down Expand Up @@ -583,13 +597,22 @@ Ftp.prototype.pasvTimeout = function(socket, cb) {
Ftp.prototype.getPasvSocket = function(callback) {
var timeout = this.timeout;
callback = once(callback || NOOP);
var self = this;
this.execute('pasv', function(err, res) {
if (err) return callback(err);

getPasvPort(res.text, function(err, res) {
if (err) return callback(err);

var socket = Net.createConnection(res.port, res.host);
var socket;
if (self.ssl) {
socket = tls.connect(res.port, res.host, self.sslOptions, function() {
self.reemit('connect');
});
}
else{
socket = Net.createConnection(res.port, res.host);
}
socket.setTimeout(timeout || TIMEOUT);
callback(null, socket);
});
Expand Down
38 changes: 31 additions & 7 deletions test/jsftp_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,26 +66,28 @@ var FTPCredentials = {
pass: "12345"
};

var createLocal = true; //Set to false if you are using your own local FTP server

function getRemotePath(path) {
return Path.join('test', 'test_c9', path);
}

function getLocalPath(path) {
return Path.join(process.cwd(), 'test', 'test_c9', path);
}
var CWD = process.cwd() + "/test";
var CWD = Path.join(process.cwd(),"test");
var remoteCWD = "test/test_c9";
exec('mkdir', [__dirname + "/" + remoteCWD]);

describe("jsftp test suite", function() {
function testRoutine(){
var ftp, server;
beforeEach(function(next) {
rimraf(getLocalPath(''), function() {
Fs.mkdirSync(getLocalPath(''));
Fs.writeFileSync(getLocalPath('testfile.txt'), "test");
Fs.writeFileSync(getLocalPath('testfile2.txt'), "test2");

if (FTPCredentials.host === "localhost") {
if (createLocal && FTPCredentials.host === "localhost") {
server = new ftpServer();
server.init(FTPCredentials);
}
Expand All @@ -99,7 +101,7 @@ describe("jsftp test suite", function() {

afterEach(function(next) {
setTimeout(function() {
server.stop();
server && server.stop();
if (ftp) {
ftp.destroy();
ftp = null;
Expand Down Expand Up @@ -362,7 +364,7 @@ describe("jsftp test suite", function() {

ftp.ls(filePath, function(err, res) {
assert.ok(!err);
assert.equal(buffer.length, Fs.statSync(CWD + "/jsftp_test.js").size);
assert.equal(buffer.length, Fs.statSync(Path.join(CWD,"jsftp_test.js")).size);

ftp.raw.dele(filePath, function(err, data) {
assert.ok(!err);
Expand Down Expand Up @@ -406,7 +408,7 @@ describe("jsftp test suite", function() {

ftp.ls(filePath, function(err, res) {
assert.ok(!err);
assert.equal(res[0].size, Fs.statSync(CWD + "/jsftp_test.js").size);
assert.equal(res[0].size, Fs.statSync(Path.join(CWD,"jsftp_test.js")).size);

ftp.raw.dele(filePath, function(err, data) {
assert.ok(!err);
Expand Down Expand Up @@ -443,7 +445,7 @@ describe("jsftp test suite", function() {
});

it("test get a file", function(next) {
var localPath = CWD + '/test_c9/testfile.txt';
var localPath = Path.join(CWD,"test_c9","testfile.txt");
var remotePath = remoteCWD + "/testfile.txt";
var realContents = Fs.readFileSync(localPath, "utf8");
var str = "";
Expand Down Expand Up @@ -795,4 +797,26 @@ describe("jsftp test suite", function() {
onDone();
});
});
}

describe("jsftp test suite", function(){
describe("without ssl", testRoutine);
describe("with ssl", function(){
before(function(){
//change ftp credentials to ssl
FTPCredentials = {
host: "localhost",
user: "user",
port: 990,
pass: "12345",
ssl:true,
//extra options added for testing locally without valid certs
sslOptions:{
requestCert: false,
rejectUnauthorized: false
}
};
});
testRoutine();
});
});