From 66c06dc602594b263225b5481d2abba653a3b5e8 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Tue, 12 May 2015 11:21:20 +0200 Subject: ssh: Align "=" sign in type declarations to decided policy --- lib/ssh/doc/src/ssh.xml | 43 +++++++++++++++++----------------- lib/ssh/doc/src/ssh_channel.xml | 32 ++++++++++++------------- lib/ssh/doc/src/ssh_client_key_api.xml | 20 ++++++++-------- lib/ssh/doc/src/ssh_connection.xml | 42 ++++++++++++++++----------------- lib/ssh/doc/src/ssh_server_key_api.xml | 24 +++++++++---------- lib/ssh/doc/src/ssh_sftp.xml | 4 ++-- lib/ssh/doc/src/ssh_sftpd.xml | 16 ++++++------- 7 files changed, 90 insertions(+), 91 deletions(-) (limited to 'lib/ssh/doc') diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index d49d3ac2a7..7cca84432e 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -57,29 +57,28 @@ this module, or abstractions to indicate the intended use of the data type, or both:

- boolean() -

= true | false

 - string() -

= [byte()]

 - ssh_daemon_ref() -

Opaque to the user, - returned by ssh:daemon/[1,2,3]

 - ssh_connection_ref() -

Opaque to the user, - returned by ssh:connect/3

 - ip_address() + boolean() = +

true | false

 + string() = +

[byte()]

 + ssh_daemon_ref() = +

opaque() - + as returned by ssh:daemon/[1,2,3]

 + ssh_connection_ref() = +

opaque() - as returned by ssh:connect/3

 + ip_address() =

inet::ip_address

 - subsystem_spec() -

= {subsystem_name(), - {channel_callback(), channel_init_args()}}

 - subsystem_name() -

= string()

 - channel_callback() -

= atom() - Name of the Erlang module - implementing the subsystem using the ssh_channel behavior, see - ssh_channel(3)

 - channel_init_args() -

= list()

 + subsystem_spec() = +

{subsystem_name(), + {channel_callback(), channel_init_args()}}

 + subsystem_name() = +

string()

 + channel_callback() = +

atom() - Name of the Erlang module + implementing the subsystem using the ssh_channel behavior, see + ssh_channel(3)

 + channel_init_args() = +

list()

 diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml index b8a03c350a..2fdecf9072 100644 --- a/lib/ssh/doc/src/ssh_channel.xml +++ b/lib/ssh/doc/src/ssh_channel.xml @@ -62,22 +62,22 @@ type, or both:

- boolean() -

= true | false

 - string() -

= list of ASCII characters

 - timeout() -

= infinity | integer() in milliseconds

 - ssh_connection_ref() -

Opaque to the user, returned by - ssh:connect/3 or sent to an SSH channel process

 - ssh_channel_id() -

= integer()

 - ssh_data_type_code() -

= 1 ("stderr") | 0 ("normal") are - the valid values, - see RFC 4254 - Section 5.2

 + boolean() = +

true | false

 + string() = +

list of ASCII characters

 + timeout() = +

infinity | integer() in milliseconds

 + ssh_connection_ref() = +

opaque() -as returned by + ssh:connect/3 or sent to an SSH channel process

 + ssh_channel_id() = +

integer()

 + ssh_data_type_code() = +

1 ("stderr") | 0 ("normal") are + the valid values, + see RFC 4254 + Section 5.2

 diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml index a8dda042c9..9a892d71fd 100644 --- a/lib/ssh/doc/src/ssh_client_key_api.xml +++ b/lib/ssh/doc/src/ssh_client_key_api.xml @@ -50,16 +50,16 @@ public_key user's guide:

- boolean() -

= true | false

 - string() -

= [byte()]

 - public_key() -

= #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 - private_key() -

= #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 - public_key_algorithm() -

= 'ssh-rsa'| 'ssh-dss' | atom()

 + boolean() = +

true | false

 + string() = +

[byte()]

 + public_key() = +

#'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 + private_key() = +

#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 + public_key_algorithm() = +

'ssh-rsa'| 'ssh-dss' | atom()

 diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 669a361db9..5422633dc3 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -56,29 +56,29 @@ type, or both:

- boolean() -

= true | false

- string() -

= list of ASCII characters

 - timeout() -

= infinity | integer() in milliseconds

 - ssh_connection_ref() -

Opaque to the user, returned by - ssh:connect/3 or sent to an SSH channel processes

 - ssh_channel_id() -

= integer()

 - ssh_data_type_code() -

= 1 ("stderr") | 0 ("normal") are + boolean() = +

true | false

+ string() = +

list of ASCII characters

 + timeout() = +

infinity | integer() in milliseconds

 + ssh_connection_ref() = +

opaque() -as returned by + ssh:connect/3 or sent to an SSH channel processes

 + ssh_channel_id() = +

integer()

 + ssh_data_type_code() = +

1 ("stderr") | 0 ("normal") are valid values, see RFC 4254 Section 5.2.

 - ssh_request_status() ssh_request_status() -

= success | failure

 - event() -

= {ssh_cm, ssh_connection_ref(), ssh_event_msg()}

 - ssh_event_msg() -

= data_events() | status_events() | terminal_events()

 - reason() -

= timeout | closed

 + ssh_request_status() = +

success | failure

 + event() = +

{ssh_cm, ssh_connection_ref(), ssh_event_msg()}

 + ssh_event_msg() = +

data_events() | status_events() | terminal_events()

 + reason() = +

timeout | closed

 diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml index 34ce7f7660..73dd90c962 100644 --- a/lib/ssh/doc/src/ssh_server_key_api.xml +++ b/lib/ssh/doc/src/ssh_server_key_api.xml @@ -50,20 +50,20 @@ public_key user's guide.

- - boolean() -

= true | false

 - string() -

= [byte()]

 - public_key() -

= #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 - private_key() -

= #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 - public_key_algorithm() -

= 'ssh-rsa'| 'ssh-dss' | atom()

 + + boolean() = +

true | false

 + string() = +

[byte()]

 + public_key() = +

#'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 + private_key() = +

#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 + public_key_algorithm() = +

'ssh-rsa'| 'ssh-dss' | atom()

 - + Module:host_key(Algorithm, DaemonOptions) -> diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 643130fe6b..fc418bc934 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -43,8 +43,8 @@

- ssh_connection_ref() -

Opaque to the user, returned by ssh:connect/3

 + ssh_connection_ref() = +

opaque() - as returned by ssh:connect/3

 timeout()

= infinity | integer() in milliseconds. Default infinity.

 diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml index bc2660f595..8b2497e6a3 100644 --- a/lib/ssh/doc/src/ssh_sftpd.xml +++ b/lib/ssh/doc/src/ssh_sftpd.xml @@ -37,16 +37,16 @@
DATA TYPES - subsystem_spec() -

= {subsystem_name(), {channel_callback(), channel_init_args()}}

 - subsystem_name() -

= "sftp"

 - channel_callback() -

= atom() - Name of the Erlang module implementing the subsystem using the + subsystem_spec() = +

{subsystem_name(), {channel_callback(), channel_init_args()}}

 + subsystem_name() = +

"sftp"

 + channel_callback() = +

atom() - Name of the Erlang module implementing the subsystem using the ssh_channel behavior, see the ssh_channel(3) manual page.

 - channel_init_args() -

= list() - The one given as argument to function subsystem_spec/1.

 + channel_init_args() = +

list() - The one given as argument to function subsystem_spec/1.
-- cgit v1.2.3 From e09dd66dc4d89c62ddfd8c19791f9678d5d787c6 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 12 May 2015 18:18:55 +0200 Subject: Prepare release --- lib/ssh/doc/src/notes.xml | 66 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) (limited to 'lib/ssh/doc') diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index 41885c684c..af5b78bff2 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -29,6 +29,72 @@ notes.xml +
Ssh 4.0 + +
Fixed Bugs and Malfunctions + + +

+ Included test of the 'e' and 'f' parameters in dh key + exchange as specified in rfc 4253 section 8.

+

+ Own Id: OTP-12649

+ + +

+ Fixes the bug that once the rekey_limit bytes (by + default, 1GB) had been transmitted the connection was + rekeyed every minute, not after the next 'rekey_limit'.

+

+ Thanks to Simon Cornish for the report and the fix!

+

+ Own Id: OTP-12692

+ + +

+ Fixes a bug that causes an SFTP connection to always fail + when {timeout, Timeout} option is used with + ssh_sftp:start_channel.

+

+ Thanks to Simon Cornish

+

+ Own Id: OTP-12708

+ + +
+ + +
Improvements and New Features + + +

+ The internal group to user_drv protocol has been changed + to be synchronous in order to guarantee that output sent + to a process implementing the user_drv protocol is + printed before replying. This protocol is used by the + standard_output device and the ssh application when + acting as a client.

+

+ This change changes the previous unlimited buffer when + printing to standard_io and other devices that end up in + user_drv to 1KB.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12240

+ + +

+ If ssh_connection:subsystem/4 fails we do not want to + crash but rather terminate gracefully.

+

+ Own Id: OTP-12648 Aux Id: seq12834

+ + +
+ +
+
Ssh 3.2.2
Improvements and New Features -- cgit v1.2.3 From 9a81b28598fadc44bf506354c9227e41aac786f6 Mon Sep 17 00:00:00 2001 From: Henrik Nord Date: Wed, 13 May 2015 09:40:16 +0200 Subject: Revert "Prepare release" This reverts commit e09dd66dc4d89c62ddfd8c19791f9678d5d787c6. --- lib/ssh/doc/src/notes.xml | 66 ----------------------------------------------- 1 file changed, 66 deletions(-) (limited to 'lib/ssh/doc') diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index af5b78bff2..41885c684c 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -29,72 +29,6 @@ notes.xml -
Ssh 4.0 - -
Fixed Bugs and Malfunctions - - -

- Included test of the 'e' and 'f' parameters in dh key - exchange as specified in rfc 4253 section 8.

-

- Own Id: OTP-12649

- - -

- Fixes the bug that once the rekey_limit bytes (by - default, 1GB) had been transmitted the connection was - rekeyed every minute, not after the next 'rekey_limit'.

-

- Thanks to Simon Cornish for the report and the fix!

-

- Own Id: OTP-12692

- - -

- Fixes a bug that causes an SFTP connection to always fail - when {timeout, Timeout} option is used with - ssh_sftp:start_channel.

-

- Thanks to Simon Cornish

-

- Own Id: OTP-12708

- - -
- - -
Improvements and New Features - - -

- The internal group to user_drv protocol has been changed - to be synchronous in order to guarantee that output sent - to a process implementing the user_drv protocol is - printed before replying. This protocol is used by the - standard_output device and the ssh application when - acting as a client.

-

- This change changes the previous unlimited buffer when - printing to standard_io and other devices that end up in - user_drv to 1KB.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12240

- - -

- If ssh_connection:subsystem/4 fails we do not want to - crash but rather terminate gracefully.

-

- Own Id: OTP-12648 Aux Id: seq12834

- - -
- -
-
Ssh 3.2.2
Improvements and New Features -- cgit v1.2.3 From 7aef211a66219b6fef9d0bdaf9b09be6c2e0a32f Mon Sep 17 00:00:00 2001 From: Hans Nilsson 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 @@

Sets a timeout on connection when no channels are active, default is infinity

 + + _}]]> + +

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 ConnectionRef is the reference to the connection on which the message arrived. The return value from the fun is not checked.

+

The default behaviour is ignore the message. + To get a printout for each message with AlwaysDisplay = true, use for example {ssh_msg_debug_fun, fun(_,true,M,_)-> io:format("DEBUG: ~p~n", [M]) end}

+ + @@ -383,8 +391,16 @@

Provide a fun to implement your own logging when a user disconnects from the server.

 - - + + _}]]> + +

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 ConnectionRef is the reference to the connection on which the message arrived. The return value from the fun is not checked.

+

The default behaviour is ignore the message. + To get a printout for each message with AlwaysDisplay = true, use for example {ssh_msg_debug_fun, fun(_,true,M,_)-> io:format("DEBUG: ~p~n", [M]) end}

+ + + + -- cgit v1.2.3 From ba0608d66d7b66d9108f79afd3c7c23b0ba06194 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 18 May 2015 09:55:10 +0200 Subject: Update release notes --- lib/ssh/doc/src/notes.xml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'lib/ssh/doc') diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index 41885c684c..579a3ae4a8 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -29,6 +29,25 @@ notes.xml +
Ssh 3.2.3 + +
Fixed Bugs and Malfunctions + + +

+ A new 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.

+

+ Own Id: OTP-12738 Aux Id: seq12860

+ + +
+ +
+
Ssh 3.2.2
Improvements and New Features -- cgit v1.2.3