File: logtofile_json.c

package info (click to toggle)
pgauditlogtofile 1.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 288 kB
  • sloc: ansic: 1,211; makefile: 21; sql: 11; sh: 7
file content (263 lines) | stat: -rw-r--r-- 8,423 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/*-------------------------------------------------------------------------
 *
 * logtofile_json.c
 *      Functions to create a json audit record
 *
 * Copyright (c) 2020-2025, Francisco Miguel Biete Banon
 *
 * This code is released under the PostgreSQL licence, as given at
 *  http://www.postgresql.org/about/licence/
 *-------------------------------------------------------------------------
 */
#include "logtofile_json.h"

#include "logtofile_string_format.h"

#include <access/xact.h>
#include <miscadmin.h>
#include <libpq/libpq-be.h>
#include <storage/proc.h>
#include <tcop/tcopprot.h>
#include <utils/json.h>
#include <utils/ps_status.h>

#include <stdarg.h>

/* forward declaration private functions */

inline static void pgauditlogtofile_append_json_key_value(StringInfo buf, const char *key, const char *value)
    __attribute__((always_inline));
static void pgauditlogtofile_append_json_key_fmt(StringInfo buf, const char *key, const char *fmt, ...)
    __attribute__((format(gnu_printf, 3, 4)));
inline static void pgauditlogtofile_pgaudit2json(StringInfo buf, char *message)
    __attribute__((always_inline));

/**
 * @brief Creates a json audit record
 * @param buf: buffer to write the json string
 * @param edata: error data
 * @param exclude_nchars: number of characters to exclude from pgaudit message
 * @return void
 */
void PgAuditLogToFile_json_audit(StringInfo buf, const ErrorData *edata, int exclude_nchars)
{
  char *formatted_log_time;

  /* json record start */
  appendStringInfoString(buf, "{\"log.source\":\"pgauditlogtofile\"");
  pgauditlogtofile_append_json_key_value(buf, "severity", "audit");

  /* timestamp with milliseconds */
  formatted_log_time = PgAuditLogToFile_format_now_timestamp_millis();
  pgauditlogtofile_append_json_key_value(buf, "timestamp", formatted_log_time);
  pfree(formatted_log_time);

  /* username */
  if (MyProcPort && MyProcPort->user_name)
    pgauditlogtofile_append_json_key_value(buf, "db.user", MyProcPort->user_name);

  /* database name */
  if (MyProcPort && MyProcPort->database_name)
    pgauditlogtofile_append_json_key_value(buf, "db.name", MyProcPort->database_name);

  /* Process id  */
  pgauditlogtofile_append_json_key_fmt(buf, "custom.process_id", "%d", MyProcPid);

  /* Remote host and port */
  if (MyProcPort && MyProcPort->remote_host)
  {
    pgauditlogtofile_append_json_key_value(buf, "net.peer.name", MyProcPort->remote_host);
    if (MyProcPort->remote_port && MyProcPort->remote_port[0] != '\0')
      pgauditlogtofile_append_json_key_value(buf, "net.peer.port", MyProcPort->remote_port);
  }

  /* session id - hex representation of start time . session process id */
  pgauditlogtofile_append_json_key_fmt(buf, "custom.session_id", "%lx.%x", (long)MyStartTime, MyProcPid);

  /* PS display */
  if (MyProcPort)
  {
    StringInfoData msgbuf;
    const char *psdisp;
    int displen;

    initStringInfo(&msgbuf);

    psdisp = get_ps_display(&displen);
    appendBinaryStringInfo(&msgbuf, psdisp, displen);

    pgauditlogtofile_append_json_key_value(buf, "custom.command_tag", msgbuf.data);

    pfree(msgbuf.data);
  }

  /* Virtual transaction id */
  /* keep VXID format in sync with lockfuncs.c */
#if (PG_VERSION_NUM >= 170000)
  if (MyProc != NULL && MyProc->vxid.procNumber != INVALID_PROC_NUMBER)
  {
    pgauditlogtofile_append_json_key_fmt(buf, "custom.virtual_transaction_id", "%d/%u", MyProc->vxid.procNumber, MyProc->vxid.lxid);
  }
#else
  if (MyProc != NULL && MyProc->backendId != InvalidBackendId)
  {
    pgauditlogtofile_append_json_key_fmt(buf, "custom.virtual_transaction_id", "%d/%u", MyProc->backendId, MyProc->lxid);
  }
#endif

  /* Transaction id */
  pgauditlogtofile_append_json_key_fmt(buf, "custom.virtual_transaction_id", "%u", GetTopTransactionIdIfAny());

  /* SQL state code */
  pgauditlogtofile_append_json_key_value(buf, "custom.state_code", unpack_sql_state(edata->sqlerrcode));

  /* errmessage - PGAUDIT formatted text, +7 exclude "AUDIT: " prefix */
  if (exclude_nchars > 0)
    pgauditlogtofile_pgaudit2json(buf, edata->message + exclude_nchars);
  else
    pgauditlogtofile_append_json_key_value(buf, "content", edata->message);

  /* errdetail or errdetail_log */
  if (edata->detail_log)
    pgauditlogtofile_append_json_key_value(buf, "custom.detail_log", edata->detail_log);
  else if (edata->detail)
    pgauditlogtofile_append_json_key_value(buf, "custom.detail_log", edata->detail);

  /* errhint */
  if (edata->hint)
    pgauditlogtofile_append_json_key_value(buf, "custom.err_hint", edata->hint);

  /* internal query */
  if (edata->internalquery)
    pgauditlogtofile_append_json_key_value(buf, "custom.internal_query", edata->internalquery);

  /* if printed internal query, print internal pos too */
  if (edata->internalpos > 0 && edata->internalquery != NULL)
  {
    pgauditlogtofile_append_json_key_fmt(buf, "custom.internal_query_pos", "%d", edata->internalpos);
  }

  /* errcontext */
  if (edata->context)
    pgauditlogtofile_append_json_key_value(buf, "custom.context", edata->context);

  /* user query --- only reported if not disabled by the caller */
  if (debug_query_string != NULL && !edata->hide_stmt)
  {
    pgauditlogtofile_append_json_key_value(buf, "custom.debug_query", debug_query_string);
    if (edata->cursorpos > 0)
    {
      pgauditlogtofile_append_json_key_fmt(buf, "custom.cursor_pos", "%d", edata->cursorpos);
    }
  }

  /* file error location */
  if (Log_error_verbosity >= PGERROR_VERBOSE)
  {
    if (edata->filename)
    {
      char buffNum[20];
      sprintf(buffNum, "%d", edata->lineno);

      pgauditlogtofile_append_json_key_value(buf, "custom.source_filename", edata->filename);
      pgauditlogtofile_append_json_key_value(buf, "custom.source_linenum", buffNum);
    }
    if (edata->funcname)
      pgauditlogtofile_append_json_key_value(buf, "custom.source_funcname", edata->funcname);
  }

  /* application name */
  if (application_name)
    pgauditlogtofile_append_json_key_value(buf, "custom.application_name", application_name);

  appendStringInfoCharMacro(buf, '}');
  appendStringInfoCharMacro(buf, '\n');
}

/* private methods */

/**
 * @brief Split and escapes each piece on pgaudit original message and writes it as json key/value pair.
 * @param buf Where to write
 * @param line original pgaudit message, it's modified in this function
 */
static void
pgauditlogtofile_pgaudit2json(StringInfo buf, char *line)
{
  char *token;

  token = strsep(&line, ",");
  if (token)
    pgauditlogtofile_append_json_key_value(buf, "custom.audit_type", token);

  token = strsep(&line, ",");
  if (token)
    pgauditlogtofile_append_json_key_value(buf, "custom.statement_id", token);

  token = strsep(&line, ",");
  if (token)
    pgauditlogtofile_append_json_key_value(buf, "custom.substatement_id", token);

  token = strsep(&line, ",");
  if (token)
    pgauditlogtofile_append_json_key_value(buf, "custom.class", token);

  token = strsep(&line, ",");
  if (token)
    pgauditlogtofile_append_json_key_value(buf, "custom.command", token);

  token = strsep(&line, ",");
  if (token)
    pgauditlogtofile_append_json_key_value(buf, "custom.object_name", token);

  if (line)
    pgauditlogtofile_append_json_key_value(buf, "content", line + 1);
}

/*
 * Derived from src/backend/utils/error/jsonlog.c appendJSONKeyValue (private)
 *
 * Append to a StringInfo a comma followed by a JSON key and a value.
 * The key is always escaped.  The value is always escaped.
 */
static void
pgauditlogtofile_append_json_key_value(StringInfo buf, const char *key, const char *value)
{
  if (value == NULL)
    return;

  if (key == NULL)
    return;

  appendStringInfoChar(buf, ',');
  escape_json(buf, key);
  appendStringInfoChar(buf, ':');
  escape_json(buf, value);
}

/**
 * @brief Append to a StringInfo a json key+value pair with quotes.
 * @param buf where to write
 * @param key json attribute key
 * @param fmt sprintf like formatting string
 * @param any format parameters
 */
static void
pgauditlogtofile_append_json_key_fmt(StringInfo buf, const char *key, const char *fmt, ...)
{
  StringInfoData formatted_value;
  va_list args;

  if (fmt == NULL)
    return;

  initStringInfo(&formatted_value);

  va_start(args, fmt);
  appendStringInfoVA(&formatted_value, fmt, args);
  va_end(args);

  pgauditlogtofile_append_json_key_value(buf, key, formatted_value.data);

  pfree(formatted_value.data);
}