From 49be92e7e76d0d52b91a2dc4944e3e1ced1abaaa Mon Sep 17 00:00:00 2001 From: Virtually Nick Date: Tue, 27 Aug 2024 19:21:05 -0400 Subject: [PATCH] GUACAMOLE-1290: Document SFTP public key parameter and correct SSH public key documentation. --- src/configuring-guacamole.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/src/configuring-guacamole.md b/src/configuring-guacamole.md index 865843d..9978926 100644 --- a/src/configuring-guacamole.md +++ b/src/configuring-guacamole.md @@ -1712,9 +1712,12 @@ by prompting the user directly. `public-key` : If SSH is using certificate-based authentication, this field allows - you to provide the Base64-encoded CA certificate that will be used - to validate the certificate of the user. This parameter is optional - and there is no default value. + you to provide the Base64-encoded public key rather than having it + extracted from the provided private key. This parameter is optional + and there is no default value. If a value is provided it will take + precendence, requiring that the private key match the provided + public key, and a mis-match will result in a failure to authenticate + using the provided private key. (ssh-command)= @@ -2185,6 +2188,15 @@ transfer features. authentication. This parameter is not needed if the private key does not require a passphrase. +`sftp-public-key` +: If the SFTP connection is using key-based authentication, this field + allows you to specify the Base64-encoded public key rather than having + it extracted from the provided private key. This parameter is optional + and there is no default value. If a value is provided it will take + precendence, requiring that the private key match the provided + public key, and a mis-match will result in a failure to authenticate + using the provided private key. + `sftp-directory` : The directory to upload files to if they are simply dragged and dropped, and thus otherwise lack a specific upload location. This parameter is