WIP: observables

If an unknown option is given, the response should be 501

.circleci/config.yml

@@ -1,103 +0,0 @@
-version: 2
-
-create-cache-file: &create-cache-file
-  run:
-    name: Setup cache
-    command: echo "$NODE_VERSION" > _cache_node_version
-
-package-json-cache: &package-json-cache
-  key: npm-install-{{ checksum "_cache_node_version" }}-{{ checksum "package-lock.json" }}
-
-base-build: &base-build
-  steps:
-    - checkout
-    - <<: *create-cache-file
-    - restore_cache:
-        <<: *package-json-cache
-    - run:
-        name: Install
-        command: npm install
-    - save_cache:
-        <<: *package-json-cache
-        paths:
-          - node_modules
-    - run:
-        name: Lint
-        command: npm run verify:js
-    - run:
-        name: Test
-        command: npm run test:once
-
-jobs:
-  test_node_10:
-    docker:
-      - image: circleci/node:10
-    environment:
-      - NODE_VERSION: 10
-    <<: *base-build
-
-  test_node_8:
-    docker:
-      - image: circleci/node:8
-    environment:
-      - NODE_VERSION: 8
-    <<: *base-build
-
-  test_node_6:
-    docker:
-      - image: circleci/node:6
-    environment:
-      - NODE_VERSION: 6
-    <<: *base-build
-
-  release:
-    docker:
-      - image: circleci/node:8
-    environment:
-      - NODE_VERSION: 8
-    steps:
-      - checkout
-      - <<: *create-cache-file
-      - restore_cache:
-          <<: *package-json-cache
-      - deploy:
-          name: Semantic Release
-          command: |
-            npm run semantic-release
-
-workflows:
-  version: 2
-  test_and_tag:
-    jobs:
-      - test_node_10:
-          filters:
-            branches:
-              only: master
-      - test_node_8:
-          filters:
-            branches:
-              only: master
-      - test_node_6:
-          filters:
-            branches:
-              only: master
-      - release:
-          requires:
-            - test_node_6
-            - test_node_8
-            - test_node_10
-
-  build_and_test:
-    jobs:
-      - test_node_10:
-          filters:
-            branches:
-              ignore: master
-      - test_node_8:
-          filters:
-            branches:
-              ignore: master
-      - test_node_6:
-          filters:
-            branches:
-              ignore: master

.eslintignore

@@ -1,9 +0,0 @@
-# START_CONFIT_GENERATED_CONTENT
-# Common folders to ignore
-node_modules/*
-bower_components/*
-
-# Config folder (optional - you might want to lint this...)
-config/*
-
-# END_CONFIT_GENERATED_CONTENT

.gitignore

@@ -1,7 +1,2 @@
 node_modules/
-
 dist/
-reports/
-npm-debug.log
-.nyc_output/
-test_tmp/

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}\\dist\\index.js",
+      "preLaunchTask": "build",
+      "outFiles": [
+        "${workspaceFolder}/dist/**/*.js"
+      ]
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,12 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "build",
+      "type": "shell",
+			"command": "npm run build"
+    }
+  ]
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Tyler Stewart
+Copyright (c) 2019 Tyler Stewart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,342 +1,48 @@
-<p align="center">
-  <a href="https://github.com/trs/ftp-srv">
-    <img alt="ftp-srv" src="logo.png" width="600px"  />
-  </a>
-</p>
-
-
-<p align="center">
-  Modern, extensible FTP Server
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/ftp-srv">
-    <img alt="npm" src="https://img.shields.io/npm/dm/ftp-srv.svg?style=for-the-badge" />
-  </a>
-
-  <a href="https://circleci.com/gh/trs/workflows/ftp-srv/tree/master">
-    <img alt="circleci" src="https://img.shields.io/circleci/project/github/trs/ftp-srv/master.svg?style=for-the-badge" />
-  </a>
-</p>
-
----
-
-- [Overview](#overview)
-- [Features](#features)
-- [Install](#install)
-- [Usage](#usage)
-  - [API](#api)
-  - [CLI](#cli)
-  - [Events](#events)
-  - [Supported Commands](#supported-commands)
-  - [File System](#file-system)
-- [Contributing](#contributing)
-- [License](#license)
-
-## Overview
-`ftp-srv` is a modern and extensible FTP server designed to be simple yet configurable.
-
-## Features
-- Extensible [file systems](#file-system) per connection
-- Passive and active transfers
-- [Explicit](https://en.wikipedia.org/wiki/FTPS#Explicit) & [Implicit](https://en.wikipedia.org/wiki/FTPS#Implicit) TLS connections
-- Promise based API
-
-## Install
-`npm install ftp-srv --save`
-
-## Usage
-
-```js
-// Quick start
-
-const FtpSrv = require('ftp-srv');
-const ftpServer = new FtpSrv({ options ... });
-
-ftpServer.on('login', (data, resolve, reject) => { ... });
-...
-
-ftpServer.listen()
-.then(() => { ... });
-```
-
-## API
-
-### `new FtpSrv({options})`
-#### url
-[URL string](https://nodejs.org/api/url.html#url_url_strings_and_url_objects) indicating the protocol, hostname, and port to listen on for connections.
-Supported protocols:
-- `ftp` Plain FTP
-- `ftps` Implicit FTP over TLS
-
-_Note:_ The hostname must be the external IP address to accept external connections. `0.0.0.0` will listen on any available hosts for server and passive connections.  
-__Default:__ `"ftp://127.0.0.1:21"`
-
-#### `pasv_url`
-The hostname to provide a client when attempting a passive connection (`PASV`). This defaults to the provided `url` hostname.
-
-_Note:_ If set to `0.0.0.0`, this will automatically resolve to the external IP of the box.  
-__Default:__ `"127.0.0.1"`
-
-#### `pasv_min`
-Tne starting port to accept passive connections.  
-__Default:__ `1024`
-
-#### `pasv_max`
-The ending port to accept passive connections.  
-The range is then queried for an available port to use when required.  
-__Default:__ `65535`
-
-#### `greeting`
-A human readable array of lines or string to send when a client connects.  
-__Default:__ `null`
-
-#### `tls`
-Node [TLS secure context object](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) used for implicit (`ftps` protocol) or explicit (`AUTH TLS`) connections.  
-__Default:__ `false`
-
-#### `anonymous`
-If true, will allow clients to authenticate using the username `anonymous`, not requiring a password from the user.  
-Can also set as a string which allows users to authenticate using the username provided.  
-The `login` event is then sent with the provided username and `@anonymous` as the password.  
-__Default:__ `false`
-
-#### `blacklist`
-Array of commands that are not allowed.  
-Response code `502` is sent to clients sending one of these commands.  
-__Example:__ `['RMD', 'RNFR', 'RNTO']` will not allow users to delete directories or rename any files.  
-__Default:__ `[]`
-
-#### `whitelist`
-Array of commands that are only allowed.  
-Response code `502` is sent to clients sending any other command.  
-__Default:__ `[]`
-
-#### `file_format`
-Sets the format to use for file stat queries such as `LIST`.  
-__Default:__ `"ls"`  
-__Allowable values:__
-  - `ls` [bin/ls format](https://cr.yp.to/ftp/list/binls.html)
-  - `ep` [Easily Parsed LIST format](https://cr.yp.to/ftp/list/eplf.html)
-  - `function () {}` A custom function returning a format or promise for one.
-    - Only one argument is passed in: a node [file stat](https://nodejs.org/api/fs.html#fs_class_fs_stats) object with additional file `name` parameter
-
-#### `log`
-A [bunyan logger](https://github.com/trentm/node-bunyan) instance. Created by default.
-
-## CLI
-
-`ftp-srv` also comes with a builtin CLI.
-
-```bash
-$ ftp-srv [url] [options]
-```
-
-```bash
-$ ftp-srv ftp://0.0.0.0:9876 --root ~/Documents
-```
-
-#### `url`
-
-Set the listening URL.
-
-Defaults to `ftp://127.0.0.1:21`
-
-#### `--root` / `-r`
-
-Set the default root directory for users.
-
-Defaults to the current directory.
-
-#### `--credentials` / `-c`
-
-Set the path to a json credentials file.
-
-Format:
-
-```js
-[
-  {
-    "username": "...",
-    "password": "...",
-    "root": "..." // Root directory
-  },
-  ...
-]
-```
-
-#### `--username`
-
-Set the username for the only user. Do not provide an argument to allow anonymous login.
-
-#### `--password`
-
-Set the password for the given `username`.
-
-## Events
-
-The `FtpSrv` class extends the [node net.Server](https://nodejs.org/api/net.html#net_class_net_server). Some custom events can be resolved or rejected, such as `login`.
-
-### `login`
-```js
-ftpServer.on('login', ({connection, username, password}, resolve, reject) => { ... });
-```
-
-Occurs when a client is attempting to login. Here you can resolve the login request by username and password.
-
-`connection` [client class object](src/connection.js)  
-`username` string of username from `USER` command  
-`password` string of password from `PASS` command  
-`resolve` takes an object of arguments:  
-- `fs`
-  - Set a custom file system class for this connection to use.
-  - See [File System](#file-system) for implementation details.
-- `root`
-  - If `fs` is not provided, this will set the root directory for the connection.
-  - The user cannot traverse lower than this directory.
-- `cwd`
-  - If `fs` is not provided, will set the starting directory for the connection
-  - This is relative to the `root` directory.
-- `blacklist`
-  - Commands that are forbidden for only this connection
-- `whitelist`
-  - If set, this connection will only be able to use the provided commands
-
-`reject` takes an error object
-
-### `client-error`
-```js
-ftpServer.on('client-error', ({connection, context, error}) => { ... });
-```
-
-Occurs when an error arises in the client connection.
-
-`connection` [client class object](src/connection.js)  
-`context` string of where the error occurred  
-`error` error object
-
-### `RETR`
-```js
-connection.on('RETR', (error, filePath) => { ... });
-```
-
-Occurs when a file is downloaded.
-
-`error` if successful, will be `null`  
-`filePath` location to which file was downloaded
-
-### `STOR`
-```js
-connection.on('STOR', (error, fileName) => { ... });
-```
-
-Occurs when a file is uploaded.
-
-`error` if successful, will be `null`  
-`fileName` name of the file that was uploaded
-
-## Supported Commands
-
-See the [command registry](src/commands/registration) for a list of all implemented FTP commands.
-
-## File System
-The default [file system](src/fs.js) can be overwritten to use your own implementation.  
-This can allow for virtual file systems, and more.  
-Each connection can set it's own file system based on the user.  
-
-The default file system is exported and can be extended as needed:  
-```js
-const {FtpSrv, FileSystem} = require('ftp-srv');
-
-class MyFileSystem extends FileSystem {
-  constructor() {
-    super(...arguments);
-  }
-
-  get(fileName) {
-    ...
+```ts
+const loginMiddleware = () => (client) => {
+  let username;
+  let password;
+
+  return {
+    USER(client, command) => {
+      username = command.arg;
+    },
+    PASS(client, command) => {
+      password = command.arg;
+    }
+  };
+}
+
+const fileSystemMiddleware = () => (client) => {
+  return {
+    CWD(client, command) => {},
+    CDUP(client) => {},
   }
 }
+
+const transferMiddleware = () => (client) => {
+
+}
+
+client.use(loginMiddleware());
 ```
 
-Custom file systems can implement the following variables depending on the developers needs:
+ 5.1.  MINIMUM IMPLEMENTATION
 
-### Methods
-#### [`currentDirectory()`](src/fs.js#L40)
-Returns a string of the current working directory  
-__Used in:__ `PWD`
+      In order to make FTP workable without needless error messages, the
+      following minimum implementation is required for all servers:
 
-#### [`get(fileName)`](src/fs.js#L44)
-Returns a file stat object of file or directory  
-__Used in:__ `LIST`, `NLST`, `STAT`, `SIZE`, `RNFR`, `MDTM`
+         TYPE - ASCII Non-print
+         MODE - Stream
+         STRUCTURE - File, Record
+         COMMANDS - USER, QUIT, PORT,
+                    TYPE, MODE, STRU,
+                      for the default values
+                    RETR, STOR,
+                    NOOP.
 
-#### [`list(path)`](src/fs.js#L50)
-Returns array of file and directory stat objects  
-__Used in:__ `LIST`, `NLST`, `STAT`
+      The default values for transfer parameters are:
 
-#### [`chdir(path)`](src/fs.js#L67)
-Returns new directory relative to current directory  
-__Used in:__ `CWD`, `CDUP`
-
-#### [`mkdir(path)`](src/fs.js#L114)
-Returns a path to a newly created directory  
-__Used in:__ `MKD`
-
-#### [`write(fileName, {append, start})`](src/fs.js#L79)
-Returns a writable stream  
-Options:  
- `append` if true, append to existing file  
- `start` if set, specifies the byte offset to write to  
-__Used in:__ `STOR`, `APPE`
-
-#### [`read(fileName, {start})`](src/fs.js#L90)
-Returns a readable stream  
-Options:  
- `start` if set, specifies the byte offset to read from  
-__Used in:__ `RETR`
-
-#### [`delete(path)`](src/fs.js#L105)
-Delete a file or directory  
-__Used in:__ `DELE`
-
-#### [`rename(from, to)`](src/fs.js#L120)
-Renames a file or directory  
-__Used in:__ `RNFR`, `RNTO`
-
-#### [`chmod(path)`](src/fs.js#L126)
-Modifies a file or directory's permissions  
-__Used in:__ `SITE CHMOD`
-
-#### [`getUniqueName()`](src/fs.js#L131)
-Returns a unique file name to write to  
-__Used in:__ `STOU`
-
-<!--[RM_CONTRIBUTING]-->
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md).
-
-<!--[]-->
-
-## Contributors
-
-- [OzairP](https://github.com/OzairP)
-- [qchar](https://github.com/qchar)
-- [jorinvo](https://github.com/jorinvo)
-- [voxsoftware](https://github.com/voxsoftware)
-- [pkeuter](https://github.com/pkeuter)
-- [TimLuq](https://github.com/TimLuq)
-- [edin-mg](https://github.com/edin-m)
-- [DiegoRBaquero](https://github.com/DiegoRBaquero)
-- [Johnnyrook777](https://github.com/Johnnyrook777)
-
-<!--[RM_LICENSE]-->
-## License
-
-This software is licensed under the MIT Licence. See [LICENSE](LICENSE).
-
-<!--[]-->
-
-## References
-
-- [https://cr.yp.to/ftp.html](https://cr.yp.to/ftp.html)
+         TYPE - ASCII Non-print
+         MODE - Stream
+         STRU - File

config/release/commitMessageConfig.js

@@ -1,38 +0,0 @@
-'use strict';
-
-module.exports = {
-
-  types: [
-    {value: 'feat',     name: 'feat:     A new feature'},
-    {value: 'fix',      name: 'fix:      A bug fix'},
-    {value: 'docs',     name: 'docs:     Documentation only changes'},
-    {value: 'style',    name: 'style:    Changes that do not affect the meaning of the code\n            (white-space, formatting, missing semi-colons, etc)'},
-    {value: 'refactor', name: 'refactor: A code change that neither fixes a bug nor adds a feature'},
-    {value: 'perf',     name: 'perf:     A code change that improves performance'},
-    {value: 'test',     name: 'test:     Adding missing tests'},
-    {value: 'chore',    name: 'chore:    Changes to the build process or auxiliary tools\n            and libraries such as documentation generation'},
-    {value: 'revert',   name: 'revert:   Revert to a commit'},
-    {value: 'WIP',      name: 'WIP:      Work in progress'}
-  ],
-
-  scopes: [],
-
-  // it needs to match the value for field type. Eg.: 'fix'
-  /*
-   scopeOverrides: {
-   fix: [
-
-   {name: 'merge'},
-   {name: 'style'},
-   {name: 'e2eTest'},
-   {name: 'unitTest'}
-   ]
-   },
-   */
-
-  allowCustomScopes: true,
-  allowBreakingChanges: ['feat', 'fix'],
-
-  // Appends the branch name to the footer of the commit. Useful for tracking commits after branches have been merged
-  appendBranchNameToCommitMessage: false
-};

config/testUnit/mocha.opts

@@ -1,5 +0,0 @@
-test/**/*.spec.js
---reporter mocha-multi-reporters
---reporter-options configFile=config/testUnit/reporters.json
---ui bdd
---bail

config/testUnit/reporters.json

@@ -1,6 +0,0 @@
-{
-  "reporterEnabled": "spec",
-  "mochaJunitReporterReporterOptions": {
-    "mochaFile": "reports/junit.xml"
-  }
-}

config/verify/.eslintrc

@@ -1,162 +0,0 @@
-{
-  "extends": "eslint:recommended",
-  "env": {
-    "node": true,
-    "mocha": true,
-    "es6": true
-  },
-  "plugins": [
-    "mocha",
-    "node"
-  ],
-  "rules": {
-    "mocha/no-exclusive-tests": 2,
-    "no-warning-comments": [
-      1,
-      {
-        "terms": ["todo", "fixme", "xxx"],
-        "location": "start"
-      },
-    ],
-    "object-curly-spacing": [
-      2,
-      "never"
-    ],
-    "array-bracket-spacing": [
-      2,
-      "never"
-    ],
-    "brace-style": [
-      2,
-      "1tbs"
-    ],
-    "consistent-return": 0,
-    "indent": [
-      "error",
-      2,
-      {
-        "SwitchCase": 1,
-        "MemberExpression": "off"
-      }
-    ],
-    "no-multiple-empty-lines": [
-      2,
-      {
-        "max": 2
-      }
-    ],
-    "no-use-before-define": [
-      2,
-      "nofunc"
-    ],
-    "one-var": [
-      2,
-      "never"
-    ],
-    "quote-props": [
-      2,
-      "as-needed"
-    ],
-    "quotes": [
-      2,
-      "single"
-    ],
-    "keyword-spacing": 2,
-    "space-before-function-paren": [
-      2,
-      {
-        "anonymous": "always",
-        "named": "never"
-      }
-    ],
-    "space-in-parens": [
-      2,
-      "never"
-    ],
-    "strict": [
-      2,
-      "global"
-    ],
-    "curly": [
-      2,
-      "multi-line"
-    ],
-    "eol-last": 2,
-    "key-spacing": [
-      2,
-      {
-        "beforeColon": false,
-        "afterColon": true
-      }
-    ],
-    "no-eval": 2,
-    "no-with": 2,
-    "space-infix-ops": 2,
-    "dot-notation": [
-      2,
-      {
-        "allowKeywords": true
-      }
-    ],
-    "eqeqeq": 2,
-    "no-alert": 2,
-    "no-caller": 2,
-    "no-extend-native": 2,
-    "no-extra-bind": 2,
-    "no-implied-eval": 2,
-    "no-iterator": 2,
-    "no-label-var": 2,
-    "no-labels": 2,
-    "no-lone-blocks": 2,
-    "no-loop-func": 2,
-    "no-multi-spaces": 2,
-    "no-multi-str": 2,
-    "no-native-reassign": 2,
-    "no-new": 2,
-    "no-new-func": 2,
-    "no-new-wrappers": 2,
-    "no-octal-escape": 2,
-    "no-proto": 2,
-    "no-return-assign": 2,
-    "no-script-url": 2,
-    "no-sequences": 2,
-    "no-unused-expressions": 2,
-    "yoda": 2,
-    "no-shadow": 2,
-    "no-shadow-restricted-names": 2,
-    "no-undef-init": 2,
-    "no-console": 1,
-    "camelcase": [
-      0,
-      {
-        "properties": "never"
-      }
-    ],
-    "comma-spacing": 2,
-    "comma-dangle": 1,
-    "new-cap": 2,
-    "new-parens": 2,
-    "arrow-parens": [2, "always"],
-    "no-array-constructor": 2,
-    "array-callback-return": 1,
-    "no-extra-parens": 2,
-    "no-new-object": 2,
-    "no-spaced-func": 2,
-    "no-trailing-spaces": 2,
-    "no-underscore-dangle": 0,
-    "no-fallthrough": 0,
-    "semi": 2,
-    "semi-spacing": [
-      2,
-      {
-        "before": false,
-        "after": true
-      }
-    ]
-  },
-  "parserOptions": {
-    "emcaVersion": 6,
-    "sourceType": "module",
-    "impliedStrict": true
-  }
-}

old/.circleci/config.yml

@@ -0,0 +1,97 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: &node-image circleci/node:lts
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - &npm-cache-key npm-cache-{{ .Branch }}-{{ .Revision }}
+            - npm-cache-{{ .Branch }}
+            - npm-cache
+      - run:
+          name: Install
+          command: npm ci
+      - persist_to_workspace:
+          root: .
+          paths:
+            - node_modules
+      - save_cache:
+          key: *npm-cache-key
+          paths:
+            - ~/.npm/_cacache
+
+  lint:
+    docker:
+      - image: *node-image
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          name: Lint
+          command: npm run verify
+
+  test:
+    docker:
+      - image: *node-image
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - deploy:
+          name: Test
+          command: |
+            npm run test
+
+  release_dry_run:
+    docker:
+      - image: *node-image
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - deploy:
+          name: Dry Release
+          command: |
+            npm run semantic-release -- --dry-run
+
+  release:
+    docker:
+      - image: *node-image
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - deploy:
+          name: Release
+          command: |
+            npm run semantic-release
+
+workflows:
+  version: 2
+  publish:
+    jobs:
+      - build
+      - lint:
+          requires:
+            - build
+      - test:
+          requires:
+            - build
+      - release_dry_run:
+          filters:
+            branches:
+              only: master
+          requires:
+            - test
+            - lint
+      - hold_release:
+          type: approval
+          requires:
+            - release_dry_run
+      - release:
+          requires:
+            - hold_release

old/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/*
+bower_components/*

old/.gitignore

@@ -0,0 +1,6 @@
+test_tmp/
+
+node_modules/
+
+dist/
+npm-debug.log

old/CONTRIBUTING.md

@@ -16,5 +16,10 @@
 
 - Any new fixes are features should include new or updated [tests](/test).
 - Commits follow the [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit), please review and commit accordingly
-- Submit your pull requests to the `master` branch, these will normally be merged into a seperate branch for any finally changes before being merged into `master`.
-- Submit any bugs or requests to the issues page in Github.
+- Submit your pull requests to the `master` branch, these will normally be merged into a separate branch for any finally changes before being merged into `master`.
+- Submit any bugs or requests to the issues page in Github.
+
+## Setup
+
+- Clone the repository `git clone`
+- Install dependencies `npm install`

old/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Tyler Stewart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

old/README.md

@@ -0,0 +1,357 @@
+<p align="center">
+  <a href="https://github.com/trs/ftp-srv">
+    <img alt="ftp-srv" src="logo.png" width="600px"  />
+  </a>
+</p>
+
+
+<p align="center">
+  Modern, extensible FTP Server
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/ftp-srv">
+    <img alt="npm" src="https://img.shields.io/npm/dm/ftp-srv.svg?style=for-the-badge" />
+  </a>
+
+  <a href="https://circleci.com/gh/trs/workflows/ftp-srv/tree/master">
+    <img alt="circleci" src="https://img.shields.io/circleci/project/github/trs/ftp-srv/master.svg?style=for-the-badge" />
+  </a>
+</p>
+
+---
+
+- [Overview](#overview)
+- [Features](#features)
+- [Install](#install)
+- [Usage](#usage)
+  - [API](#api)
+  - [CLI](#cli)
+  - [Events](#events)
+  - [Supported Commands](#supported-commands)
+  - [File System](#file-system)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Overview
+`ftp-srv` is a modern and extensible FTP server designed to be simple yet configurable.
+
+## Features
+- Extensible [file systems](#file-system) per connection
+- Passive and active transfers
+- [Explicit](https://en.wikipedia.org/wiki/FTPS#Explicit) & [Implicit](https://en.wikipedia.org/wiki/FTPS#Implicit) TLS connections
+- Promise based API
+
+## Install
+`npm install ftp-srv --save`
+
+## Usage
+
+```js
+// Quick start
+
+const FtpSrv = require('ftp-srv');
+const ftpServer = new FtpSrv({ options ... });
+
+ftpServer.on('login', (data, resolve, reject) => { ... });
+...
+
+ftpServer.listen()
+.then(() => { ... });
+```
+
+## API
+
+### `new FtpSrv({options})`
+#### url
+[URL string](https://nodejs.org/api/url.html#url_url_strings_and_url_objects) indicating the protocol, hostname, and port to listen on for connections.
+Supported protocols:
+- `ftp` Plain FTP
+- `ftps` Implicit FTP over TLS
+
+_Note:_ The hostname must be the external IP address to accept external connections. `0.0.0.0` will listen on any available hosts for server and passive connections.  
+__Default:__ `"ftp://127.0.0.1:21"`
+
+#### `pasv_url`
+The hostname to provide a client when attempting a passive connection (`PASV`). This defaults to the provided `url` hostname.
+
+__Default:__ `"127.0.0.1"`
+
+#### `pasv_min`
+Tne starting port to accept passive connections.  
+__Default:__ `1024`
+
+#### `pasv_max`
+The ending port to accept passive connections.  
+The range is then queried for an available port to use when required.  
+__Default:__ `65535`
+
+#### `greeting`
+A human readable array of lines or string to send when a client connects.  
+__Default:__ `null`
+
+#### `tls`
+Node [TLS secure context object](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) used for implicit (`ftps` protocol) or explicit (`AUTH TLS`) connections.  
+__Default:__ `false`
+
+#### `anonymous`
+If true, will allow clients to authenticate using the username `anonymous`, not requiring a password from the user.  
+Can also set as a string which allows users to authenticate using the username provided.  
+The `login` event is then sent with the provided username and `@anonymous` as the password.  
+__Default:__ `false`
+
+#### `blacklist`
+Array of commands that are not allowed.  
+Response code `502` is sent to clients sending one of these commands.  
+__Example:__ `['RMD', 'RNFR', 'RNTO']` will not allow users to delete directories or rename any files.  
+__Default:__ `[]`
+
+#### `whitelist`
+Array of commands that are only allowed.  
+Response code `502` is sent to clients sending any other command.  
+__Default:__ `[]`
+
+#### `file_format`
+Sets the format to use for file stat queries such as `LIST`.  
+__Default:__ `"ls"`  
+__Allowable values:__
+  - `ls` [bin/ls format](https://cr.yp.to/ftp/list/binls.html)
+  - `ep` [Easily Parsed LIST format](https://cr.yp.to/ftp/list/eplf.html)
+  - `function () {}` A custom function returning a format or promise for one.
+    - Only one argument is passed in: a node [file stat](https://nodejs.org/api/fs.html#fs_class_fs_stats) object with additional file `name` parameter
+
+#### `log`
+A [bunyan logger](https://github.com/trentm/node-bunyan) instance. Created by default.
+
+#### `timeout`
+Sets the timeout (in ms) after that an idle connection is closed by the server  
+__Default:__ `0`
+
+## CLI
+
+`ftp-srv` also comes with a builtin CLI.
+
+```bash
+$ ftp-srv [url] [options]
+```
+
+```bash
+$ ftp-srv ftp://0.0.0.0:9876 --root ~/Documents
+```
+
+#### `url`
+
+Set the listening URL.
+
+Defaults to `ftp://127.0.0.1:21`
+
+#### `--root` / `-r`
+
+Set the default root directory for users.
+
+Defaults to the current directory.
+
+#### `--credentials` / `-c`
+
+Set the path to a json credentials file.
+
+Format:
+
+```js
+[
+  {
+    "username": "...",
+    "password": "...",
+    "root": "..." // Root directory
+  },
+  ...
+]
+```
+
+#### `--username`
+
+Set the username for the only user. Do not provide an argument to allow anonymous login.
+
+#### `--password`
+
+Set the password for the given `username`.
+
+## Events
+
+The `FtpSrv` class extends the [node net.Server](https://nodejs.org/api/net.html#net_class_net_server). Some custom events can be resolved or rejected, such as `login`.
+
+### `login`
+```js
+ftpServer.on('login', ({connection, username, password}, resolve, reject) => { ... });
+```
+
+Occurs when a client is attempting to login. Here you can resolve the login request by username and password.
+
+`connection` [client class object](src/connection.js)  
+`username` string of username from `USER` command  
+`password` string of password from `PASS` command  
+`resolve` takes an object of arguments:  
+- `fs`
+  - Set a custom file system class for this connection to use.
+  - See [File System](#file-system) for implementation details.
+- `root`
+  - If `fs` is not provided, this will set the root directory for the connection.
+  - The user cannot traverse lower than this directory.
+- `cwd`
+  - If `fs` is not provided, will set the starting directory for the connection
+  - This is relative to the `root` directory.
+- `blacklist`
+  - Commands that are forbidden for only this connection
+- `whitelist`
+  - If set, this connection will only be able to use the provided commands
+
+`reject` takes an error object
+
+### `client-error`
+```js
+ftpServer.on('client-error', ({connection, context, error}) => { ... });
+```
+
+Occurs when an error arises in the client connection.
+
+`connection` [client class object](src/connection.js)  
+`context` string of where the error occurred  
+`error` error object
+
+### `RETR`
+```js
+connection.on('RETR', (error, filePath) => { ... });
+```
+
+Occurs when a file is downloaded.
+
+`error` if successful, will be `null`  
+`filePath` location to which file was downloaded
+
+### `STOR`
+```js
+connection.on('STOR', (error, fileName) => { ... });
+```
+
+Occurs when a file is uploaded.
+
+`error` if successful, will be `null`  
+`fileName` name of the file that was uploaded
+
+### `RNTO`
+```js
+connection.on('RNTO', (error, fileName) => { ... });
+```
+
+Occurs when a file is renamed.
+
+`error` if successful, will be `null`  
+`fileName` name of the file that was renamed
+
+## Supported Commands
+
+See the [command registry](src/commands/registration) for a list of all implemented FTP commands.
+
+## File System
+The default [file system](src/fs.js) can be overwritten to use your own implementation.  
+This can allow for virtual file systems, and more.  
+Each connection can set it's own file system based on the user.  
+
+The default file system is exported and can be extended as needed:  
+```js
+const {FtpSrv, FileSystem} = require('ftp-srv');
+
+class MyFileSystem extends FileSystem {
+  constructor() {
+    super(...arguments);
+  }
+
+  get(fileName) {
+    ...
+  }
+}
+```
+
+Custom file systems can implement the following variables depending on the developers needs:
+
+### Methods
+#### [`currentDirectory()`](src/fs.js#L40)
+Returns a string of the current working directory  
+__Used in:__ `PWD`
+
+#### [`get(fileName)`](src/fs.js#L44)
+Returns a file stat object of file or directory  
+__Used in:__ `LIST`, `NLST`, `STAT`, `SIZE`, `RNFR`, `MDTM`
+
+#### [`list(path)`](src/fs.js#L50)
+Returns array of file and directory stat objects  
+__Used in:__ `LIST`, `NLST`, `STAT`
+
+#### [`chdir(path)`](src/fs.js#L67)
+Returns new directory relative to current directory  
+__Used in:__ `CWD`, `CDUP`
+
+#### [`mkdir(path)`](src/fs.js#L114)
+Returns a path to a newly created directory  
+__Used in:__ `MKD`
+
+#### [`write(fileName, {append, start})`](src/fs.js#L79)
+Returns a writable stream  
+Options:  
+ `append` if true, append to existing file  
+ `start` if set, specifies the byte offset to write to  
+__Used in:__ `STOR`, `APPE`
+
+#### [`read(fileName, {start})`](src/fs.js#L90)
+Returns a readable stream  
+Options:  
+ `start` if set, specifies the byte offset to read from  
+__Used in:__ `RETR`
+
+#### [`delete(path)`](src/fs.js#L105)
+Delete a file or directory  
+__Used in:__ `DELE`
+
+#### [`rename(from, to)`](src/fs.js#L120)
+Renames a file or directory  
+__Used in:__ `RNFR`, `RNTO`
+
+#### [`chmod(path)`](src/fs.js#L126)
+Modifies a file or directory's permissions  
+__Used in:__ `SITE CHMOD`
+
+#### [`getUniqueName()`](src/fs.js#L131)
+Returns a unique file name to write to  
+__Used in:__ `STOU`
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Contributors
+
+- [OzairP](https://github.com/OzairP)
+- [TimLuq](https://github.com/TimLuq)
+- [crabl](https://github.com/crabl)
+- [hirviid](https://github.com/hirviid)
+- [DiegoRBaquero](https://github.com/DiegoRBaquero)
+- [edin-m](https://github.com/edin-m)
+- [voxsoftware](https://github.com/voxsoftware)
+- [jorinvo](https://github.com/jorinvo)
+- [Johnnyrook777](https://github.com/Johnnyrook777)
+- [qchar](https://github.com/qchar)
+- [mikejestes](https://github.com/mikejestes)
+- [pkeuter](https://github.com/pkeuter)
+- [qiansc](https://github.com/qiansc)
+- [broofa](https://github.com/broofa)
+- [lafin](https://github.com/lafin)
+- [alancnet](https://github.com/alancnet)
+- [zgwit](https://github.com/zgwit)
+
+## License
+
+This software is licensed under the MIT Licence. See [LICENSE](LICENSE).
+
+## References
+
+- [https://cr.yp.to/ftp.html](https://cr.yp.to/ftp.html)

old/bin/index.js

@@ -19,7 +19,8 @@ function setupYargs() {
     })
     .option('username', {
       describe: 'Blank for anonymous',
-      type: 'string'
+      type: 'string',
+      default: ''
     })
     .option('password', {
       describe: 'Password for given username',
@@ -36,6 +37,20 @@ function setupYargs() {
       boolean: true,
       default: false
     })
+    .option('pasv_url', {
+      describe: 'URL to provide for passive connections',
+      type: 'string'
+    })
+    .option('pasv_min', {
+      describe: 'Starting point to use when creating passive connections',
+      type: 'number',
+      default: 1024
+    })
+    .option('pasv_max', {
+      describe: 'Ending port to use when creating passive connections',
+      type: 'number',
+      default: 65535
+    })
     .parse();
 }
 
@@ -46,15 +61,18 @@ function setupState(_args) {
     if (_args._ && _args._.length > 0) {
       _state.url = _args._[0];
     }
+    _state.pasv_url = _args.pasv_url;
+    _state.pasv_min = _args.pasv_min;
+    _state.pasv_max = _args.pasv_max;
     _state.anonymous = _args.username === '';
   }
 
   function setupRoot() {
     const dirPath = _args.root;
     if (dirPath) {
-      _state.root = process.cwd();
-    } else {
       _state.root = dirPath;
+    } else {
+      _state.root = process.cwd();
     }
   }
 
@@ -95,17 +113,25 @@ function setupState(_args) {
 }
 
 function startFtpServer(_state) {
+  // Remove null/undefined options so they get set to defaults, below
+  for (const key in _state) {
+    if (_state[key] === undefined) delete _state[key];
+  }
 
   function checkLogin(data, resolve, reject) {
-    const user = _state.credentials[data.username]
-    if (_state.anonymous || (user && user.password === data.password)) {
-      return resolve({root: (user && user.root) || _state.root});
+    const user = _state.credentials[data.username];
+    if (_state.anonymous || user && user.password === data.password) {
+      return resolve({root: user && user.root || _state.root});
     }
 
     return reject(new errors.GeneralError('Invalid username or password', 401));
   }
 
-  const ftpServer = new FtpSrv(_state.url, {
+  const ftpServer = new FtpSrv({
+    url: _state.url,
+    pasv_url: _state.pasv_url,
+    pasv_min: _state.pasv_min,
+    pasv_max: _state.pasv_max,
     anonymous: _state.anonymous,
     blacklist: _state.blacklist
   });

old/ftp-srv.d.ts

@@ -62,13 +62,15 @@ export interface FtpServerOptions {
     url?: string,
     pasv_min?: number,
     pasv_max?: number,
+    pasv_url?: string,
     greeting?: string | string[],
-    tls?: tls.SecureContext | false,
+    tls?: tls.SecureContextOptions | false,
     anonymous?: boolean,
     blacklist?: Array<string>,
     whitelist?: Array<string>,
     file_format?: (stat: Stats) => string | Promise<string> | "ls" | "ep",
-    log?: any,
+	log?: any,
+	timeout?: number
 }
 
 export class FtpServer extends EventEmitter {
@@ -110,6 +112,13 @@ export class FtpServer extends EventEmitter {
             whitelist?: Array<string>
         }) => void,
 		reject: (err?: Error) => void
+  ) => void): this;
+
+	on(event: "disconnect", listener: (
+		data: {
+      connection: FtpConnection,
+      id: string
+		}
 	) => void): this;
 
 	on(event: "client-error", listener: (

old/meta/contributors/contributors.js

@@ -0,0 +1,27 @@
+const {get} = require('https');
+
+get('https://api.github.com/repos/trs/ftp-srv/contributors', {
+  headers: {
+    'User-Agent': 'Chrome'
+  }
+}, (res) => {
+  let response = '';
+  res.on('data', (data) => {
+    response += data;
+  });
+  res.on('end', () => {
+    const contributors = JSON.parse(response)
+      .filter((contributor) => contributor.type === 'User');
+
+    for (const contributor of contributors) {
+      const url = contributor.html_url;
+      const username = contributor.login;
+
+      const markdown = `- [${username}](${url})\n`;
+
+      process.stdout.write(markdown);
+    }
+  });
+}).on('error', (err) => {
+  process.stderr.write(err);
+});

old/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "ftp-srv",
+  "version": "0.0.0",
+  "description": "Modern, extensible FTP Server",
+  "keywords": [
+    "ftp",
+    "ftp-server",
+    "ftp-srv",
+    "ftp-svr",
+    "ftpd",
+    "ftpserver",
+    "server"
+  ],
+  "license": "MIT",
+  "files": [
+    "src",
+    "bin",
+    "ftp-srv.d.ts"
+  ],
+  "main": "ftp-srv.js",
+  "bin": "./bin/index.js",
+  "types": "./ftp-srv.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trs/ftp-srv"
+  },
+  "scripts": {
+    "pre-release": "npm run verify",
+    "semantic-release": "semantic-release",
+    "test": "mocha test/**/*.spec.js test/*.spec.js --ui bdd",
+    "verify": "eslint src/**/*.js test/**/*.js bin/**/*.js"
+  },
+  "release": {
+    "verifyConditions": "condition-circle"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "eslintConfig": {
+    "extends": "eslint:recommended",
+    "env": {
+      "node": true,
+      "mocha": true,
+      "es6": true
+    },
+    "parserOptions": {
+      "ecmaVersion": 6,
+      "sourceType": "module"
+    }
+  },
+  "dependencies": {
+    "bluebird": "^3.5.1",
+    "bunyan": "^1.8.12",
+    "ip": "^1.1.5",
+    "lodash": "^4.17.15",
+    "moment": "^2.22.1",
+    "uuid": "^3.2.1",
+    "yargs": "^11.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^8.1.0",
+    "@commitlint/config-conventional": "^8.1.0",
+    "@icetee/ftp": "^1.0.2",
+    "chai": "^4.2.0",
+    "condition-circle": "^2.0.2",
+    "eslint": "^5.14.1",
+    "husky": "^1.3.1",
+    "lint-staged": "^8.1.4",
+    "mocha": "^5.2.0",
+    "rimraf": "^2.6.1",
+    "semantic-release": "^15.13.24",
+    "sinon": "^2.3.5"
+  },
+  "engines": {
+    "node": ">=6.x"
+  }
+}

old/src/commands/index.js

@@ -45,7 +45,7 @@ class FtpCommands {
     log.trace({command: logCommand}, 'Handle command');
 
     if (!REGISTRY.hasOwnProperty(command.directive)) {
-      return this.connection.reply(402, 'Command not allowed');
+      return this.connection.reply(502, 'Command not allowed');
     }
 
     if (_.includes(this.blacklist, command.directive)) {

old/src/commands/registration/list.js

@@ -36,6 +36,7 @@ module.exports = {
     .tap(() => this.reply(150))
     .then((fileList) => {
       if (fileList.length) return this.reply({}, ...fileList);
+      return this.reply({socket: this.connector.socket, useEmptyMessage: true});
     })
     .tap(() => this.reply(226))
     .catch(Promise.TimeoutError, (err) => {

old/src/commands/registration/opts.js

@@ -13,7 +13,7 @@ module.exports = {
     const [_option, ...args] = command.arg.split(' ');
     const option = _.toUpper(_option);
 
-    if (!OPTIONS.hasOwnProperty(option)) return this.reply(500);
+    if (!OPTIONS.hasOwnProperty(option)) return this.reply(501, 'Unknown option command');
     return OPTIONS[option].call(this, args);
   },
   syntax: '{{cmd}}',
@@ -33,7 +33,6 @@ function utf8([setting] = []) {
   if (!encoding) return this.reply(501, 'Unknown setting for option');
 
   this.encoding = encoding;
-  if (this.transferType !== 'binary') this.transferType = this.encoding;
 
   return this.reply(200, `UTF8 encoding ${_.toLower(setting)}`);
 }

old/src/commands/registration/pasv.js

@@ -1,18 +1,31 @@
 const PassiveConnector = require('../../connector/passive');
+const {isLocalIP} = require('../../helpers/is-local');
 
 module.exports = {
   directive: 'PASV',
-  handler: function () {
+  handler: function ({log} = {}) {
+    if (!this.server.options.pasv_url) {
+      return this.reply(502);
+    }
+
     this.connector = new PassiveConnector(this);
     return this.connector.setupServer()
     .then((server) => {
-      const address = this.server.options.pasv_url;
+      let address = this.server.options.pasv_url;
+      // Allow connecting from local
+      if (isLocalIP(this.ip)) {
+        address = this.ip;
+      }
       const {port} = server.address();
       const host = address.replace(/\./g, ',');
       const portByte1 = port / 256 | 0;
       const portByte2 = port % 256;
 
       return this.reply(227, `PASV OK (${host},${portByte1},${portByte2})`);
+    })
+    .catch((err) => {
+      log.error(err);
+      return this.reply(425);
     });
   },
   syntax: '{{cmd}}',

old/src/commands/registration/port.js

@@ -3,7 +3,7 @@ const ActiveConnector = require('../../connector/active');
 
 module.exports = {
   directive: 'PORT',
-  handler: function ({command} = {}) {
+  handler: function ({log, command} = {}) {
     this.connector = new ActiveConnector(this);
 
     const rawConnection = _.get(command, 'arg', '').split(',');
@@ -14,7 +14,11 @@ module.exports = {
     const port = portBytes[0] * 256 + portBytes[1];
 
     return this.connector.setupConnection(ip, port)
-    .then(() => this.reply(200));
+    .then(() => this.reply(200))
+    .catch((err) => {
+      log.error(err);
+      return this.reply(425);
+    });
   },
   syntax: '{{cmd}} <x>,<x>,<x>,<x>,<y>,<y>',
   description: 'Specifies an address and port to which the server should connect'

old/src/commands/registration/retr.js

@@ -28,7 +28,7 @@ module.exports = {
         stream.on('data', (data) => {
           if (stream) stream.pause();
           if (this.connector.socket) {
-            this.connector.socket.write(data, this.transferType, () => stream && stream.resume());
+            this.connector.socket.write(data, () => stream && stream.resume());
           }
         });
         stream.once('end', () => resolve());

old/src/commands/registration/rnto.js

@@ -15,8 +15,10 @@ module.exports = {
     .then(() => {
       return this.reply(250);
     })
+    .tap(() => this.emit('RNTO', null, to))
     .catch((err) => {
       log.error(err);
+      this.emit('RNTO', err);
       return this.reply(550, err.message);
     })
     .finally(() => {

old/src/commands/registration/stor.js

@@ -21,11 +21,14 @@ module.exports = {
       const serverPath = stream.path || fileName;
 
       const destroyConnection = (connection, reject) => (err) => {
-        if (connection) {
-          if (connection.writeable) connection.end();
-          connection.destroy(err);
+        try {
+          if (connection) {
+            if (connection.writable) connection.end();
+            connection.destroy(err);
+          }
+        } finally {
+          reject(err);
         }
-        reject(err);
       };
 
       const streamPromise = new Promise((resolve, reject) => {
@@ -36,8 +39,8 @@ module.exports = {
       const socketPromise = new Promise((resolve, reject) => {
         this.connector.socket.on('data', (data) => {
           if (this.connector.socket) this.connector.socket.pause();
-          if (stream) {
-            stream.write(data, this.transferType, () => this.connector.socket && this.connector.socket.resume());
+          if (stream && stream.writable) {
+            stream.write(data, () => this.connector.socket && this.connector.socket.resume());
           }
         });
         this.connector.socket.once('end', () => {

old/src/connection.js

@@ -30,7 +30,10 @@ class FtpConnection extends EventEmitter {
       this.server.emit('client-error', {connection: this, context: 'commandSocket', error: err});
     });
     this.commandSocket.on('data', this._handleData.bind(this));
-    this.commandSocket.on('timeout', () => {});
+    this.commandSocket.on('timeout', () => {
+      this.log.trace('Client timeout');
+      this.close().catch((e) => this.log.trace(e, 'Client close error'));
+    });
     this.commandSocket.on('close', () => {
       if (this.connector) this.connector.end();
       if (this.commandSocket && !this.commandSocket.destroyed) this.commandSocket.destroy();
@@ -101,15 +104,21 @@ class FtpConnection extends EventEmitter {
           else if (typeof letter === 'string') letter = {message: letter}; // allow passing in message as first param
 
           if (!letter.socket) letter.socket = options.socket ? options.socket : this.commandSocket;
-          if (!letter.message) letter.message = DEFAULT_MESSAGE[options.code] || 'No information';
-          if (!letter.encoding) letter.encoding = this.encoding;
+          if (!options.useEmptyMessage) {
+            if (!letter.message) letter.message = DEFAULT_MESSAGE[options.code] || 'No information';
+            if (!letter.encoding) letter.encoding = this.encoding;
+          }
           return Promise.resolve(letter.message) // allow passing in a promise as a message
           .then((message) => {
-            const seperator = !options.hasOwnProperty('eol') ?
-              letters.length - 1 === index ? ' ' : '-' :
-              options.eol ? ' ' : '-';
-            message = !letter.raw ? _.compact([letter.code || options.code, message]).join(seperator) : message;
-            letter.message = message;
+            if (!options.useEmptyMessage) {
+              const seperator = !options.hasOwnProperty('eol') ?
+                letters.length - 1 === index ? ' ' : '-' :
+                options.eol ? ' ' : '-';
+              message = !letter.raw ? _.compact([letter.code || options.code, message]).join(seperator) : message;
+              letter.message = message;
+            } else {
+              letter.message = '';
+            }
             return letter;
           });
         });

old/src/connector/active.js

@@ -28,7 +28,6 @@ class Active extends Connector {
     return closeExistingServer()
     .then(() => {
       this.dataSocket = new Socket();
-      this.dataSocket.setEncoding(this.connection.transferType);
       this.dataSocket.on('error', (err) => this.server && this.server.emit('client-error', {connection: this.connection, context: 'dataSocket', error: err}));
       this.dataSocket.connect({host, port, family}, () => {
         this.dataSocket.pause();

old/src/connector/passive.js

@@ -6,6 +6,8 @@ const Promise = require('bluebird');
 const Connector = require('./base');
 const errors = require('../errors');
 
+const CONNECT_TIMEOUT = 30 * 1000;
+
 class Passive extends Connector {
   constructor(connection) {
     super(connection);
@@ -30,6 +32,9 @@ class Passive extends Connector {
     this.closeServer();
     return this.server.getNextPasvPort()
     .then((port) => {
+      this.dataSocket = null;
+      let idleServerTimeout;
+
       const connectionHandler = (socket) => {
         if (!ip.isEqual(this.connection.commandSocket.remoteAddress, socket.remoteAddress)) {
           this.log.error({
@@ -41,19 +46,19 @@ class Passive extends Connector {
           return this.connection.reply(550, 'Remote addresses do not match')
           .finally(() => this.connection.close());
         }
+        clearTimeout(idleServerTimeout);
+
         this.log.trace({port, remoteAddress: socket.remoteAddress}, 'Passive connection fulfilled.');
 
         this.dataSocket = socket;
-        this.dataSocket.setEncoding(this.connection.transferType);
         this.dataSocket.on('error', (err) => this.server && this.server.emit('client-error', {connection: this.connection, context: 'dataSocket', error: err}));
+        this.dataSocket.once('close', () => this.closeServer());
 
         if (!this.connection.secure) {
           this.dataSocket.connected = true;
         }
       };
 
-      this.dataSocket = null;
-
       const serverOptions = Object.assign({}, this.connection.secure ? this.server.options.tls : {}, {pauseOnConnect: true});
       this.dataServer = (this.connection.secure ? tls : net).createServer(serverOptions, connectionHandler);
       this.dataServer.maxConnections = 1;
@@ -74,6 +79,8 @@ class Passive extends Connector {
         this.dataServer.listen(port, this.server.url.hostname, (err) => {
           if (err) reject(err);
           else {
+            idleServerTimeout = setTimeout(() => this.closeServer(), CONNECT_TIMEOUT);
+
             this.log.debug({port}, 'Passive connection listening');
             resolve(this.dataServer);
           }

old/src/fs.js

@@ -2,13 +2,14 @@ const _ = require('lodash');
 const nodePath = require('path');
 const uuid = require('uuid');
 const Promise = require('bluebird');
-const fs = Promise.promisifyAll(require('fs'));
+const {createReadStream, createWriteStream, constants} = require('fs');
+const fsAsync = require('./helpers/fs-async');
 const errors = require('./errors');
 
 class FileSystem {
   constructor(connection, {root, cwd} = {}) {
     this.connection = connection;
-    this.cwd = cwd ? nodePath.join(nodePath.sep, cwd) : nodePath.sep;
+    this.cwd = nodePath.normalize(cwd ? nodePath.join(nodePath.sep, cwd) : nodePath.sep);
     this._root = nodePath.resolve(root || process.cwd());
   }
 
@@ -27,8 +28,8 @@ class FileSystem {
     })();
 
     const fsPath = (() => {
-      const resolvedPath = nodePath.resolve(this.root, `.${nodePath.sep}${clientPath}`);
-      return nodePath.join(resolvedPath);
+      const resolvedPath = nodePath.join(this.root, clientPath);
+      return nodePath.resolve(nodePath.normalize(nodePath.join(resolvedPath)));
     })();
 
     return {
@@ -43,19 +44,19 @@ class FileSystem {
 
   get(fileName) {
     const {fsPath} = this._resolvePath(fileName);
-    return fs.statAsync(fsPath)
+    return fsAsync.stat(fsPath)
     .then((stat) => _.set(stat, 'name', fileName));
   }
 
   list(path = '.') {
     const {fsPath} = this._resolvePath(path);
-    return fs.readdirAsync(fsPath)
+    return fsAsync.readdir(fsPath)
     .then((fileNames) => {
       return Promise.map(fileNames, (fileName) => {
         const filePath = nodePath.join(fsPath, fileName);
-        return fs.accessAsync(filePath, fs.constants.F_OK)
+        return fsAsync.access(filePath, constants.F_OK)
         .then(() => {
-          return fs.statAsync(filePath)
+          return fsAsync.stat(filePath)
           .then((stat) => _.set(stat, 'name', fileName));
         })
         .catch(() => null);
@@ -66,7 +67,7 @@ class FileSystem {
 
   chdir(path = '.') {
     const {fsPath, clientPath} = this._resolvePath(path);
-    return fs.statAsync(fsPath)
+    return fsAsync.stat(fsPath)
     .tap((stat) => {
       if (!stat.isDirectory()) throw new errors.FileSystemError('Not a valid directory');
     })
@@ -78,8 +79,8 @@ class FileSystem {
 
   write(fileName, {append = false, start = undefined} = {}) {
     const {fsPath, clientPath} = this._resolvePath(fileName);
-    const stream = fs.createWriteStream(fsPath, {flags: !append ? 'w+' : 'a+', start});
-    stream.once('error', () => fs.unlinkAsync(fsPath));
+    const stream = createWriteStream(fsPath, {flags: !append ? 'w+' : 'a+', start});
+    stream.once('error', () => fsAsync.unlink(fsPath));
     stream.once('close', () => stream.end());
     return {
       stream,
@@ -89,12 +90,12 @@ class FileSystem {
 
   read(fileName, {start = undefined} = {}) {
     const {fsPath, clientPath} = this._resolvePath(fileName);
-    return fs.statAsync(fsPath)
+    return fsAsync.stat(fsPath)
     .tap((stat) => {
       if (stat.isDirectory()) throw new errors.FileSystemError('Cannot read a directory');
     })
     .then(() => {
-      const stream = fs.createReadStream(fsPath, {flags: 'r', start});
+      const stream = createReadStream(fsPath, {flags: 'r', start});
       return {
         stream,
         clientPath
@@ -104,28 +105,28 @@ class FileSystem {
 
   delete(path) {
     const {fsPath} = this._resolvePath(path);
-    return fs.statAsync(fsPath)
+    return fsAsync.stat(fsPath)
     .then((stat) => {
-      if (stat.isDirectory()) return fs.rmdirAsync(fsPath);
-      else return fs.unlinkAsync(fsPath);
+      if (stat.isDirectory()) return fsAsync.rmdir(fsPath);
+      else return fsAsync.unlink(fsPath);
     });
   }
 
   mkdir(path) {
     const {fsPath} = this._resolvePath(path);
-    return fs.mkdirAsync(fsPath)
+    return fsAsync.mkdir(fsPath)
     .then(() => fsPath);
   }
 
   rename(from, to) {
     const {fsPath: fromPath} = this._resolvePath(from);
     const {fsPath: toPath} = this._resolvePath(to);
-    return fs.renameAsync(fromPath, toPath);
+    return fsAsync.rename(fromPath, toPath);
   }
 
   chmod(path, mode) {
     const {fsPath} = this._resolvePath(path);
-    return fs.chmodAsync(fsPath, mode);
+    return fsAsync.chmod(fsPath, mode);
   }
 
   getUniqueName() {

old/src/helpers/find-port.js

@@ -0,0 +1,61 @@
+const net = require('net');
+const errors = require('../errors');
+
+const MAX_PORT = 65535;
+const MAX_PORT_CHECK_ATTEMPT = 5;
+
+function* portNumberGenerator(min, max = MAX_PORT) {
+  let current = min;
+  while (true) {
+    if (current > MAX_PORT || current > max) {
+      current = min;
+    }
+    yield current++;
+  }
+}
+
+function getNextPortFactory(host, portMin, portMax, maxAttempts = MAX_PORT_CHECK_ATTEMPT) {
+  const nextPortNumber = portNumberGenerator(portMin, portMax);
+
+  return () => new Promise((resolve, reject) => {
+    const portCheckServer = net.createServer();
+    portCheckServer.maxConnections = 0;
+
+    let attemptCount = 0;
+    const tryGetPort = () => {
+      attemptCount++;
+      if (attemptCount > maxAttempts) {
+        reject(new errors.ConnectorError('Unable to find valid port'));
+        return;
+      }
+
+      const {value: port} = nextPortNumber.next();
+
+      portCheckServer.removeAllListeners();
+      portCheckServer.once('error', (err) => {
+        if (['EADDRINUSE'].includes(err.code)) {
+          tryGetPort();
+        } else {
+          reject(err);
+        }
+      });
+      portCheckServer.once('listening', () => {
+        portCheckServer.removeAllListeners();
+        portCheckServer.close(() => resolve(port));
+      });
+
+      try {
+        portCheckServer.listen(port, host);
+      } catch (err) {
+        reject(err);
+      }
+    };
+
+    tryGetPort();
+  });
+}
+
+module.exports = {
+  getNextPortFactory,
+  portNumberGenerator
+};

old/src/helpers/fs-async.js

@@ -0,0 +1,18 @@
+const fs = require('fs');
+const {promisify} = require('bluebird');
+
+const methods = [
+  'stat',
+  'readdir',
+  'access',
+  'unlink',
+  'rmdir',
+  'mkdir',
+  'rename',
+  'chmod'
+];
+
+module.exports = methods.reduce((obj, method) => {
+  obj[method] = promisify(fs[method]);
+  return obj;
+}, {});

old/src/helpers/is-local.js

@@ -0,0 +1,3 @@
+module.exports.isLocalIP = function(ip) {
+  return ip === '127.0.0.1' || ip == '::1';
+}

old/src/index.js

@@ -7,7 +7,6 @@ const tls = require('tls');
 const EventEmitter = require('events');
 
 const Connection = require('./connection');
-const resolveHost = require('./helpers/resolve-host');
 const {getNextPortFactory} = require('./helpers/find-port');
 
 class FtpServer extends EventEmitter {
@@ -24,7 +23,8 @@ class FtpServer extends EventEmitter {
       blacklist: [],
       whitelist: [],
       greeting: null,
-      tls: false
+      tls: false,
+      timeout: 0
     }, options);
 
     this._greeting = this.setupGreeting(this.options.greeting);
@@ -36,10 +36,15 @@ class FtpServer extends EventEmitter {
     this.log = this.options.log;
     this.url = nodeUrl.parse(this.options.url);
     this.getNextPasvPort = getNextPortFactory(
+      _.get(this, 'url.hostname'),
       _.get(this, 'options.pasv_min'),
       _.get(this, 'options.pasv_max'));
 
+    const timeout = Number(this.options.timeout);
+    this.options.timeout = isNaN(timeout) ? 0 : Number(timeout);
+
     const serverConnectionHandler = (socket) => {
+      socket.setTimeout(this.options.timeout);
       let connection = new Connection(this, {log: this.log, socket});
       this.connections[connection.id] = connection;
 
@@ -48,7 +53,7 @@ class FtpServer extends EventEmitter {
       const greeting = this._greeting || [];
       const features = this._features || 'Ready';
       return connection.reply(220, ...greeting, features)
-      .finally(() => socket.resume());
+        .finally(() => socket.resume());
     };
     const serverOptions = Object.assign({}, this.isTLS ? this.options.tls : {}, {pauseOnConnect: true});
 
@@ -67,22 +72,21 @@ class FtpServer extends EventEmitter {
   }
 
   listen() {
-    return resolveHost(this.options.pasv_url || this.url.hostname)
-    .then((pasvUrl) => {
-      this.options.pasv_url = pasvUrl;
+    if (!this.options.pasv_url) {
+      this.log.warn('Passive URL not set. Passive connections not available.');
+    }
 
-      return new Promise((resolve, reject) => {
-        this.server.once('error', reject);
-        this.server.listen(this.url.port, this.url.hostname, (err) => {
-          this.server.removeListener('error', reject);
-          if (err) return reject(err);
-          this.log.info({
-            protocol: this.url.protocol.replace(/\W/g, ''),
-            ip: this.url.hostname,
-            port: this.url.port
-          }, 'Listening');
-          resolve('Listening');
-        });
+    return new Promise((resolve, reject) => {
+      this.server.once('error', reject);
+      this.server.listen(this.url.port, this.url.hostname, (err) => {
+        this.server.removeListener('error', reject);
+        if (err) return reject(err);
+        this.log.info({
+          protocol: this.url.protocol.replace(/\W/g, ''),
+          ip: this.url.hostname,
+          port: this.url.port
+        }, 'Listening');
+        resolve('Listening');
       });
     });
   }
@@ -115,6 +119,7 @@ class FtpServer extends EventEmitter {
     return new Promise((resolve) => {
       const client = this.connections[id];
       if (!client) return resolve();
+      this.emit('disconnect', {connection: client, id});
       delete this.connections[id];
       try {
         client.close(0);

old/test/commands/index.spec.js

@@ -90,7 +90,7 @@ describe('FtpCommands', function () {
       return commands.handle('bad')
       .then(() => {
         expect(mockConnection.reply.callCount).to.equal(1);
-        expect(mockConnection.reply.args[0][0]).to.equal(402);
+        expect(mockConnection.reply.args[0][0]).to.equal(502);
       });
     });