From 66583499ed6270373dd9813e7d099fad44b7b644 Mon Sep 17 00:00:00 2001 From: Tom Smeding Date: Mon, 13 Jul 2020 18:10:36 +0200 Subject: tomsg_clientlib: Async connect routines This is quite complex, and it probably can be implemented with a simpler API and implementation. Regardless, it _seems_ to work. --- ssh/client.c | 58 ++++++++- ssh/tomsg_clientlib.c | 337 ++++++++++++++++++++++++++++++++++++++++++++++++++ ssh/tomsg_clientlib.h | 52 ++++++++ 3 files changed, 442 insertions(+), 5 deletions(-) diff --git a/ssh/client.c b/ssh/client.c index a763c68..fbf4c1d 100644 --- a/ssh/client.c +++ b/ssh/client.c @@ -448,9 +448,7 @@ static void handle_event(struct state *state, const struct tomsg_event event) { } } -static bool hostkey_checker(const unsigned char *hash, size_t length, void *stdinbuf_) { - struct readbuffer *stdinbuf = stdinbuf_; - +static bool hostkey_checker(const unsigned char *hash, size_t length, struct readbuffer *stdinbuf) { const char *fingerprint = tomsg_print_hash(hash, length); printf("Server host key fingerprint: %s\n", fingerprint); @@ -459,6 +457,57 @@ static bool hostkey_checker(const unsigned char *hash, size_t length, void *stdi "member that you trust and is already connected to the server?"); } +static enum tomsg_retval connect_server( + const char *hostname, int port, + struct readbuffer *stdinbuf, + struct tomsg_client **clientp +) { + struct tomsg_async_connect *async; + enum tomsg_retval ret = tomsg_async_connect(hostname, port, &async); + if (ret != TOMSG_OK) return ret; + + const int fd = tomsg_async_connect_poll_fd(async); + + struct pollfd pfd; + pfd.fd = fd; + pfd.events = POLLIN; + + while (true) { + pfd.revents = 0; + int pollret = poll(&pfd, 1, -1); + if (pollret < 0) { + perror("poll"); + // Can't really close the async connector? + exit(1); + } + + if (pfd.revents & (POLLIN | POLLHUP | POLLERR)) { + struct tomsg_async_connect_event event; + ret = tomsg_async_connect_next_event(async, &event); + if (ret == TOMSG_ERR_AGAIN) continue; + if (ret != TOMSG_OK) { + fprintf(stderr, "next_event returned %d\n", ret); + return ret; + } + + switch (event.type) { + case TOMSG_AC_HOSTKEY: + ret = tomsg_async_connect_accept(async, + hostkey_checker(event.key.hostkey, event.key.length, stdinbuf)); + if (ret != TOMSG_OK) { + fprintf(stderr, "connect_accept returned %d\n", ret); + return ret; + } + break; + + case TOMSG_AC_SUCCESS: + *clientp = event.client; + return TOMSG_OK; + } + } + } +} + int main(int argc, char **argv) { if (argc != 2) { printf("Usage: %s \n", argv[0]); @@ -477,8 +526,7 @@ int main(int argc, char **argv) { printf("Connecting...\n"); struct tomsg_client *client; - enum tomsg_retval ret = tomsg_connect( - hostname, port, hostkey_checker, &stdinbuf, &client); + enum tomsg_retval ret = connect_server(hostname, port, &stdinbuf, &client); if (ret != TOMSG_OK) { printf("Could not connect: %s\n", tomsg_strerror(ret)); return 1; diff --git a/ssh/tomsg_clientlib.c b/ssh/tomsg_clientlib.c index 80a9bf3..9c2d80a 100644 --- a/ssh/tomsg_clientlib.c +++ b/ssh/tomsg_clientlib.c @@ -4,7 +4,10 @@ #include #include #include +#include #include +#include +#include #include #include "tomsg_clientlib.h" #include "sshnc.h" @@ -32,6 +35,25 @@ struct tomsg_client { struct inflight *inflight; }; +enum tomsg_async_connect_state { + STATE_CONNECTING, + STATE_KEY_RECEIVED, + STATE_ACCEPTED, +}; + +// Only field written to by the thread is 'client'. +struct tomsg_async_connect { + enum tomsg_async_connect_state state; + + char *hostname; + int port; + + // Two pipes for communicating with the thread + int host_w, host_r, thread_w, thread_r; + + struct tomsg_client *client; // filled by thread in case all is successful +}; + static size_t min_size_t(size_t a, size_t b) { return a < b ? a : b; } static bool hasspacelf(const char *string) { @@ -140,6 +162,7 @@ const char* tomsg_strerror(enum tomsg_retval code) { switch (code) { case TOMSG_OK: return "Success"; case TOMSG_ERR_CONNECT: return "Server refused connection"; + case TOMSG_ERR_UNTRUSTED: return "Hostkey was rejected"; case TOMSG_ERR_CLOSED: return "Server connection unexpectedly closed"; case TOMSG_ERR_VERSION: return "Server protocol version incompatible"; case TOMSG_ERR_TRANSPORT: return "Error in the underlying SSH transport"; @@ -198,6 +221,7 @@ enum tomsg_retval tomsg_connect( hostname, port, "tomsg", "tomsg", checker, userdata, &conn); if (ret == SSHNC_ERR_CONNECT) return TOMSG_ERR_CONNECT; + if (ret == SSHNC_ERR_UNTRUSTED) return TOMSG_ERR_UNTRUSTED; if (ret != SSHNC_OK) return TOMSG_ERR_TRANSPORT; struct tomsg_client *client = malloc(sizeof(struct tomsg_client)); @@ -219,6 +243,319 @@ enum tomsg_retval tomsg_connect( return version_negotiation(client); } +// Returns whether successful +static bool writeall(int fd, const unsigned char *buffer, size_t length) { + size_t cursor = 0; + while (cursor < length) { + ssize_t nw = write(fd, buffer + cursor, length - cursor); + if (nw < 0) { + if (errno == EINTR) continue; + return false; + } + if (nw == 0) return false; + cursor += nw; + } + return true; +} + +// Returns whether successful +static bool readall(int fd, unsigned char *buffer, size_t length) { + size_t cursor = 0; + while (cursor < length) { + ssize_t nr = read(fd, buffer + cursor, length - cursor); + if (nr < 0) { + if (errno == EINTR) continue; + return false; + } + if (nr == 0) return false; + cursor += nr; + } + return true; +} + +// Async socket protocol: +// Sizes are always indicated using a host-order 8-byte signed integer. +// - Thread sends an error byte; if that's TOMSG_OK, it is followed by size and +// hashbytes of the hostkey. Otherwise, the thread exits. +// - Host sends one byte: 0 for reject, 1 for accept. +// - For reject, the thread closes the connection and exits. For accept, the +// thread negotiates the protocol version and if successful, initialises and +// populates a client structure in the state, and sends a TOMSG_OK byte. If +// unsuccessful, sends an error byte and exits. +// After the thread sends either an error byte or the final OK byte, or after +// it has received a reject message, it will not access 'state' anymore; it can +// thus be freed by the host. + +static bool async_hostkey_checker(const unsigned char *hash, size_t length, void *state_) { + struct tomsg_async_connect *state = state_; + + unsigned char buffer[256]; + if (9 + length > sizeof buffer) { assert(false); return false; } + buffer[0] = TOMSG_OK; + *(int64_t*)&buffer[1] = length; + memcpy(buffer + 9, hash, length); + + if (!writeall(state->thread_w, buffer, 9 + length)) return false; + + char response; + ssize_t nr = -1; + while (nr < 0) { + nr = read(state->thread_r, &response, 1); + if (nr == 0 || (nr < 0 && errno != EINTR)) break; + } + if (nr < 0) return false; + + return response == 1; +} + +static void* async_connect_thread_entry(void *state_) { + struct tomsg_async_connect *state = state_; + + const int thread_r = state->thread_r; + const int thread_w = state->thread_w; + + struct sshnc_client *conn; + enum sshnc_retval ret = sshnc_connect( + state->hostname, state->port, "tomsg", "tomsg", + async_hostkey_checker, state, &conn); + + enum tomsg_retval sendret; + if (ret == SSHNC_ERR_CONNECT) sendret = TOMSG_ERR_CONNECT; + else if (ret == SSHNC_ERR_UNTRUSTED) sendret = TOMSG_ERR_UNTRUSTED; + else if (ret != SSHNC_OK) sendret = TOMSG_ERR_TRANSPORT; + else sendret = TOMSG_OK; + + // If sendret is TOMSG_ERR_UNTRUSTED, the host may free 'state' at this point. Thus, don't access it, please. + + struct tomsg_client *client = NULL; + unsigned char byte; + + if (sendret == TOMSG_ERR_UNTRUSTED) goto pipe_return; + if (sendret != TOMSG_OK) goto send_error_return; + + client = calloc(1, sizeof(struct tomsg_client)); + if (!client) { sendret = TOMSG_ERR_MEMORY; goto send_error_return; } + client->conn = conn; + client->buffer_len = 0; + client->buffer_cap = 1024; + client->buffer = malloc(client->buffer_cap); + if (!client->buffer) { sendret = TOMSG_ERR_MEMORY; goto send_error_return; } + client->buffer_newline_cursor = 0; + client->next_tag = 1; + client->inflight_num = 0; + client->inflight_cap = 2; + client->inflight = malloc(client->inflight_cap * sizeof(struct inflight)); + if (!client->inflight) { sendret = TOMSG_ERR_MEMORY; goto send_error_return; } + + enum tomsg_retval versionret = version_negotiation(client); + if (versionret != TOMSG_OK) { sendret = versionret; goto send_error_return; } + + state->client = client; + + byte = TOMSG_OK; + // After the writeall, it is forbidden to access anything in 'state', + // because it may have been freed by the host at this point. + if (!writeall(thread_w, &byte, 1)) goto free_client; + goto pipe_return; + +send_error_return: + // After this, it is forbidden to access anything in 'state', because it + // may have been freed by the host at this point. + byte = sendret; + writeall(thread_w, &byte, 1); +free_client: + sshnc_close(conn); + if (client) { + if (client->buffer) free(client->buffer); + if (client->inflight) free(client->inflight); + free(client); + } +pipe_return: + close(thread_r); + close(thread_w); + return NULL; +} + +enum tomsg_retval tomsg_async_connect( + const char *hostname, int port, + struct tomsg_async_connect **clientp) { + // In case we throw an error along the way + *clientp = NULL; + + struct tomsg_async_connect *client = malloc(sizeof(struct tomsg_async_connect)); + if (!client) return TOMSG_ERR_MEMORY; + + client->state = STATE_CONNECTING; + + client->hostname = strdup(hostname); + client->port = port; + + pthread_attr_t attr; + if (pthread_attr_init(&attr) < 0) { + free(client->hostname); + free(client); + if (errno == ENOMEM) return TOMSG_ERR_MEMORY; + return TOMSG_ERR_CONNECT; + } + + pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED); + + int pipeHT[2] = {-1, -1}, pipeTH[2]; + if (pipe(pipeHT) < 0 || pipe(pipeTH) < 0) { + if (pipeHT[0] != -1) { close(pipeHT[0]); close(pipeHT[1]); } + free(client->hostname); + free(client); + return TOMSG_ERR_CONNECT; + } + + client->host_w = pipeHT[1]; + client->thread_r = pipeHT[0]; + client->thread_w = pipeTH[1]; + client->host_r = pipeTH[0]; + + pthread_t thread; + if (pthread_create(&thread, &attr, async_connect_thread_entry, client) < 0) { + pthread_attr_destroy(&attr); + close(client->host_w); close(client->host_r); + close(client->thread_w); close(client->thread_r); + free(client->hostname); + free(client); + return TOMSG_ERR_CONNECT; + } + + *clientp = client; + return TOMSG_OK; +} + +static bool check_readable(int fd) { + struct pollfd pfd; + pfd.fd = fd; + pfd.events = POLLIN; + pfd.revents = 0; + poll(&pfd, 1, 0); + return pfd.revents & (POLLIN | POLLHUP | POLLERR); +} + +void tomsg_async_connect_event_nullify(struct tomsg_async_connect_event *event) { + switch (event->type) { + case TOMSG_AC_HOSTKEY: + free(event->key.hostkey); + break; + + case TOMSG_AC_SUCCESS: + tomsg_close(event->client); + break; + } +} + +enum tomsg_retval tomsg_async_connect_next_event( + struct tomsg_async_connect *client, + struct tomsg_async_connect_event *event // output +) { + enum tomsg_retval final_retval; + + switch (client->state) { + case STATE_CONNECTING: { + if (!check_readable(client->host_r)) return TOMSG_ERR_AGAIN; + + unsigned char byte; + if (!readall(client->host_r, &byte, 1)) goto non_recoverable_error; + if (byte != TOMSG_OK) { + final_retval = byte; + goto free_return; + } + + // Now read the hostkey from the pipe + int64_t length; + if (!readall(client->host_r, (unsigned char*)&length, 8)) goto non_recoverable_error; + unsigned char *hash = malloc(length); + if (!hash) goto non_recoverable_error; + if (!readall(client->host_r, hash, length)) goto non_recoverable_error; + + client->state = STATE_KEY_RECEIVED; + event->type = TOMSG_AC_HOSTKEY; + event->key.hostkey = hash; + event->key.length = length; + return TOMSG_OK; + } + + case STATE_KEY_RECEIVED: + return TOMSG_ERR_AGAIN; // you need to accept or reject! + + case STATE_ACCEPTED: { + if (!check_readable(client->host_r)) return TOMSG_ERR_AGAIN; + + unsigned char byte; + if (!readall(client->host_r, &byte, 1)) goto non_recoverable_error; + if (byte == TOMSG_OK) { + event->type = TOMSG_AC_SUCCESS; + event->client = client->client; + client->client = NULL; + final_retval = TOMSG_OK; + goto free_return; + } else { + final_retval = byte; + goto free_return; + } + break; + } + } + +non_recoverable_error: + // Don't even know how to handle this correctly; let's just hope the thread kills itself somehow + close(client->host_w); + close(client->host_r); + return TOMSG_ERR_TRANSPORT; + +free_return: + free(client->hostname); + close(client->host_w); + close(client->host_r); + if (client->client) tomsg_close(client->client); + return final_retval; +} + +enum tomsg_retval tomsg_async_connect_accept(struct tomsg_async_connect *client, bool accept) { + enum tomsg_retval final_retval; + if (client->state != STATE_KEY_RECEIVED) { + fprintf(stderr, "connect_accept: client->state = %d != STATE_KEY_RECEIVED\n", client->state); + final_retval = TOMSG_ERR_TRANSPORT; // shrug + goto free_return; + } + + unsigned char byte = accept ? 1 : 0; + if (!writeall(client->host_w, &byte, 1)) { + fprintf(stderr, "writeall failed: %s\n", strerror(errno)); + goto non_recoverable_error; + } + + if (!accept) { + final_retval = TOMSG_ERR_UNTRUSTED; + goto free_return; + } + + client->state = STATE_ACCEPTED; + + return TOMSG_OK; + +non_recoverable_error: + // Don't even know how to handle this correctly; let's just hope the thread kills itself somehow + close(client->host_w); + close(client->host_r); + return TOMSG_ERR_TRANSPORT; + +free_return: + free(client->hostname); + close(client->host_w); + close(client->host_r); + if (client->client) tomsg_close(client->client); + return final_retval; +} + +int tomsg_async_connect_poll_fd(const struct tomsg_async_connect *client) { + return client->host_r; +} + void tomsg_close(struct tomsg_client *client) { if (client->conn) sshnc_close(client->conn); free(client->buffer); diff --git a/ssh/tomsg_clientlib.h b/ssh/tomsg_clientlib.h index 03f1fcf..e8cb3a7 100644 --- a/ssh/tomsg_clientlib.h +++ b/ssh/tomsg_clientlib.h @@ -21,6 +21,7 @@ enum tomsg_retval { // Error codes TOMSG_ERR_CONNECT, // Server refused connection + TOMSG_ERR_UNTRUSTED, // Hostkey was rejected TOMSG_ERR_CLOSED, // Server connection unexpectedly closed TOMSG_ERR_VERSION, // Server protocol version incompatible TOMSG_ERR_TRANSPORT, // Error in the underlying SSH transport @@ -45,6 +46,8 @@ const char* tomsg_strerror(enum tomsg_retval code); // If successful, stores a new connection structure in 'client' and returns // TOMSG_OK. On error, stores NULL in 'client' and returns an error code. +// This function blocks until version negotiation is complete. For a +// non-blocking version, see tomsg_async_connect(). enum tomsg_retval tomsg_connect( const char *hostname, int port, tomsg_hostkey_checker_t checker, @@ -52,6 +55,55 @@ enum tomsg_retval tomsg_connect( struct tomsg_client **client // output ); +struct tomsg_async_connect; + +// If this returns an error code, it stores NULL in *client. +enum tomsg_retval tomsg_async_connect( + const char *hostname, int port, + struct tomsg_async_connect **client // output +); + +enum tomsg_async_connect_event_type { + TOMSG_AC_HOSTKEY, // should check hostkey, see 'key' and tomsg_async_{accept,reject}() + TOMSG_AC_SUCCESS, // the tomsg_async_connect struct has been freed; connection is in 'client' +}; + +struct tomsg_async_connect_event { + enum tomsg_async_connect_event_type type; + + union { + struct { + // Same as arguments to tomsg_hostkey_checker_t + unsigned char *hostkey; + size_t length; + } key; // TOMSG_AC_HOSTKEY + struct tomsg_client *client; // TOMSG_AC_SUCCESS + }; +}; + +void tomsg_async_connect_event_nullify(struct tomsg_async_connect_event *event); + +// Will return TOMSG_ERR_AGAIN if no events are available at present. In that +// case, use poll(2) on the file descriptor from tomsg_async_connect_poll_fd(). +// NOTE: If an error message is returned, the struct tomsg_async_connect will +// already be freed. +enum tomsg_retval tomsg_async_connect_next_event( + struct tomsg_async_connect *client, + struct tomsg_async_connect_event *event // output +); + +// Accept or reject the hostkey obtained using a prior invocation of +// tomsg_async_connect_next_event(). Pass true to accept, false to reject. In +// case of rejection, as well as on error, the connection will be closed and +// the client structure freed. A successful rejection is indicated by +// TOMSG_ERR_UNTRUSTED. +enum tomsg_retval tomsg_async_connect_accept(struct tomsg_async_connect *client, bool accept); + +// Returns a file descriptor that can be listened for read-ready events (using +// e.g. select(2) or poll(2)). Whenever it becomes ready for reading, you +// should call tomsg_async_connect_next_event(). +int tomsg_async_connect_poll_fd(const struct tomsg_async_connect *client); + // Close the connection. This also frees the client structure. Note that even // in case of an error, you must still call this function to prevent a memory // leak. -- cgit v1.2.3-54-g00ecf