suricata
output-json-ftp.c
Go to the documentation of this file.
1 /* Copyright (C) 2017-2021 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Jeff Lucovsky <jeff@lucovsky.org>
22  *
23  * Implement JSON/eve logging app-layer FTP.
24  */
25 
26 
27 #include "suricata-common.h"
28 #include "debug.h"
29 #include "detect.h"
30 #include "pkt-var.h"
31 #include "conf.h"
32 
33 #include "threads.h"
34 #include "threadvars.h"
35 #include "tm-threads.h"
36 
37 #include "util-unittest.h"
38 #include "util-buffer.h"
39 #include "util-debug.h"
40 #include "util-mem.h"
41 
42 #include "output.h"
43 #include "output-json.h"
44 
45 #include "app-layer.h"
46 #include "app-layer-parser.h"
47 
48 #include "app-layer-ftp.h"
49 #include "output-json-ftp.h"
50 
51 static void EveFTPLogCommand(Flow *f, FTPTransaction *tx, JsonBuilder *jb)
52 {
53  /* Preallocate array objects to simplify failure case */
54  JsonBuilder *js_resplist = NULL;
55  if (!TAILQ_EMPTY(&tx->response_list)) {
56  js_resplist = jb_new_array();
57 
58  if (unlikely(js_resplist == NULL)) {
59  return;
60  }
61  }
62  jb_set_string(jb, "command", tx->command_descriptor->command_name);
63  uint32_t min_length = tx->command_descriptor->command_length + 1; /* command + space */
64  if (tx->request_length > min_length) {
65  jb_set_string_from_bytes(jb,
66  "command_data",
67  (const uint8_t *)tx->request + min_length,
68  tx->request_length - min_length - 1);
69  if (tx->request_truncated) {
70  JB_SET_TRUE(jb, "command_truncated");
71  } else {
72  JB_SET_FALSE(jb, "command_truncated");
73  }
74  }
75 
76  bool reply_truncated = false;
77 
78  if (!TAILQ_EMPTY(&tx->response_list)) {
79  int resp_code_cnt = 0;
80  int resp_cnt = 0;
81  FTPString *response;
82  bool is_cc_array_open = false;
83  TAILQ_FOREACH(response, &tx->response_list, next) {
84  /* handle multiple lines within the response, \r\n delimited */
85  uint8_t *where = response->str;
86  uint16_t length = 0;
87  uint16_t pos;
88  if (response->len > 0 && response->len <= UINT16_MAX) {
89  length = (uint16_t)response->len - 1;
90  } else if (response->len > UINT16_MAX) {
91  length = UINT16_MAX;
92  }
93  if (!reply_truncated && response->truncated) {
94  reply_truncated = true;
95  }
96  while ((pos = JsonGetNextLineFromBuffer((const char *)where, length)) != UINT16_MAX) {
97  uint16_t offset = 0;
98  /* Try to find a completion code for this line */
99  if (pos >= 3) {
100  /* Gather the completion code if present */
101  if (isdigit(where[0]) && isdigit(where[1]) && isdigit(where[2])) {
102  if (!is_cc_array_open) {
103  jb_open_array(jb, "completion_code");
104  is_cc_array_open = true;
105  }
106  jb_append_string_from_bytes(jb, (const uint8_t *)where, 3);
107  resp_code_cnt++;
108  offset = 4;
109  }
110  }
111  /* move past 3 character completion code */
112  if (pos >= offset) {
113  jb_append_string_from_bytes(js_resplist, (const uint8_t *)where + offset, pos - offset);
114  resp_cnt++;
115  }
116 
117  where += pos;
118  length -= pos;
119  }
120  }
121 
122  if (is_cc_array_open) {
123  jb_close(jb);
124  }
125  if (resp_cnt) {
126  jb_close(js_resplist);
127  jb_set_object(jb, "reply", js_resplist);
128  }
129  jb_free(js_resplist);
130  }
131 
132  if (tx->dyn_port) {
133  jb_set_uint(jb, "dynamic_port", tx->dyn_port);
134  }
135 
138  if (tx->active) {
139  JB_SET_STRING(jb, "mode", "active");
140  } else {
141  JB_SET_STRING(jb, "mode", "passive");
142  }
143  }
144 
145  if (tx->done) {
146  JB_SET_STRING(jb, "reply_received", "yes");
147  } else {
148  JB_SET_STRING(jb, "reply_received", "no");
149  }
150 
151  if (reply_truncated) {
152  JB_SET_TRUE(jb, "reply_truncated");
153  } else {
154  JB_SET_FALSE(jb, "reply_truncated");
155  }
156 }
157 
158 
159 static int JsonFTPLogger(ThreadVars *tv, void *thread_data,
160  const Packet *p, Flow *f, void *state, void *vtx, uint64_t tx_id)
161 {
162  SCEnter();
163  OutputJsonThreadCtx *thread = thread_data;
164 
165  const char *event_type;
166  if (f->alproto == ALPROTO_FTPDATA) {
167  event_type = "ftp_data";
168  } else {
169  event_type = "ftp";
170  }
171  FTPTransaction *tx = vtx;
172 
173  JsonBuilder *jb =
174  CreateEveHeaderWithTxId(p, LOG_DIR_FLOW, event_type, NULL, tx_id, thread->ctx);
175  if (likely(jb)) {
176  jb_open_object(jb, event_type);
177  if (f->alproto == ALPROTO_FTPDATA) {
178  EveFTPDataAddMetadata(f, jb);
179  } else {
180  EveFTPLogCommand(f, tx, jb);
181  }
182 
183  if (!jb_close(jb)) {
184  goto fail;
185  }
186 
187  OutputJsonBuilderBuffer(jb, thread);
188 
189  jb_free(jb);
190  }
191  return TM_ECODE_OK;
192 
193 fail:
194  jb_free(jb);
195  return TM_ECODE_FAILED;
196 }
197 
198 static OutputInitResult OutputFTPLogInitSub(ConfNode *conf,
199  OutputCtx *parent_ctx)
200 {
203  return OutputJsonLogInitSub(conf, parent_ctx);
204 }
205 
207 {
208  /* Register as an eve sub-module. */
209  OutputRegisterTxSubModule(LOGGER_JSON_FTP, "eve-log", "JsonFTPLog", "eve-log.ftp",
210  OutputFTPLogInitSub, ALPROTO_FTP, JsonFTPLogger, JsonLogThreadInit, JsonLogThreadDeinit,
211  NULL);
212  OutputRegisterTxSubModule(LOGGER_JSON_FTP, "eve-log", "JsonFTPLog", "eve-log.ftp",
213  OutputFTPLogInitSub, ALPROTO_FTPDATA, JsonFTPLogger, JsonLogThreadInit,
214  JsonLogThreadDeinit, NULL);
215 
216  SCLogDebug("FTP JSON logger registered.");
217 }
FTPTransaction_::request_truncated
bool request_truncated
Definition: app-layer-ftp.h:144
FtpCommand_::command_length
const uint8_t command_length
Definition: app-layer-ftp.h:95
tm-threads.h
FTPTransaction_::command_descriptor
const FtpCommand * command_descriptor
Definition: app-layer-ftp.h:147
output-json-ftp.h
OutputJsonLogInitSub
OutputInitResult OutputJsonLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
Definition: output-json-common.c:88
FTPTransaction_::request
uint8_t * request
Definition: app-layer-ftp.h:143
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
OutputJsonThreadCtx_::ctx
OutputJsonCtx * ctx
Definition: output-json.h:90
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:296
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
JsonLogThreadInit
TmEcode JsonLogThreadInit(ThreadVars *t, const void *initdata, void **data)
Definition: output-json-common.c:105
threads.h
Flow_
Flow data structure.
Definition: flow.h:353
FTPTransaction_::done
bool done
Definition: app-layer-ftp.h:150
OutputJsonBuilderBuffer
int OutputJsonBuilderBuffer(JsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:960
TAILQ_EMPTY
#define TAILQ_EMPTY(head)
Definition: queue.h:248
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:252
FtpCommand_::command
FtpRequestCommand command
Definition: app-layer-ftp.h:93
ALPROTO_FTP
@ ALPROTO_FTP
Definition: app-layer-protos.h:31
FtpCommand_::command_name
const char * command_name
Definition: app-layer-ftp.h:94
app-layer-ftp.h
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:83
FTPString_::len
uint32_t len
Definition: app-layer-ftp.h:130
LOGGER_JSON_FTP
@ LOGGER_JSON_FTP
Definition: suricata-common.h:450
util-unittest.h
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:82
OutputCtx_
Definition: tm-modules.h:78
OutputJsonThreadCtx_
Definition: output-json.h:89
FTPString_::truncated
bool truncated
Definition: app-layer-ftp.h:131
util-debug.h
JB_SET_STRING
#define JB_SET_STRING(jb, key, val)
Definition: rust.h:37
output-json.h
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:492
SCEnter
#define SCEnter(...)
Definition: util-debug.h:298
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:56
FTP_COMMAND_PORT
@ FTP_COMMAND_PORT
Definition: app-layer-ftp.h:65
pkt-var.h
JB_SET_TRUE
#define JB_SET_TRUE(jb, key)
Definition: rust.h:38
app-layer-parser.h
CreateEveHeaderWithTxId
JsonBuilder * CreateEveHeaderWithTxId(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr, uint64_t tx_id, OutputJsonCtx *eve_ctx)
Definition: output-json.c:905
Packet_
Definition: decode.h:433
conf.h
util-mem.h
OutputInitResult_
Definition: output.h:44
FTPTransaction_::request_length
uint32_t request_length
Definition: app-layer-ftp.h:142
suricata-common.h
ALPROTO_FTPDATA
@ ALPROTO_FTPDATA
Definition: app-layer-protos.h:47
OutputRegisterTxSubModule
void OutputRegisterTxSubModule(LoggerId id, const char *parent_name, const char *name, const char *conf_name, OutputInitSubFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
Definition: output.c:412
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:31
JB_SET_FALSE
#define JB_SET_FALSE(jb, key)
Definition: rust.h:39
threadvars.h
LOG_DIR_FLOW
@ LOG_DIR_FLOW
Definition: output-json.h:40
ConfNode_
Definition: conf.h:32
util-buffer.h
JsonFTPLogRegister
void JsonFTPLogRegister(void)
Definition: output-json-ftp.c:206
EveFTPDataAddMetadata
void EveFTPDataAddMetadata(const Flow *f, JsonBuilder *jb)
Definition: app-layer-ftp.c:1487
FTPTransaction_::dyn_port
uint16_t dyn_port
Definition: app-layer-ftp.h:149
FTPTransaction_::active
bool active
Definition: app-layer-ftp.h:151
likely
#define likely(expr)
Definition: util-optimize.h:32
FTP_COMMAND_EPRT
@ FTP_COMMAND_EPRT
Definition: app-layer-ftp.h:85
FTPString_
Definition: app-layer-ftp.h:128
JsonLogThreadDeinit
TmEcode JsonLogThreadDeinit(ThreadVars *t, void *data)
Definition: output-json-common.c:138
JsonGetNextLineFromBuffer
uint16_t JsonGetNextLineFromBuffer(const char *buffer, const uint16_t len)
Definition: app-layer-ftp.c:1477
FTPTransaction_
Definition: app-layer-ftp.h:135
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:460
FTPString_::str
uint8_t * str
Definition: app-layer-ftp.h:129
debug.h
output.h
app-layer.h