aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2015-06-08 13:59:20 +0200
committerHans Nilsson <[email protected]>2015-06-08 13:59:20 +0200
commit2ce77297d3475448d2f969b851ddaaa6c4c2e4e2 (patch)
tree5285a0e4e79add4e61e194f9af9e8c3f0aae3471
parent9ff377471267934cb222a5468e413ed00e12ace1 (diff)
downloadotp-2ce77297d3475448d2f969b851ddaaa6c4c2e4e2.tar.gz
otp-2ce77297d3475448d2f969b851ddaaa6c4c2e4e2.tar.bz2
otp-2ce77297d3475448d2f969b851ddaaa6c4c2e4e2.zip
ssh: add missing doc for option auth_method_kb_interactive_data
-rw-r--r--lib/ssh/doc/src/ssh.xml16
1 files changed, 15 insertions, 1 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 0516945c0e..4d2d68f460 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -360,7 +360,7 @@ kex is implicit but public_key is set explicitly.</p>
an own CLI channel. If set to <c>no_cli</c>, the CLI channels
are disabled and only subsystem channels are allowed.</p>
</item>
- <tag><c><![CDATA[{user_dir, String}]]></c></tag>
+ <tag><c><![CDATA[{user_dir, string()}]]></c></tag>
<item>
<p>Sets the user directory. That is, the directory containing
<c>ssh</c> configuration files for the user, such as
@@ -377,6 +377,7 @@ kex is implicit but public_key is set explicitly.</p>
<c><![CDATA[/etc/ssh]]></c>. For security reasons,
this directory is normally accessible only to the root user.</p>
</item>
+
<tag><c><![CDATA[{auth_methods, string()}]]></c></tag>
<item>
<p>Comma-separated string that determines which
@@ -384,6 +385,19 @@ kex is implicit but public_key is set explicitly.</p>
in what order they are tried. Defaults to
<c><![CDATA["publickey,keyboard-interactive,password"]]></c></p>
</item>
+
+ <tag><c><![CDATA[{auth_method_kb_interactive_data, PromptTexts}]]>
+ <br/>where:
+ <br/>PromptTexts = kb_int_tuple() | fun(PeerName::string(), User::string(), Service::string()) -> kb_int_tuple()
+ <br/>kb_int_tuple() = {Name::string(), Instruction::string(), Prompt::string(), Echo::boolean()}</c>
+ </tag>
+ <item>
+ <p>Sets the text strings that the daemon sends to the client for presentation to the user when using <c>keyboar-interactive</c> authentication. If the fun/3 is used, it is called when the actual authentication occurs and may therefore return dynamic data like time, remote ip etc.</p>
+ <p>The parameter <c>Echo</c> guides the client about need to hide the password.</p>
+ <p>The default value is:
+ <c>{auth_method_kb_interactive_data, {"SSH server", "Enter password for \""++User++"\"", "pwd: ", false}></c></p>
+ </item>
+
<tag><c><![CDATA[{user_passwords, [{string() = User,
string() = Password}]}]]></c></tag>
<item>