diff options
Diffstat (limited to 'src/fluent-bit/plugins/out_websocket')
-rw-r--r-- | src/fluent-bit/plugins/out_websocket/CMakeLists.txt | 5 | ||||
-rw-r--r-- | src/fluent-bit/plugins/out_websocket/websocket.c | 331 | ||||
-rw-r--r-- | src/fluent-bit/plugins/out_websocket/websocket.h | 54 | ||||
-rw-r--r-- | src/fluent-bit/plugins/out_websocket/websocket_conf.c | 159 | ||||
-rw-r--r-- | src/fluent-bit/plugins/out_websocket/websocket_conf.h | 32 |
5 files changed, 581 insertions, 0 deletions
diff --git a/src/fluent-bit/plugins/out_websocket/CMakeLists.txt b/src/fluent-bit/plugins/out_websocket/CMakeLists.txt new file mode 100644 index 000000000..5f715a173 --- /dev/null +++ b/src/fluent-bit/plugins/out_websocket/CMakeLists.txt @@ -0,0 +1,5 @@ +set(src + websocket_conf.c + websocket.c) + +FLB_PLUGIN(out_websocket "${src}" "") diff --git a/src/fluent-bit/plugins/out_websocket/websocket.c b/src/fluent-bit/plugins/out_websocket/websocket.c new file mode 100644 index 000000000..6a196e16d --- /dev/null +++ b/src/fluent-bit/plugins/out_websocket/websocket.c @@ -0,0 +1,331 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ + +/* Fluent Bit + * ========== + * Copyright (C) 2015-2022 The Fluent Bit Authors + * + * Licensed 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 <fluent-bit/flb_info.h> +#include <fluent-bit/flb_output.h> +#include <fluent-bit/flb_utils.h> +#include <fluent-bit/flb_network.h> +#include <fluent-bit/flb_time.h> +#include <fluent-bit/flb_upstream.h> +#include <fluent-bit/flb_crypto.h> +#include <fluent-bit/flb_pack.h> +#include <fluent-bit/flb_sds.h> +#include <fluent-bit/flb_http_client.h> +#include <fluent-bit/flb_config_map.h> +#include <msgpack.h> + +#include "websocket.h" +#include "websocket_conf.h" +struct flb_output_plugin out_websocket_plugin; + +#define SECURED_BY "Fluent Bit" + + +static int flb_ws_handshake(struct flb_connection *u_conn, + struct flb_out_ws *ctx) +{ + int ret; + size_t bytes_sent; + struct flb_http_client *c; + + if (!u_conn) { + flb_error("[output_ws] upstream connection error"); + return -1; + } + + /* Compose HTTP Client request */ + c = flb_http_client(u_conn, FLB_HTTP_GET, ctx->uri, + NULL, 0, NULL, 0, NULL, 0); + if (!c) { + flb_upstream_conn_release(u_conn); + return -1; + } + + flb_http_buffer_size(c, ctx->buffer_size); + flb_http_add_header(c, "Upgrade", 7, "websocket", 9); + flb_http_add_header(c, "Connection", 10, "Upgrade", 7); + flb_http_add_header(c, "Sec-WebSocket-Key", 17, "dGhlIHNhbXBsZSBub25jZQ==", 24); + flb_http_add_header(c, "Sec-WebSocket-Version", 21, "13", 2); + + /* Perform request*/ + ret = flb_http_do(c, &bytes_sent); + + if (ret != 0 || c->resp.status != 101) { + if (c->resp.payload_size > 0) { + flb_debug("[output_ws] Websocket Server Response\n%s", + c->resp.payload); + } + flb_http_client_destroy(c); + flb_upstream_conn_release(u_conn); + flb_debug("[out_ws] Http Get Operation ret = %i, http resp = %i", ret, c->resp.status); + return -1; + } + flb_http_client_destroy(c); + return 0; +} + +static void flb_ws_mask(char *data, int len, char *mask) +{ + int i; + for (i=0;i<len;++i) { + *(data+i) ^= *(mask+(i%4)); + } +} + +static int flb_ws_sendDataFrameHeader(struct flb_connection *u_conn, + struct flb_out_ws *ctx, const void *data, size_t bytes) +{ + int ret = -1; + char* data_frame_head; + size_t bytes_sent; + int data_frame_head_len = 0; + //TODO use random function to generate masking_key + char masking_key[4] = {0x12, 0x34, 0x56, 0x78}; + unsigned long long payloadSize = bytes; + + flb_ws_mask((char *)data, payloadSize, masking_key); + if (payloadSize < 126) { + data_frame_head = (char *)flb_malloc(6); + if (!data_frame_head) { + flb_errno(); + return -1; + } + data_frame_head[0] = 0x81; + data_frame_head[1] = (payloadSize & 0xff) | 0x80; + data_frame_head[2] = masking_key[0]; + data_frame_head[3] = masking_key[1]; + data_frame_head[4] = masking_key[2]; + data_frame_head[5] = masking_key[3]; + data_frame_head_len = 6; + } + else if (payloadSize < 65536) { + data_frame_head = (char *)flb_malloc(8); + if (!data_frame_head) { + flb_errno(); + return -1; + } + data_frame_head[0] = 0x81; + data_frame_head[1] = 126 | 0x80; + data_frame_head[2] = (payloadSize >> 8) & 0xff; + data_frame_head[3] = (payloadSize >> 0) & 0xff; + data_frame_head[4] = masking_key[0]; + data_frame_head[5] = masking_key[1]; + data_frame_head[6] = masking_key[2]; + data_frame_head[7] = masking_key[3]; + data_frame_head_len = 8; + } + else { + data_frame_head = (char *)flb_malloc(14); + if (!data_frame_head) { + flb_errno(); + return -1; + } + data_frame_head[0] = 0x81; + data_frame_head[1] = 127 | 0x80; + data_frame_head[2] = (payloadSize >> 56) & 0xff; + data_frame_head[3] = (payloadSize >> 48) & 0xff; + data_frame_head[4] = (payloadSize >> 40) & 0xff; + data_frame_head[5] = (payloadSize >> 32) & 0xff; + data_frame_head[6] = (payloadSize >> 24) & 0xff; + data_frame_head[7] = (payloadSize >> 16) & 0xff; + data_frame_head[8] = (payloadSize >> 8) & 0xff; + data_frame_head[9] = (payloadSize >> 0) & 0xff; + data_frame_head[10] = masking_key[0]; + data_frame_head[11] = masking_key[1]; + data_frame_head[12] = masking_key[2]; + data_frame_head[13] = masking_key[3]; + data_frame_head_len = 14; + } + ret = flb_io_net_write(u_conn, data_frame_head, data_frame_head_len, &bytes_sent); + if (ret == -1) { + flb_error("[out_ws] could not write dataframe header"); + goto error; + } + flb_free(data_frame_head); + return 0; + +error: + flb_free(data_frame_head); + return -1; +} + +static int cb_ws_init(struct flb_output_instance *ins, + struct flb_config *config, void *data) +{ + struct flb_out_ws *ctx = NULL; + + ctx = flb_ws_conf_create(ins, config); + if (!ctx) { + return -1; + } + + ctx->handshake = 1; + ctx->last_input_timestamp = time(NULL); + flb_output_set_context(ins, ctx); + return 0; +} + +static int cb_ws_exit(void *data, struct flb_config *config) +{ + struct flb_out_ws *ctx = data; + flb_ws_conf_destroy(ctx); + return 0; +} + +static void cb_ws_flush(struct flb_event_chunk *event_chunk, + struct flb_output_flush *out_flush, + struct flb_input_instance *i_ins, + void *out_context, + struct flb_config *config) +{ + int ret = -1; + size_t bytes_sent; + flb_sds_t json = NULL; + struct flb_upstream *u; + struct flb_connection *u_conn; + struct flb_out_ws *ctx = out_context; + time_t now; + + /* Get upstream context and connection */ + u = ctx->u; + u_conn = flb_upstream_conn_get(u); + + if (!u_conn) { + flb_error("[out_ws] no upstream connections available to %s:%i", u->tcp_host, u->tcp_port); + ctx->handshake = 1; + FLB_OUTPUT_RETURN(FLB_RETRY); + } + + now = time(NULL); + + //TODO how to determine the interval? conn disconnet is about 30 sec, so we set 20 ssecnds here. + flb_debug("[out_ws] interval is %ld and handshake is %d", now - ctx->last_input_timestamp, ctx->handshake); + if ((now - ctx->last_input_timestamp > ctx->idle_interval) && (ctx->handshake == 0)) { + ctx->handshake = 1; + flb_upstream_conn_release(u_conn); + FLB_OUTPUT_RETURN(FLB_RETRY); + } + ctx->last_input_timestamp = now; + + if (ctx->handshake == 1) { + /* Handshake with websocket server*/ + flb_info("[out_ws] handshake for ws"); + ret = flb_ws_handshake(u_conn, ctx); + if (ret == -1) { + flb_upstream_conn_release(u_conn); + FLB_OUTPUT_RETURN(FLB_RETRY); + } + ctx->handshake = 0; + } + + /* Data format process*/ + if (ctx->out_format != FLB_PACK_JSON_FORMAT_NONE) { + json = flb_pack_msgpack_to_json_format(event_chunk->data, + event_chunk->size, + ctx->out_format, + ctx->json_date_format, + ctx->json_date_key); + + if (!json) { + flb_error("[out_ws] error formatting JSON payload"); + flb_upstream_conn_release(u_conn); + FLB_OUTPUT_RETURN(FLB_ERROR); + } + } + + /* Write message header */ + if (ctx->out_format == FLB_PACK_JSON_FORMAT_NONE) { + ret = flb_ws_sendDataFrameHeader(u_conn, ctx, + event_chunk->data, + event_chunk->size); + } + else { + ret = flb_ws_sendDataFrameHeader(u_conn, ctx, json, flb_sds_len(json)); + } + + if (ret == -1) { + flb_error("[out_ws] dataFrameHeader sent failed"); + ctx->handshake = 1; + if (json) { + flb_sds_destroy(json); + } + flb_upstream_conn_release(u_conn); + FLB_OUTPUT_RETURN(FLB_RETRY); + } + + /* Write message body*/ + if (ctx->out_format == FLB_PACK_JSON_FORMAT_NONE) { + ret = flb_io_net_write(u_conn, + event_chunk->data, + event_chunk->size, + &bytes_sent); + } + else { + ret = flb_io_net_write(u_conn, json, flb_sds_len(json), &bytes_sent); + flb_sds_destroy(json); + } + + //flb_info("[out_ws] sendDataFrame number of bytes sent = %i", ret); + if (ret == -1) { + ctx->handshake = 1; + flb_upstream_conn_release(u_conn); + FLB_OUTPUT_RETURN(FLB_RETRY); + } + + /* Release the connection */ + flb_upstream_conn_release(u_conn); + FLB_OUTPUT_RETURN(FLB_OK); +} + +/* Configuration properties map */ +static struct flb_config_map config_map[] = { + { + FLB_CONFIG_MAP_STR, "uri", NULL, + 0, FLB_TRUE, offsetof(struct flb_out_ws, uri), + "Specify an optional URI for the target web socket server, e.g: /something" + }, + { + FLB_CONFIG_MAP_STR, "format", NULL, + 0, FLB_FALSE, 0, + "Set desired payload format: json, json_stream, json_lines, gelf or msgpack" + }, + { + FLB_CONFIG_MAP_STR, "json_date_format", "double", + 0, FLB_FALSE, 0, + "Specify the format of the date" + }, + { + FLB_CONFIG_MAP_STR, "json_date_key", "date", + 0, FLB_TRUE, offsetof(struct flb_out_ws, json_date_key), + "Specify the name of the date field in output" + }, + /* EOF */ + {0} +}; + +/* Plugin reference */ +struct flb_output_plugin out_websocket_plugin = { + .name = "websocket", + .description = "Websocket", + .cb_init = cb_ws_init, + .cb_flush = cb_ws_flush, + .cb_exit = cb_ws_exit, + .config_map = config_map, + .flags = FLB_OUTPUT_NET | FLB_IO_OPT_TLS, +}; diff --git a/src/fluent-bit/plugins/out_websocket/websocket.h b/src/fluent-bit/plugins/out_websocket/websocket.h new file mode 100644 index 000000000..69007294e --- /dev/null +++ b/src/fluent-bit/plugins/out_websocket/websocket.h @@ -0,0 +1,54 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ + +/* Fluent Bit + * ========== + * Copyright (C) 2015-2022 The Fluent Bit Authors + * + * Licensed 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 FLB_OUT_WS +#define FLB_OUT_WS + +#include <fluent-bit/flb_info.h> +#include <fluent-bit/flb_sds.h> + +/* + * Configuration: we put this separate from the main + * context so every Upstream Node can have it own configuration + * reference and pass it smoothly to the required caller. + * + * On simple mode (no HA), the structure is referenced + * by flb_forward->config. In HA mode the structure is referenced + * by the Upstream node context as an opaque data type. + */ +struct flb_out_ws { + int out_format; + char *uri; + char *host; + int port; + /* Timestamp format */ + int json_date_format; + + flb_sds_t json_date_key; + size_t buffer_size; + struct flb_upstream *u; + int handshake; + time_t last_input_timestamp; + int idle_interval; + + /* Plugin instance */ + struct flb_output_instance *ins; +}; + +#endif diff --git a/src/fluent-bit/plugins/out_websocket/websocket_conf.c b/src/fluent-bit/plugins/out_websocket/websocket_conf.c new file mode 100644 index 000000000..9c397a93c --- /dev/null +++ b/src/fluent-bit/plugins/out_websocket/websocket_conf.c @@ -0,0 +1,159 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ + +/* Fluent Bit + * ========== + * Copyright (C) 2015-2022 The Fluent Bit Authors + * + * Licensed 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 <fluent-bit/flb_info.h> +#include <fluent-bit/flb_output.h> +#include <fluent-bit/flb_utils.h> +#include <fluent-bit/flb_pack.h> +#include <fluent-bit/flb_sds.h> + +#include "websocket.h" +#include "websocket_conf.h" + +struct flb_out_ws *flb_ws_conf_create(struct flb_output_instance *ins, + struct flb_config *config) +{ + int ret; + int ulen; + int io_flags = 0; + char *uri = NULL; + char *tmp_uri = NULL; + const char *tmp; + int idle_interval; + struct flb_upstream *upstream; + struct flb_out_ws *ctx = NULL; + + /* Allocate plugin context */ + ctx = flb_calloc(1, sizeof(struct flb_out_ws)); + if (!ctx) { + flb_errno(); + return NULL; + } + ctx->ins = ins; + + ret = flb_output_config_map_set(ins, (void *) ctx); + if (ret == -1) { + flb_free(ctx); + return NULL; + } + + flb_output_net_default("127.0.0.1", 80, ins); + + /* Check if SSL/TLS is enabled */ +#ifdef FLB_HAVE_TLS + if (ins->use_tls == FLB_TRUE) { + io_flags = FLB_IO_TLS; + } + else { + io_flags = FLB_IO_TCP; + } +#else + io_flags = FLB_IO_TCP; +#endif + + upstream = flb_upstream_create(config, ins->host.name, ins->host.port, io_flags, ins->tls); + if (!upstream) { + flb_free(ctx); + return NULL; + } + + /* Output format */ + ctx->out_format = FLB_PACK_JSON_FORMAT_NONE; + tmp = flb_output_get_property("format", ins); + if (tmp) { + ret = flb_pack_to_json_format_type(tmp); + if (ret == -1) { + flb_error("[out_ws] unrecognized 'format' option '%s'. Using 'msgpack'", tmp); + } + else { + ctx->out_format = ret; + } + } + + /* Date format for JSON output */ + ctx->json_date_format = FLB_PACK_JSON_DATE_DOUBLE; + tmp = flb_output_get_property("json_date_format", ins); + if (tmp) { + ret = flb_pack_to_json_date_type(tmp); + if (ret == -1) { + flb_error("[out_ws] unrecognized 'json_date_format' option '%s'. Using 'double'", tmp); + } + else { + ctx->json_date_format = ret; + } + } + + if (ins->host.uri) { + uri = flb_strdup(ins->host.uri->full); + } + else { + tmp = flb_output_get_property("uri", ins); + if (tmp) { + uri = flb_strdup(tmp); + } + } + + if (!uri) { + uri = flb_strdup("/"); + } + else if (uri[0] != '/') { + ulen = strlen(uri); + tmp_uri = flb_malloc(ulen + 2); + tmp_uri[0] = '/'; + memcpy(tmp_uri + 1, uri, ulen); + tmp_uri[ulen + 1] = '\0'; + flb_free(uri); + uri = tmp_uri; + } + + idle_interval = ins->net_setup.keepalive_idle_timeout; + if (idle_interval > 5) { + ctx->idle_interval = idle_interval - 5; + } else if (idle_interval <= 2) { + flb_error("[out_ws] the keepalive timeout value is smaller than 2, which is meaningless! Please set it higher than 10 seconds. Current value will bring disorder for websocket plugin."); + ctx->idle_interval = idle_interval; + } else { + ctx->idle_interval = idle_interval - 2; + } + + ctx->u = upstream; + ctx->uri = uri; + ctx->host = ins->host.name; + ctx->port = ins->host.port; + + flb_output_upstream_set(ctx->u, ins); + + flb_info("[out_ws] we have following parameter %s, %s, %d, %d", ctx->uri, ctx->host, ctx->port, ctx->idle_interval); + return ctx; +} + +void flb_ws_conf_destroy(struct flb_out_ws *ctx) +{ + flb_info("[out_ws] flb_ws_conf_destroy "); + if (!ctx) { + return; + } + + if (ctx->u) { + flb_upstream_destroy(ctx->u); + } + + flb_free(ctx->uri); + flb_free(ctx); +} diff --git a/src/fluent-bit/plugins/out_websocket/websocket_conf.h b/src/fluent-bit/plugins/out_websocket/websocket_conf.h new file mode 100644 index 000000000..969f84aa5 --- /dev/null +++ b/src/fluent-bit/plugins/out_websocket/websocket_conf.h @@ -0,0 +1,32 @@ +/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ + +/* Fluent Bit + * ========== + * Copyright (C) 2015-2022 The Fluent Bit Authors + * + * Licensed 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 FLB_OUT_WS_CONF_H +#define FLB_OUT_WS_CONF_H + +#include <fluent-bit/flb_info.h> +#include <fluent-bit/flb_output.h> + +#include "websocket.h" + +struct flb_out_ws *flb_ws_conf_create(struct flb_output_instance *ins, + struct flb_config *config); +void flb_ws_conf_destroy(struct flb_out_ws *ctx); + +#endif |