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 #include "suricata-common.h"
27 #include "detect.h"
28 #include "pkt-var.h"
29 #include "conf.h"
30 
31 #include "threads.h"
32 #include "threadvars.h"
33 #include "tm-threads.h"
34 
35 #include "util-unittest.h"
36 #include "util-buffer.h"
37 #include "util-debug.h"
38 #include "util-mem.h"
39 
40 #include "output.h"
41 #include "output-json.h"
42 
43 #include "app-layer.h"
44 #include "app-layer-parser.h"
45 
46 #include "app-layer-ftp.h"
47 #include "output-json-ftp.h"
48 
49 bool EveFTPLogCommand(void *vtx, JsonBuilder *jb)
50 {
51  FTPTransaction *tx = vtx;
52  /* Preallocate array objects to simplify failure case */
53  JsonBuilder *js_resplist = NULL;
54  if (!TAILQ_EMPTY(&tx->response_list)) {
55  js_resplist = jb_new_array();
56 
57  if (unlikely(js_resplist == NULL)) {
58  return false;
59  }
60  }
61  jb_open_object(jb, "ftp");
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_cnt = 0;
80  FTPString *response;
81  bool is_cc_array_open = false;
82  TAILQ_FOREACH(response, &tx->response_list, next) {
83  /* handle multiple lines within the response, \r\n delimited */
84  uint8_t *where = response->str;
85  uint16_t length = 0;
86  uint16_t pos;
87  if (response->len > 0 && response->len <= UINT16_MAX) {
88  length = (uint16_t)response->len - 1;
89  } else if (response->len > UINT16_MAX) {
90  length = UINT16_MAX;
91  }
92  if (!reply_truncated && response->truncated) {
93  reply_truncated = true;
94  }
95  while ((pos = JsonGetNextLineFromBuffer((const char *)where, length)) != UINT16_MAX) {
96  uint16_t offset = 0;
97  /* Try to find a completion code for this line */
98  if (pos >= 3) {
99  /* Gather the completion code if present */
100  if (isdigit(where[0]) && isdigit(where[1]) && isdigit(where[2])) {
101  if (!is_cc_array_open) {
102  jb_open_array(jb, "completion_code");
103  is_cc_array_open = true;
104  }
105  jb_append_string_from_bytes(jb, (const uint8_t *)where, 3);
106  offset = 4;
107  }
108  }
109  /* move past 3 character completion code */
110  if (pos >= offset) {
111  jb_append_string_from_bytes(js_resplist, (const uint8_t *)where + offset, pos - offset);
112  resp_cnt++;
113  }
114 
115  where += pos;
116  length -= pos;
117  }
118  }
119 
120  if (is_cc_array_open) {
121  jb_close(jb);
122  }
123  if (resp_cnt) {
124  jb_close(js_resplist);
125  jb_set_object(jb, "reply", js_resplist);
126  }
127  jb_free(js_resplist);
128  }
129 
130  if (tx->dyn_port) {
131  jb_set_uint(jb, "dynamic_port", tx->dyn_port);
132  }
133 
136  if (tx->active) {
137  JB_SET_STRING(jb, "mode", "active");
138  } else {
139  JB_SET_STRING(jb, "mode", "passive");
140  }
141  }
142 
143  if (tx->done) {
144  JB_SET_STRING(jb, "reply_received", "yes");
145  } else {
146  JB_SET_STRING(jb, "reply_received", "no");
147  }
148 
149  if (reply_truncated) {
150  JB_SET_TRUE(jb, "reply_truncated");
151  } else {
152  JB_SET_FALSE(jb, "reply_truncated");
153  }
154  jb_close(jb);
155  return true;
156 }
FTPTransaction_::request_truncated
bool request_truncated
Definition: app-layer-ftp.h:127
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:130
output-json-ftp.h
FTPTransaction_::request
uint8_t * request
Definition: app-layer-ftp.h:126
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
threads.h
FTPTransaction_::done
bool done
Definition: app-layer-ftp.h:133
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:94
FtpCommand_::command_name
const char * command_name
Definition: app-layer-ftp.h:93
app-layer-ftp.h
FTPString_::len
uint32_t len
Definition: app-layer-ftp.h:113
util-unittest.h
FTPString_::truncated
bool truncated
Definition: app-layer-ftp.h:114
util-debug.h
JB_SET_STRING
#define JB_SET_STRING(jb, key, val)
Definition: rust.h:26
output-json.h
detect.h
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:27
EveFTPLogCommand
bool EveFTPLogCommand(void *vtx, JsonBuilder *jb)
Definition: output-json-ftp.c:49
app-layer-parser.h
conf.h
util-mem.h
FTPTransaction_::request_length
uint32_t request_length
Definition: app-layer-ftp.h:125
suricata-common.h
JB_SET_FALSE
#define JB_SET_FALSE(jb, key)
Definition: rust.h:28
threadvars.h
util-buffer.h
FTPTransaction_::dyn_port
uint16_t dyn_port
Definition: app-layer-ftp.h:132
FTPTransaction_::active
bool active
Definition: app-layer-ftp.h:134
FTP_COMMAND_EPRT
@ FTP_COMMAND_EPRT
Definition: app-layer-ftp.h:85
FTPString_
Definition: app-layer-ftp.h:111
JsonGetNextLineFromBuffer
uint16_t JsonGetNextLineFromBuffer(const char *buffer, const uint16_t len)
Definition: app-layer-ftp.c:1405
FTPTransaction_
Definition: app-layer-ftp.h:118
FTPString_::str
uint8_t * str
Definition: app-layer-ftp.h:112
output.h
app-layer.h