maride/guacamole-spice-protocol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

GUACAMOLE-337: Move libguacd functionality into libguac.

Browse Source
This commit is contained in:
Michael Jumper 2017-07-01 15:51:15 -07:00
parent 5b748a4b42
commit f504b1a5e8
15 changed files with 131 additions and 271 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.am
View File

@ -22,7 +22,6 @@ ACLOCAL_AMFLAGS = -I m4
# Subprojects
DIST_SUBDIRS = \
src/libguac \
src/libguacd \
src/common \
src/common-ssh \
src/terminal \
@ -38,7 +37,6 @@ DIST_SUBDIRS = \
SUBDIRS = \
src/libguac \
src/common \
src/libguacd \
tests
if ENABLE_COMMON_SSH

5
configure.ac
View File

@ -123,10 +123,6 @@ AC_SUBST([COMMON_INCLUDE], '-I$(top_srcdir)/src/common')
AC_SUBST([PULSE_LTLIB], '$(top_builddir)/src/pulse/libguac_pulse.la')
AC_SUBST([PULSE_INCLUDE], '-I$(top_srcdir)/src/pulse')
# Common utility library for guacd implementations
AC_SUBST([LIBGUACD_LTLIB], '$(top_builddir)/src/libguacd/libguacd.la')
AC_SUBST([LIBGUACD_INCLUDE], '-I$(top_srcdir)/src/libguacd')
# Common base SSH client
AC_SUBST([COMMON_SSH_LTLIB], '$(top_builddir)/src/common-ssh/libguac_common_ssh.la')
AC_SUBST([COMMON_SSH_INCLUDE], '-I$(top_srcdir)/src/common-ssh')
@ -1172,7 +1168,6 @@ AC_CONFIG_FILES([Makefile
src/common-ssh/Makefile
src/terminal/Makefile
src/libguac/Makefile
src/libguacd/Makefile
src/guacd/Makefile
src/guacenc/Makefile
src/pulse/Makefile

2
src/guacd/Makefile.am
View File

@ -49,12 +49,10 @@ guacd_SOURCES = \
guacd_CFLAGS = \
-Werror -Wall -pedantic \
@COMMON_INCLUDE@ \
@LIBGUACD_INCLUDE@ \
@LIBGUAC_INCLUDE@
guacd_LDADD = \
@COMMON_LTLIB@ \
@LIBGUACD_LTLIB@ \
@LIBGUAC_LTLIB@
guacd_LDFLAGS = \

1
src/guacd/connection.c
View File

@ -22,7 +22,6 @@
#include "connection.h"
#include "log.h"
#include "move-fd.h"
#include "libguacd/user.h"
#include "proc.h"
#include "proc-map.h"

1
src/guacd/daemon.c
View File

@ -22,7 +22,6 @@
#include "connection.h"
#include "conf-args.h"
#include "conf-file.h"
#include "libguacd/user.h"
#include "log.h"
#include "proc-map.h"

1
src/guacd/proc-map.c
View File

@ -19,7 +19,6 @@
#include "config.h"
#include "common/list.h"
#include "libguacd/user.h"
#include "proc.h"
#include "proc-map.h"

1
src/guacd/proc-map.h
View File

@ -23,7 +23,6 @@
#include "config.h"
#include "common/list.h"
#include "libguacd/user.h"
#include "proc.h"
#include <guacamole/client.h>

3
src/guacd/proc.c
View File

@ -19,7 +19,6 @@
#include "config.h"
#include "libguacd/user.h"
#include "log.h"
#include "move-fd.h"
#include "proc.h"
@ -92,7 +91,7 @@ static void* guacd_user_thread(void* data) {
user->owner = params->owner;
/* Handle user connection from handshake until disconnect/completion */
guacd_handle_user(user, GUACD_USEC_TIMEOUT);
guac_user_handle_connection(user, GUACD_USEC_TIMEOUT);
/* Stop client and prevent future users if all users are disconnected */
if (client->connected_users == 0) {

3
src/libguac/Makefile.am
View File

@ -91,7 +91,8 @@ libguac_la_SOURCES = \
timestamp.c \
unicode.c \
user.c \
user-handlers.c
user-handlers.c \
user-handshake.c
# Compile WebP support if available
if ENABLE_WEBP

24
src/libguac/guacamole/user.h
View File

@ -492,6 +492,30 @@ guac_user* guac_user_alloc();
*/
void guac_user_free(guac_user* user);
/**
* Handles the portion of a user's Guacamole protocol handshake following the
* "select" instruction all subsequent I/O, automatically populating the
* handshake-related properties of the given guac_user and invoking
* guac_user_handle_instruction() for received instructions after the handshake
* has completed. This function blocks until the connection/user is aborted or
* the user disconnects.
*
* @param user
* The user whose handshake and entire Guacamole protocol exchange should
* be handled. The user must already be associated with a guac_socket and
* guac_client, and the guac_client must already be fully initialized.
*
* @param usec_timeout
* The number of microseconds to wait for instructions from the given
* user before closing the connection with an error.
*
* @return
* Zero if the user's Guacamole connection was successfully handled and
* the user has disconnected, or non-zero if an error prevented the user's
* connection from being handled properly.
*/
int guac_user_handle_connection(guac_user* user, int usec_timeout);
/**
* Call the appropriate handler defined by the given user for the given
* instruction. A comparison is made between the instruction opcode and the

151
src/libguacd/user.c → src/libguac/user-handshake.c
View File

@ -19,15 +19,12 @@
#include "config.h"
#include "libguacd/user.h"
#include "log.h"
#include <guacamole/client.h>
#include <guacamole/error.h>
#include <guacamole/parser.h>
#include <guacamole/protocol.h>
#include <guacamole/socket.h>
#include <guacamole/user.h>
#include "client.h"
#include "error.h"
#include "parser.h"
#include "protocol.h"
#include "socket.h"
#include "user.h"
#include <pthread.h>
#include <stdlib.h>
@ -36,7 +33,7 @@
/**
* Parameters required by the user input thread.
*/
typedef struct guacd_user_input_thread_params {
typedef struct guac_user_input_thread_params {
/**
* The parser which will be used throughout the user's session.
@ -54,12 +51,72 @@ typedef struct guacd_user_input_thread_params {
*/
int usec_timeout;
} guacd_user_input_thread_params;
} guac_user_input_thread_params;
/**
* Prints an error message using the logging facilities of the given user,
* automatically including any information present in guac_error.
*
* @param user
* The guac_user associated with the error that occurred.
*
* @param level
* The level at which to log this message.
*
* @param message
* The message to log.
*/
static void guac_user_log_guac_error(guac_user* user,
guac_client_log_level level, const char* message) {
if (guac_error != GUAC_STATUS_SUCCESS) {
/* If error message provided, include in log */
if (guac_error_message != NULL)
guac_user_log(user, level, "%s: %s", message,
guac_error_message);
/* Otherwise just log with standard status string */
else
guac_user_log(user, level, "%s: %s", message,
guac_status_string(guac_error));
}
/* Just log message if no status code */
else
guac_user_log(user, level, "%s", message);
}
/**
* Logs a reasonable explanatory message regarding handshake failure based on
* the current value of guac_error.
*
* @param user
* The guac_user associated with the failed Guacamole protocol handshake.
*/
static void guac_user_log_handshake_failure(guac_user* user) {
if (guac_error == GUAC_STATUS_CLOSED)
guac_user_log(user, GUAC_LOG_INFO,
"Guacamole connection closed during handshake");
else if (guac_error == GUAC_STATUS_PROTOCOL_ERROR)
guac_user_log(user, GUAC_LOG_ERROR,
"Guacamole protocol violation. Perhaps the version of "
"guacamole-client is incompatible with this version of "
"libguac?");
else
guac_user_log(user, GUAC_LOG_WARNING,
"Guacamole handshake failed: %s",
guac_status_string(guac_error));
}
/**
* Copies the given array of mimetypes (strings) into a newly-allocated NULL-
* terminated array of strings. Both the array and the strings within the array
* are newly-allocated and must be later freed via guacd_free_mimetypes().
* are newly-allocated and must be later freed via guac_free_mimetypes().
*
* @param mimetypes
* The array of mimetypes to copy.
@ -72,7 +129,7 @@ typedef struct guacd_user_input_thread_params {
* copies of each of the mimetypes provided in the original mimetypes
* array.
*/
static char** guacd_copy_mimetypes(char** mimetypes, int count) {
static char** guac_copy_mimetypes(char** mimetypes, int count) {
int i;
@ -93,13 +150,13 @@ static char** guacd_copy_mimetypes(char** mimetypes, int count) {
/**
* Frees the given array of mimetypes, including the space allocated to each
* mimetype string within the array. The provided array of mimetypes MUST have
* been allocated with guacd_copy_mimetypes().
* been allocated with guac_copy_mimetypes().
*
* @param mimetypes
* The NULL-terminated array of mimetypes to free. This array MUST have
* been previously allocated with guacd_copy_mimetypes().
* been previously allocated with guac_copy_mimetypes().
*/
static void guacd_free_mimetypes(char** mimetypes) {
static void guac_free_mimetypes(char** mimetypes) {
char** current_mimetype = mimetypes;
@ -119,17 +176,17 @@ static void guacd_free_mimetypes(char** mimetypes) {
* instructions.
*
* @param data
* A pointer to a guacd_user_input_thread_params structure describing the
* A pointer to a guac_user_input_thread_params structure describing the
* user whose input is being handled and the guac_parser with which to
* handle it.
*
* @return
* Always NULL.
*/
static void* guacd_user_input_thread(void* data) {
static void* guac_user_input_thread(void* data) {
guacd_user_input_thread_params* params =
(guacd_user_input_thread_params*) data;
guac_user_input_thread_params* params =
(guac_user_input_thread_params*) data;
int usec_timeout = params->usec_timeout;
guac_user* user = params->user;
@ -148,7 +205,7 @@ static void* guacd_user_input_thread(void* data) {
else {
if (guac_error != GUAC_STATUS_CLOSED)
guacd_client_log_guac_error(client, GUAC_LOG_WARNING,
guac_user_log_guac_error(user, GUAC_LOG_WARNING,
"Guacamole connection failure");
guac_user_stop(user);
}
@ -165,7 +222,7 @@ static void* guacd_user_input_thread(void* data) {
if (guac_user_handle_instruction(user, parser->opcode, parser->argc, parser->argv) < 0) {
/* Log error */
guacd_client_log_guac_error(client, GUAC_LOG_WARNING,
guac_user_log_guac_error(user, GUAC_LOG_WARNING,
"User connection aborted");
/* Log handler details */
@ -200,10 +257,10 @@ static void* guacd_user_input_thread(void* data) {
* Zero if the I/O threads started successfully and user has disconnected,
* or non-zero if the I/O threads could not be started.
*/
static int guacd_user_start(guac_parser* parser, guac_user* user,
static int guac_user_start(guac_parser* parser, guac_user* user,
int usec_timeout) {
guacd_user_input_thread_params params = {
guac_user_input_thread_params params = {
.parser = parser,
.user = user,
.usec_timeout = usec_timeout
@ -211,7 +268,7 @@ static int guacd_user_start(guac_parser* parser, guac_user* user,
pthread_t input_thread;
if (pthread_create(&input_thread, NULL, guacd_user_input_thread, (void*) &params)) {
if (pthread_create(&input_thread, NULL, guac_user_input_thread, (void*) &params)) {
guac_user_log(user, GUAC_LOG_ERROR, "Unable to start input thread");
guac_user_stop(user);
return -1;
@ -229,7 +286,7 @@ static int guacd_user_start(guac_parser* parser, guac_user* user,
}
int guacd_handle_user(guac_user* user, int usec_timeout) {
int guac_user_handle_connection(guac_user* user, int usec_timeout) {
guac_socket* socket = user->socket;
guac_client* client = user->client;
@ -239,8 +296,8 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
|| guac_socket_flush(socket)) {
/* Log error */
guacd_client_log_handshake_failure(client);
guacd_client_log_guac_error(client, GUAC_LOG_DEBUG,
guac_user_log_handshake_failure(user);
guac_user_log_guac_error(user, GUAC_LOG_DEBUG,
"Error sending \"args\" to new user");
return 1;
@ -252,8 +309,8 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
if (guac_parser_expect(parser, socket, usec_timeout, "size")) {
/* Log error */
guacd_client_log_handshake_failure(client);
guacd_client_log_guac_error(client, GUAC_LOG_DEBUG,
guac_user_log_handshake_failure(user);
guac_user_log_guac_error(user, GUAC_LOG_DEBUG,
"Error reading \"size\"");
guac_parser_free(parser);
@ -262,7 +319,7 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
/* Validate content of size instruction */
if (parser->argc < 2) {
guac_client_log(client, GUAC_LOG_ERROR, "Received \"size\" "
guac_user_log(user, GUAC_LOG_ERROR, "Received \"size\" "
"instruction lacked required arguments.");
guac_parser_free(parser);
return 1;
@ -272,7 +329,7 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
user->info.optimal_width = atoi(parser->argv[0]);
user->info.optimal_height = atoi(parser->argv[1]);
/* If DPI given, set the client resolution */
/* If DPI given, set the user resolution */
if (parser->argc >= 3)
user->info.optimal_resolution = atoi(parser->argv[2]);
@ -284,8 +341,8 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
if (guac_parser_expect(parser, socket, usec_timeout, "audio")) {
/* Log error */
guacd_client_log_handshake_failure(client);
guacd_client_log_guac_error(client, GUAC_LOG_DEBUG,
guac_user_log_handshake_failure(user);
guac_user_log_guac_error(user, GUAC_LOG_DEBUG,
"Error reading \"audio\"");
guac_parser_free(parser);
@ -293,15 +350,15 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
}
/* Store audio mimetypes */
char** audio_mimetypes = guacd_copy_mimetypes(parser->argv, parser->argc);
char** audio_mimetypes = guac_copy_mimetypes(parser->argv, parser->argc);
user->info.audio_mimetypes = (const char**) audio_mimetypes;
/* Get supported video formats */
if (guac_parser_expect(parser, socket, usec_timeout, "video")) {
/* Log error */
guacd_client_log_handshake_failure(client);
guacd_client_log_guac_error(client, GUAC_LOG_DEBUG,
guac_user_log_handshake_failure(user);
guac_user_log_guac_error(user, GUAC_LOG_DEBUG,
"Error reading \"video\"");
guac_parser_free(parser);
@ -309,15 +366,15 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
}
/* Store video mimetypes */
char** video_mimetypes = guacd_copy_mimetypes(parser->argv, parser->argc);
char** video_mimetypes = guac_copy_mimetypes(parser->argv, parser->argc);
user->info.video_mimetypes = (const char**) video_mimetypes;
/* Get supported image formats */
if (guac_parser_expect(parser, socket, usec_timeout, "image")) {
/* Log error */
guacd_client_log_handshake_failure(client);
guacd_client_log_guac_error(client, GUAC_LOG_DEBUG,
guac_user_log_handshake_failure(user);
guac_user_log_guac_error(user, GUAC_LOG_DEBUG,
"Error reading \"image\"");
guac_parser_free(parser);
@ -325,15 +382,15 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
}
/* Store image mimetypes */
char** image_mimetypes = guacd_copy_mimetypes(parser->argv, parser->argc);
char** image_mimetypes = guac_copy_mimetypes(parser->argv, parser->argc);
user->info.image_mimetypes = (const char**) image_mimetypes;
/* Get args from connect instruction */
if (guac_parser_expect(parser, socket, usec_timeout, "connect")) {
/* Log error */
guacd_client_log_handshake_failure(client);
guacd_client_log_guac_error(client, GUAC_LOG_DEBUG,
guac_user_log_handshake_failure(user);
guac_user_log_guac_error(user, GUAC_LOG_DEBUG,
"Error reading \"connect\"");
guac_parser_free(parser);
@ -357,7 +414,7 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
client->connection_id, client->connected_users);
/* Handle user I/O, wait for connection to terminate */
guacd_user_start(parser, user, usec_timeout);
guac_user_start(parser, user, usec_timeout);
/* Remove/free user */
guac_client_remove_user(client, user);
@ -367,9 +424,9 @@ int guacd_handle_user(guac_user* user, int usec_timeout) {
}
/* Free mimetype lists */
guacd_free_mimetypes(audio_mimetypes);
guacd_free_mimetypes(video_mimetypes);
guacd_free_mimetypes(image_mimetypes);
guac_free_mimetypes(audio_mimetypes);
guac_free_mimetypes(video_mimetypes);
guac_free_mimetypes(image_mimetypes);
guac_parser_free(parser);

47
src/libguacd/Makefile.am
View File

@ -1,47 +0,0 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
AUTOMAKE_OPTIONS = foreign
lib_LTLIBRARIES = libguacd.la
libguacdincdir = $(includedir)/libguacd
libguacdinc_HEADERS = \
libguacd/user.h
noinst_HEADERS = \
log.h
libguacd_la_SOURCES = \
log.c \
user.c
libguacd_la_CFLAGS = \
-Werror -Wall -pedantic \
@LIBGUAC_INCLUDE@
libguacd_la_LIBADD = \
@LIBGUAC_LTLIB@
libguacd_la_LDFLAGS = \
-version-info 0:0:0 \
-no-undefined \
@PTHREAD_LIBS@

48
src/libguacd/libguacd/user.h
View File

@ -1,48 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef LIBGUACD_USER_H
#define LIBGUACD_USER_H
#include <guacamole/parser.h>
#include <guacamole/socket.h>
#include <guacamole/user.h>
/**
* Handles the initial handshake of a user and all subsequent I/O. This
* function blocks until the user disconnects.
*
* @param user
* The user whose handshake and entire Guacamole protocol exchange should
* be handled.
*
* @param usec_timeout
* The number of microseconds to wait for instructions from the given
* user before closing the connection with an error.
*
* @return
* Zero if the user's Guacamole connection was successfully handled and
* the user has disconnected, or non-zero if an error prevented the user's
* connection from being handled properly.
*/
int guacd_handle_user(guac_user* user, int usec_timeout);
#endif

71
src/libguacd/log.c
View File

@ -1,71 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#include "config.h"
#include "log.h"
#include <guacamole/client.h>
#include <guacamole/error.h>
#include <stdarg.h>
#include <stdio.h>
#include <unistd.h>
void guacd_client_log_guac_error(guac_client* client,
guac_client_log_level level, const char* message) {
if (guac_error != GUAC_STATUS_SUCCESS) {
/* If error message provided, include in log */
if (guac_error_message != NULL)
guac_client_log(client, level, "%s: %s",
message,
guac_error_message);
/* Otherwise just log with standard status string */
else
guac_client_log(client, level, "%s: %s",
message,
guac_status_string(guac_error));
}
/* Just log message if no status code */
else
guac_client_log(client, level, "%s", message);
}
void guacd_client_log_handshake_failure(guac_client* client) {
if (guac_error == GUAC_STATUS_CLOSED)
guac_client_log(client, GUAC_LOG_INFO,
"Guacamole connection closed during handshake");
else if (guac_error == GUAC_STATUS_PROTOCOL_ERROR)
guac_client_log(client, GUAC_LOG_ERROR,
"Guacamole protocol violation. Perhaps the version of "
"guacamole-client is incompatible with this version of "
"guacd?");
else
guac_client_log(client, GUAC_LOG_WARNING,
"Guacamole handshake failed: %s",
guac_status_string(guac_error));
}

42
src/libguacd/log.h
View File

@ -1,42 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef LIBGUACD_LOG_H
#define LIBGUACD_LOG_H
#include "config.h"
#include <guacamole/client.h>
/**
* Prints an error message using the logging facilities of the given client,
* automatically including any information present in guac_error. This function
* accepts parameters identically to printf.
*/
void guacd_client_log_guac_error(guac_client* client,
guac_client_log_level level, const char* message);
/**
* Logs a reasonable explanatory message regarding handshake failure based on
* the current value of guac_error.
*/
void guacd_client_log_handshake_failure(guac_client* client);
#endif