From b6cfbdc04c4b1bd81df08f66f4d3f6444cb3032c Mon Sep 17 00:00:00 2001
From: Lance Whatley <whatl3y@gmail.com>
Date: Thu, 25 Mar 2021 07:59:01 -0400
Subject: [PATCH] update README with info on none ctx.method

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 78d368bb..5f1e2558 100644
--- a/README.md
+++ b/README.md
@@ -606,6 +606,8 @@ new ssh2.Server({
         if (!checkValue(Buffer.from(ctx.password), allowedPassword))
           return ctx.reject();
         break;
+      case 'none':
+        return ctx.reject(['password']);
       default:
         return ctx.reject();
     }
@@ -994,6 +996,10 @@ You can find more examples in the `examples` directory of this repository.
 
 * **authentication**(< _AuthContext_ >ctx) - The client has requested authentication. `ctx.username` contains the client username, `ctx.method` contains the requested authentication method, and `ctx.accept()` and `ctx.reject([< Array >authMethodsLeft[, < Boolean >isPartialSuccess]])` are used to accept or reject the authentication request respectively. `abort` is emitted if the client aborts the authentication request. Other properties/methods available on `ctx` depends on the `ctx.method` of authentication the client has requested:
 
+    * `none`:
+
+        * This is sometimes used by SFTP clients to determine what methods are actually usable. In particular FileZilla and Cyberduck use this when initially connecting. You can pass such a list of methods as an array to ctx.reject(), ex. `ctx.reject(['password'])` would tell the client only the password method is available.
+
     * `password`:
 
         * **password** - _string_ - This is the password sent by the client.