suricata
util-print.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2023 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 Victor Julien <victor@inliniac.net>
22  *
23  * Print utility functions
24  */
25 
26 #include "suricata-common.h"
27 #include "util-print.h"
28 #include "util-error.h"
29 #include "util-debug.h"
30 #include "util-validate.h"
31 #include "rust.h"
32 
33 /**
34  * \brief print a buffer as hex on a single line
35  *
36  * Prints in the format "00 AA BB"
37  *
38  * \param nbuf buffer into which the output is written
39  * \param offset of where to start writing into the buffer
40  * \param max_size the size of the output buffer
41  * \param buf buffer to print from
42  * \param buflen length of the input buffer
43  */
44 void PrintBufferRawLineHex(char *nbuf, int *offset, int max_size, const uint8_t *buf, uint32_t buflen)
45 {
46  for (uint32_t u = 0; u < buflen; u++) {
47  PrintBufferData(nbuf, offset, max_size, "%02X ", buf[u]);
48  }
49 }
50 
51 /**
52  * \brief print a buffer as hex on a single line into retbuf buffer
53  *
54  * Prints in the format "00 AA BB"
55  *
56  * \param retbuf pointer to the buffer which will have the result
57  * \param rebuflen length of the buffer
58  * \param buf buffer to print from
59  * \param buflen length of the input buffer
60  */
61 void PrintRawLineHexBuf(char *retbuf, uint32_t retbuflen, const uint8_t *buf, uint32_t buflen)
62 {
63  uint32_t offset = 0;
64  for (uint32_t u = 0; u < buflen; u++) {
65  PrintBufferData(retbuf, &offset, retbuflen, "%02X ", buf[u]);
66  }
67 }
68 
69 void PrintRawUriFp(FILE *fp, uint8_t *buf, uint32_t buflen)
70 {
71 #define BUFFER_LENGTH 2048
72  char nbuf[BUFFER_LENGTH] = "";
73  uint32_t offset = 0;
74 
75  for (uint32_t u = 0; u < buflen; u++) {
76  if (isprint(buf[u]) && buf[u] != '\"') {
77  if (buf[u] == '\\') {
79  "\\\\");
80  } else {
82  "%c", buf[u]);
83  }
84  } else {
86  "\\x%02X", buf[u]);
87  }
88  }
89 
90  fprintf(fp, "%s", nbuf);
91 }
92 
93 void PrintRawUriBuf(char *retbuf, uint32_t *offset, uint32_t retbuflen,
94  uint8_t *buf, uint32_t buflen)
95 {
96  for (uint32_t u = 0; u < buflen; u++) {
97  if (isprint(buf[u]) && buf[u] != '\"') {
98  if (buf[u] == '\\') {
99  PrintBufferData(retbuf, offset, retbuflen,
100  "\\\\");
101  } else {
102  PrintBufferData(retbuf, offset, retbuflen,
103  "%c", buf[u]);
104  }
105  } else {
106  PrintBufferData(retbuf, offset, retbuflen,
107  "\\x%02X", buf[u]);
108  }
109  }
110 
111  return;
112 }
113 
114 void PrintRawDataFp(FILE *fp, const uint8_t *buf, uint32_t buflen)
115 {
116  int ch = 0;
117 
118  if (buf == NULL) {
119  fprintf(fp, " (null)\n");
120  return;
121  }
122  for (uint32_t u = 0; u < buflen; u += 16) {
123  fprintf(fp ," %04X ", u);
124  for (ch = 0; (u+ch) < buflen && ch < 16; ch++) {
125  fprintf(fp, "%02X ", (uint8_t)buf[u+ch]);
126 
127  if (ch == 7) fprintf(fp, " ");
128  }
129  if (ch == 16) fprintf(fp, " ");
130  else if (ch < 8) {
131  int spaces = (16 - ch) * 3 + 2 + 1;
132  int s = 0;
133  for ( ; s < spaces; s++) fprintf(fp, " ");
134  } else if(ch < 16) {
135  int spaces = (16 - ch) * 3 + 2;
136  int s = 0;
137  for ( ; s < spaces; s++) fprintf(fp, " ");
138  }
139 
140  for (ch = 0; (u+ch) < buflen && ch < 16; ch++) {
141  fprintf(fp, "%c", isprint((uint8_t)buf[u+ch]) ? (uint8_t)buf[u+ch] : '.');
142 
143  if (ch == 7) fprintf(fp, " ");
144  if (ch == 15) fprintf(fp, "\n");
145  }
146  }
147  if (ch != 16)
148  fprintf(fp, "\n");
149 }
150 
151 void PrintRawDataToBuffer(uint8_t *dst_buf, uint32_t *dst_buf_offset_ptr, uint32_t dst_buf_size,
152  const uint8_t *src_buf, uint32_t src_buf_len)
153 {
154  int ch = 0;
155 
156  for (uint32_t u = 0; u < src_buf_len; u += 16) {
157  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size,
158  " %04X ", u);
159  for (ch = 0; (u + ch) < src_buf_len && ch < 16; ch++) {
160  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size,
161  "%02X ", (uint8_t)src_buf[u + ch]);
162 
163  if (ch == 7) {
164  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size,
165  " ");
166  }
167  }
168  if (ch == 16) {
169  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size, " ");
170  } else if (ch < 8) {
171  int spaces = (16 - ch) * 3 + 2 + 1;
172  int s = 0;
173  for ( ; s < spaces; s++)
174  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size, " ");
175  } else if(ch < 16) {
176  int spaces = (16 - ch) * 3 + 2;
177  int s = 0;
178  for ( ; s < spaces; s++)
179  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size, " ");
180  }
181 
182  for (ch = 0; (u+ch) < src_buf_len && ch < 16; ch++) {
183  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size,
184  "%c",
185  isprint((uint8_t)src_buf[u + ch]) ? (uint8_t)src_buf[u + ch] : '.');
186 
187  if (ch == 7)
188  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size, " ");
189  if (ch == 15)
190  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size, "\n");
191  }
192  }
193  if (ch != 16)
194  PrintBufferData((char *)dst_buf, dst_buf_offset_ptr, dst_buf_size, "\n");
195 
196  return;
197 }
198 
199 void PrintStringsToBuffer(uint8_t *dst_buf, uint32_t *dst_buf_offset_ptr, uint32_t dst_buf_size,
200  const uint8_t *src_buf, const uint32_t src_buf_len)
201 {
202  for (uint32_t ch = 0; ch < src_buf_len && *dst_buf_offset_ptr < dst_buf_size;
203  ch++, (*dst_buf_offset_ptr)++) {
204  if (isprint((uint8_t)src_buf[ch]) || src_buf[ch] == '\n' || src_buf[ch] == '\r') {
205  dst_buf[*dst_buf_offset_ptr] = src_buf[ch];
206  } else {
207  dst_buf[*dst_buf_offset_ptr] = '.';
208  }
209  }
210  dst_buf[dst_buf_size - 1] = 0;
211 
212  return;
213 }
214 
215 #ifndef s6_addr16
216 # define s6_addr16 __u6_addr.__u6_addr16
217 #endif
218 
219 static const char *PrintInetIPv6(const void *src, char *dst, socklen_t size)
220 {
221  char s_part[6];
222  uint16_t x[8];
223  memcpy(&x, src, 16);
224 
225  /* current IPv6 format is fixed size */
226  if (size < 8 * 5) {
227  SCLogWarning("Too small buffer to write IPv6 address");
228  return NULL;
229  }
230  memset(dst, 0, size);
231  for (int i = 0; i < 8; i++) {
232  snprintf(s_part, sizeof(s_part), "%04x:", htons(x[i]));
233  strlcat(dst, s_part, size);
234  }
235  /* suppress last ':' */
236  dst[strlen(dst) - 1] = 0;
237 
238  return dst;
239 }
240 
241 const char *PrintInet(int af, const void *src, char *dst, socklen_t size)
242 {
243  switch (af) {
244  case AF_INET:
245 #if defined(OS_WIN32) && NTDDI_VERSION >= NTDDI_VISTA
246 {
247  // because Windows has to provide a non-conformant inet_ntop, of
248  // course!
249  struct in_addr _src;
250  memcpy(&_src, src, sizeof(struct in_addr));
251  return inet_ntop(af, &_src, dst, size);
252 }
253 #else
254  return inet_ntop(af, src, dst, size);
255 #endif
256  case AF_INET6:
257  /* Format IPv6 without deleting zeroes */
258  return PrintInetIPv6(src, dst, size);
259  default:
260  SCLogError("Unsupported protocol: %d", af);
261  }
262  return NULL;
263 }
264 
265 void PrintHexString(char *str, size_t size, uint8_t *buf, size_t buf_len)
266 {
267  DEBUG_VALIDATE_BUG_ON(size < 2 * buf_len);
268  rs_to_hex((uint8_t *)str, size, buf, buf_len);
269 }
BUFFER_LENGTH
#define BUFFER_LENGTH
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
PrintHexString
void PrintHexString(char *str, size_t size, uint8_t *buf, size_t buf_len)
Definition: util-print.c:265
rust.h
PrintStringsToBuffer
void PrintStringsToBuffer(uint8_t *dst_buf, uint32_t *dst_buf_offset_ptr, uint32_t dst_buf_size, const uint8_t *src_buf, const uint32_t src_buf_len)
Definition: util-print.c:199
util-debug.h
util-error.h
PrintRawDataToBuffer
void PrintRawDataToBuffer(uint8_t *dst_buf, uint32_t *dst_buf_offset_ptr, uint32_t dst_buf_size, const uint8_t *src_buf, uint32_t src_buf_len)
Definition: util-print.c:151
PrintBufferRawLineHex
void PrintBufferRawLineHex(char *nbuf, int *offset, int max_size, const uint8_t *buf, uint32_t buflen)
print a buffer as hex on a single line
Definition: util-print.c:44
strlcat
size_t strlcat(char *, const char *src, size_t siz)
Definition: util-strlcatu.c:45
util-print.h
PrintInet
const char * PrintInet(int af, const void *src, char *dst, socklen_t size)
Definition: util-print.c:241
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
PrintRawDataFp
void PrintRawDataFp(FILE *fp, const uint8_t *buf, uint32_t buflen)
Definition: util-print.c:114
PrintBufferData
#define PrintBufferData(buf, buf_offset_ptr, buf_size,...)
Definition: util-print.h:27
suricata-common.h
util-validate.h
PrintRawUriFp
void PrintRawUriFp(FILE *fp, uint8_t *buf, uint32_t buflen)
Definition: util-print.c:69
str
#define str(s)
Definition: suricata-common.h:291
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
src
uint16_t src
Definition: app-layer-dnp3.h:5
PrintRawUriBuf
void PrintRawUriBuf(char *retbuf, uint32_t *offset, uint32_t retbuflen, uint8_t *buf, uint32_t buflen)
Definition: util-print.c:93
af
uint16_t af
Definition: decode-gre.h:0
dst
uint16_t dst
Definition: app-layer-dnp3.h:4
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:103
PrintRawLineHexBuf
void PrintRawLineHexBuf(char *retbuf, uint32_t retbuflen, const uint8_t *buf, uint32_t buflen)
print a buffer as hex on a single line into retbuf buffer
Definition: util-print.c:61