From 7aef211a66219b6fef9d0bdaf9b09be6c2e0a32f Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Tue, 12 May 2015 17:03:28 +0200
Subject: ssh: option for handling the SSH_MSG_DEBUG message's printouts

A fun could be given in the options that will be called whenever
the SSH_MSG_DEBUG message arrives.  This enables the user to
format the printout or just discard it.

The default is changed to not print the message. In RFC4253
printing is a SHOULD, but our new default is to protect logs
from dos attacs.
---
 lib/ssh/doc/src/ssh.xml | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

(limited to 'lib/ssh/doc')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 72dafc0c09..501668ca78 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -201,6 +201,14 @@
 	  <tag><c><![CDATA[{idle_time, integer()}]]></c></tag>
 	  <item>
  	  <p>Sets a timeout on connection when no channels are active, default is infinity</p></item>
+
+	  <tag><c><![CDATA[{ssh_msg_debug_fun, fun(ConnectionRef::ssh_connection_ref(), AlwaysDisplay::boolean(), Msg::binary(), LanguageTag::binary()) -> _}]]></c></tag>
+	  <item>
+	    <p>Provide a fun to implement your own logging of the SSH message SSH_MSG_DEBUG. The last three parameters are from the message, see RFC4253, section 11.3. The <c>ConnectionRef</c> is the reference to the connection on which the message arrived. The return value from the fun is not checked.</p>
+	    <p>The default behaviour is ignore the message.
+	    To get a printout for each message with <c>AlwaysDisplay = true</c>, use for example <c>{ssh_msg_debug_fun, fun(_,true,M,_)-> io:format("DEBUG: ~p~n", [M]) end}</c></p>
+	  </item>
+
 	</taglist>
       </desc>   
     </func>
@@ -383,8 +391,16 @@
 	  <item>
 	    <p>Provide a fun to implement your own logging when a user disconnects from the server.</p>
 	  </item>
-        </taglist>
-      </desc>
+
+	  <tag><c><![CDATA[{ssh_msg_debug_fun, fun(ConnectionRef::ssh_connection_ref(), AlwaysDisplay::boolean(), Msg::binary(), LanguageTag::binary()) -> _}]]></c></tag>
+	  <item>
+	    <p>Provide a fun to implement your own logging of the SSH message SSH_MSG_DEBUG. The last three parameters are from the message, see RFC4253, section 11.3. The <c>ConnectionRef</c> is the reference to the connection on which the message arrived. The return value from the fun is not checked.</p>
+	    <p>The default behaviour is ignore the message.
+	    To get a printout for each message with <c>AlwaysDisplay = true</c>, use for example <c>{ssh_msg_debug_fun, fun(_,true,M,_)-> io:format("DEBUG: ~p~n", [M]) end}</c></p>
+	  </item>
+
+	</taglist>
+      </desc>   
     </func>
 
 
-- 
cgit v1.2.3