suricata
output-json-pgsql.c
Go to the documentation of this file.
1 /* Copyright (C) 2022 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 Juliana Fajardini <jufajardini@oisf.net>
22  *
23  * Implement JSON/eve logging for app-layer Pgsql.
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-byte.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 "output-json-pgsql.h"
47 #include "rust.h"
48 
49 #define PGSQL_LOG_PASSWORDS BIT_U32(0)
50 
51 typedef struct OutputPgsqlCtx_ {
52  uint32_t flags;
55 
56 typedef struct LogPgsqlLogThread_ {
60 
61 static int JsonPgsqlLogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f, void *state,
62  void *txptr, uint64_t tx_id)
63 {
64  LogPgsqlLogThread *thread = thread_data;
65  SCLogDebug("Logging pgsql transaction %" PRIu64 ".", tx_id);
66 
67  JsonBuilder *jb =
68  CreateEveHeader(p, LOG_DIR_FLOW, "pgsql", NULL, thread->pgsqllog_ctx->eve_ctx);
69  if (unlikely(jb == NULL)) {
70  return TM_ECODE_FAILED;
71  }
72 
73  jb_open_object(jb, "pgsql");
74  if (!rs_pgsql_logger(txptr, thread->pgsqllog_ctx->flags, jb)) {
75  goto error;
76  }
77  jb_close(jb);
78 
79  OutputJsonBuilderBuffer(jb, thread->ctx);
80  jb_free(jb);
81 
82  return TM_ECODE_OK;
83 
84 error:
85  jb_free(jb);
86  return TM_ECODE_FAILED;
87 }
88 
89 static void OutputPgsqlLogDeInitCtxSub(OutputCtx *output_ctx)
90 {
91  OutputPgsqlCtx *pgsqllog_ctx = (OutputPgsqlCtx *)output_ctx->data;
92  SCFree(pgsqllog_ctx);
93  SCFree(output_ctx);
94 }
95 
96 static void JsonPgsqlLogParseConfig(ConfNode *conf, OutputPgsqlCtx *pgsqllog_ctx)
97 {
98  pgsqllog_ctx->flags = ~0U;
99 
100  const char *query = ConfNodeLookupChildValue(conf, "passwords");
101  if (query != NULL) {
102  if (ConfValIsTrue(query)) {
103  pgsqllog_ctx->flags |= PGSQL_LOG_PASSWORDS;
104  } else {
105  pgsqllog_ctx->flags &= ~PGSQL_LOG_PASSWORDS;
106  }
107  } else {
108  pgsqllog_ctx->flags &= ~PGSQL_LOG_PASSWORDS;
109  }
110 }
111 
112 static OutputInitResult OutputPgsqlLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
113 {
114  OutputInitResult result = { NULL, false };
115  OutputJsonCtx *ojc = parent_ctx->data;
116 
117  OutputPgsqlCtx *pgsql_ctx = SCMalloc(sizeof(OutputPgsqlCtx));
118  if (unlikely(pgsql_ctx == NULL))
119  return result;
120 
121  OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
122  if (unlikely(output_ctx == NULL)) {
123  SCFree(pgsql_ctx);
124  return result;
125  }
126 
127  pgsql_ctx->eve_ctx = ojc;
128 
129  output_ctx->data = pgsql_ctx;
130  output_ctx->DeInit = OutputPgsqlLogDeInitCtxSub;
131 
132  JsonPgsqlLogParseConfig(conf, pgsql_ctx);
133 
135 
136  SCLogDebug("PostgreSQL log sub-module initialized.");
137 
138  result.ctx = output_ctx;
139  result.ok = true;
140  return result;
141 }
142 
143 static TmEcode JsonPgsqlLogThreadInit(ThreadVars *t, const void *initdata, void **data)
144 {
145  LogPgsqlLogThread *thread = SCCalloc(1, sizeof(LogPgsqlLogThread));
146  if (unlikely(thread == NULL)) {
147  return TM_ECODE_FAILED;
148  }
149 
150  if (initdata == NULL) {
151  SCLogDebug("Error getting context for EveLogPgsql. \"initdata\" is NULL.");
152  goto error_exit;
153  }
154 
155  thread->pgsqllog_ctx = ((OutputCtx *)initdata)->data;
156  thread->ctx = CreateEveThreadCtx(t, thread->pgsqllog_ctx->eve_ctx);
157  if (!thread->ctx) {
158  goto error_exit;
159  }
160  *data = (void *)thread;
161 
162  return TM_ECODE_OK;
163 
164 error_exit:
165  SCFree(thread);
166  return TM_ECODE_FAILED;
167 }
168 
169 static TmEcode JsonPgsqlLogThreadDeinit(ThreadVars *t, void *data)
170 {
171  LogPgsqlLogThread *thread = (LogPgsqlLogThread *)data;
172  if (thread == NULL) {
173  return TM_ECODE_OK;
174  }
175  FreeEveThreadCtx(thread->ctx);
176  SCFree(thread);
177  return TM_ECODE_OK;
178 }
179 
181 {
182  /* PGSQL_START_REMOVE */
183  if (ConfGetNode("app-layer.protocols.pgsql") == NULL) {
184  SCLogDebug("Disabling Pgsql eve-logger");
185  return;
186  }
187  /* PGSQL_END_REMOVE */
188  /* Register as an eve sub-module. */
189  OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonPgsqlLog", "eve-log.pgsql",
190  OutputPgsqlLogInitSub, ALPROTO_PGSQL, JsonPgsqlLogger, JsonPgsqlLogThreadInit,
191  JsonPgsqlLogThreadDeinit, NULL);
192 
193  SCLogDebug("PostgreSQL JSON logger registered.");
194 }
util-byte.h
tm-threads.h
PGSQL_LOG_PASSWORDS
#define PGSQL_LOG_PASSWORDS
Definition: output-json-pgsql.c:49
JsonPgsqlLogRegister
void JsonPgsqlLogRegister(void)
Definition: output-json-pgsql.c:180
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
FreeEveThreadCtx
void FreeEveThreadCtx(OutputJsonThreadCtx *ctx)
Definition: output-json-common.c:58
ConfGetNode
ConfNode * ConfGetNode(const char *name)
Get a ConfNode by name.
Definition: conf.c:181
threads.h
OutputJsonCtx_
Definition: output-json.h:81
Flow_
Flow data structure.
Definition: flow.h:357
output-json-pgsql.h
OutputJsonBuilderBuffer
int OutputJsonBuilderBuffer(JsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:934
CreateEveThreadCtx
OutputJsonThreadCtx * CreateEveThreadCtx(ThreadVars *t, OutputJsonCtx *ctx)
Definition: output-json-common.c:29
rust.h
LogPgsqlLogThread_::pgsqllog_ctx
OutputPgsqlCtx * pgsqllog_ctx
Definition: output-json-pgsql.c:57
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:85
util-unittest.h
ConfValIsTrue
int ConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:531
OutputPgsqlCtx_::eve_ctx
OutputJsonCtx * eve_ctx
Definition: output-json-pgsql.c:53
OutputCtx_::data
void * data
Definition: tm-modules.h:81
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
OutputCtx_
Definition: tm-modules.h:78
OutputJsonThreadCtx_
Definition: output-json.h:89
LogPgsqlLogThread_::ctx
OutputJsonThreadCtx * ctx
Definition: output-json-pgsql.c:58
util-debug.h
LogPgsqlLogThread_
Definition: output-json-pgsql.c:56
OutputInitResult_::ctx
OutputCtx * ctx
Definition: output.h:47
output-json.h
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:477
CreateEveHeader
JsonBuilder * CreateEveHeader(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr, OutputJsonCtx *eve_ctx)
Definition: output-json.c:796
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
pkt-var.h
OutputInitResult_::ok
bool ok
Definition: output.h:48
LogPgsqlLogThread
struct LogPgsqlLogThread_ LogPgsqlLogThread
app-layer-parser.h
Packet_
Definition: decode.h:428
conf.h
TmEcode
TmEcode
Definition: tm-threads-common.h:83
OutputPgsqlCtx_
Definition: output-json-pgsql.c:51
OutputPgsqlCtx_::flags
uint32_t flags
Definition: output-json-pgsql.c:52
OutputInitResult_
Definition: output.h:46
suricata-common.h
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:84
ALPROTO_PGSQL
@ ALPROTO_PGSQL
Definition: app-layer-protos.h:57
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:410
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
threadvars.h
LOG_DIR_FLOW
@ LOG_DIR_FLOW
Definition: output-json.h:40
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
LOGGER_JSON_TX
@ LOGGER_JSON_TX
Definition: suricata-common.h:456
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
util-buffer.h
OutputPgsqlCtx
struct OutputPgsqlCtx_ OutputPgsqlCtx
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
output.h
app-layer.h
ConfNodeLookupChildValue
const char * ConfNodeLookupChildValue(const ConfNode *node, const char *name)
Lookup the value of a child configuration node by name.
Definition: conf.c:808