From a1339466880b1dcaff2d2419f7d5aa5bd09fa1de Mon Sep 17 00:00:00 2001 From: Přemysl Janouch Date: Thu, 11 Sep 2014 08:10:33 +0200 Subject: Write stubs for the plugins Make them compile. --- .gitignore | 1 + Makefile | 6 +- plugin-api.h | 2 +- plugin-http.c | 24 ------- plugin-irc.c | 194 --------------------------------------------------- plugins/http.c | 95 +++++++++++++++++++++++++ plugins/irc.c | 215 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ponymap.c | 3 - utils.c | 3 + 9 files changed, 319 insertions(+), 224 deletions(-) delete mode 100644 plugin-http.c delete mode 100644 plugin-irc.c create mode 100644 plugins/http.c create mode 100644 plugins/irc.c diff --git a/.gitignore b/.gitignore index 4eee501..972f800 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # Build files /ponymap +/plugins/*.so # Qt Creator files /ponymap.config diff --git a/Makefile b/Makefile index 87a593e..8a75a99 100644 --- a/Makefile +++ b/Makefile @@ -9,13 +9,15 @@ LDFLAGS = `pkg-config --libs libssl` -lpthread -lrt -ldl .PHONY: all clean .SUFFIXES: -targets = ponymap +targets = ponymap plugins/http.so plugins/irc.so all: $(targets) clean: rm -f $(targets) -ponymap: ponymap.c utils.c siphash.c +ponymap: ponymap.c utils.c plugin-api.h siphash.c $(CC) ponymap.c siphash.c -o $@ $(CFLAGS) $(LDFLAGS) +plugins/%.so: plugins/%.c utils.c plugin-api.h + $(CC) $< -o $@ $(CFLAGS) $(LDFLAGS) -shared -fPIC diff --git a/plugin-api.h b/plugin-api.h index a8e6c58..96056ee 100644 --- a/plugin-api.h +++ b/plugin-api.h @@ -36,7 +36,7 @@ struct service const char *name; ///< Name of the service int flags; ///< Service flags - // XXX: what event happens when? + // scan_init -> on_data* -> [on_eof/on_error] -> on_aborted -> scan_free /// Initialize a scan, returning a handle to it void *(*scan_init) (struct unit *u); diff --git a/plugin-http.c b/plugin-http.c deleted file mode 100644 index 647814e..0000000 --- a/plugin-http.c +++ /dev/null @@ -1,24 +0,0 @@ -/* - * plugin-http.c: HTTP service detection plugin - * - * Copyright (c) 2014, Přemysl Janouch - * All rights reserved. - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION - * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN - * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - * - */ - -#include "utils.c" -#include "plugin-api.h" - -// TODO diff --git a/plugin-irc.c b/plugin-irc.c deleted file mode 100644 index 0daff0c..0000000 --- a/plugin-irc.c +++ /dev/null @@ -1,194 +0,0 @@ -/* - * plugin-http.c: IRC service detection plugin - * - * Copyright (c) 2014, Přemysl Janouch - * All rights reserved. - * - * Permission to use, copy, modify, and/or distribute this software for any - * purpose with or without fee is hereby granted, provided that the above - * copyright notice and this permission notice appear in all copies. - * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES - * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY - * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION - * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN - * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - * - */ - -#include "utils.c" -#include "plugin-api.h" - -// TODO - -// --- IRC utilities ----------------------------------------------------------- - -struct irc_message -{ - struct str_map tags; ///< IRC 3.2 message tags - char *prefix; ///< Message prefix - char *command; ///< IRC command - struct str_vector params; ///< Command parameters -}; - -static void -irc_parse_message_tags (const char *tags, struct str_map *out) -{ - struct str_vector v; - str_vector_init (&v); - split_str_ignore_empty (tags, ';', &v); - - for (size_t i = 0; i < v.len; i++) - { - char *key = v.vector[i], *equal_sign = strchr (key, '='); - if (equal_sign) - { - *equal_sign = '\0'; - str_map_set (out, key, xstrdup (equal_sign + 1)); - } - else - str_map_set (out, key, xstrdup ("")); - } - - str_vector_free (&v); -} - -static void -irc_parse_message (struct irc_message *msg, const char *line) -{ - str_map_init (&msg->tags); - msg->tags.free = free; - - msg->prefix = NULL; - msg->command = NULL; - str_vector_init (&msg->params); - - // IRC 3.2 message tags - if (*line == '@') - { - size_t tags_len = strcspn (++line, " "); - char *tags = xstrndup (line, tags_len); - irc_parse_message_tags (tags, &msg->tags); - free (tags); - - line += tags_len; - while (*line == ' ') - line++; - } - - // Prefix - if (*line == ':') - { - size_t prefix_len = strcspn (++line, " "); - msg->prefix = xstrndup (line, prefix_len); - line += prefix_len; - } - - // Command name - { - while (*line == ' ') - line++; - - size_t cmd_len = strcspn (line, " "); - msg->command = xstrndup (line, cmd_len); - line += cmd_len; - } - - // Arguments - while (true) - { - while (*line == ' ') - line++; - - if (*line == ':') - { - str_vector_add (&msg->params, ++line); - break; - } - - size_t param_len = strcspn (line, " "); - if (!param_len) - break; - - str_vector_add_owned (&msg->params, xstrndup (line, param_len)); - line += param_len; - } -} - -static void -irc_free_message (struct irc_message *msg) -{ - str_map_free (&msg->tags); - free (msg->prefix); - free (msg->command); - str_vector_free (&msg->params); -} - -static void -irc_process_buffer (struct str *buf, - void (*callback)(const struct irc_message *, const char *, void *), - void *user_data) -{ - char *start = buf->str, *end = start + buf->len; - for (char *p = start; p + 1 < end; p++) - { - // Split the input on newlines - if (p[0] != '\r' || p[1] != '\n') - continue; - - *p = 0; - - struct irc_message msg; - irc_parse_message (&msg, start); - callback (&msg, start, user_data); - irc_free_message (&msg); - - start = p + 2; - } - - // XXX: we might want to just advance some kind of an offset to avoid - // moving memory around unnecessarily. - str_remove_slice (buf, 0, start - buf->str); -} - -static int -irc_tolower (int c) -{ - if (c == '[') return '{'; - if (c == ']') return '}'; - if (c == '\\') return '|'; - if (c == '~') return '^'; - return c >= 'A' && c <= 'Z' ? c + ('a' - 'A') : c; -} - -static size_t -irc_strxfrm (char *dest, const char *src, size_t n) -{ - size_t len = strlen (src); - while (n-- && (*dest++ = irc_tolower (*src++))) - ; - return len; -} - -static int -irc_strcmp (const char *a, const char *b) -{ - int x; - while (*a || *b) - if ((x = irc_tolower (*a++) - irc_tolower (*b++))) - return x; - return 0; -} - -static int -irc_fnmatch (const char *pattern, const char *string) -{ - size_t pattern_size = strlen (pattern) + 1; - size_t string_size = strlen (string) + 1; - char x_pattern[pattern_size], x_string[string_size]; - irc_strxfrm (x_pattern, pattern, pattern_size); - irc_strxfrm (x_string, string, string_size); - return fnmatch (x_pattern, x_string, 0); -} diff --git a/plugins/http.c b/plugins/http.c new file mode 100644 index 0000000..d037326 --- /dev/null +++ b/plugins/http.c @@ -0,0 +1,95 @@ +/* + * http.c: HTTP service detection plugin + * + * Copyright (c) 2014, Přemysl Janouch + * All rights reserved. + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY + * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION + * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + */ + +#include "../utils.c" +#include "../plugin-api.h" + +// --- Service detection ------------------------------------------------------- + +static struct plugin_data +{ + void *ctx; ///< Application context + struct plugin_api *api; ///< Plugin API vtable +} +g_data; + +static void * +scan_init (struct unit *u) +{ + // TODO + return NULL; +} + +static void +scan_free (void *handle) +{ + // TODO +} + +static void +on_data (void *handle, struct unit *u, struct str *data) +{ + // TODO +} + +static void +on_eof (void *handle, struct unit *u) +{ + // TODO +} + +static void +on_error (void *handle, struct unit *u) +{ + // TODO +} + +static void +on_aborted (void *handle, struct unit *u) +{ + // TODO +} + +static struct service g_http_service = +{ + .name = "HTTP", + .flags = SERVICE_SUPPORTS_TLS, + + .scan_init = scan_init, + .scan_free = scan_free, + .on_data = on_data, + .on_eof = on_eof, + .on_error = on_error, + .on_aborted = on_aborted +}; + +static bool +initialize (void *ctx, struct plugin_api *api) +{ + g_data = (struct plugin_data) { .ctx = ctx, .api = api }; + api->register_service (ctx, &g_http_service); + return true; +} + +struct plugin_info ponymap_plugin_info = +{ + .api_version = API_VERSION, + .initialize = initialize +}; diff --git a/plugins/irc.c b/plugins/irc.c new file mode 100644 index 0000000..58f594a --- /dev/null +++ b/plugins/irc.c @@ -0,0 +1,215 @@ +/* + * http.c: IRC service detection plugin + * + * Copyright (c) 2014, Přemysl Janouch + * All rights reserved. + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY + * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION + * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + */ + +#include "../utils.c" +#include "../plugin-api.h" + +// --- IRC utilities ----------------------------------------------------------- + +struct irc_message +{ + struct str_map tags; ///< IRC 3.2 message tags + char *prefix; ///< Message prefix + char *command; ///< IRC command + struct str_vector params; ///< Command parameters +}; + +static void +irc_parse_message_tags (const char *tags, struct str_map *out) +{ + struct str_vector v; + str_vector_init (&v); + split_str_ignore_empty (tags, ';', &v); + + for (size_t i = 0; i < v.len; i++) + { + char *key = v.vector[i], *equal_sign = strchr (key, '='); + if (equal_sign) + { + *equal_sign = '\0'; + str_map_set (out, key, xstrdup (equal_sign + 1)); + } + else + str_map_set (out, key, xstrdup ("")); + } + + str_vector_free (&v); +} + +static void +irc_parse_message (struct irc_message *msg, const char *line) +{ + str_map_init (&msg->tags); + msg->tags.free = free; + + msg->prefix = NULL; + msg->command = NULL; + str_vector_init (&msg->params); + + // IRC 3.2 message tags + if (*line == '@') + { + size_t tags_len = strcspn (++line, " "); + char *tags = xstrndup (line, tags_len); + irc_parse_message_tags (tags, &msg->tags); + free (tags); + + line += tags_len; + while (*line == ' ') + line++; + } + + // Prefix + if (*line == ':') + { + size_t prefix_len = strcspn (++line, " "); + msg->prefix = xstrndup (line, prefix_len); + line += prefix_len; + } + + // Command name + { + while (*line == ' ') + line++; + + size_t cmd_len = strcspn (line, " "); + msg->command = xstrndup (line, cmd_len); + line += cmd_len; + } + + // Arguments + while (true) + { + while (*line == ' ') + line++; + + if (*line == ':') + { + str_vector_add (&msg->params, ++line); + break; + } + + size_t param_len = strcspn (line, " "); + if (!param_len) + break; + + str_vector_add_owned (&msg->params, xstrndup (line, param_len)); + line += param_len; + } +} + +static void +irc_free_message (struct irc_message *msg) +{ + str_map_free (&msg->tags); + free (msg->prefix); + free (msg->command); + str_vector_free (&msg->params); +} + +static void +irc_process_buffer (struct str *buf, + void (*callback)(const struct irc_message *, const char *, void *), + void *user_data) +{ + char *start = buf->str, *end = start + buf->len; + for (char *p = start; p + 1 < end; p++) + { + // Split the input on newlines + if (p[0] != '\r' || p[1] != '\n') + continue; + + *p = 0; + + struct irc_message msg; + irc_parse_message (&msg, start); + callback (&msg, start, user_data); + irc_free_message (&msg); + + start = p + 2; + } + + // XXX: we might want to just advance some kind of an offset to avoid + // moving memory around unnecessarily. + str_remove_slice (buf, 0, start - buf->str); +} + +static int +irc_tolower (int c) +{ + if (c == '[') return '{'; + if (c == ']') return '}'; + if (c == '\\') return '|'; + if (c == '~') return '^'; + return c >= 'A' && c <= 'Z' ? c + ('a' - 'A') : c; +} + +static size_t +irc_strxfrm (char *dest, const char *src, size_t n) +{ + size_t len = strlen (src); + while (n-- && (*dest++ = irc_tolower (*src++))) + ; + return len; +} + +static int +irc_strcmp (const char *a, const char *b) +{ + int x; + while (*a || *b) + if ((x = irc_tolower (*a++) - irc_tolower (*b++))) + return x; + return 0; +} + +static int +irc_fnmatch (const char *pattern, const char *string) +{ + size_t pattern_size = strlen (pattern) + 1; + size_t string_size = strlen (string) + 1; + char x_pattern[pattern_size], x_string[string_size]; + irc_strxfrm (x_pattern, pattern, pattern_size); + irc_strxfrm (x_string, string, string_size); + return fnmatch (x_pattern, x_string, 0); +} + +// --- Service detection ------------------------------------------------------- + +static struct plugin_data +{ + void *ctx; ///< Application context + struct plugin_api *api; ///< Plugin API vtable +} +g_data; + +static bool +initialize (void *ctx, struct plugin_api *api) +{ + g_data = (struct plugin_data) { .ctx = ctx, .api = api }; + // TODO: register a service + return true; +} + +struct plugin_info ponymap_plugin_info = +{ + .api_version = API_VERSION, + .initialize = initialize +}; diff --git a/ponymap.c b/ponymap.c index 5eb9cf0..185f657 100644 --- a/ponymap.c +++ b/ponymap.c @@ -18,9 +18,6 @@ * */ -#define PROGRAM_NAME "ponymap" -#define PROGRAM_VERSION "alpha" - #include "utils.c" #include "plugin-api.h" #include diff --git a/utils.c b/utils.c index f2aea74..18dd48e 100644 --- a/utils.c +++ b/utils.c @@ -18,6 +18,9 @@ * */ +#define PROGRAM_NAME "ponymap" +#define PROGRAM_VERSION "alpha" + #define _POSIX_C_SOURCE 199309L #define _XOPEN_SOURCE 600 -- cgit v1.2.3-70-g09d2