Re: [PATCH] doc: Missing algorithms in documentation

[Jakub Jelen <jjelen@xxxxxxxxxx>]

On Tue, 2017-11-07 at 12:26 +0100, Jakub Jelen wrote:
> Hello,
> during recent work with libssh, I noticed that the doxygen
> documentation about supported algorithms is not up to date. Looking
> into the list of supported algorithm on the page [1], it is more up
> to
> date, but still miss hmac-sha2-384 MAC algorithm and ecdh-sha2-
> nistp384 
> and ecdh-sha2-nistp521 Kex algorithms.
> 
> The attached patches update the doxygen documentation, but I didn't
> find a way to update the documentation on the website. Also I am not
> sure about the significance of the italics in the list of algorithms,
> which is used in both places.

My bad. I just noticed that also ssh-ed25519 is missing from the
doxygen documentation too. Adding a modified patches covering also
this one.

> 
> Regards,
-- 
Jakub Jelen
Software Engineer
Security Technologies
Red Hat, Inc.

From 75b7d1071f4566ba47bad6442d1f80ba055f0e21 Mon Sep 17 00:00:00 2001
From: Jakub Jelen <jjelen@xxxxxxxxxx>
Date: Mon, 23 Oct 2017 15:32:03 +0200
Subject: [PATCH 1/3] doc: Missing new ECDH algorithms in documentation

Signed-off-by: Jakub Jelen <jjelen@xxxxxxxxxx>
---
 doc/mainpage.dox | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 00f46cbd..3a1af1d9 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -19,7 +19,7 @@ the interesting functions as you go.
 
 The libssh library provides:
 
- - <strong>Key Exchange Methods</strong>: <i>curve25519-sha256@xxxxxxxxxx, ecdh-sha2-nistp256</i>, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1
+ - <strong>Key Exchange Methods</strong>: <i>curve25519-sha256@xxxxxxxxxx, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521</i>, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1
  - <strong>Hostkey Types</strong>: <i>ecdsa-sha2-nistp256</i>, ssh-dss, ssh-rsa
  - <strong>Ciphers</strong>: <i>aes256-ctr, aes192-ctr, aes128-ctr</i>, aes256-cbc (rijndael-cbc@xxxxxxxxxxxxxx), aes192-cbc, aes128-cbc, 3des-cbc, blowfish-cbc, none
  - <strong>Compression Schemes</strong>: zlib, <i>zlib@xxxxxxxxxxx</i>, none
-- 
2.13.6


From ab1c7fc45bb59873449c7d055a33a00f30779538 Mon Sep 17 00:00:00 2001
From: Jakub Jelen <jjelen@xxxxxxxxxx>
Date: Mon, 23 Oct 2017 15:35:03 +0200
Subject: [PATCH 2/3] doc: Missing new MAC algorithms in documentation

Signed-off-by: Jakub Jelen <jjelen@xxxxxxxxxx>
---
 doc/mainpage.dox | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 3a1af1d9..531d6a57 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -23,7 +23,7 @@ The libssh library provides:
  - <strong>Hostkey Types</strong>: <i>ecdsa-sha2-nistp256</i>, ssh-dss, ssh-rsa
  - <strong>Ciphers</strong>: <i>aes256-ctr, aes192-ctr, aes128-ctr</i>, aes256-cbc (rijndael-cbc@xxxxxxxxxxxxxx), aes192-cbc, aes128-cbc, 3des-cbc, blowfish-cbc, none
  - <strong>Compression Schemes</strong>: zlib, <i>zlib@xxxxxxxxxxx</i>, none
- - <strong>MAC hashes</strong>: hmac-sha1, none
+ - <strong>MAC hashes</strong>: hmac-sha1, hmac-sha2-256, hmac-sha2-384, hmac-sha2-512, hmac-md5, none
  - <strong>Authentication</strong>: none, password, public-key, hostbased, keyboard-interactive, <i>gssapi-with-mic</i>
  - <strong>Channels</strong>: shell, exec (incl. SCP wrapper), direct-tcpip, subsystem, <i>auth-agent-req@xxxxxxxxxxx</i>
  - <strong>Global Requests</strong>: tcpip-forward, forwarded-tcpip
-- 
2.13.6


From d3d2d1ece4996134814e6b1d5f93523f5566ce03 Mon Sep 17 00:00:00 2001
From: Jakub Jelen <jjelen@xxxxxxxxxx>
Date: Tue, 7 Nov 2017 10:40:44 +0100
Subject: [PATCH 3/3] doc: Missing new Host Key algorithms

Signed-off-by: Jakub Jelen <jjelen@xxxxxxxxxx>
---
 doc/mainpage.dox | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 531d6a57..1b86baa9 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -20,7 +20,7 @@ the interesting functions as you go.
 The libssh library provides:
 
  - <strong>Key Exchange Methods</strong>: <i>curve25519-sha256@xxxxxxxxxx, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521</i>, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1
- - <strong>Hostkey Types</strong>: <i>ecdsa-sha2-nistp256</i>, ssh-dss, ssh-rsa
+ - <strong>Hostkey Types</strong>: <i>ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521</i>, ssh-dss, ssh-rsa
  - <strong>Ciphers</strong>: <i>aes256-ctr, aes192-ctr, aes128-ctr</i>, aes256-cbc (rijndael-cbc@xxxxxxxxxxxxxx), aes192-cbc, aes128-cbc, 3des-cbc, blowfish-cbc, none
  - <strong>Compression Schemes</strong>: zlib, <i>zlib@xxxxxxxxxxx</i>, none
  - <strong>MAC hashes</strong>: hmac-sha1, hmac-sha2-256, hmac-sha2-384, hmac-sha2-512, hmac-md5, none
-- 
2.13.6