Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GUACAMOLE-1290: Add SFTP support for public keys and correct SSH protocol issue. #538

Merged
merged 2 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/protocols/rdp/rdp.c
Original file line number Diff line number Diff line change
Expand Up @@ -800,6 +800,33 @@ void* guac_rdp_client_thread(void* data) {
return NULL;
}

/* Import the public key, if that is specified. */
if (settings->sftp_public_key != NULL) {

guac_client_log(client, GUAC_LOG_DEBUG,
"Attempting public key import");

/* Attempt to read public key */
if (guac_common_ssh_user_import_public_key(rdp_client->sftp_user,
settings->sftp_public_key)) {

/* Public key import fails. */
guac_client_abort(client,
GUAC_PROTOCOL_STATUS_CLIENT_UNAUTHORIZED,
"Failed to import public key: %s",
guac_common_ssh_key_error());

guac_common_ssh_destroy_user(rdp_client->sftp_user);
return NULL;

}

/* Success */
guac_client_log(client, GUAC_LOG_INFO,
"Public key successfully imported.");

}

}

/* Otherwise, use specified password */
Expand Down
15 changes: 14 additions & 1 deletion src/protocols/rdp/settings.c
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ const char* GUAC_RDP_CLIENT_ARGS[] = {
"sftp-password",
"sftp-private-key",
"sftp-passphrase",
"sftp-public-key",
"sftp-directory",
"sftp-root-directory",
"sftp-server-alive-interval",
Expand Down Expand Up @@ -492,6 +493,12 @@ enum RDP_ARGS_IDX {
*/
IDX_SFTP_PASSPHRASE,

/**
* The base64-encoded public key to use when authenticating with the SSH
* server for SFTP.
*/
IDX_SFTP_PUBLIC_KEY,

/**
* The default location for file uploads within the SSH server. This will
* apply only to uploads which do not use the filesystem guac_object (where
Expand Down Expand Up @@ -1126,11 +1133,16 @@ guac_rdp_settings* guac_rdp_parse_args(guac_user* user,
guac_user_parse_args_string(user, GUAC_RDP_CLIENT_ARGS, argv,
IDX_SFTP_PRIVATE_KEY, NULL);

/* Passphrase for decrypting the SFTP private key (if applicable */
/* Passphrase for decrypting the SFTP private key (if applicable) */
settings->sftp_passphrase =
guac_user_parse_args_string(user, GUAC_RDP_CLIENT_ARGS, argv,
IDX_SFTP_PASSPHRASE, "");

/* Public key for authenticating to SFTP server, if applicable. */
settings->sftp_public_key =
guac_user_parse_args_string(user, GUAC_RDP_CLIENT_ARGS, argv,
IDX_SFTP_PUBLIC_KEY, NULL);

/* Default upload directory */
settings->sftp_directory =
guac_user_parse_args_string(user, GUAC_RDP_CLIENT_ARGS, argv,
Expand Down Expand Up @@ -1397,6 +1409,7 @@ void guac_rdp_settings_free(guac_rdp_settings* settings) {
guac_mem_free(settings->sftp_password);
guac_mem_free(settings->sftp_port);
guac_mem_free(settings->sftp_private_key);
guac_mem_free(settings->sftp_public_key);
guac_mem_free(settings->sftp_username);
#endif

Expand Down
5 changes: 5 additions & 0 deletions src/protocols/rdp/settings.h
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,11 @@ typedef struct guac_rdp_settings {
*/
char* sftp_passphrase;

/**
* The public key to use when connecting to the SFTP server, if applicable.
*/
char* sftp_public_key;

/**
* The default location for file uploads within the SSH server. This will
* apply only to uploads which do not use the filesystem guac_object (where
Expand Down
39 changes: 20 additions & 19 deletions src/protocols/ssh/ssh.c
Original file line number Diff line number Diff line change
Expand Up @@ -134,33 +134,34 @@ static guac_common_ssh_user* guac_ssh_get_user(guac_client* client) {
guac_client_log(client, GUAC_LOG_INFO,
"Auth key successfully imported.");

} /* end if key given */
/* Import public key, if available. */
if (settings->public_key_base64 != NULL) {

if (settings->public_key_base64 != NULL) {
guac_client_log(client, GUAC_LOG_DEBUG,
"Attempting public key import");

guac_client_log(client, GUAC_LOG_DEBUG,
"Attempting public key import");
/* Attempt to read public key */
if (guac_common_ssh_user_import_public_key(user,
settings->public_key_base64)) {

/* Attempt to read public key */
if (guac_common_ssh_user_import_public_key(user,
settings->public_key_base64)) {
/* Public key import fails. */
guac_client_abort(client,
GUAC_PROTOCOL_STATUS_CLIENT_UNAUTHORIZED,
"Auth public key import failed: %s",
guac_common_ssh_key_error());

/* If failing*/
guac_client_abort(client,
GUAC_PROTOCOL_STATUS_CLIENT_UNAUTHORIZED,
"Auth public key import failed: %s",
guac_common_ssh_key_error());
guac_common_ssh_destroy_user(user);
return NULL;

guac_common_ssh_destroy_user(user);
return NULL;
}

}
/* Success */
guac_client_log(client, GUAC_LOG_INFO,
"Auth public key successfully imported.");

/* Success */
guac_client_log(client, GUAC_LOG_INFO,
"Auth public key successfully imported.");
}

}
} /* end if key given */

/* If available, get password from settings */
else if (settings->password != NULL) {
Expand Down
13 changes: 13 additions & 0 deletions src/protocols/vnc/settings.c
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ const char* GUAC_VNC_CLIENT_ARGS[] = {
"sftp-password",
"sftp-private-key",
"sftp-passphrase",
"sftp-public-key",
"sftp-directory",
"sftp-root-directory",
"sftp-server-alive-interval",
Expand Down Expand Up @@ -272,6 +273,12 @@ enum VNC_ARGS_IDX {
*/
IDX_SFTP_PASSPHRASE,

/**
* The base64-encode public key to use when authentication with the SSH
* server for SFTP using key-based authentication.
*/
IDX_SFTP_PUBLIC_KEY,

/**
* The default location for file uploads within the SSH server. This will
* apply only to uploads which do not use the filesystem guac_object (where
Expand Down Expand Up @@ -608,6 +615,11 @@ guac_vnc_settings* guac_vnc_parse_args(guac_user* user,
guac_user_parse_args_string(user, GUAC_VNC_CLIENT_ARGS, argv,
IDX_SFTP_PASSPHRASE, "");

/* Public key for SFTP using key-based authentication. */
settings->sftp_public_key =
guac_user_parse_args_string(user, GUAC_VNC_CLIENT_ARGS, argv,
IDX_SFTP_PUBLIC_KEY, NULL);

/* Default upload directory */
settings->sftp_directory =
guac_user_parse_args_string(user, GUAC_VNC_CLIENT_ARGS, argv,
Expand Down Expand Up @@ -743,6 +755,7 @@ void guac_vnc_settings_free(guac_vnc_settings* settings) {
guac_mem_free(settings->sftp_password);
guac_mem_free(settings->sftp_port);
guac_mem_free(settings->sftp_private_key);
guac_mem_free(settings->sftp_public_key);
guac_mem_free(settings->sftp_username);
#endif

Expand Down
6 changes: 6 additions & 0 deletions src/protocols/vnc/settings.h
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,12 @@ typedef struct guac_vnc_settings {
*/
char* sftp_passphrase;

/**
* The base64-encoded public key to use when authenticating with the SSH
* server for SFTP using key-based authentication.
*/
char* sftp_public_key;

/**
* The default location for file uploads within the SSH server. This will
* apply only to uploads which do not use the filesystem guac_object (where
Expand Down
27 changes: 27 additions & 0 deletions src/protocols/vnc/vnc.c
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,33 @@ void* guac_vnc_client_thread(void* data) {
return NULL;
}

/* Import the public key, if that is specified. */
if (settings->sftp_public_key != NULL) {

guac_client_log(client, GUAC_LOG_DEBUG,
"Attempting public key import");

/* Attempt to read public key */
if (guac_common_ssh_user_import_public_key(vnc_client->sftp_user,
settings->sftp_public_key)) {

/* Public key import fails. */
guac_client_abort(client,
GUAC_PROTOCOL_STATUS_CLIENT_UNAUTHORIZED,
"Failed to import public key: %s",
guac_common_ssh_key_error());

guac_common_ssh_destroy_user(vnc_client->sftp_user);
return NULL;

}

/* Success */
guac_client_log(client, GUAC_LOG_INFO,
"Public key successfully imported.");

}

}

/* Otherwise, use specified password */
Expand Down
Loading