Add support for SASL mechanisms handled by scripts

This implements the suggested API from #323 with a caveat: currently the
SASL mechanisms are tied to IRC and needs a bit of extra work to make
them generic enough to move to the regular src/core instead of solely in
src/irc/core.

This greatly simplifies scripts for each mechanism since this handles
the splitting and reassembly of the 400 byte fragments going to and
coming from the server.

The ECDSA-NIST256P-CHALLENGE mechanism has been reimplemented using this
new API and found to work.
This commit is contained in:
Kenny Root 2016-06-28 18:26:02 -07:00
commit 7c37b2a4d6
14 changed files with 286 additions and 96 deletions

View file

@ -28,50 +28,131 @@
#define SASL_TIMEOUT (20 * 1000) // ms
static gboolean sasl_timeout(IRC_SERVER_REC *server)
static GSList *sasl_mechanisms;
static GHashTable *sasl_buffers;
void sasl_mechanism_register(const char *name)
{
if (gslist_find_string(sasl_mechanisms, name) == NULL) {
sasl_mechanisms = g_slist_append(sasl_mechanisms, g_strdup(name));
}
}
void sasl_mechanism_unregister(const char *name)
{
GSList *pos;
pos = gslist_find_string(sasl_mechanisms, name);
if (pos != NULL) {
g_free(pos->data);
sasl_mechanisms = g_slist_remove(sasl_mechanisms, pos->data);
}
}
static gboolean is_registered_mechanism(const char *name)
{
return gslist_find_string(sasl_mechanisms, name) != NULL;
}
static void sasl_emit_abort_signal(IRC_SERVER_REC *server)
{
IRC_SERVER_CONNECT_REC *conn;
conn = server->connrec;
if (is_registered_mechanism(conn->sasl_mechanism)) {
char *str;
str = g_strconcat("server sasl abort ", conn->sasl_mechanism, NULL);
ascii_strdown(str+18);
if (!signal_emit(str, 1, server)) {
g_warning("No one handled the abort of SASL mechanism %s",
conn->sasl_mechanism);
}
g_free(str);
}
}
/*
* This is the callback from g_timeout_add.
*/
static gboolean sasl_timeout_callback(IRC_SERVER_REC *server)
{
/* The authentication timed out, we can't do much beside terminating it */
irc_send_cmd_now(server, "AUTHENTICATE *");
cap_finish_negotiation(server);
server->sasl_timeout = 0;
sasl_abort(server);
signal_emit("server sasl failure", 2, server, "The authentication timed out");
return FALSE;
}
static void sasl_timeout_cancel(IRC_SERVER_REC *server)
{
if (server->sasl_timeout != 0) {
g_source_remove(server->sasl_timeout);
server->sasl_timeout = 0;
}
}
static void sasl_timeout_start(IRC_SERVER_REC *server)
{
sasl_timeout_cancel(server);
server->sasl_timeout = g_timeout_add_seconds(SASL_TIMEOUT, (GSourceFunc) sasl_timeout_callback,
server);
}
void sasl_abort(IRC_SERVER_REC *server)
{
sasl_timeout_cancel(server);
irc_send_cmd_now(server, "AUTHENTICATE *");
cap_finish_negotiation(server);
sasl_emit_abort_signal(server);
}
static void sasl_start(IRC_SERVER_REC *server, const char *data, const char *from)
{
IRC_SERVER_CONNECT_REC *conn;
conn = server->connrec;
switch (conn->sasl_mechanism) {
case SASL_MECHANISM_PLAIN:
irc_send_cmd_now(server, "AUTHENTICATE PLAIN");
break;
if (!g_strcmp0(conn->sasl_mechanism, "PLAIN")) {
irc_send_cmd_now(server, "AUTHENTICATE PLAIN");
sasl_timeout_start(server);
} else if (!g_strcmp0(conn->sasl_mechanism, "external")) {
irc_send_cmd_now(server, "AUTHENTICATE EXTERNAL");
sasl_timeout_start(server);
} else if (is_registered_mechanism(conn->sasl_mechanism)) {
char *str;
case SASL_MECHANISM_EXTERNAL:
irc_send_cmd_now(server, "AUTHENTICATE EXTERNAL");
break;
str = g_strconcat("server sasl init ", conn->sasl_mechanism, NULL);
ascii_strdown(str+17);
if (!signal_emit(str, 1, server)) {
g_warning("Nothing handled initialization of SASL mechanism %s",
conn->sasl_mechanism);
}
g_free(str);
str = g_strconcat("AUTHENTICATE ", conn->sasl_mechanism, NULL);
irc_send_cmd_now(server, str);
g_free(str);
sasl_timeout_start(server);
} else {
g_warning("Unsupported SASL mechanism \"%s\" selected", conn->sasl_mechanism);
sasl_abort(server);
}
server->sasl_timeout = g_timeout_add(SASL_TIMEOUT, (GSourceFunc) sasl_timeout, server);
}
static void sasl_fail(IRC_SERVER_REC *server, const char *data, const char *from)
{
char *params, *error;
/* Stop any pending timeout, if any */
if (server->sasl_timeout != 0) {
g_source_remove(server->sasl_timeout);
server->sasl_timeout = 0;
}
sasl_timeout_cancel(server);
params = event_get_params(data, 2, NULL, &error);
signal_emit("server sasl failure", 2, server, error);
sasl_emit_abort_signal(server);
/* Terminate the negotiation */
cap_finish_negotiation(server);
@ -81,12 +162,10 @@ static void sasl_fail(IRC_SERVER_REC *server, const char *data, const char *from
static void sasl_already(IRC_SERVER_REC *server, const char *data, const char *from)
{
if (server->sasl_timeout != 0) {
g_source_remove(server->sasl_timeout);
server->sasl_timeout = 0;
}
sasl_timeout_cancel(server);
signal_emit("server sasl success", 1, server);
sasl_emit_abort_signal(server);
/* We're already authenticated, do nothing */
cap_finish_negotiation(server);
@ -94,10 +173,7 @@ static void sasl_already(IRC_SERVER_REC *server, const char *data, const char *f
static void sasl_success(IRC_SERVER_REC *server, const char *data, const char *from)
{
if (server->sasl_timeout != 0) {
g_source_remove(server->sasl_timeout);
server->sasl_timeout = 0;
}
sasl_timeout_cancel(server);
signal_emit("server sasl success", 1, server);
@ -105,52 +181,112 @@ static void sasl_success(IRC_SERVER_REC *server, const char *data, const char *f
cap_finish_negotiation(server);
}
static void sasl_send_step_if_complete(IRC_SERVER_REC *server, const char *enc_req)
{
char *buffer;
size_t enc_req_len;
enc_req_len = strlen(enc_req);
buffer = g_hash_table_lookup(sasl_buffers, server->tag);
if (buffer != NULL) {
if (!g_strcmp0("+", enc_req)) {
enc_req = buffer;
} else {
enc_req = g_strconcat(buffer, enc_req, NULL);
}
g_hash_table_remove(sasl_buffers, server->tag);
}
if (enc_req_len == 400) {
g_hash_table_insert(sasl_buffers, server->tag, g_strdup(enc_req));
} else {
gchar *output;
GBytes *decoded;
IRC_SERVER_CONNECT_REC *conn;
if (!g_strcmp0("+", enc_req)) {
decoded = g_bytes_new("", 0);
} else {
gsize dec_len;
guchar *tmp;
tmp = g_base64_decode(enc_req, &dec_len);
decoded = g_bytes_new(tmp, dec_len);
}
conn = server->connrec;
output = g_strconcat("server sasl step ", conn->sasl_mechanism, NULL);
ascii_strdown(output+17);
if (!signal_emit(output, 2, server, decoded)) {
g_warning("No one can handle SASL mechanism: %s",
conn->sasl_mechanism);
}
g_free(output);
g_bytes_unref(decoded);
}
g_free_not_null(buffer);
}
void sasl_send_response(IRC_SERVER_REC *server, GBytes *response)
{
char *enc;
const guchar *p;
gsize len;
size_t offset, enc_len;
p = g_bytes_get_data(response, &len);
enc = g_base64_encode(p, len);
enc_len = strlen(enc);
offset = 0;
while (offset < enc_len) {
irc_send_cmdv(server, "AUTHENTICATE %400s",
offset == enc_len ? "+" : (enc + offset));
offset += 400;
}
g_free(enc);
}
static void sasl_step(IRC_SERVER_REC *server, const char *data, const char *from)
{
IRC_SERVER_CONNECT_REC *conn;
GString *req;
char *enc_req;
conn = server->connrec;
/* Stop the timer */
if (server->sasl_timeout != 0) {
g_source_remove(server->sasl_timeout);
server->sasl_timeout = 0;
}
sasl_timeout_cancel(server);
switch (conn->sasl_mechanism) {
case SASL_MECHANISM_PLAIN:
/* At this point we assume that conn->sasl_{username, password} are non-NULL.
* The PLAIN mechanism expects a NULL-separated string composed by the authorization identity, the
* authentication identity and the password.
* The authorization identity field is explicitly set to the user provided username.
* The whole request is then encoded in base64. */
if (!g_strcmp0(conn->sasl_mechanism, "plain")) {
/* At this point we assume that conn->sasl_{username, password} are non-NULL.
* The PLAIN mechanism expects a NULL-separated string composed by the authorization identity, the
* authentication identity and the password.
* The authorization identity field is explicitly set to the user provided username.
* The whole request is then encoded in base64. */
GBytes *bytes;
req = g_string_new(NULL);
req = g_string_new(NULL);
g_string_append(req, conn->sasl_username);
g_string_append_c(req, '\0');
g_string_append(req, conn->sasl_username);
g_string_append_c(req, '\0');
g_string_append(req, conn->sasl_password);
g_string_append(req, conn->sasl_username);
g_string_append_c(req, '\0');
g_string_append(req, conn->sasl_username);
g_string_append_c(req, '\0');
g_string_append(req, conn->sasl_password);
enc_req = g_base64_encode((const guchar *)req->str, req->len);
irc_send_cmdv(server, "AUTHENTICATE %s", enc_req);
g_free(enc_req);
g_string_free(req, TRUE);
break;
case SASL_MECHANISM_EXTERNAL:
/* Empty response */
irc_send_cmdv(server, "AUTHENTICATE +");
break;
bytes = g_bytes_new(req->str, req->len);
sasl_send_response(server, bytes);
g_string_free(req, TRUE);
} else if (!g_strcmp0(conn->sasl_mechanism, "external")) {
/* Empty response */
irc_send_cmdv(server, "AUTHENTICATE +");
} else {
sasl_send_step_if_complete(server, data);
}
/* We expect a response within a reasonable time */
server->sasl_timeout = g_timeout_add(SASL_TIMEOUT, (GSourceFunc) sasl_timeout, server);
sasl_timeout_start(server);
}
static void sasl_disconnected(IRC_SERVER_REC *server)
@ -161,14 +297,15 @@ static void sasl_disconnected(IRC_SERVER_REC *server)
return;
}
if (server->sasl_timeout != 0) {
g_source_remove(server->sasl_timeout);
server->sasl_timeout = 0;
}
sasl_timeout_cancel(server);
sasl_emit_abort_signal(server);
}
void sasl_init(void)
{
sasl_buffers = g_hash_table_new((GHashFunc) g_str_hash, (GCompareFunc) g_str_equal);
signal_add_first("server cap ack sasl", (SIGNAL_FUNC) sasl_start);
signal_add_first("event authenticate", (SIGNAL_FUNC) sasl_step);
signal_add_first("event 903", (SIGNAL_FUNC) sasl_success);
@ -182,6 +319,8 @@ void sasl_init(void)
void sasl_deinit(void)
{
g_hash_table_destroy(sasl_buffers);
signal_remove("server cap ack sasl", (SIGNAL_FUNC) sasl_start);
signal_remove("event authenticate", (SIGNAL_FUNC) sasl_step);
signal_remove("event 903", (SIGNAL_FUNC) sasl_success);